public abstract class

TextAction

extends AbstractAction
java.lang.Object
   ↳ javax.swing.AbstractAction
     ↳ javax.swing.text.TextAction
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
[Expand]
Inherited Fields
From class javax.swing.AbstractAction
Public Constructors
TextAction(String name)
Creates a new JTextAction object.
Public Methods
final static Action[] augmentList(Action[] list1, Action[] list2)
Takes one list of commands and augments it with another list of commands.
Protected Methods
final JTextComponent getFocusedComponent()
Fetches the text component that currently has focus.
final JTextComponent getTextComponent(ActionEvent e)
Determines the component to use for the action.
[Expand]
Inherited Methods
From class javax.swing.AbstractAction
From class java.lang.Object
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
Returns
  • the augmented list

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.

Returns
  • the component

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