Examples of org.eclipse.ui.ISaveablesSource

org.eclipse.ui.ISaveablesSource

Represents a source of Saveable objects (units of saveability). Workbench parts that show more than one unit of saveability, or whose units of saveability change over time, should implement this interface in order to provide better integration with workbench facilities like the Save command, prompts to save on part close or shutdown, etc.

IMPORTANT: As of 3.2, implementers of ISaveablesSource must satisfy the following conditions:

If ISaveablesSource is implemented by an IWorkbenchPart:
- the part must implement ISaveablePart
- if any of its Saveable objects are dirty, the part must return true from {@link ISaveablePart#isDirty()}
- the part must return true from {@link ISaveablePart#isSaveOnCloseNeeded()} if it is dirty (the defaultbehaviour implemented by {@link EditorPart})
- the part must not implement {@link ISaveablePart2}
If ISaveablesSource is implemented by a non-part (possible as of 3.2.1 and 3.3):
- the Workbench's {@link ISaveablesLifecycleListener} (obtained from theWorkbench by calling workbench.getService(ISaveablesLifecycleListener.class)) must be notified of any change to the result of {@link #getSaveables()}
- getActiveSaveables() should be implemented to return an empty array

If any of these conditions are not met, it is undefined whether the Workbench will prompt to save dirty Saveables when closing parts or the Workbench.

These conditions may be relaxed in future releases.

@since 3.2

        if (saveable == null) {
          saveable = getActiveEditor();
        }
        /* **********************************************************************************/
        if (saveable instanceof ISaveablesSource) {
      ISaveablesSource modelSource = (ISaveablesSource) saveable;
      setEnabled(SaveableHelper.needsSave(modelSource));
      return;
        }
        setEnabled(saveable != null && saveable.isDirty());
    }

   *            the workbench part
   * @return the saveable models
   */
  private Saveable[] getSaveables(IWorkbenchPart part) {
    if (part instanceof ISaveablesSource) {
      ISaveablesSource source = (ISaveablesSource) part;
      return source.getSaveables();
    } else if (part instanceof ISaveablePart) {
      return new Saveable[] { new DefaultSaveable(part) };
    } else {
      return new Saveable[0];
    }

   * @param part the workbench part
   * @return the saveable models
   */
  private static Saveable[] getSaveables(IWorkbenchPart part) {
    if (part instanceof ISaveablesSource) {
      ISaveablesSource source = (ISaveablesSource) part;
      return source.getSaveables();
    }
    return new Saveable[] { new DefaultSaveable(part) };
  }

Related Classes of org.eclipse.ui.ISaveablesSource

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.