rle.core.ui
Class CommandSet

java.lang.Object
  rle.core.ui.CommandSet

public class CommandSet
extends java.lang.Object

Class that encapsulates a set of commands which are available to the player at a given point in time. Instances of this class can be configured in several ways. See the documentation for individual constructors for details.

Field Summary

protected java.lang.String

name

Constructor Summary

CommandSet(java.lang.String name)
Constructor to create a named, empty command set.

CommandSet(java.lang.String name, java.util.List<InfoView> list)
Creates a named command set with mappings configured by calling the createPlugIn() method for each InfoView in the list parameter, and casting the result to a UIAction.

Method Summary

void	addMapping(java.lang.String key, javax.swing.KeyStroke ks, javax.swing.Action action) Add a named mapping.
void	addMapping(java.lang.String key, java.lang.String ks, javax.swing.Action action) Add a named mapping.
void	applyCommandSet(javax.swing.JComponent c) Apply the key-bindings in this CommandSet to c, first wiping any old key-bindings on this component.
void	applyCommandSet(javax.swing.JComponent c, boolean clearOld) Apply the key-bindings in this CommandSet to c.
java.lang.String	getName()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

Constructor Detail

CommandSet

public CommandSet(java.lang.String name)

Constructor to create a named, empty command set. Key bindings may then be specified via calls to the addMapping() method.

CommandSet

public CommandSet(java.lang.String name,
                  java.util.List<InfoView> list)

Creates a named command set with mappings configured by calling the createPlugIn() method for each InfoView in the list parameter, and casting the result to a UIAction. This constructor provides support for specifying key bindings in the Variant Manager.

Method Detail

addMapping

public void addMapping(java.lang.String key,
                       javax.swing.KeyStroke ks,
                       javax.swing.Action action)

Add a named mapping.

addMapping

public void addMapping(java.lang.String key,
                       java.lang.String ks,
                       javax.swing.Action action)

Add a named mapping. The parameter ks will be passed as is to KeyStroke.getKeyStroke() to determine the key to activate the action.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()

applyCommandSet

public void applyCommandSet(javax.swing.JComponent c)

Apply the key-bindings in this CommandSet to c, first wiping any old key-bindings on this component.

applyCommandSet

public void applyCommandSet(javax.swing.JComponent c,
                            boolean clearOld)

Apply the key-bindings in this CommandSet to c.