de.tsl2.nano.action

Class CommonAction<RETURNTYPE>

java.lang.Object

de.tsl2.nano.action.CommonAction<RETURNTYPE>

Type Parameters:

RETURNTYPE -

All Implemented Interfaces:

IAction<RETURNTYPE>, Serializable, Comparable<CommonAction<RETURNTYPE>>, Runnable

public abstract class CommonAction<RETURNTYPE>
extends Object
implements IAction<RETURNTYPE>, Serializable, Comparable<CommonAction<RETURNTYPE>>

Version:

$Revision$

Author:

Thomas Schneider

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected IActivable	enabler
protected String	id
protected String	imagePath
protected boolean	isDefault
protected boolean	isEnabled
protected Object	keyStroke
protected String	longDescription
protected Parameters	parameter
protected Collection<String>	receiverIDs
protected String	shortDescription
protected boolean	synchron
protected static String	UNNAMED

Fields inherited from interface de.tsl2.nano.action.IAction

CANCELED, MODE_DLG_CANCEL, MODE_DLG_OK, MODE_UNDEFINED

Constructor Summary

Constructors

Constructor and Description
CommonAction() The default constructor can be used for hidden actions.
CommonAction(String id)
CommonAction(String id, boolean isDefault, boolean isEnabled, Object keyStroke, String shortDescription, String longDescription, boolean synchron, IActivable actionEnabler, Collection<String> receiverIDs) Constructor
CommonAction(String id, String shortDescription, String longDescription)
CommonAction(String id, String shortDescription, String longDescription, IActivable actionEnabler)
CommonAction(String id, String shortDescription, String longDescription, IActivable enabler, Collection<String> receiverIDs)

Method Summary

Modifier and Type	Method and Description
RETURNTYPE	activate() if the action is asynchron, the result will be mostly null.
int	compareTo(CommonAction<RETURNTYPE> o)
boolean	equals(Object obj)
int	getActionMode() action mode. e.g. on dialogs it is usable to define the buttons result type. see IAction.MODE_DLG_CANCEL, IAction.MODE_DLG_OK.
Class[]	getArgumentTypes() getArgumentTypes
IActivable	getEnabler()
String	getId() getId
String	getImagePath()
Object	getKeyStroke() Getter getKeyStroke
RETURNTYPE	getLastResult()
String	getLongDescription() getLongDescription
Object[]	getParameter()
Object	getParameter(int i)
Collection<String>	getReceiverIDs() the receivers will receive the result of the activation.
String	getShortDescription() getShortDescription
int	hashCode()
protected boolean	isDebugMode() override this method to enable debugging
boolean	isDefault() isDefault
boolean	isEnabled() isEnabled
boolean	isRunning()
boolean	isSynchron() Getter isSynchron
Parameters	parameters()
protected void	resetCursor(Object lastCursor) override this method to handle the mouse cursor
void	run() run
void	setDefault(boolean isDefault) setDefault
void	setEnabled(boolean isEnabled) setEnabled
void	setEnabler(IActivable enabler)
void	setImagePath(String imagePath)
void	setParameter(Object... parameter)
protected Object	setWaitCursor() override this method to handle the mouse cursor
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.tsl2.nano.action.IAction

action, doFor

Field Detail

id

protected String id

shortDescription

protected String shortDescription

longDescription

protected String longDescription

isDefault

protected boolean isDefault

isEnabled

protected boolean isEnabled

synchron

protected boolean synchron

keyStroke

protected Object keyStroke

receiverIDs

protected Collection<String> receiverIDs

enabler

protected IActivable enabler

parameter

protected Parameters parameter

imagePath

protected String imagePath

UNNAMED

protected static final String UNNAMED

See Also:

Constant Field Values

Constructor Detail

CommonAction

public CommonAction()

The default constructor can be used for hidden actions. This are action, not connected to a user interface like a button.

CommonAction

public CommonAction(String id)

Parameters:

id - unique id

CommonAction

public CommonAction(String id,
                    String shortDescription,
                    String longDescription)

Parameters:

id - unique id

shortDescription - name of the button (representing this action).

longDescription - tooltip text of the button (representing this action).

CommonAction

public CommonAction(String id,
                    String shortDescription,
                    String longDescription,
                    IActivable actionEnabler)

Parameters:

id - unique id

shortDescription - name of the button (representing this action).

longDescription - tooltip text of the button (representing this action).

instance - for an action enabler

CommonAction

public CommonAction(String id,
                    String shortDescription,
                    String longDescription,
                    IActivable enabler,
                    Collection<String> receiverIDs)

Parameters:

id - unique id

shortDescription - name of the button (representing this action).

longDescription - tooltip text of the button (representing this action).

enabler - is able to to functional checks for button enabling

receiverIDs - ids of visible components to receive the result of this action.

CommonAction

public CommonAction(String id,
                    boolean isDefault,
                    boolean isEnabled,
                    Object keyStroke,
                    String shortDescription,
                    String longDescription,
                    boolean synchron,
                    IActivable actionEnabler,
                    Collection<String> receiverIDs)

Constructor

Parameters:

id - unique id

isDefault - whether the button (representing this action) is the default button.

isEnabled - whether the button (representing this action) is enabled.

keyStroke - button key stroke

longDescription - tooltip text of the button (representing this action).

shortDescription - name of the button (representing this action).

synchron - whether this method is synchron or asynchron.

Method Detail

isEnabled

public boolean isEnabled()

isEnabled

Specified by:

isEnabled in interface IAction<RETURNTYPE>

Returns:

Returns the isEnabled.

See Also:

IAction.isEnabled()

setEnabled

public void setEnabled(boolean isEnabled)

setEnabled

Specified by:

setEnabled in interface IAction<RETURNTYPE>

Parameters:

isEnabled - The isEnabled to set.

See Also:

IAction.setEnabled(boolean)

getEnabler

public IActivable getEnabler()

Returns:

Returns the enabler.

setEnabler

public void setEnabler(IActivable enabler)

Parameters:

enabler - The enabler to set.

getId

public String getId()

getId

Specified by:

getId in interface IAction<RETURNTYPE>

Returns:

Returns the id.

See Also:

IAction.getId()

getShortDescription

public String getShortDescription()

getShortDescription

Specified by:

getShortDescription in interface IAction<RETURNTYPE>

Returns:

Returns the shortDescription.

See Also:

IAction.getShortDescription()

getLongDescription

public String getLongDescription()

getLongDescription

Specified by:

getLongDescription in interface IAction<RETURNTYPE>

Returns:

Returns the longDescription.

See Also:

IAction.getLongDescription()

isDefault

public boolean isDefault()

isDefault

Specified by:

isDefault in interface IAction<RETURNTYPE>

Returns:

Returns the isDefault.

See Also:

IAction.isDefault()

setDefault

public void setDefault(boolean isDefault)

setDefault

Specified by:

setDefault in interface IAction<RETURNTYPE>

Parameters:

isDefault - whether to set the action as default action

isSynchron

public boolean isSynchron()

Getter isSynchron

Specified by:

isSynchron in interface IAction<RETURNTYPE>

Returns:

Returns the synchron.

run

public void run()

run

Specified by:

run in interface Runnable

See Also:

Runnable.run()

isDebugMode

protected boolean isDebugMode()

override this method to enable debugging

Returns:

true, if debugging is enabled

activate

public RETURNTYPE activate()

if the action is asynchron, the result will be mostly null.

Specified by:

activate in interface IAction<RETURNTYPE>

Returns:

the result

See Also:

IAction.activate()

setWaitCursor

protected Object setWaitCursor()

override this method to handle the mouse cursor

Returns:

the last cursor instance

resetCursor

protected void resetCursor(Object lastCursor)

override this method to handle the mouse cursor

Parameters:

lastCursor - cursor to be set

getReceiverIDs

public Collection<String> getReceiverIDs()

Description copied from interface: IAction

the receivers will receive the result of the activation.

Specified by:

getReceiverIDs in interface IAction<RETURNTYPE>

Returns:

Returns the receiverIDs.

parameters

public Parameters parameters()

getArgumentTypes

public Class[] getArgumentTypes()

Description copied from interface: IAction

getArgumentTypes

Specified by:

getArgumentTypes in interface IAction<RETURNTYPE>

Returns:

optional definition of argument types to check IAction.getParameter() and IAction.setParameter(Object...). default is null

getParameter

public Object[] getParameter()

Specified by:

getParameter in interface IAction<RETURNTYPE>

Returns:

Returns the parameter.

getParameter

public Object getParameter(int i)

Specified by:

getParameter in interface IAction<RETURNTYPE>

setParameter

public void setParameter(Object... parameter)

Specified by:

setParameter in interface IAction<RETURNTYPE>

Parameters:

parameter - The parameter to set.

getImagePath

public String getImagePath()

Specified by:

getImagePath in interface IAction<RETURNTYPE>

Returns:

image

getLastResult

public RETURNTYPE getLastResult()

getKeyStroke

public Object getKeyStroke()

Description copied from interface: IAction

Getter getKeyStroke

Specified by:

getKeyStroke in interface IAction<RETURNTYPE>

Returns:

Returns the keyStroke.

setImagePath

public void setImagePath(String imagePath)

compareTo

public int compareTo(CommonAction<RETURNTYPE> o)

Specified by:

compareTo in interface Comparable<CommonAction<RETURNTYPE>>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getActionMode

public int getActionMode()

action mode. e.g. on dialogs it is usable to define the buttons result type. see IAction.MODE_DLG_CANCEL, IAction.MODE_DLG_OK.

Specified by:

getActionMode in interface IAction<RETURNTYPE>

Returns:

action mode

isRunning

public boolean isRunning()

Specified by:

isRunning in interface IAction<RETURNTYPE>

Returns:

Returns the isRunning.