xdev.ui

Class XdevKeyAction

java.lang.Object

xdev.ui.XdevKeyAction

public class XdevKeyAction
extends Object

Helper class to connect a specific action to a shortcut.

Usage:

 Component target = ...;
 KeyStroke shortcut = ...;
 
 XdevKeyAction keyAction = new XdevKeyAction();
 keyAction.setTarget(target);
 keyAction.setShortcut(shortcut);
 keyAction.addActionListener(...);
 

or just

 new XdevKeyAction(cpn,shortcut).addActionListener(...);
 

Since:

3.1

Author:

XDEV Software

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XdevKeyAction.Condition Decides when the key action takes place.

Constructor Summary

Constructors

Constructor and Description
XdevKeyAction() Creates a new empty key action.
XdevKeyAction(JComponent target, KeyStroke shortcut) Creates a new focus helper with a shortcut for the component target.

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener l) Adds an ActionListener to the key action.
protected void	fireActionPerformed(ActionEvent e)
ActionListener[]	getActionListeners() Returns an array of all the ActionListeners added to this key action with addActionListener(ActionListener)
XdevKeyAction.Condition	getCondition()
KeyStroke	getShortcut() Return the shortcut associated with this key action.
JComponent	getTarget() Returns the target of this key action.
void	removeActionListener(ActionListener l) Removes an ActionListener from the key action.
void	setCondition(XdevKeyAction.Condition condition) Sets the new condition when the action should take place.
void	setShortcut(KeyStroke shortcut) Sets the shortcut for this key action.
void	setTarget(JComponent target) Sets the target component for this key action.

Methods inherited from class java.lang.Object

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

Constructor Detail

XdevKeyAction

public XdevKeyAction()

Creates a new empty key action.

XdevKeyAction

public XdevKeyAction(JComponent target,
                     KeyStroke shortcut)

Creates a new focus helper with a shortcut for the component target.

Parameters:

target - the component to focus

shortcut - the keystroke to trigger the action

Method Detail

setCondition

public void setCondition(XdevKeyAction.Condition condition)

Sets the new condition when the action should take place.

Parameters:

condition - the new condition

Since:

4.0

See Also:

XdevKeyAction.Condition

getCondition

public XdevKeyAction.Condition getCondition()

Returns:

the condition when the action takes place

Since:

4.0

See Also:

XdevKeyAction.Condition

setTarget

public void setTarget(JComponent target)

Sets the target component for this key action.

Parameters:

target - the component to register the shortcut at

getTarget

public JComponent getTarget()

Returns the target of this key action.

Returns:

the target of this key action

setShortcut

public void setShortcut(KeyStroke shortcut)

Sets the shortcut for this key action.

Parameters:

shortcut - the KeyStroke which triggers this action

getShortcut

public KeyStroke getShortcut()

Return the shortcut associated with this key action.

Returns:

the shortcut associated with this key action

addActionListener

public void addActionListener(ActionListener l)

Adds an ActionListener to the key action.

Parameters:

l - the ActionListener to be added

removeActionListener

public void removeActionListener(ActionListener l)

Removes an ActionListener from the key action.

Parameters:

l - the ActionListener to be removed

getActionListeners

public ActionListener[] getActionListeners()

Returns an array of all the ActionListeners added to this key action with addActionListener(ActionListener)

Returns:

all of the ActionListeners added or an empty array if no listeners have been added

fireActionPerformed

protected void fireActionPerformed(ActionEvent e)