org.apache.cayenne.modeler.util

Class CayenneAction

java.lang.Object

javax.swing.AbstractAction

org.apache.cayenne.modeler.util.CayenneAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

Direct Known Subclasses:

AboutAction, ChangeObjEntityListenerClassAction, CollapseTreeAction, ConfigurePreferencesAction, CopyAction, CreateAttributeAction, CreateCallbackMethodAction, CreateDataMapAction, CreateDbEntityAction, CreateEmbeddableAction, CreateNodeAction, CreateObjEntityAction, CreateObjEntityListenerAction, CreateProcedureAction, CreateProcedureParameterAction, CreateQueryAction, CreateRelationshipAction, CutAction, DbEntityCounterpartAction, DbEntitySyncAction, DBWizardAction, DocumentationAction, EntityDisplayAction, FilterAction, FindAction, GenerateCodeAction, ImportDataMapAction, ImportEOModelAction, InferRelationshipsAction, LinkDataMapAction, LinkDataMapsAction, NavigateBackwardAction, NavigateForwardAction, ObjEntityCounterpartAction, ObjEntitySyncAction, PasteAction, ProjectAction, RebuildGraphAction, RedoAction, RemoveAction, RevertAction, SaveAsAction, SaveAsImageAction, ShowGraphEntityAction, ShowLogConsoleAction, UndoAction, ValidateAction, ZoomInAction, ZoomOutAction

public abstract class CayenneAction
extends AbstractAction

Superclass of CayenneModeler actions that implements support for some common functionality, exception handling, etc.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	alwaysOn
protected Application	application

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
CayenneAction(String name, Application application) Creates a named CayenneAction.
CayenneAction(String name, Application application, String shortDescription) Creates a named CayenneAction.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) Internally calls performAction.
JButton	buildButton() Factory method that creates a button hooked up to this action.
JCheckBoxMenuItem	buildCheckBoxMenu() Factory method that creates a checkbox menu item hooked up to this action.
JMenuItem	buildMenu() Factory method that creates a menu item hooked up to this action.
Icon	createIcon() Creates and returns an ImageIcon that can be used for buttons that rely on this action.
boolean	enableForPath(ConfigurationNode object) Returns true if the action is enabled for the specified "project path" - a path on the project tree to a currently selected object.
KeyStroke	getAcceleratorKey() Returns keyboard shortcut for this action.
Application	getApplication()
protected Project	getCurrentProject()
String	getIconName() Returns the name of the icon that should be used for buttons.
String	getKey() Returns the key under which this action should be stored in the ActionMap.
ProjectController	getProjectController() Returns current project controller.
boolean	isAlwaysOn() Returns true if this action is always enabled.
abstract void	performAction(ActionEvent e) Subclasses must implement this method instead of actionPerformed to allow for exception handling.
void	setAlwaysOn(boolean alwaysOn) Sets the alwaysOn.
void	setEnabled(boolean b) Overrides super implementation to take into account "alwaysOn" flag.
void	setName(String newName) Changes the name of this action, propagating the change to all widgets using this action.

Methods inherited from class javax.swing.AbstractAction

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

Methods inherited from class java.lang.Object

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

Field Detail

alwaysOn

protected boolean alwaysOn

application

protected Application application

Constructor Detail

CayenneAction

public CayenneAction(String name,
             Application application)

Creates a named CayenneAction.

CayenneAction

public CayenneAction(String name,
             Application application,
             String shortDescription)

Creates a named CayenneAction.

Method Detail

getApplication

public Application getApplication()

getCurrentProject

protected Project getCurrentProject()

setName

public void setName(String newName)

Changes the name of this action, propagating the change to all widgets using this action.

getAcceleratorKey

public KeyStroke getAcceleratorKey()

Returns keyboard shortcut for this action. Default implementation returns null.

getIconName

public String getIconName()

Returns the name of the icon that should be used for buttons. Name will be reolved relative to RESOURCE_PATH. Default implementation returns null.

createIcon

public Icon createIcon()

Creates and returns an ImageIcon that can be used for buttons that rely on this action. Returns null if getIconName returns null.

getKey

public String getKey()

Returns the key under which this action should be stored in the ActionMap.

performAction

public abstract void performAction(ActionEvent e)

Subclasses must implement this method instead of actionPerformed to allow for exception handling.

enableForPath

public boolean enableForPath(ConfigurationNode object)

Returns true if the action is enabled for the specified "project path" - a path on the project tree to a currently selected object. Default implementation simply returns false.

getProjectController

public ProjectController getProjectController()

Returns current project controller.

actionPerformed

public void actionPerformed(ActionEvent e)

Internally calls performAction. Traps exceptions that ocurred during action processing.

buildMenu

public JMenuItem buildMenu()

Factory method that creates a menu item hooked up to this action.

buildCheckBoxMenu

public JCheckBoxMenuItem buildCheckBoxMenu()

Factory method that creates a checkbox menu item hooked up to this action.

buildButton

public JButton buildButton()

Factory method that creates a button hooked up to this action.

isAlwaysOn

public boolean isAlwaysOn()

Returns true if this action is always enabled.

Returns:

boolean

setAlwaysOn

public void setAlwaysOn(boolean alwaysOn)

Sets the alwaysOn.

Parameters:

alwaysOn - The alwaysOn to set

setEnabled

public void setEnabled(boolean b)

Overrides super implementation to take into account "alwaysOn" flag.

Specified by:

setEnabled in interface Action

Overrides:

setEnabled in class AbstractAction