com.xmlmind.xmledit.control

Class BindingSpec

java.lang.Object

com.xmlmind.xmledit.control.BindingBase

com.xmlmind.xmledit.control.BindingSpec

public final class BindingSpec
extends BindingBase

Specifies a Binding.

Field Summary

Fields

Modifier and Type	Field and Description
static BindingSpec[]	EMPTY_LIST An empty array of binding specifications.
static String	REMOVE_BINDING_SPEC Fake command name which may be used to specify to merge(com.xmlmind.xmledit.control.BindingSpec[], com.xmlmind.xmledit.control.BindingSpec[]) that the corresponding BindingSpec, if any, is to be removed from the merged list.

Fields inherited from class com.xmlmind.xmledit.control.BindingBase

appEventName, userInputs

Constructor Summary

Constructors

Constructor and Description
BindingSpec(String appEventName, CommandMenuSpec menuSpec) Constructs a specification associating specified menu with specified application event.
BindingSpec(String appEventName, String commandName, String commandParameter) Constructs a specification associating specified command with specified application event.
BindingSpec(UserInput[] userInputs, String commandName, String commandParameter) Constructs a specification associating specified command with specified user input sequence.
BindingSpec(UserInput userInput, CommandMenuSpec menuSpec) Constructs a specification associating specified menu with specified user input.
BindingSpec(UserInput userInput, String commandName, String commandParameter) Constructs a specification associating specified command with specified user input.
BindingSpec(UserInput userInput1, UserInput userInput2, String commandName, String commandParameter) Constructs a specification associating specified command with specified user input sequence.
BindingSpec(UserInput userInput1, UserInput userInput2, UserInput userInput3, String commandName, String commandParameter) Constructs a specification associating specified command with specified user input sequence.

Method Summary

Modifier and Type	Method and Description
protected void	check()
String	getCommandName() Returns the name of the command triggered by user input, if any.
String	getCommandParameter() Returns the parameter of the command triggered by user input, if any.
CommandMenuSpec	getMenuSpec() Returns the specification of the menu displayed in response to user input, if any.
static BindingSpec[]	merge(BindingSpec[] specs1, BindingSpec[] specs2) Returns an array of BindingSpec containing the union of specified arrays, where BindingSpecs found in second array may replace BindingSpecs with same UserInput sequence found in first array.
Binding	toBinding(CommandRegistry commands) Returns binding object corresponding to this specification.
static Binding[]	toBindings(BindingSpec[] specs, CommandRegistry commands) Returns specified BindingSpecs converted to Bindings.

Methods inherited from class com.xmlmind.xmledit.control.BindingBase

equals, equals, getAppEventName, getUserInputs, hashCode, hashCode, hasSameTrigger, isAppEventBinding, isKeyBinding, isMouseBinding, toString, triggerToString

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_LIST

public static final BindingSpec[] EMPTY_LIST

An empty array of binding specifications.

REMOVE_BINDING_SPEC

public static final String REMOVE_BINDING_SPEC

Fake command name which may be used to specify to merge(com.xmlmind.xmledit.control.BindingSpec[], com.xmlmind.xmledit.control.BindingSpec[]) that the corresponding BindingSpec, if any, is to be removed from the merged list.

See Also:

Constant Field Values

Constructor Detail

BindingSpec

public BindingSpec(UserInput userInput,
                   String commandName,
                   String commandParameter)

Constructs a specification associating specified command with specified user input.

Parameters:

userInput - user input

commandName - name of command invoked by specified user input

commandParameter - parameter of the command; may be null

BindingSpec

public BindingSpec(UserInput userInput1,
                   UserInput userInput2,
                   String commandName,
                   String commandParameter)

Constructs a specification associating specified command with specified user input sequence.

A user input sequence (that is, not a single user input event) cannot contain mouse inputs, just keyboard inputs.

Parameters:

userInput1 - first user input of the sequence

userInput2 - second user input of the sequence

commandName - name of command invoked by specified user input

commandParameter - parameter of the command; may be null

BindingSpec

public BindingSpec(UserInput userInput1,
                   UserInput userInput2,
                   UserInput userInput3,
                   String commandName,
                   String commandParameter)

Constructs a specification associating specified command with specified user input sequence.

A user input sequence (that is, not a single user input event) cannot contain mouse inputs, just keyboard inputs.

Parameters:

userInput1 - first user input of the sequence

userInput2 - second user input of the sequence

userInput3 - third user input of the sequence

commandName - name of command command invoked by specified user input

commandParameter - parameter of the command; may be null

BindingSpec

public BindingSpec(UserInput[] userInputs,
                   String commandName,
                   String commandParameter)

Constructs a specification associating specified command with specified user input sequence.

A user input sequence (that is, not a single user input event) cannot contain mouse inputs, just keyboard inputs.

Parameters:

userInputs - user input sequence

commandName - name of command invoked by specified user input

commandParameter - parameter of the command; may be null

BindingSpec

public BindingSpec(UserInput userInput,
                   CommandMenuSpec menuSpec)

Constructs a specification associating specified menu with specified user input.

A keyboard input cannot be used to dislay a menu.

Parameters:

userInput - user input

menuSpec - specifies a menu

BindingSpec

public BindingSpec(String appEventName,
                   String commandName,
                   String commandParameter)

Constructs a specification associating specified command with specified application event.

Parameters:

appEventName - name of application event

commandName - name of command invoked by specified application event

commandParameter - parameter of the command; may be null

See Also:

AppEvent

BindingSpec

public BindingSpec(String appEventName,
                   CommandMenuSpec menuSpec)

Constructs a specification associating specified menu with specified application event.

Parameters:

appEventName - name of application event

menuSpec - specifies a menu

See Also:

AppEvent

Method Detail

check

protected void check()
              throws IllegalArgumentException

Overrides:

check in class BindingBase

Throws:

IllegalArgumentException

getCommandName

public String getCommandName()

Returns the name of the command triggered by user input, if any. Returns null otherwise.

getCommandParameter

public String getCommandParameter()

Returns the parameter of the command triggered by user input, if any. Returns null otherwise.

getMenuSpec

public CommandMenuSpec getMenuSpec()

Returns the specification of the menu displayed in response to user input, if any. Returns null otherwise.

toBinding

public Binding toBinding(CommandRegistry commands)

Returns binding object corresponding to this specification. Returns null if any named command referenced in this specification has not been registered using specified CommandRegistry.

merge

public static BindingSpec[] merge(BindingSpec[] specs1,
                                  BindingSpec[] specs2)

Returns an array of BindingSpec containing the union of specified arrays, where BindingSpecs found in second array may replace BindingSpecs with same UserInput sequence found in first array.

If the command name used by a BindingSpec in second array is REMOVE_BINDING_SPEC, then the corresponding BindingSpec, if any, is removed from first array.

toBindings

public static Binding[] toBindings(BindingSpec[] specs,
                                   CommandRegistry commands)
                            throws IllegalArgumentException

Returns specified BindingSpecs converted to Bindings.

Throws:

IllegalArgumentException - if a named command referenced in a BindingSpec has not been registered using specified CommandRegistry