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 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
/* * @(#)AccessibleState.java 1.39 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; /** * <P>Class AccessibleState describes a component's particular state. The actual * state of the component is defined as an AccessibleStateSet, which is a * composed set of AccessibleStates. * <p>The toDisplayString method allows you to obtain the localized string * for a locale independent key from a predefined ResourceBundle for the * keys defined in this class. * <p>The constants in this class present a strongly typed enumeration * of common object roles. A public constructor for this class has been * purposely omitted and applications should use one of the constants * from this class. If the constants in this class are not sufficient * to describe the role of an object, a subclass should be generated * from this class and it should provide constants in a similar manner. * * @version 1.39 11/17/05 * @author Willie Walker * @author Peter Korn */ public class AccessibleState extends AccessibleBundle { // If you add or remove anything from here, make sure you // update AccessibleResourceBundle.java. /** * Indicates a window is currently the active window. This includes * windows, dialogs, frames, etc. In addition, this state is used * to indicate the currently active child of a component such as a * list, table, or tree. For example, the active child of a list * is the child that is drawn with a rectangle around it. * @see AccessibleRole#WINDOW * @see AccessibleRole#FRAME * @see AccessibleRole#DIALOG */ public static final AccessibleState ACTIVE = new AccessibleState("active"); /** * Indicates this object is currently pressed. This is usually * associated with buttons and indicates the user has pressed a * mouse button while the pointer was over the button and has * not yet released the mouse button. * @see AccessibleRole#PUSH_BUTTON */ public static final AccessibleState PRESSED = new AccessibleState("pressed"); /** * Indicates that the object is armed. This is usually used on buttons * that have been pressed but not yet released, and the mouse pointer * is still over the button. * @see AccessibleRole#PUSH_BUTTON */ public static final AccessibleState ARMED = new AccessibleState("armed"); /** * Indicates the current object is busy. This is usually used on objects * such as progress bars, sliders, or scroll bars to indicate they are * in a state of transition. * @see AccessibleRole#PROGRESS_BAR * @see AccessibleRole#SCROLL_BAR * @see AccessibleRole#SLIDER */ public static final AccessibleState BUSY = new AccessibleState("busy"); /** * Indicates this object is currently checked. This is usually used on * objects such as toggle buttons, radio buttons, and check boxes. * @see AccessibleRole#TOGGLE_BUTTON * @see AccessibleRole#RADIO_BUTTON * @see AccessibleRole#CHECK_BOX */ public static final AccessibleState CHECKED = new AccessibleState("checked"); /** * Indicates the user can change the contents of this object. This * is usually used primarily for objects that allow the user to * enter text. Other objects, such as scroll bars and sliders, * are automatically editable if they are enabled. * @see #ENABLED */ public static final AccessibleState EDITABLE = new AccessibleState("editable"); /** * Indicates this object allows progressive disclosure of its children. * This is usually used with hierarchical objects such as trees and * is often paired with the EXPANDED or COLLAPSED states. * @see #EXPANDED * @see #COLLAPSED * @see AccessibleRole#TREE */ public static final AccessibleState EXPANDABLE = new AccessibleState("expandable"); /** * Indicates this object is collapsed. This is usually paired with the * EXPANDABLE state and is used on objects that provide progressive * disclosure such as trees. * @see #EXPANDABLE * @see #EXPANDED * @see AccessibleRole#TREE */ public static final AccessibleState COLLAPSED = new AccessibleState("collapsed"); /** * Indicates this object is expanded. This is usually paired with the * EXPANDABLE state and is used on objects that provide progressive * disclosure such as trees. * @see #EXPANDABLE * @see #COLLAPSED * @see AccessibleRole#TREE */ public static final AccessibleState EXPANDED = new AccessibleState("expanded"); /** * Indicates this object is enabled. The absence of this state from an * object's state set indicates this object is not enabled. An object * that is not enabled cannot be manipulated by the user. In a graphical * display, it is usually grayed out. */ public static final AccessibleState ENABLED = new AccessibleState("enabled"); /** * Indicates this object can accept keyboard focus, which means all * events resulting from typing on the keyboard will normally be * passed to it when it has focus. * @see #FOCUSED */ public static final AccessibleState FOCUSABLE = new AccessibleState("focusable"); /** * Indicates this object currently has the keyboard focus. * @see #FOCUSABLE */ public static final AccessibleState FOCUSED = new AccessibleState("focused"); /** * Indicates this object is minimized and is represented only by an * icon. This is usually only associated with frames and internal * frames. * @see AccessibleRole#FRAME * @see AccessibleRole#INTERNAL_FRAME */ public static final AccessibleState ICONIFIED = new AccessibleState("iconified"); /** * Indicates something must be done with this object before the * user can interact with an object in a different window. This * is usually associated only with dialogs. * @see AccessibleRole#DIALOG */ public static final AccessibleState MODAL = new AccessibleState("modal"); /** * Indicates this object paints every pixel within its * rectangular region. A non-opaque component paints only some of * its pixels, allowing the pixels underneath it to "show through". * A component that does not fully paint its pixels therefore * provides a degree of transparency. * @see Accessible#getAccessibleContext * @see AccessibleContext#getAccessibleComponent * @see AccessibleComponent#getBounds */ public static final AccessibleState OPAQUE = new AccessibleState("opaque"); /** * Indicates the size of this object is not fixed. * @see Accessible#getAccessibleContext * @see AccessibleContext#getAccessibleComponent * @see AccessibleComponent#getSize * @see AccessibleComponent#setSize */ public static final AccessibleState RESIZABLE = new AccessibleState("resizable"); /** * Indicates this object allows more than one of its children to * be selected at the same time. * @see Accessible#getAccessibleContext * @see AccessibleContext#getAccessibleSelection * @see AccessibleSelection */ public static final AccessibleState MULTISELECTABLE = new AccessibleState("multiselectable"); /** * Indicates this object is the child of an object that allows its * children to be selected, and that this child is one of those * children that can be selected. * @see #SELECTED * @see Accessible#getAccessibleContext * @see AccessibleContext#getAccessibleSelection * @see AccessibleSelection */ public static final AccessibleState SELECTABLE = new AccessibleState("selectable"); /** * Indicates this object is the child of an object that allows its * children to be selected, and that this child is one of those * children that has been selected. * @see #SELECTABLE * @see Accessible#getAccessibleContext * @see AccessibleContext#getAccessibleSelection * @see AccessibleSelection */ public static final AccessibleState SELECTED = new AccessibleState("selected"); /** * Indicates this object, the object's parent, the object's parent's * parent, and so on, are all visible. Note that this does not * necessarily mean the object is painted on the screen. It might * be occluded by some other showing object. * @see #VISIBLE */ public static final AccessibleState SHOWING = new AccessibleState("showing"); /** * Indicates this object is visible. Note: this means that the * object intends to be visible; however, it may not in fact be * showing on the screen because one of the objects that this object * is contained by is not visible. * @see #SHOWING */ public static final AccessibleState VISIBLE = new AccessibleState("visible"); /** * Indicates the orientation of this object is vertical. This is * usually associated with objects such as scrollbars, sliders, and * progress bars. * @see #VERTICAL * @see AccessibleRole#SCROLL_BAR * @see AccessibleRole#SLIDER * @see AccessibleRole#PROGRESS_BAR */ public static final AccessibleState VERTICAL = new AccessibleState("vertical"); /** * Indicates the orientation of this object is horizontal. This is * usually associated with objects such as scrollbars, sliders, and * progress bars. * @see #HORIZONTAL * @see AccessibleRole#SCROLL_BAR * @see AccessibleRole#SLIDER * @see AccessibleRole#PROGRESS_BAR */ public static final AccessibleState HORIZONTAL = new AccessibleState("horizontal"); /** * Indicates this (text) object can contain only a single line of text */ public static final AccessibleState SINGLE_LINE = new AccessibleState("singleline"); /** * Indicates this (text) object can contain multiple lines of text */ public static final AccessibleState MULTI_LINE = new AccessibleState("multiline"); /** * Indicates this object is transient. An assistive technology should * not add a PropertyChange listener to an object with transient state, * as that object will never generate any events. Transient objects * are typically created to answer Java Accessibility method queries, * but otherwise do not remain linked to the underlying object (for * example, those objects underneath lists, tables, and trees in Swing, * where only one actual UI Component does shared rendering duty for * all of the data objects underneath the actual list/table/tree elements). * * @since 1.5 * */ public static final AccessibleState TRANSIENT = new AccessibleState("transient"); /** * Indicates this object is responsible for managing its * subcomponents. This is typically used for trees and tables * that have a large number of subcomponents and where the * objects are created only when needed and otherwise remain virtual. * The application should not manage the subcomponents directly. * * @since 1.5 */ public static final AccessibleState MANAGES_DESCENDANTS = new AccessibleState ("managesDescendants"); /** * Indicates that the object state is indeterminate. An example * is selected text that is partially bold and partially not * bold. In this case the attributes associated with the selected * text are indeterminate. * * @since 1.5 */ public static final AccessibleState INDETERMINATE = new AccessibleState ("indeterminate"); /** * A state indicating that text is truncated by a bounding rectangle * and that some of the text is not displayed on the screen. An example * is text in a spreadsheet cell that is truncated by the bounds of * the cell. * * @since 1.5 */ static public final AccessibleState TRUNCATED = new AccessibleState("truncated"); /** * Creates a new AccessibleState using the given locale independent key. * This should not be a public method. Instead, it is used to create * the constants in this file to make it a strongly typed enumeration. * Subclasses of this class should enforce similar policy. * <p> * The key String should be a locale independent key for the state. * It is not intended to be used as the actual String to display * to the user. To get the localized string, use toDisplayString. * * @param key the locale independent name of the state. * @see AccessibleBundle#toDisplayString */ protected AccessibleState(String key) { this.key = key; } }