public interface ISaveablePart
Save
and
Save As
actions.IEditorPart
Modifier and Type | Field and Description |
---|---|
static int |
PROP_DIRTY
The property id for
isDirty . |
Modifier and Type | Method and Description |
---|---|
void |
doSave(IProgressMonitor monitor)
Saves the contents of this part.
|
void |
doSaveAs()
Saves the contents of this part to another object.
|
boolean |
isDirty()
Returns whether the contents of this part have changed since the last save
operation.
|
boolean |
isSaveAsAllowed()
Returns whether the "Save As" operation is supported by this part.
|
boolean |
isSaveOnCloseNeeded()
Returns whether the contents of this part should be saved when the part
is closed.
|
static final int PROP_DIRTY
isDirty
.void doSave(IProgressMonitor monitor)
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.
monitor
- the progress monitorvoid doSaveAs()
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).
boolean isDirty()
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 need
saving, and false
if they have not changed since the last
saveboolean isSaveAsAllowed()
true
if "Save As" is supported, and false
if not supportedboolean isSaveOnCloseNeeded()
true
if the contents of the part should be saved on
close, and false
if the contents are expendable
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.