com.simsilica.lemur

Class Action

java.lang.Object

com.simsilica.lemur.Action

All Implemented Interfaces:

com.simsilica.lemur.Command<com.simsilica.lemur.Button>, com.simsilica.lemur.core.VersionedObject<Action>

Direct Known Subclasses:

CallMethodAction, EmptyAction

public abstract class Action
extends java.lang.Object
implements com.simsilica.lemur.core.VersionedObject<Action>, com.simsilica.lemur.Command<com.simsilica.lemur.Button>

A combination of a command and some attributes that define what the GUI element should look like. The action is versioned so that GUI elements can automatically update themselves as these attributes are changed. This is similar to Swing's Action.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_ENABLED
static java.lang.String	KEY_ICON
static java.lang.String	KEY_LARGE_ICON
static java.lang.String	KEY_NAME
static java.lang.String	KEY_SELECTED
static java.lang.String	KEY_SHORT_DESCRIPTION

Constructor Summary

Constructors

Constructor and Description
Action()
Action(java.lang.String name)
Action(java.lang.String name, com.simsilica.lemur.core.GuiComponent icon)
Action(java.lang.String name, com.simsilica.lemur.core.GuiComponent icon, boolean enabled)

Method Summary

Modifier and Type	Method and Description
protected void	appendFields(java.lang.StringBuilder sb)
com.simsilica.lemur.core.VersionedReference<Action>	createReference()
abstract void	execute(com.simsilica.lemur.Button source) Subclasses must override this to perform the action.
com.simsilica.lemur.core.GuiComponent	getIcon()
com.simsilica.lemur.core.GuiComponent	getLargeIcon()
java.lang.String	getName()
Action	getObject()
<T> T	getValue(java.lang.String key) Returns a previously set value from this action or null if the property has not been set.
<T> T	getValue(java.lang.String key, T defaultValue) Returns a previously set value from this action or defaultValue if the property has not been set.
long	getVersion()
protected void	incrementVersion()
boolean	isEnabled()
boolean	isSelected()
void	putValue(java.lang.String key, java.lang.Object value) Sets a general value onto this action that other action users or custom GUI elements can reference.
void	setEnabled(boolean b) Sets the enabled/disabled state of this action.
void	setIcon(com.simsilica.lemur.core.GuiComponent component) Sets the icon that will be used as the icon in wrapping Action GUI elements.
void	setLargeIcon(com.simsilica.lemur.core.GuiComponent component) Sets the icon that will be used as the icon in wrapping Action GUI elements.
void	setName(java.lang.String name) Sets the name of the action that will be used as the label in wrapping Action GUI elements.
void	setSelected(boolean b) Sets the selected/deselected state of this action.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

KEY_ENABLED

public static final java.lang.String KEY_ENABLED

See Also:

Constant Field Values

KEY_NAME

public static final java.lang.String KEY_NAME

See Also:

Constant Field Values

KEY_ICON

public static final java.lang.String KEY_ICON

See Also:

Constant Field Values

KEY_LARGE_ICON

public static final java.lang.String KEY_LARGE_ICON

See Also:

Constant Field Values

KEY_SHORT_DESCRIPTION

public static final java.lang.String KEY_SHORT_DESCRIPTION

See Also:

Constant Field Values

KEY_SELECTED

public static final java.lang.String KEY_SELECTED

See Also:

Constant Field Values

Constructor Detail

Action

public Action()

Action

public Action(java.lang.String name)

Action

public Action(java.lang.String name,
              com.simsilica.lemur.core.GuiComponent icon)

Action

public Action(java.lang.String name,
              com.simsilica.lemur.core.GuiComponent icon,
              boolean enabled)

Method Detail

execute

public abstract void execute(com.simsilica.lemur.Button source)

Subclasses must override this to perform the action.

Specified by:

execute in interface com.simsilica.lemur.Command<com.simsilica.lemur.Button>

setEnabled

public void setEnabled(boolean b)

Sets the enabled/disabled state of this action. Action GUI elements that support being disabled will adhere to this state.

isEnabled

public boolean isEnabled()

setSelected

public void setSelected(boolean b)

Sets the selected/deselected state of this action. Action GUI elements that support selection (checkboxes) will adhere to this state and reflect it back into the action itself.

isSelected

public boolean isSelected()

setName

public void setName(java.lang.String name)

Sets the name of the action that will be used as the label in wrapping Action GUI elements.

getName

public java.lang.String getName()

setIcon

public void setIcon(com.simsilica.lemur.core.GuiComponent component)

Sets the icon that will be used as the icon in wrapping Action GUI elements. This is used when a smaller icon is needed or when there is no large icon specified.

getIcon

public com.simsilica.lemur.core.GuiComponent getIcon()

setLargeIcon

public void setLargeIcon(com.simsilica.lemur.core.GuiComponent component)

Sets the icon that will be used as the icon in wrapping Action GUI elements. ActionButton will use this as its icon if specified. getLargeIcon() defaults to getIcon() when not set.

getLargeIcon

public com.simsilica.lemur.core.GuiComponent getLargeIcon()

putValue

public void putValue(java.lang.String key,
                     java.lang.Object value)

Sets a general value onto this action that other action users or custom GUI elements can reference.

getValue

public <T> T getValue(java.lang.String key)

Returns a previously set value from this action or null if the property has not been set.

getValue

public <T> T getValue(java.lang.String key,
                      T defaultValue)

Returns a previously set value from this action or defaultValue if the property has not been set.

incrementVersion

protected void incrementVersion()

getVersion

public long getVersion()

Specified by:

getVersion in interface com.simsilica.lemur.core.VersionedObject<Action>

getObject

public Action getObject()

Specified by:

getObject in interface com.simsilica.lemur.core.VersionedObject<Action>

createReference

public com.simsilica.lemur.core.VersionedReference<Action> createReference()

Specified by:

createReference in interface com.simsilica.lemur.core.VersionedObject<Action>

appendFields

protected void appendFields(java.lang.StringBuilder sb)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object