Class TextAction

java.lang.Object

javax.swing.AbstractAction

javax.swing.text.TextAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

Direct Known Subclasses:

DefaultEditorKit.BeepAction, DefaultEditorKit.CopyAction, DefaultEditorKit.CutAction, DefaultEditorKit.DefaultKeyTypedAction, DefaultEditorKit.InsertBreakAction, DefaultEditorKit.InsertContentAction, DefaultEditorKit.InsertTabAction, DefaultEditorKit.PasteAction, StyledEditorKit.StyledTextAction

public abstract class TextAction
extends AbstractAction

An Action implementation useful for key bindings that are shared across a number of different text components. Because the action is shared, it must have a way of getting it's target to act upon. This class provides support to try and find a text component to operate on. The preferred way of getting the component to act upon is through the ActionEvent that is received. If the Object returned by getSource can be narrowed to a text component, it will be used. If the action event is null or can't be narrowed, the last focused text component is tried. This is determined by being used in conjunction with a JTextController which arranges to share that information with a TextAction.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans has been added to the java.beans package. Please see XMLEncoder.

Field Summary

Fields declared in class AbstractAction

changeSupport, enabled

Modifier and Type	Field	Description
protected SwingPropertyChangeSupport	changeSupport	If any PropertyChangeListeners have been registered, the changeSupport field describes them.
protected boolean	enabled	Specifies whether action is enabled; the default is true.

Fields declared in interface 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

Modifier and Type	Field	Description
static final String	ACCELERATOR_KEY	The key used for storing a KeyStroke to be used as the accelerator for the action.
static final String	ACTION_COMMAND_KEY	The key used to determine the command String for the ActionEvent that will be created when an Action is going to be notified as the result of residing in a Keymap associated with a JComponent.
static final String	DEFAULT	Not currently used.
static final String	DISPLAYED_MNEMONIC_INDEX_KEY	The key used for storing an Integer that corresponds to the index in the text (identified by the NAME property) that the decoration for a mnemonic should be rendered at.
static final String	LARGE_ICON_KEY	The key used for storing an Icon.
static final String	LONG_DESCRIPTION	The key used for storing a longer String description for the action, could be used for context-sensitive help.
static final String	MNEMONIC_KEY	The key used for storing an Integer that corresponds to one of the KeyEvent key codes.
static final String	NAME	The key used for storing the String name for the action, used for a menu or button.
static final String	SELECTED_KEY	The key used for storing a Boolean that corresponds to the selected state.
static final String	SHORT_DESCRIPTION	The key used for storing a short String description for the action, used for tooltip text.
static final String	SMALL_ICON	The key used for storing a small Icon, such as ImageIcon.

Constructor Summary

Constructors

Constructor	Description
TextAction(String name)	Creates a new JTextAction object.

Method Summary

Modifier and Type	Method	Description
static final Action[]	augmentList(Action[] list1, Action[] list2)	Takes one list of commands and augments it with another list of commands.
protected final JTextComponent	getFocusedComponent()	Fetches the text component that currently has focus.
protected final JTextComponent	getTextComponent(ActionEvent e)	Determines the component to use for the action.

Methods declared in class AbstractAction

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

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)	Adds a PropertyChangeListener to the listener list.
protected Object	clone()	Clones the abstract action.
protected void	firePropertyChange(String propertyName, Object oldValue, Object newValue)	Supports reporting bound property changes.
Object[]	getKeys()	Returns an array of Objects which are keys for which values have been set for this AbstractAction, or null if no keys have values set.
PropertyChangeListener[]	getPropertyChangeListeners()	Returns an array of all the PropertyChangeListeners added to this AbstractAction with addPropertyChangeListener().
Object	getValue(String key)	Gets the Object associated with the specified key.
boolean	isEnabled()	Returns true if the action is enabled.
void	putValue(String key, Object newValue)	Sets the Value associated with the specified key.
void	removePropertyChangeListener(PropertyChangeListener listener)	Removes a PropertyChangeListener from the listener list.
void	setEnabled(boolean newValue)	Sets whether the Action is enabled.

Methods declared in class Object

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

Modifier and Type	Method	Description
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Methods declared in interface Action

accept

Modifier and Type	Method	Description
default boolean	accept(Object sender)	Determines whether the action should be performed with the specified sender object.

Methods declared in interface ActionListener

actionPerformed

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)	Invoked when an action occurs.

Constructor Details

TextAction

public TextAction(String name)

Creates a new JTextAction object.

Parameters:

name - the name of the action

Method Details

getTextComponent

protected final JTextComponent getTextComponent(ActionEvent e)

Determines the component to use for the action. This if fetched from the source of the ActionEvent if it's not null and can be narrowed. Otherwise, the last focused component is used.

Parameters:

e - the ActionEvent

Returns:

the component

augmentList

public static final Action[] augmentList(Action[] list1,
 Action[] list2)

Takes one list of commands and augments it with another list of commands. The second list takes precedence over the first list; that is, when both lists contain a command with the same name, the command from the second list is used.

Parameters:

list1 - the first list, may be empty but not null

list2 - the second list, may be empty but not null

Returns:

the augmented list

getFocusedComponent

protected final JTextComponent getFocusedComponent()

Fetches the text component that currently has focus. This allows actions to be shared across text components which is useful for key-bindings where a large set of actions are defined, but generally used the same way across many different components.

Returns:

the component