org.mdi.bootstrap.swing

Class AbstractMDIAction

java.lang.Object

javax.swing.AbstractAction

org.mdi.bootstrap.swing.AbstractMDIAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action, MDIAction

public abstract class AbstractMDIAction
extends javax.swing.AbstractAction
implements MDIAction

An MDIAction that is also an AbstractAction, which allows to use it directly in swing components.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected MDIApplication	app The application.
protected MDIActionHandler	handler The action handler.

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
AbstractMDIAction() Defines an AbstractMDIAction object with a default description string and default icon.
AbstractMDIAction(MDIApplication app) Defines an AbstractMDIAction object with a default description string and default icon.
AbstractMDIAction(MDIApplication app, java.lang.String name) Defines an AbstractMDIAction object with a specified description string and default icon.
AbstractMDIAction(MDIApplication app, java.lang.String name, javax.swing.Icon icon) Defines an AbstractMDIAction object with specified description string and icon.
AbstractMDIAction(java.lang.String name) Defines an AbstractMDIAction object with a specified description string and default icon.
AbstractMDIAction(java.lang.String name, javax.swing.Icon icon) Defines an AbstractMDIAction object with specified description string and icon.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Call MDIApplication.executeAction(MDIAction).
void	endAction() Code to perform after the end of the MDIAction (for example creating a new tab for the MDIApplication, with the result of the MDIAction.
void	executeAction() Execute the Action.
java.lang.Object	executeAction(boolean inSameThread) Execute the Action.
MDIActionHandler	getActionHandler() Return the associated MDIActionHandler, or null if there is none.
protected java.lang.String	getActionName() Return the action name.
java.lang.String	getLongDescription() Return the long description of this MDIAction, which is the Action.LONG_DESCRIPTION of the AbstractAction from which it derives.
java.lang.String	getMessage() Get the message associated with the action.
java.lang.String	getShortDescription() Return a short description of the action.
abstract void	run() Run the action.
void	setActionHandler(MDIActionHandler handler) Set the MDIActionHandler for this AbstractMDIAction (null by default).
void	setDescription(java.lang.String shortDesc, java.lang.String longDesc) Set the short and long description of this MDIAction.

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

Methods inherited from interface org.mdi.bootstrap.MDIAction

getActionResult

Field Detail

handler

protected MDIActionHandler handler

The action handler.

app

protected MDIApplication app

The application.

Constructor Detail

AbstractMDIAction

public AbstractMDIAction()

Defines an AbstractMDIAction object with a default description string and default icon.

AbstractMDIAction

public AbstractMDIAction(java.lang.String name)

Defines an AbstractMDIAction object with a specified description string and default icon.

Parameters:

name - the Action name

AbstractMDIAction

public AbstractMDIAction(java.lang.String name,
                         javax.swing.Icon icon)

Defines an AbstractMDIAction object with specified description string and icon.

Parameters:

name - the Action name

icon - the Action Icon

AbstractMDIAction

public AbstractMDIAction(MDIApplication app)

Defines an AbstractMDIAction object with a default description string and default icon.

Parameters:

app - the application

AbstractMDIAction

public AbstractMDIAction(MDIApplication app,
                         java.lang.String name)

Defines an AbstractMDIAction object with a specified description string and default icon.

Parameters:

app - the application

name - the name

See Also:

app

AbstractMDIAction

public AbstractMDIAction(MDIApplication app,
                         java.lang.String name,
                         javax.swing.Icon icon)

Defines an AbstractMDIAction object with specified description string and icon.

Parameters:

app - the application

name - the name

icon - the icon

Method Detail

getActionName

protected java.lang.String getActionName()

Return the action name.

Returns:

the action name

setActionHandler

public void setActionHandler(MDIActionHandler handler)

Set the MDIActionHandler for this AbstractMDIAction (null by default). The MDIActionHandler can perform specific code before or after the Action.

Specified by:

setActionHandler in interface MDIAction

Parameters:

handler - the handler

getShortDescription

public java.lang.String getShortDescription()

Return a short description of the action.

Specified by:

getShortDescription in interface MDIAction

Returns:

a short description of the action

setDescription

public void setDescription(java.lang.String shortDesc,
                           java.lang.String longDesc)

Set the short and long description of this MDIAction.

Parameters:

shortDesc - the short description

longDesc - the long description

getLongDescription

public java.lang.String getLongDescription()

Return the long description of this MDIAction, which is the Action.LONG_DESCRIPTION of the AbstractAction from which it derives.

Specified by:

getLongDescription in interface MDIAction

Returns:

the long description of the action

getActionHandler

public MDIActionHandler getActionHandler()

Return the associated MDIActionHandler, or null if there is none.

Specified by:

getActionHandler in interface MDIAction

Returns:

the handler

See Also:

MDIAction.setActionHandler(MDIActionHandler)

endAction

public void endAction()

Code to perform after the end of the MDIAction (for example creating a new tab for the MDIApplication, with the result of the MDIAction. This code will be performed in the event dispatching thread after the action has finished. Does nothing by default.

Specified by:

endAction in interface MDIAction

getMessage

public java.lang.String getMessage()

Get the message associated with the action. Is equal by default to getLongDescription().

Specified by:

getMessage in interface MDIAction

Returns:

the message

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Call MDIApplication.executeAction(MDIAction). The Action will ensure that the Plugins ClassLoader will be used for the execution, to be sure that any additional libraries, only available in the Plugin.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - the Action Event

executeAction

public void executeAction()

Execute the Action.

See Also:

actionPerformed(ActionEvent)

executeAction

public java.lang.Object executeAction(boolean inSameThread)

Execute the Action.

Parameters:

inSameThread - true if the execution must be performed in the current thread

Returns:

the action result

See Also:

actionPerformed(ActionEvent)

run

public abstract void run()
                  throws java.lang.Exception

Run the action. As the action is meant to be run for example in a in a ThreadQueue, the exception will be swallowed by the framework, and presented in an error panel after. Note that this method will be perfoemd in a background Thread.

Specified by:

run in interface MDIAction

Throws:

java.lang.Exception - if an Exception is encountered while running the Action