- All Known Implementing Classes:
public interface ISaveablesSourceRepresents 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
ISaveablesSourcemust satisfy the following conditions:
- If ISaveablesSource is implemented by an IWorkbenchPart:
- the part must implement
- if any of its Saveable objects are dirty, the part must return
- the part must return
ISaveablePart.isSaveOnCloseNeeded()if it is dirty (the default behaviour implemented by
- the part must not implement
- the part must implement
- If ISaveablesSource is implemented by a non-part (possible as of 3.2.1 and 3.3):
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.
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
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_CLOSEfollowed by an event of type
SaveablesLifecycleEvent.POST_CLOSE. Since firing the
PRE_CLOSEevent 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_CLOSEnotification is sufficient.
The listener is obtained from the part site by calling
The part must not notify from its initialization methods (e.g.
createPartControl), or from its dispose method. Parts that implement
IReusableEditormust notify when their input is changed through
- the saveables presented by the workbench part
- See Also:
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.
- the saveables currently active in the workbench part