javax.swing.text: abstract public class: TextAction

javax.swing.text
abstract public class: TextAction [javadoc | source]

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

All Implemented Interfaces:
Action, Cloneable, Serializable

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 java.beans.XMLEncoder .

author: Timothy - Prinzing

Fields inherited from javax.swing.AbstractAction:
enabled, changeSupport

Constructor:

Constructor:
public TextAction(String name) { super(name); } Creates a new JTextAction object. Parameters: `name` - the name of the action

 public TextAction(String name) {
        super(name);
}

Creates a new JTextAction object.

Parameters:

name - the name of the action

Method from javax.swing.text.TextAction Summary:
augmentList, getFocusedComponent, getTextComponent

Methods from javax.swing.AbstractAction:
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, hasSelectedKey, isEnabled, isSelected, putValue, removePropertyChangeListener, setEnabled, setEnabledFromAction, setToolTipTextFromAction, shouldReconfigure

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

Method from javax.swing.text.TextAction Detail:
public static final Action[] augmentList(Action[] list1, Action[] list2) { Hashtable< String, Action > h = new Hashtable< String, Action >(); for (Action a : list1) { String value = (String)a.getValue(Action.NAME); h.put((value!=null ? value:""), a); } for (Action a : list2) { String value = (String)a.getValue(Action.NAME); h.put((value!=null ? value:""), a); } Action[] actions = new Action[h.size()]; int index = 0; for (Enumeration e = h.elements() ; e.hasMoreElements() ;) { actions[index++] = (Action) e.nextElement(); } return actions; } 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.
protected final JTextComponent getFocusedComponent() { return 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.
protected final JTextComponent getTextComponent(ActionEvent e) { if (e != null) { Object o = e.getSource(); if (o instanceof JTextComponent) { return (JTextComponent) o; } } return getFocusedComponent(); } 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.

Method from javax.swing.text.TextAction Detail:

 public static final Action[] augmentList(Action[] list1,
    Action[] list2) {
        Hashtable< String, Action > h = new Hashtable< String, Action >();
        for (Action a : list1) {
            String value = (String)a.getValue(Action.NAME);
            h.put((value!=null ? value:""), a);
        }
        for (Action a : list2) {
            String value = (String)a.getValue(Action.NAME);
            h.put((value!=null ? value:""), a);
        }
        Action[] actions = new Action[h.size()];
        int index = 0;
        for (Enumeration e = h.elements() ; e.hasMoreElements() ;) {
            actions[index++] = (Action) e.nextElement();
        }
        return actions;
}

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.

 protected final JTextComponent getFocusedComponent() {
        return 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.

 protected final JTextComponent getTextComponent(ActionEvent e) {
        if (e != null) {
            Object o = e.getSource();
            if (o instanceof JTextComponent) {
                return (JTextComponent) o;
            }
        }
        return getFocusedComponent();
}

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.