com.xmlmind.xmleditapp.desktop.file

Class OpenAction

java.lang.Object

javax.swing.AbstractAction

com.xmlmind.xmleditapp.desktop.AppAction

com.xmlmind.xmleditapp.desktop.LengthyAction

com.xmlmind.xmleditapp.desktop.file.OpenAction

All Implemented Interfaces:

AppPart, OpenDocumentService, ActionListener, Serializable, Cloneable, EventListener, Action

public class OpenAction
extends LengthyAction
implements OpenDocumentService

Open a document in the App.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected URL	inURL The URL of the document to be opened.
protected boolean	readOnly true if the document is to be opened in read-only mode; true if the document is to be opened in (normal) read-write mode.

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.OpenDocumentService

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
OpenAction()

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) Simply invokes AppAction.doIt().
static void	autoShowValidityPane(App app, Diagnostic[] diagnostics) Ensure that CheckValidityPane is visible depending on the severity of specified diagnostics and on the value of user preference autoShowValidityPane.
protected boolean	canRevertToSaved(OpenedDocument openedDoc)
protected CommandResult	doExec(URL openURL, boolean notEditable, Object settings)
protected void	exec() Second step of LengthyAction.doIt().
protected boolean	init() First step of LengthyAction.doIt().
boolean	openDocument(URL url, boolean readOnly, Object settings) Opens specified document in the XML editor.
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

activeEditorChanged, applyPreferences, destroyApp, editingContextChanged, flushPreferences, getAccelerator, getApp, getDialogTitle, getIcon, getId, getLabel, getMnemonic, getMnemonicIndex, getModifiersToolTip, getSelectedIcon, getToolTip, getUnselectedIcon, hasListeners, initApp, isEditingContextSensitive, isSelected, namespacePrefixesChanged, saveStateChanged, 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

inURL

protected URL inURL

The URL of the document to be opened. This field is set in init().

readOnly

protected boolean readOnly

true if the document is to be opened in read-only mode; true if the document is to be opened in (normal) read-write mode. This field is set in init().

Constructor Detail

OpenAction

public OpenAction()

Method Detail

actionPerformed

public void actionPerformed(ActionEvent e)

Description copied from class: AppAction

Simply invokes AppAction.doIt().

Specified by:

actionPerformed in interface ActionListener

Overrides:

actionPerformed in class AppAction

init

protected boolean init()

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).

This implementation displays a file chooser dialog box and then sets inURL and readOnly to reflect the user choice.

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(URL openURL,
                               boolean notEditable,
                               Object settings)

autoShowValidityPane

public static void autoShowValidityPane(App app,
                                        Diagnostic[] diagnostics)

Ensure that CheckValidityPane is visible depending on the severity of specified diagnostics and on the value of user preference autoShowValidityPane.

canRevertToSaved

protected boolean canRevertToSaved(OpenedDocument openedDoc)

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()

openDocument

public boolean openDocument(URL url,
                            boolean readOnly,
                            Object settings)

Description copied from interface: OpenDocumentService

Opens specified document in the XML editor.

Specified by:

openDocument in interface OpenDocumentService

Parameters:

url - URL of document to be opened

readOnly - if true, the document is to be opened in read-only mode

settings - implementation-specific information about the way specified document is to be opened. May be null which means: use defaults.

Returns:

true if document has been successfully opened; false otherwise (e.g. specified location cannot be opened)