Class KeyCommand

java.lang.Object

javax.swing.AbstractAction

VASSAL.counters.KeyCommand

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

Direct Known Subclasses:

DynamicProperty.DynamicKeyCommand, KeyCommandSubMenu, MultiLocationCommand.MultiLocationKeyCommand

public class KeyCommand
extends AbstractAction

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected TranslatablePiece	i18nPiece
protected String	localizedMenuText
protected NamedKeyStroke	namedKeyStroke
static final KeyCommand[]	NONE
protected String	untranslatedName

Fields inherited from class javax.swing.AbstractAction

changeSupport

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	Description
KeyCommand(String name, KeyStroke key, GamePiece target)
KeyCommand(String name, KeyStroke key, GamePiece target, boolean enabled)
KeyCommand(String name, KeyStroke key, GamePiece target, TranslatablePiece i18nPiece)
KeyCommand(String name, KeyStroke key, GamePiece target, TranslatablePiece i18nPiece, boolean enabled)
KeyCommand(String name, NamedKeyStroke key, GamePiece target)
KeyCommand(String name, NamedKeyStroke key, GamePiece target, boolean enabled)
KeyCommand(String name, NamedKeyStroke key, GamePiece target, TranslatablePiece i18nPiece)
KeyCommand(String name, NamedKeyStroke key, GamePiece target, TranslatablePiece i18nPiece, boolean enabled)
KeyCommand(KeyCommand command)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent evt)
KeyStroke	getKeyStroke()
String	getLocalizedMenuText()	The human-readable text that will appear in the right-click menu, translated to the user's Locale
String	getName()
NamedKeyStroke	getNamedKeyStroke()
GamePiece	getTarget()
boolean	isEnabled()
boolean	isGlobal()	If true, then this action will apply to all selected pieces
boolean	isMenuSeparator()
boolean	matches(KeyStroke key)
void	setEnabled(boolean b)
void	setGlobal(boolean global)	If true, then this action will apply to all selected pieces

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, putValue, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.Action

accept

Field Details

NONE

public static final KeyCommand[] NONE

untranslatedName

protected String untranslatedName

localizedMenuText

protected String localizedMenuText

i18nPiece

protected TranslatablePiece i18nPiece

namedKeyStroke

protected NamedKeyStroke namedKeyStroke

Constructor Details

KeyCommand

public KeyCommand(String name,
 KeyStroke key,
 GamePiece target)

KeyCommand

public KeyCommand(String name,
 NamedKeyStroke key,
 GamePiece target)

KeyCommand

public KeyCommand(String name,
 KeyStroke key,
 GamePiece target,
 TranslatablePiece i18nPiece)

KeyCommand

public KeyCommand(String name,
 NamedKeyStroke key,
 GamePiece target,
 TranslatablePiece i18nPiece)

KeyCommand

public KeyCommand(String name,
 NamedKeyStroke key,
 GamePiece target,
 boolean enabled)

KeyCommand

public KeyCommand(String name,
 NamedKeyStroke key,
 GamePiece target,
 TranslatablePiece i18nPiece,
 boolean enabled)

KeyCommand

public KeyCommand(String name,
 KeyStroke key,
 GamePiece target,
 boolean enabled)

KeyCommand

public KeyCommand(String name,
 KeyStroke key,
 GamePiece target,
 TranslatablePiece i18nPiece,
 boolean enabled)

KeyCommand

public KeyCommand(KeyCommand command)

Method Details

getName

public String getName()

matches

public boolean matches(KeyStroke key)

getKeyStroke

public KeyStroke getKeyStroke()

getNamedKeyStroke

public NamedKeyStroke getNamedKeyStroke()

getTarget

public GamePiece getTarget()

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Action

Overrides:

isEnabled in class AbstractAction

setEnabled

public void setEnabled(boolean b)

Specified by:

setEnabled in interface Action

Overrides:

setEnabled in class AbstractAction

isGlobal

public boolean isGlobal()

If true, then this action will apply to all selected pieces

Returns:

global

setGlobal

public void setGlobal(boolean global)

If true, then this action will apply to all selected pieces

Parameters:

global - value to set

actionPerformed

public void actionPerformed(ActionEvent evt)

isMenuSeparator

public boolean isMenuSeparator()

getLocalizedMenuText

public String getLocalizedMenuText()

The human-readable text that will appear in the right-click menu, translated to the user's Locale

Returns:

Localized text