|
Eclipse Platform 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Workbench parts implement or adapt to this interface to participate
in the enablement and execution of the Save
and
Save As
actions.
NOTE: This is experimental API, which may be changed or removed at any point in time. This API should not be called, overridden or otherwise used in production code.
IEditorPart
Field Summary | |
static int |
PROP_DIRTY
The property id for isDirty . |
Method Summary | |
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. |
Field Detail |
public static final int PROP_DIRTY
isDirty
.Method Detail |
public 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 monitorpublic void 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).
public boolean isDirty()
PROP_DIRTY
.
true
if the contents have been modified and need
saving, and false
if they have not changed since the last
savepublic boolean isSaveAsAllowed()
true
if "Save As" is supported, and false
if not supportedpublic boolean isSaveOnCloseNeeded()
true
if the contents of the part should be saved on
close, and false
if the contents are expendable
|
Eclipse Platform 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |