Known Direct Subclasses
|
Known Indirect Subclasses
|
Class Overview
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 JavaBeansTM
has been added to the java.beans
package.
Please see XMLEncoder
.
Summary
[Expand]
Inherited Constants |
From interface
javax.swing.Action
String |
ACCELERATOR_KEY |
The key used for storing a KeyStroke to be used as the
accelerator for the action. |
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 . |
String |
DEFAULT |
Not currently used. |
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. |
String |
LARGE_ICON_KEY |
The key used for storing an Icon . |
String |
LONG_DESCRIPTION |
The key used for storing a longer String
description for the action, could be used for context-sensitive help. |
String |
MNEMONIC_KEY |
The key used for storing an Integer that corresponds to
one of the KeyEvent key codes. |
String |
NAME |
The key used for storing the String name
for the action, used for a menu or button. |
String |
SELECTED_KEY |
The key used for storing a Boolean that corresponds
to the selected state. |
String |
SHORT_DESCRIPTION |
The key used for storing a short String
description for the action, used for tooltip text. |
String |
SMALL_ICON |
The key used for storing a small Icon , such
as ImageIcon . |
|
[Expand]
Inherited Methods |
From class
javax.swing.AbstractAction
|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object .
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait()
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object.
|
final
void
|
wait(long timeout, int nanos)
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object, or
some other thread interrupts the current thread, or a certain
amount of real time has elapsed.
|
final
void
|
wait(long timeout)
Causes the current thread to wait until either another thread invokes the
notify() method or the
notifyAll() method for this object, or a
specified amount of time has elapsed.
|
|
From interface
java.awt.event.ActionListener
|
From interface
javax.swing.Action
|
Public Constructors
public
TextAction
(String name)
Creates a new JTextAction object.
Parameters
name
| the name of the action
|
Public Methods
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 |
Protected Methods
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.
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.