Package etomica.action

Class ActionToggle

java.lang.Object

etomica.action.ActionToggle

All Implemented Interfaces:

IAction, java.io.Serializable

public class ActionToggle
extends java.lang.Object
implements IAction, java.io.Serializable

Action that toggles a boolean value. This action can connect to any object capable of switching between two states. The action operates through a ModifierBoolean instance that must be connected to the state of the controlled object.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ActionToggle(ModifierBoolean modifier)
ActionToggle(ModifierBoolean modifier, java.lang.String trueText, java.lang.String falseText)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed()	Toggles the state of the target object (true to false, false to true).
java.lang.String	getFalseLabel()
java.lang.String	getLabel()	Returns the true or false label, depending on the current state of the toggle.
ModifierBoolean	getModifier()	Returns the boolean modifier used by this action.
java.lang.String	getTrueLabel()
void	setFalseLabel(java.lang.String text)	Specifies the button's label when the toggle is set to false.
void	setModifier(ModifierBoolean newModifier)	Specifies the boolean modifier that is set between true and false by the action.
void	setTrueLabel(java.lang.String text)	Specifies the button's label when the toggle is set to true.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionToggle

public ActionToggle(ModifierBoolean modifier)

ActionToggle

public ActionToggle(ModifierBoolean modifier,
                    java.lang.String trueText,
                    java.lang.String falseText)

Method Detail

actionPerformed

public void actionPerformed()

Toggles the state of the target object (true to false, false to true).

Specified by:

actionPerformed in interface IAction

getModifier

public ModifierBoolean getModifier()

Returns the boolean modifier used by this action.

setModifier

public void setModifier(ModifierBoolean newModifier)

Specifies the boolean modifier that is set between true and false by the action.

setTrueLabel

public void setTrueLabel(java.lang.String text)

Specifies the button's label when the toggle is set to true.

getTrueLabel

public java.lang.String getTrueLabel()

Returns:

the label displayed when the toggle is set to true.

setFalseLabel

public void setFalseLabel(java.lang.String text)

Specifies the button's label when the toggle is set to false.

getFalseLabel

public java.lang.String getFalseLabel()

Returns:

the label displayed when the toggle is set to false.

getLabel

public java.lang.String getLabel()

Returns the true or false label, depending on the current state of the toggle.