com.xmlmind.xmleditapp.desktop.file

Class SaveAction

java.lang.Object

javax.swing.AbstractAction

com.xmlmind.xmleditapp.desktop.AppAction

com.xmlmind.xmleditapp.desktop.LengthyAction

com.xmlmind.xmleditapp.desktop.file.SaveAction

All Implemented Interfaces:

AppPart, SaveDocumentService, ActionListener, Serializable, Cloneable, EventListener, Action

public class SaveAction
extends LengthyAction
implements SaveDocumentService

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected URL	outURL

Fields inherited from class com.xmlmind.xmleditapp.desktop.AppAction

app, id, MODIFIERS_TOOLTIP_KEY, NO_MNEMONIC, SELECTED_ICON_KEY, UNSELECTED_ICON_KEY

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface com.xmlmind.xmleditapp.desktop.SaveDocumentService

PART_ID

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor and Description
SaveAction()

Method Summary

Modifier and Type	Method and Description
protected CommandResult	doExec(OpenedDocument openedDoc, URL saveURL)
protected void	exec() Second step of LengthyAction.doIt().
protected boolean	init() First step of LengthyAction.doIt().
boolean	saveDocument(OpenedDocument openedDoc, URL saveURL) Saves specified opened document.
void	saveStateChanged() Invoked after active document has been saved or, on the contrary, when its has been modified and thus needs to be saved.
void	updateEnabled() This action should enable or disable itself using standard method setEnabled(boolean).

Methods inherited from class com.xmlmind.xmleditapp.desktop.LengthyAction

doIt, finish

Methods inherited from class com.xmlmind.xmleditapp.desktop.AppAction

actionPerformed, activeEditorChanged, applyPreferences, destroyApp, editingContextChanged, flushPreferences, getAccelerator, getApp, getDialogTitle, getIcon, getId, getLabel, getMnemonic, getMnemonicIndex, getModifiersToolTip, getSelectedIcon, getToolTip, getUnselectedIcon, hasListeners, initApp, isEditingContextSensitive, isSelected, namespacePrefixesChanged, setAccelerator, setDisabledIcons, setIcon, setLabel, setMnemonic, setMnemonicIndex, setModifiersToolTip, setSelected, setSelectedIcon, setToolTip, setUnselectedIcon, undoStateChanged, validityStateChanged, wasCtrlClick, wasRightClick, wasShiftClick

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

outURL

protected URL outURL

Constructor Detail

SaveAction

public SaveAction()

Method Detail

init

protected boolean init()

Description copied from class: LengthyAction

First step of LengthyAction.doIt(). Possibly an interactive one. It is possible to prompt the user during this step and therefore, the user can cancel the execution of the action (before it actually starts).

Specified by:

init in class LengthyAction

Returns:

true if execution should proceed; false if execution has been canceled

exec

protected void exec()

Description copied from class: LengthyAction

Second step of LengthyAction.doIt(). Actual execution of the action. A busy cursor is displayed during this step.

Specified by:

exec in class LengthyAction

doExec

protected CommandResult doExec(OpenedDocument openedDoc,
                               URL saveURL)

updateEnabled

public void updateEnabled()

Description copied from class: AppAction

This action should enable or disable itself using standard method setEnabled(boolean).

This method is invoked:

• each time the active editor changes;
• for a context sensitive action, each time the editing context changes.

Specified by:

updateEnabled in class AppAction

See Also:

AppAction.activeEditorChanged(), AppAction.editingContextChanged()

saveStateChanged

public void saveStateChanged()

Description copied from class: AppAction

Invoked after active document has been saved or, on the contrary, when its has been modified and thus needs to be saved.

Default implementation does nothing at all.

Specified by:

saveStateChanged in interface AppPart

Overrides:

saveStateChanged in class AppAction

See Also:

App.getActiveOpenedDocument(), OpenedDocument.isSaveNeeded()

saveDocument

public boolean saveDocument(OpenedDocument openedDoc,
                            URL saveURL)

Description copied from interface: SaveDocumentService

Saves specified opened document.

Specified by:

saveDocument in interface SaveDocumentService

Parameters:

openedDoc - document to be saved

saveURL - if null, the document is saved to its current location; otherwise it is saved to specified location, in which case this method behaves like File|Save As.

Returns:

true if document has been successfully saved; false otherwise