Package docking.action

Class MultipleKeyAction

java.lang.Object

javax.swing.AbstractAction

docking.DockingKeyBindingAction

docking.action.MultipleKeyAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action

public class MultipleKeyAction
extends DockingKeyBindingAction

Action that manages multiple DockingActions mapped to a given key binding

See Also:

Serialized Form

Field Summary

Fields inherited from class docking.DockingKeyBindingAction

keyStroke, tool

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

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
MultipleKeyAction(Tool tool, ComponentProvider provider, DockingActionIf action, javax.swing.KeyStroke keyStroke)	Creates new MultipleKeyAction

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(java.awt.event.ActionEvent event)
void	addAction(ComponentProvider provider, DockingActionIf action)
java.util.List<DockingActionIf>	getActions()
KeyBindingPrecedence	getKeyBindingPrecedence()
KeyBindingPrecedence	geValidKeyBindingPrecedence(java.awt.Component source)	This is a special version of getKeyBindingPrecedence() that allows the internal key event processing to specify the source component when determining how precedence should be established for the actions contained herein.
boolean	isEmpty()
boolean	isEnabled()	Returns the enabled state of the Action.
boolean	isReservedKeybindingPrecedence()
void	removeAction(DockingActionIf action)
void	setEnabled(boolean newValue)	Enables or disables the action.
java.lang.String	toString()

Methods inherited from class docking.DockingKeyBindingAction

getLocalContext

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, wait, wait, wait

Methods inherited from interface javax.swing.Action

accept

Constructor Detail

MultipleKeyAction

public MultipleKeyAction(Tool tool,
                         ComponentProvider provider,
                         DockingActionIf action,
                         javax.swing.KeyStroke keyStroke)

Creates new MultipleKeyAction

Parameters:

tool - used to determine context

provider - the provider, if any, associated with the action

action - action that will be added to the list of actions bound to a keystroke

keyStroke - the keystroke, if any, associated with the action

Method Detail

isEmpty

public boolean isEmpty()

addAction

public void addAction(ComponentProvider provider,
                      DockingActionIf action)

removeAction

public void removeAction(DockingActionIf action)

isEnabled

public boolean isEnabled()

Returns the enabled state of the Action. When enabled, any component associated with this object is active and able to fire this object's actionPerformed method.

Specified by:

isEnabled in interface javax.swing.Action

Overrides:

isEnabled in class DockingKeyBindingAction

Returns:

true if this Action is enabled

setEnabled

public void setEnabled(boolean newValue)

Enables or disables the action. This affects all uses of the action. Note that for popups, this affects whether or not the option is "grayed out", not whether the action is added to the popup.

Specified by:

setEnabled in interface javax.swing.Action

Overrides:

setEnabled in class javax.swing.AbstractAction

Parameters:

newValue - true to enable the action, false to disable it

See Also:

Action.setEnabled(boolean)

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class DockingKeyBindingAction

isReservedKeybindingPrecedence

public boolean isReservedKeybindingPrecedence()

Overrides:

isReservedKeybindingPrecedence in class DockingKeyBindingAction

getKeyBindingPrecedence

public KeyBindingPrecedence getKeyBindingPrecedence()

Specified by:

getKeyBindingPrecedence in class DockingKeyBindingAction

geValidKeyBindingPrecedence

public KeyBindingPrecedence geValidKeyBindingPrecedence(java.awt.Component source)

This is a special version of getKeyBindingPrecedence() that allows the internal key event processing to specify the source component when determining how precedence should be established for the actions contained herein.

Parameters:

source - the component; may be null

Returns:

the precedence; may be null

getActions

public java.util.List<DockingActionIf> getActions()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object