| org.eclipse.ui.ISaveablePart
| ISaveablePart | | public interface ISaveablePart (Code) | | Workbench parts implement or adapt to this interface to participate
in the enablement and execution of the Save and
Save As actions.
since:
2.1
See Also: org.eclipse.ui.IEditorPart
See Also: |
| Field Summary | |
| final public static int | PROP_DIRTY
The property id for isDirty. |
| Method Summary | |
| public void | doSave(IProgressMonitor monitor)
Saves the contents of this part.
If the save is successful, the part should fire a property changed event
reflecting the new dirty state (PROP_DIRTY property).
If the save is cancelled through user action, or for any other reason, the
part should invoke setCancelled on the IProgressMonitor
to inform the caller.
This method is long-running; progress and cancellation are provided
by the given progress monitor. | | public void | doSaveAs()
Saves the contents of this part to another object.
Implementors are expected to open a "Save As" dialog where the user will
be able to select a new name for the contents. | | public boolean | isDirty()
Returns whether the contents of this part have changed since the last save
operation. | | public boolean | isSaveAsAllowed()
Returns whether the "Save As" operation is supported by this part. | | public boolean | isSaveOnCloseNeeded()
Returns whether the contents of this part should be saved when the part
is closed. |
| PROP_DIRTY | | final public static int PROP_DIRTY(Code) | | The property id for isDirty.
|
| doSave | | public void doSave(IProgressMonitor monitor)(Code) | | Saves the contents of this part.
If the save is successful, the part should fire a property changed event
reflecting the new dirty state (PROP_DIRTY property).
If the save is cancelled through user action, or for any other reason, the
part should invoke setCancelled on the IProgressMonitor
to inform the caller.
This method is long-running; progress and cancellation are provided
by the given progress monitor.
Parameters:
monitor - the progress monitor |
| doSaveAs | | public void doSaveAs()(Code) | | Saves the contents of this part to another object.
Implementors are expected to open a "Save As" dialog where the user will
be able to select a new name for the contents. After the selection is made,
the contents should be saved to that new name. During this operation a
IProgressMonitor should be used to indicate progress.
If the save is successful, the part fires a property changed event
reflecting the new dirty state (PROP_DIRTY property).
|
| isDirty | | public boolean isDirty()(Code) | | Returns whether the contents of this part have changed since the last save
operation. If this value changes the part must fire a property listener
event with PROP_DIRTY.
Note: this method is called often on a part open or part
activation switch, for example by actions to determine their
enabled status.
true if the contents have been modified and needsaving, and false if they have not changed since the lastsave |
| isSaveAsAllowed | | public boolean isSaveAsAllowed()(Code) | | Returns whether the "Save As" operation is supported by this part.
true if "Save As" is supported, and falseif not supported |
| isSaveOnCloseNeeded | | public boolean isSaveOnCloseNeeded()(Code) | | Returns whether the contents of this part should be saved when the part
is closed.
true if the contents of the part should be saved onclose, and false if the contents are expendable |
|
|