TextAction (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing.text
class TextAction

java.lang.Object
  javax.swing.AbstractAction
      javax.swing.text.TextAction

All Implemented Interfaces:: Serializable, Cloneable, 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^TM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.

Field Summary

Fields inherited from class javax.swing.AbstractAction
`changeSupport, enabled`

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

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

Methods inherited from class javax.swing.AbstractAction
`addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

TextAction

public TextAction(String name)

Creates a new JTextAction object.

Parameters:: name - the name of the action

Method Detail

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

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