1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
/* * @(#)AccessibleStateSet.java 1.19 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.accessibility; import java.util.Vector; import java.util.Locale; import java.util.MissingResourceException; import java.util.ResourceBundle; /** * Class AccessibleStateSet determines a component's state set. The state set * of a component is a set of AccessibleState objects and descriptions. E.G., The * current overall state of the object, such as whether it is enabled, * has focus, etc. * * @see AccessibleState * * @version 1.10 10/12/99 15:05:34 * @author Willie Walker */ public class AccessibleStateSet { /** * Each entry in the Vector represents an AccessibleState. * @see #add * @see #addAll * @see #remove * @see #contains * @see #toArray * @see #clear */ protected Vector<AccessibleState> states = null; /** * Creates a new empty state set. */ public AccessibleStateSet() { states = null; } /** * Creates a new state with the initial set of states contained in * the array of states passed in. Duplicate entries are ignored. * * @param states an array of AccessibleState describing the state set. */ public AccessibleStateSet(AccessibleState[] states) { if (states.length != 0) { this.states = new Vector(states.length); for (int i = 0; i < states.length; i++) { if (!this.states.contains(states[i])) { this.states.addElement(states[i]); } } } } /** * Adds a new state to the current state set if it is not already * present. If the state is already in the state set, the state * set is unchanged and the return value is false. Otherwise, * the state is added to the state set and the return value is * true. * @param state the state to add to the state set * @return true if state is added to the state set; false if the state set * is unchanged */ public boolean add(AccessibleState state) { // [[[ PENDING: WDW - the implementation of this does not need // to always use a vector of states. It could be improved by // caching the states as a bit set.]]] if (states == null) { states = new Vector(); } if (!states.contains(state)) { states.addElement(state); return true; } else { return false; } } /** * Adds all of the states to the existing state set. Duplicate entries * are ignored. * @param states AccessibleState array describing the state set. */ public void addAll(AccessibleState[] states) { if (states.length != 0) { if (this.states == null) { this.states = new Vector(states.length); } for (int i = 0; i < states.length; i++) { if (!this.states.contains(states[i])) { this.states.addElement(states[i]); } } } } /** * Removes a state from the current state set. If the state is not * in the set, the state set will be unchanged and the return value * will be false. If the state is in the state set, it will be removed * from the set and the return value will be true. * * @param state the state to remove from the state set * @return true if the state is in the state set; false if the state set * will be unchanged */ public boolean remove(AccessibleState state) { if (states == null) { return false; } else { return states.removeElement(state); } } /** * Removes all the states from the current state set. */ public void clear() { if (states != null) { states.removeAllElements(); } } /** * Checks if the current state is in the state set. * @param state the state * @return true if the state is in the state set; otherwise false */ public boolean contains(AccessibleState state) { if (states == null) { return false; } else { return states.contains(state); } } /** * Returns the current state set as an array of AccessibleState * @return AccessibleState array containing the current state. */ public AccessibleState[] toArray() { if (states == null) { return new AccessibleState[0]; } else { AccessibleState[] stateArray = new AccessibleState[states.size()]; for (int i = 0; i < stateArray.length; i++) { stateArray[i] = (AccessibleState) states.elementAt(i); } return stateArray; } } /** * Creates a localized String representing all the states in the set * using the default locale. * * @return comma separated localized String * @see AccessibleBundle#toDisplayString */ public String toString() { String ret = null; if ((states != null) && (states.size() > 0)) { ret = ((AccessibleState) (states.elementAt(0))).toDisplayString(); for (int i = 1; i < states.size(); i++) { ret = ret + "," + ((AccessibleState) (states.elementAt(i))). toDisplayString(); } } return ret; } }