Interface ISaveablePart2

  • All Superinterfaces:
    ISaveablePart

    public interface ISaveablePart2
    extends ISaveablePart
    Workbench parts implement or adapt to this interface to participate in actions that require a prompt for the user to provide input on what to do with unsaved data when the part is closed or the Workbench is shut down.

    Note that if a part implements this interface, it is excluded from the common "prompt to save" dialog, and instead opens its own dialog. This may cause multiple prompts to the end user during a single user operation. Implementors should be aware that this may lead to a less than optimal user experience.

    Since:
    3.1
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int CANCEL
      Standard return code constant (value 2) indicating that the part does not need to be saved and the part should not be closed.
      static int DEFAULT
      Standard return code constant (value 3) indicating that the default behavior for prompting the user to save will be used.
      static int NO
      Standard return code constant (value 1) indicating that the part does not need to be saved and the part should be closed.
      static int YES
      Standard return code constant (value 0) indicating that the part needs to be saved.
    • Field Detail

      • YES

        static final int YES
        Standard return code constant (value 0) indicating that the part needs to be saved.
        See Also:
        Constant Field Values
      • NO

        static final int NO
        Standard return code constant (value 1) indicating that the part does not need to be saved and the part should be closed.
        See Also:
        Constant Field Values
      • CANCEL

        static final int CANCEL
        Standard return code constant (value 2) indicating that the part does not need to be saved and the part should not be closed.
        See Also:
        Constant Field Values
      • DEFAULT

        static final int DEFAULT
        Standard return code constant (value 3) indicating that the default behavior for prompting the user to save will be used.
        See Also:
        Constant Field Values
    • Method Detail

      • promptToSaveOnClose

        int promptToSaveOnClose()
        Prompts the user for input on what to do with unsaved data. This method is only called when the part is closed or when the Workbench is shutting down.

        Implementors are expected to open a custom dialog where the user will be able to determine what to do with the unsaved data. Implementors may also return a result of DEFAULT to get the default prompt handling from the Workbench.

        Returns:
        the return code, must be either YES, NO, CANCEL or DEFAULT.