001 /*
002 * Copyright 1997-2003 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 package javax.swing.text;
026
027 import java.awt.event.ActionEvent;
028 import java.awt.KeyboardFocusManager;
029 import java.awt.Component;
030 import java.util.Hashtable;
031 import java.util.Enumeration;
032 import javax.swing.Action;
033 import javax.swing.AbstractAction;
034 import javax.swing.KeyStroke;
035
036 /**
037 * An Action implementation useful for key bindings that are
038 * shared across a number of different text components. Because
039 * the action is shared, it must have a way of getting it's
040 * target to act upon. This class provides support to try and
041 * find a text component to operate on. The preferred way of
042 * getting the component to act upon is through the ActionEvent
043 * that is received. If the Object returned by getSource can
044 * be narrowed to a text component, it will be used. If the
045 * action event is null or can't be narrowed, the last focused
046 * text component is tried. This is determined by being
047 * used in conjunction with a JTextController which
048 * arranges to share that information with a TextAction.
049 * <p>
050 * <strong>Warning:</strong>
051 * Serialized objects of this class will not be compatible with
052 * future Swing releases. The current serialization support is
053 * appropriate for short term storage or RMI between applications running
054 * the same version of Swing. As of 1.4, support for long term storage
055 * of all JavaBeans<sup><font size="-2">TM</font></sup>
056 * has been added to the <code>java.beans</code> package.
057 * Please see {@link java.beans.XMLEncoder}.
058 *
059 * @author Timothy Prinzing
060 * @version 1.36 05/05/07
061 */
062 public abstract class TextAction extends AbstractAction {
063
064 /**
065 * Creates a new JTextAction object.
066 *
067 * @param name the name of the action
068 */
069 public TextAction(String name) {
070 super (name);
071 }
072
073 /**
074 * Determines the component to use for the action.
075 * This if fetched from the source of the ActionEvent
076 * if it's not null and can be narrowed. Otherwise,
077 * the last focused component is used.
078 *
079 * @param e the ActionEvent
080 * @return the component
081 */
082 protected final JTextComponent getTextComponent(ActionEvent e) {
083 if (e != null) {
084 Object o = e.getSource();
085 if (o instanceof JTextComponent) {
086 return (JTextComponent) o;
087 }
088 }
089 return getFocusedComponent();
090 }
091
092 /**
093 * Takes one list of
094 * commands and augments it with another list
095 * of commands. The second list takes precedence
096 * over the first list; that is, when both lists
097 * contain a command with the same name, the command
098 * from the second list is used.
099 *
100 * @param list1 the first list, may be empty but not
101 * <code>null</code>
102 * @param list2 the second list, may be empty but not
103 * <code>null</code>
104 * @return the augmented list
105 */
106 public static final Action[] augmentList(Action[] list1,
107 Action[] list2) {
108 Hashtable h = new Hashtable();
109 for (int i = 0; i < list1.length; i++) {
110 Action a = list1[i];
111 String value = (String) a.getValue(Action.NAME);
112 h.put((value != null ? value : ""), a);
113 }
114 for (int i = 0; i < list2.length; i++) {
115 Action a = list2[i];
116 String value = (String) a.getValue(Action.NAME);
117 h.put((value != null ? value : ""), a);
118 }
119 Action[] actions = new Action[h.size()];
120 int index = 0;
121 for (Enumeration e = h.elements(); e.hasMoreElements();) {
122 actions[index++] = (Action) e.nextElement();
123 }
124 return actions;
125 }
126
127 /**
128 * Fetches the text component that currently has focus.
129 * This allows actions to be shared across text components
130 * which is useful for key-bindings where a large set of
131 * actions are defined, but generally used the same way
132 * across many different components.
133 *
134 * @return the component
135 */
136 protected final JTextComponent getFocusedComponent() {
137 return JTextComponent.getFocusedComponent();
138 }
139 }
|