libjava/javax/swing/text/TextAction.java

   1 /* TextAction.java --
   2    Copyright (C) 2002, 2004 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.swing.text;
  40
  41 import java.awt.event.ActionEvent;
  42 import java.util.ArrayList;
  43 import java.util.HashSet;
  44
  45 import javax.swing.AbstractAction;
  46 import javax.swing.Action;
  47
  48 /**
  49  * TextAction
  50  * @author Andrew Selkirk
  51  */
  52 public abstract class TextAction extends AbstractAction
  53 {
  54   /**
  55    * Constructor TextAction
  56    * @param name TODO
  57    */
  58   public TextAction(String name)
  59   {
  60     super(name);
  61   }
  62
  63   /**
  64    * Returns the <code>JTextComponent</code> object associated with the given
  65    * <code>ActionEvent</code>. If the source of the event is not a
  66    * <code>JTextComponent</code> the currently focused text component is returned.
  67    *
  68    * @param event the action event
  69    *
  70    * @return the <code>JTextComponent</code>
  71    */
  72   protected final JTextComponent getTextComponent(ActionEvent event)
  73   {
  74     if (event.getSource() instanceof JTextComponent)
  75       return (JTextComponent) event.getSource();
  76
  77     return getFocusedComponent();
  78   }
  79
  80   /**
  81    * Creates a new array of <code>Action</code> containing both given arrays.
  82    *
  83    * @param list1 the first action array
  84    * @param list2 the second action array
  85    *
  86    * @return the augmented array of actions
  87    */
  88   public static final Action[] augmentList(Action[] list1, Action[] list2)
  89   {
  90     HashSet actionSet = new HashSet();
  91
  92     for (int i = 0; i < list1.length; ++i)
  93       actionSet.add(list1[i]);
  94
  95     for (int i = 0; i < list2.length; ++i)
  96       actionSet.add(list2[i]);
  97
  98     ArrayList list = new ArrayList(actionSet);
  99     return (Action[]) list.toArray(new Action[actionSet.size()]);
 100   }
 101
 102   /**
 103    * Returns the current focused <code>JTextComponent</code> object.
 104    *
 105    * @return the <code>JTextComponent</code>
 106    */
 107   protected final JTextComponent getFocusedComponent()
 108   {
 109     return null; // TODO
 110   }
 111 }