com.xmlmind.xmleditapp.desktop.help

Class HelpAction

java.lang.Object

javax.swing.AbstractAction

com.xmlmind.xmleditapp.desktop.AppAction

com.xmlmind.xmleditapp.desktop.help.HelpAction

All Implemented Interfaces:

AppPart, ActionListener, Serializable, Cloneable, EventListener, Action

public class HelpAction
extends AppAction

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	doIt() Actually implements the action.
String	getHelpId()
void	initApp(App app, String id) Specifies the App containing this part and the unique ID of this part within the App.
void	setHelpId(String helpId)
void	updateEnabled() This action should enable or disable itself using standard method setEnabled(boolean).

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, 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

Constructor Detail

HelpAction

public HelpAction()

Method Detail

initApp

public void initApp(App app,
                    String id)

Description copied from class: AppAction

Specifies the App containing this part and the unique ID of this part within the App. Invoked when the component is attached to the App.

Default implementation simply stores its arguments in AppAction.app and AppAction.id.

Specified by:

initApp in interface AppPart

Overrides:

initApp in class AppAction

See Also:

AppPart.getApp(), AppPart.getId(), App.getPart(java.lang.String)

setHelpId

public void setHelpId(String helpId)

getHelpId

public String getHelpId()

doIt

public void doIt()

Description copied from class: AppAction

Actually implements the action. (Standard method actionPerformed(ActionEvent) simply invokes doIt().)

Will not be called if this action is not enabled (that is, isEnabled() returns false).

Specified by:

doIt in class AppAction

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