org.eclipse.ui
Interface ISaveablesSource
-
All Known Implementing Classes:
-
AbstractDecoratedTextEditor,
AbstractTextEditor,
CommonNavigator,
ProjectExplorer,
SaveableCompareEditorInput,
StatusTextEditor,
SyncInfoCompareInput,
TextEditor
-
public interface 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:
- If ISaveablesSource is implemented by a non-part (possible as of 3.2.1 and 3.3):
- the Workbench's
ISaveablesLifecycleListener (obtained from the
Workbench by calling
workbench.getService(ISaveablesLifecycleListener.class)) must
be notified of any change to the result of
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
getSaveables
Saveable[] getSaveables()
- Returns the saveables presented by the workbench part. If the return
value of this method changes during the lifetime of
this part (i.e. after initialization and control creation but before disposal)
the part must notify an implicit listener using
ISaveablesLifecycleListener.handleLifecycleEvent(SaveablesLifecycleEvent).
Additions of saveables to the list of saveables of this part are
announced using an event of type
SaveablesLifecycleEvent.POST_OPEN. Removals are announced in a
two-stage process, first using an event of type
SaveablesLifecycleEvent.PRE_CLOSE followed by an event of type
SaveablesLifecycleEvent.POST_CLOSE. Since firing the
PRE_CLOSE event may trigger prompts to save dirty
saveables, the cancellation status of the event must be checked by the
part after the notification. When removing only non-dirty saveables,
POST_CLOSE notification is sufficient.
The listener is obtained from the part site by calling
partSite.getService(ISaveablesLifecycleListener.class).
The part must not notify from its initialization methods (e.g. init
or createPartControl), or from its dispose method. Parts that
implement
IReusableEditor must notify when their input is changed
through
IReusableEditor.setInput(IEditorInput).
-
-
Returns:
- the saveables presented by the workbench part
-
See Also:
-
ISaveablesLifecycleListener
getActiveSaveables
Saveable[] getActiveSaveables()
- Returns the saveables currently active in the workbench part.
Certain workbench actions, such as Save, target only the active saveables
in the active part. For example, the active saveables could be determined
based on the current selection in the part.
-
-
Returns:
- the saveables currently active in the workbench part
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
