Source for org.jfree.ui.action.ActionConcentrator

   1: /* ========================================================================
   2:  * JCommon : a free general purpose class library for the Java(tm) platform
   3:  * ========================================================================
   4:  *
   5:  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
   6:  * 
   7:  * Project Info:  http://www.jfree.org/jcommon/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  * 
  27:  * -----------------------
  28:  * ActionConcentrator.java
  29:  * -----------------------
  30:  * (C)opyright 2003, 2004, by Thomas Morgner and Contributors.
  31:  *
  32:  * Original Author:  Thomas Morgner;
  33:  * Contributor(s):   David Gilbert (for Object Refinery Limited);
  34:  *
  35:  * $Id: ActionConcentrator.java,v 1.4 2007/11/02 17:50:36 taqua Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 24-Aug-2003 : Initial version
  40:  * 07-Jun-2004 : Corrected source headers (DG);
  41:  */
  42: 
  43: package org.jfree.ui.action;
  44: 
  45: import java.util.ArrayList;
  46: import javax.swing.Action;
  47: 
  48: /**
  49:  * This class is used to collect actions to be enabled or disabled
  50:  * by a sinle call.
  51:  * 
  52:  * @author Thomas Morgner
  53:  */
  54: public class ActionConcentrator {
  55: 
  56:     /** The collection used to store the actions of this concentrator. */
  57:     private final ArrayList actions;
  58: 
  59:     /**
  60:      * DefaultConstructor.
  61:      */
  62:     public ActionConcentrator() {
  63:         this.actions = new ArrayList();
  64:     }
  65: 
  66:     /**
  67:      * Adds the action to this concentrator.
  68:      * 
  69:      * @param a the action to be added.
  70:      */
  71:     public void addAction(final Action a) {
  72:         if (a == null) {
  73:             throw new NullPointerException();
  74:         }
  75:         this.actions.add(a);
  76:     }
  77: 
  78:     /**
  79:      * Removes the action from this concentrator.
  80:      * 
  81:      * @param a the action to be removed.
  82:      */
  83:     public void removeAction(final Action a) {
  84:         if (a == null) {
  85:             throw new NullPointerException();
  86:         }
  87:         this.actions.remove(a);
  88:     }
  89: 
  90:     /**
  91:      * Defines the state for all actions. 
  92:      * 
  93:      * @param b the new state for all actions.
  94:      */
  95:     public void setEnabled(final boolean b) {
  96:         for (int i = 0; i < this.actions.size(); i++) {
  97:             final Action a = (Action) this.actions.get(i);
  98:             a.setEnabled(b);
  99:         }
 100:     }
 101: 
 102:     /**
 103:      * Returns, whether all actions are disabled.
 104:      * If one action is enabled, then this method will return
 105:      * true.
 106:      * 
 107:      * @return true, if at least one action is enabled, false
 108:      * otherwise.
 109:      */
 110:     public boolean isEnabled() {
 111:         for (int i = 0; i < this.actions.size(); i++) {
 112:             final Action a = (Action) this.actions.get(i);
 113:             if (a.isEnabled()) {
 114:                 return true;
 115:             }
 116:         }
 117:         return false;
 118:     }
 119:     
 120: }