org.eclipse.ui
Interface ISaveableModelSource

All Known Implementing Classes:

ModelSynchronizeParticipant

public interface ISaveableModelSource

Workbench parts that work in terms of saveable models 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.

Since:

3.2

Method Summary

ISaveableModel[]	getActiveModels() Returns the saveable models currently active in the workbench part.
ISaveableModel[]	getModels() Returns the saveable models presented by the workbench part.

Method Detail

getModels

public ISaveableModel[] getModels()

Returns the saveable models presented by the workbench part. If the return value of this method changes during the lifetime of this part, the model manager must be notified about these changes by calling ISaveableModelManager.handleModelLifecycleEvent(ModelLifecycleEvent).

The model manager is available as a service from the part site, by calling partSite.getService(ISaveableModelManager.class).

Returns:

the saveable models presented by the workbench part

See Also:

ISaveableModelManager

getActiveModels

public ISaveableModel[] getActiveModels()

Returns the saveable models currently active in the workbench part.

Certain workbench actions, such as Save, target only the active models in the active part. For example, the active saveable models could be determined based on the current selection in the part.

Returns:

the saveable models currently active in the workbench part