Targetable.java
上传用户:zhengdagz
上传日期:2014-03-06
资源大小:1956k
文件大小:2k
源码类别:

xml/soap/webservice

开发平台:

Java

  1. /*
  2.  * $Id: Targetable.java,v 1.2 2005/10/10 18:02:41 rbair Exp $
  3.  *
  4.  * Copyright 2004 Sun Microsystems, Inc., 4150 Network Circle,
  5.  * Santa Clara, California 95054, U.S.A. All rights reserved.
  6.  *
  7.  * This library is free software; you can redistribute it and/or
  8.  * modify it under the terms of the GNU Lesser General Public
  9.  * License as published by the Free Software Foundation; either
  10.  * version 2.1 of the License, or (at your option) any later version.
  11.  * 
  12.  * This library is distributed in the hope that it will be useful,
  13.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15.  * Lesser General Public License for more details.
  16.  * 
  17.  * You should have received a copy of the GNU Lesser General Public
  18.  * License along with this library; if not, write to the Free Software
  19.  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20.  */
  21. package org.jdesktop.swingx.action;
  22. /**
  23.  * An interface which exposes the allowable actions to a TargetManager. 
  24.  * The getCommands method will expose the allowable actions to another class
  25.  * and the doCommand method is called to invoke an action on the class.
  26.  * <p>
  27.  * Usually, the command key will be the key value of the Action. For components
  28.  * This could be the ActionMap keys. For actions managed with the ActionManager,
  29.  * this will be the value of an actions Action.ACTION_COMMAND_KEY
  30.  * 
  31.  * @see TargetManager
  32.  * @author Mark Davidson
  33.  */
  34. public interface Targetable {
  35.     /**
  36.      * Perform the command using the object value.
  37.      *
  38.      * @param command is a Action.ACTION_COMMAND_KEY
  39.      * @param value an arbitrary value. Usually this will be
  40.      *              EventObject which trigered the command.
  41.      */
  42.     boolean doCommand(Object command, Object value);
  43.     /**
  44.      * Return a flag that indicates if a command is supported.
  45.      * 
  46.      * @param command is a Action.ACTION_COMMAND_KEY
  47.      * @return true if command is supported; false otherwise
  48.      */
  49.     boolean hasCommand(Object command);
  50.     /**
  51.      * Returns an array of supported commands. If this Targetable 
  52.      * doesn't support any commands (which is unlikely) then an 
  53.      * empty array is returned.
  54.      *
  55.      * @return array of supported commands
  56.      */
  57.     Object[] getCommands();
  58. }