Source for javax.accessibility.AccessibleStateSet

   1: /* AccessibleStateSet.java -- the combined state of an accessible object
   2:    Copyright (C) 2002, 2005 Free Software Foundation
   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., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 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: package javax.accessibility;
  39: 
  40: import java.util.Locale;
  41: import java.util.Vector;
  42: 
  43: /**
  44:  * Describes all elements of an accessible object's state. For example, an
  45:  * object may be enabled and have focus.
  46:  *
  47:  * @author Eric Blake (ebb9@email.byu.edu)
  48:  * @see AccessibleState
  49:  * @since 1.2
  50:  * @status updated to 1.4
  51:  */
  52: public class AccessibleStateSet
  53: {
  54:   /**
  55:    * The list of states, should be instances of AccessibleState. Don't set
  56:    * this to null.
  57:    *
  58:    * @see #add(AccessibleState)
  59:    * @see #addAll(AccessibleState[])
  60:    * @see #remove(AccessibleState)
  61:    * @see #contains(AccessibleState)
  62:    * @see #toArray()
  63:    * @see #clear()
  64:    */
  65:   protected Vector<AccessibleState> states = new Vector<AccessibleState>();
  66: 
  67:   /**
  68:    * Create an empty state set.
  69:    */
  70:   public AccessibleStateSet()
  71:   {
  72:   }
  73: 
  74:   /**
  75:    * Create a state set initialized with the given states, duplicates are
  76:    * ignored.
  77:    *
  78:    * @param states the states to insert
  79:    * @throws NullPointerException if states is null
  80:    */
  81:   public AccessibleStateSet(AccessibleState[] states)
  82:   {
  83:     addAll(states);
  84:   }
  85: 
  86:   /**
  87:    * Add a new state to the current set. Return true if the state was added,
  88:    * as duplicates are ignored. Entering a null state will cause problems
  89:    * later, so don't do it.
  90:    *
  91:    * @param state the state to add
  92:    * @return true if the state was added
  93:    */
  94:   public boolean add(AccessibleState state)
  95:   {
  96:     return states.contains(state) ? false : states.add(state);
  97:   }
  98: 
  99:   /**
 100:    * Add all of the states to the current set. Duplicates are ignored.
 101:    * Entering a null state will cause problems later, so don't do it.
 102:    *
 103:    * @param array the array of states to add
 104:    * @throws NullPointerException if array is null
 105:    */
 106:   public void addAll(AccessibleState[] array)
 107:   {
 108:     int i = array.length;
 109:     while (--i >= 0)
 110:       add(array[i]);
 111:   }
 112: 
 113:   /**
 114:    * Remove a state from the set. If a state was removed, return true.
 115:    *
 116:    * @param state the state to remove
 117:    * @return true if the set changed
 118:    */
 119:   public boolean remove(AccessibleState state)
 120:   {
 121:     return states.remove(state);
 122:   }
 123: 
 124:   /**
 125:    * Clear all states in the set.
 126:    */
 127:   public void clear()
 128:   {
 129:     states.clear();
 130:   }
 131: 
 132:   /**
 133:    * Check if the current state is in the set.
 134:    *
 135:    * @param state the state to locate
 136:    * @return true if it is in the set
 137:    */
 138:   public boolean contains(AccessibleState state)
 139:   {
 140:     return states.contains(state);
 141:   }
 142: 
 143:   /**
 144:    * Return the state set as an array.
 145:    *
 146:    * @return an array of the current states
 147:    */
 148:   public AccessibleState[] toArray()
 149:   {
 150:     AccessibleState[] result = new AccessibleState[states.size()];
 151:     states.toArray(result);
 152:     return result;
 153:   }
 154: 
 155:   /**
 156:    * Return a localized, comma-separated string representing all states
 157:    * in the set. This is in arbitrary order.
 158:    *
 159:    * @return the string representation
 160:    * @see AccessibleBundle#toDisplayString(String, Locale)
 161:    */
 162:   public String toString()
 163:   {
 164:     int i = states.size();
 165:     if (i == 0)
 166:       return "";
 167:     // Pre-allocate an average of 10 chars per state.
 168:     StringBuffer b = new StringBuffer(i * 10);
 169:     while (--i >= 0)
 170:       b.append(states.get(i)).append(',');
 171:     return b.substring(0, b.length() - 1);
 172:   }
 173: } // class AccessibleStateSet