public abstract class IlvCheckableActionHandler extends IlvSingleActionHandler
Constructor and Description |
---|
IlvCheckableActionHandler(String command)
Constructs a new
IlvCheckableActionHandler that handles the
checkable action with the specified command key. |
Modifier and Type | Method and Description |
---|---|
protected void |
checkStateChanged(boolean check)
Invoked after the action handled by this object has been checked or
unchecked, depending on the value of the
check parameter. |
String |
getGroup()
Returns the check group that the checkable action that this object handles belongs
to.
|
boolean |
isChecked()
Determines whether the action handled by this object is checked.
|
boolean |
isLocked()
Determines whether the action handled by this object is locked.
|
boolean |
isOneShot()
Determines whether the checkable action handled by this object is one-shot.
|
protected void |
lockStateChanged(boolean lock)
Invoked when the lock state of the action handled by this object has
changed.
|
void |
setAction(Action action)
Sets the action that this instance handles.
|
void |
setChecked(boolean check)
Checks or unchecks the checkable action handled by this object, depending
on the value of the
check parameter. |
void |
setLocked(boolean lock)
Locks or unlocks the checkable action handled by this object, depending
on the value of the
lock parameter. |
void |
setOneShot(boolean oneShot)
Sets the action one-shot or not, depending on the value of the
oneShot parameter. |
actionPerformed, getAction, getCommand, isProcessingAction, setCommand, updateAction, updateSingleAction
public IlvCheckableActionHandler(String command)
IlvCheckableActionHandler
that handles the
checkable action with the specified command
key.command
- The command key of the action handled by this action handler.public boolean isChecked()
true
if the action is checked; false
otherwise.setChecked(boolean)
,
checkStateChanged(boolean)
public void setChecked(boolean check)
check
parameter.check
- If true
, the action will be checked; if
false
, the action will be unchecked.isChecked()
,
checkStateChanged(boolean)
protected void checkStateChanged(boolean check)
check
parameter.check
- The new check state of the action. If true
, the
action will be checked; if false
, the action will be unchecked.public String getGroup()
null
if the checkable
action does not belong to any check group.public boolean isOneShot()
IlvAction
class for detailed
explanations on one-shot actions.true
if the action is one-shot; false
otherwise.setOneShot(boolean)
,
getGroup()
,
setLocked(boolean)
,
isLocked()
public void setOneShot(boolean oneShot)
oneShot
parameter.oneShot
- if true
, the action will be set one-shot; if
false
, the action will be set to the default check mode.isOneShot()
protected void lockStateChanged(boolean lock)
IlvAction
.lock
- The new lock state of the action. If true
, the
action has been locked; if false
the action has been unlocked.isLocked()
public boolean isLocked()
IlvAction
.true
if the action is locked; false
otherwise.setLocked(boolean)
public void setLocked(boolean lock)
lock
parameter.lock
- If true
the action will be locked; if
false
the action will be unlocked.isLocked()
public void setAction(Action action)
IlvSingleActionHandler.setCommand(java.lang.String)
method.setAction
in class IlvSingleActionHandler
action
- the new action that this instance handles.IlvSingleActionHandler.getAction()
,
IlvSingleActionHandler.setCommand(java.lang.String)
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.