APIdia Launch Partner
Top Description Fields Constructors Methods
javax.swing.text

public abstract Class TextAction

extends AbstractAction
Class Inheritance
Known Direct Subclasses
javax.swing.text.html.HTMLEditorKit.NavigateLinkAction, javax.swing.text.html.HTMLEditorKit.ActivateLinkAction, javax.swing.text.html.HTMLEditorKit.BeginAction, javax.swing.JFormattedTextField.CancelAction, javax.swing.JTextField.NotifyAction, javax.swing.plaf.basic.BasicTextUI.TextActionWrapper, javax.swing.text.DefaultEditorKit.DefaultKeyTypedAction, javax.swing.text.DefaultEditorKit.InsertContentAction, javax.swing.text.DefaultEditorKit.InsertBreakAction, javax.swing.text.DefaultEditorKit.InsertTabAction, javax.swing.text.DefaultEditorKit.DeletePrevCharAction, javax.swing.text.DefaultEditorKit.DeleteNextCharAction, javax.swing.text.DefaultEditorKit.DeleteWordAction, javax.swing.text.DefaultEditorKit.ReadOnlyAction, javax.swing.text.DefaultEditorKit.WritableAction, javax.swing.text.DefaultEditorKit.CutAction, javax.swing.text.DefaultEditorKit.CopyAction, javax.swing.text.DefaultEditorKit.PasteAction, javax.swing.text.DefaultEditorKit.BeepAction, javax.swing.text.DefaultEditorKit.VerticalPageAction, javax.swing.text.DefaultEditorKit.PageAction, javax.swing.text.DefaultEditorKit.DumpModelAction, javax.swing.text.DefaultEditorKit.NextVisualPositionAction, javax.swing.text.DefaultEditorKit.BeginWordAction, javax.swing.text.DefaultEditorKit.EndWordAction, javax.swing.text.DefaultEditorKit.PreviousWordAction, javax.swing.text.DefaultEditorKit.NextWordAction, javax.swing.text.DefaultEditorKit.BeginLineAction, javax.swing.text.DefaultEditorKit.EndLineAction, javax.swing.text.DefaultEditorKit.EndLineDownAction, javax.swing.text.DefaultEditorKit.BeginLineUpAction, javax.swing.text.DefaultEditorKit.BeginParagraphAction, javax.swing.text.DefaultEditorKit.EndParagraphAction, javax.swing.text.DefaultEditorKit.BeginAction, javax.swing.text.DefaultEditorKit.EndAction, javax.swing.text.DefaultEditorKit.SelectWordAction, javax.swing.text.DefaultEditorKit.SelectLineAction, javax.swing.text.DefaultEditorKit.SelectParagraphAction, javax.swing.text.DefaultEditorKit.SelectAllAction, javax.swing.text.DefaultEditorKit.UnselectAction, javax.swing.text.DefaultEditorKit.ToggleComponentOrientationAction, javax.swing.text.StyledEditorKit.StyledTextAction
Annotations
@SuppressWarnings:serial
Imports
java.awt.event.ActionEvent, java.awt.KeyboardFocusManager, .Component, java.util.Hashtable, .Enumeration, javax.swing.Action, .AbstractAction, .KeyStroke
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 java.beans.XMLEncoder.

Author
Timothy Prinzing

Field Summary

Inherited from javax.swing.AbstractAction:
changeSupportenabled

Constructor Summary

AccessConstructor and Description
public
TextAction(String
the name of the action
name)

Creates a new JTextAction object.

Method Summary

Modifier and TypeMethod and Description
public static final Action[]

Returns:

the augmented list
augmentList(Action[]
the first list, may be empty but not null
list1, Action[]
the second list, may be empty but not null
list2)

Takes one list of commands and augments it with another list of commands.

protected final JTextComponent

Returns:

the component
getFocusedComponent()

Fetches the text component that currently has focus.

protected final JTextComponent

Returns:

the component
getTextComponent(ActionEvent
the ActionEvent
e)

Determines the component to use for the action.

Inherited from javax.swing.AbstractAction:
addPropertyChangeListenerclonefirePropertyChangegetKeysgetPropertyChangeListenersgetValueisEnabledputValueremovePropertyChangeListenersetEnabled

Constructor Detail

TextActionback to summary
public TextAction(String name)

Creates a new JTextAction object.

Parameters
name:String

the name of the action

Method Detail

augmentListback to summary
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:Action[]

the first list, may be empty but not null

list2:Action[]

the second list, may be empty but not null

Returns:Action[]

the augmented list

getFocusedComponentback to summary
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:JTextComponent

the component

getTextComponentback to summary
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:ActionEvent

the ActionEvent

Returns:JTextComponent

the component