libjava/javax/accessibility/AccessibleRole.java

   1 /* AccessibleRole.java -- the primary role of an accessible object
   2    Copyright (C) 2002 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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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 /**
  41  * The role of an accessible object. For example, this could be "button" or
  42  * "table". This strongly typed "enumeration" supports localized strings. If
  43  * the constants of this class are not adequate, new ones may be added in a
  44  * similar matter, while avoiding a public constructor.
  45  *
  46  * @author Eric Blake (ebb9@email.byu.edu)
  47  * @since 1.2
  48  * @status updated to 1.4
  49  */
  50 public class AccessibleRole extends AccessibleBundle
  51 {
  52   /** The object alerts the user about something. */
  53   public static final AccessibleRole ALERT
  54     = new AccessibleRole("alert");
  55
  56   /** The header for a column of data. */
  57   public static final AccessibleRole COLUMN_HEADER
  58     = new AccessibleRole("column header");
  59
  60   /**
  61    * The object can be drawn into, and traps events.
  62    *
  63    * @see #FRAME
  64    * @see #GLASS_PANE
  65    * @see #LAYERED_PANE
  66    */
  67   public static final AccessibleRole CANVAS
  68     = new AccessibleRole("canvas");
  69
  70   /**
  71    * A list of choices, which may optionally allow the user to create a new
  72    * choice.
  73    */
  74   public static final AccessibleRole COMBO_BOX
  75     = new AccessibleRole("combo box");
  76
  77   /**
  78    * An iconified frame in a desktop.
  79    *
  80    * @see #DESKTOP_PANE
  81    * @see #INTERNAL_FRAME
  82    */
  83   public static final AccessibleRole DESKTOP_ICON
  84     = new AccessibleRole("desktop icon");
  85
  86   /**
  87    * A frame-like object clipped by a desktop pane.
  88    *
  89    * @see #DESKTOP_ICON
  90    * @see #DESKTOP_PANE
  91    * @see #FRAME
  92    */
  93   public static final AccessibleRole INTERNAL_FRAME
  94     = new AccessibleRole("internal frame");
  95
  96   /**
  97    * A pane which supports internal frames and their icons.
  98    *
  99    * @see #DESKTOP_ICON
 100    * @see #INTERNAL_FRAME
 101    */
 102   public static final AccessibleRole DESKTOP_PANE
 103     = new AccessibleRole("desktop pane");
 104
 105   /**
 106    * A specialized pane for use in a dialog.
 107    *
 108    * @see #DIALOG
 109    */
 110   public static final AccessibleRole OPTION_PANE
 111     = new AccessibleRole("option pane");
 112
 113   /**
 114    * A top level window with no title or border.
 115    *
 116    * @see #FRAME
 117    * @see #DIALOG
 118    */
 119   public static final AccessibleRole WINDOW
 120     = new AccessibleRole("window");
 121
 122   /**
 123    * A top level window with title, menu bar, border, and so forth. It is
 124    * often the primary window of an application.
 125    *
 126    * @see #DIALOG
 127    * @see #CANVAS
 128    * @see #WINDOW
 129    */
 130   public static final AccessibleRole FRAME
 131     = new AccessibleRole("frame");
 132
 133   /**
 134    * A top level window title bar and border. It is limited compared to a
 135    * frame, and is often a secondary window.
 136    *
 137    * @see #FRAME
 138    * @see #WINDOW
 139    */
 140   public static final AccessibleRole DIALOG
 141     = new AccessibleRole("dialog");
 142
 143   /** A specialized dialog for choosing a color. */
 144   public static final AccessibleRole COLOR_CHOOSER
 145     = new AccessibleRole("color chooser");
 146
 147   /**
 148    * A pane for navigating through directories.
 149    *
 150    * @see #FILE_CHOOSER
 151    */
 152   public static final AccessibleRole DIRECTORY_PANE
 153     = new AccessibleRole("directory pane");
 154
 155   /**
 156    * A specialized dialog that allows a user to select a file.
 157    *
 158    * @see #DIRECTORY_PANE
 159    */
 160   public static final AccessibleRole FILE_CHOOSER
 161     = new AccessibleRole("file chooser");
 162
 163   /** An object to fill space between other components. */
 164   public static final AccessibleRole FILLER
 165     = new AccessibleRole("filler");
 166
 167   /** A hypertext anchor. */
 168   public static final AccessibleRole HYPERLINK
 169     = new AccessibleRole("hyperlink");
 170
 171   /** A small picture to decorate components. */
 172   public static final AccessibleRole ICON
 173     = new AccessibleRole("icon");
 174
 175   /** An object to label something in a graphic interface. */
 176   public static final AccessibleRole LABEL
 177     = new AccessibleRole("label");
 178
 179   /**
 180    * A specialized pane with a glass pane and layered pane as children.
 181    *
 182    * @see #GLASS_PANE
 183    * @see #LAYERED_PANE
 184    */
 185   public static final AccessibleRole ROOT_PANE
 186     = new AccessibleRole("root pane");
 187
 188   /**
 189    * A pane guaranteed to be painted on top of panes beneath it.
 190    *
 191    * @see #ROOT_PANE
 192    * @see #LAYERED_PANE
 193    */
 194   public static final AccessibleRole GLASS_PANE
 195     = new AccessibleRole("glass pane");
 196
 197   /**
 198    * A specialized pane that allows drawing children in layers. This is often
 199    * used in menus and other visual components.
 200    *
 201    * @see #ROOT_PANE
 202    * @see #GLASS_PANE
 203    */
 204   public static final AccessibleRole LAYERED_PANE
 205     = new AccessibleRole("layered pane");
 206
 207   /**
 208    * An object which presents a list of items for selection. Often contained
 209    * in a scroll pane.
 210    *
 211    * @see #SCROLL_PANE
 212    * @see #LIST_ITEM
 213    */
 214   public static final AccessibleRole LIST
 215     = new AccessibleRole("list");
 216
 217   /**
 218    * An object which represents an item in a list. Often contained in a scroll
 219    * pane.
 220    *
 221    * @see #SCROLL_PANE
 222    * @see #LIST
 223    */
 224   public static final AccessibleRole LIST_ITEM
 225     = new AccessibleRole("list item");
 226
 227   /**
 228    * An object usually at the top of a frame to list available menus.
 229    *
 230    * @see #MENU
 231    * @see #POPUP_MENU
 232    * @see #LAYERED_PANE
 233    */
 234   public static final AccessibleRole MENU_BAR
 235     = new AccessibleRole("menu bar");
 236
 237   /**
 238    * A temporary window with a menu of options, which hides on selection.
 239    *
 240    * @see #MENU
 241    * @see #MENU_ITEM
 242    */
 243   public static final AccessibleRole POPUP_MENU
 244     = new AccessibleRole("popup menu");
 245
 246   /**
 247    * An object usually in a menu bar which contains a list of actions to
 248    * perform. Such actions are usually associated with menu items or submenus.
 249    *
 250    * @see #MENU_BAR
 251    * @see #MENU_ITEM
 252    * @see #SEPARATOR
 253    * @see #RADIO_BUTTON
 254    * @see #CHECK_BOX
 255    * @see #POPUP_MENU
 256    */
 257   public static final AccessibleRole MENU
 258     = new AccessibleRole("menu");
 259
 260   /**
 261    * An object usually in a menu with an action available for the user.
 262    *
 263    * @see #MENU_BAR
 264    * @see #SEPARATOR
 265    * @see #POPUP_MENU
 266    */
 267   public static final AccessibleRole MENU_ITEM
 268     = new AccessibleRole("menu item");
 269
 270   /**
 271    * An object usually in a menu which separates logical sections of items.
 272    *
 273    * @see #MENU
 274    * @see #MENU_ITEM
 275    */
 276   public static final AccessibleRole SEPARATOR
 277     = new AccessibleRole("separator");
 278
 279   /**
 280    * An object which presents a series of panels, usually via tabs along the
 281    * top. Children are all page tabs.
 282    *
 283    * @see #PAGE_TAB
 284    */
 285   public static final AccessibleRole PAGE_TAB_LIST
 286     = new AccessibleRole("page tab list");
 287
 288   /**
 289    * An object in a page tab list, which contains the panel to display when
 290    * selected from the list.
 291    *
 292    * @see #PAGE_TAB_LIST
 293    */
 294   public static final AccessibleRole PAGE_TAB
 295     = new AccessibleRole("page tab");
 296
 297   /** A generic container to group objects. */
 298   public static final AccessibleRole PANEL
 299     = new AccessibleRole("panel");
 300
 301   /** An object used to track amount of a task that has completed. */
 302   public static final AccessibleRole PROGRESS_BAR
 303     = new AccessibleRole("progress bar");
 304
 305   /** An object for passwords which should not be shown to the user. */
 306   public static final AccessibleRole PASSWORD_TEXT
 307     = new AccessibleRole("password text");
 308
 309   /**
 310    * An object that can be manipulated to do something.
 311    *
 312    * @see #CHECK_BOX
 313    * @see #TOGGLE_BUTTON
 314    * @see #RADIO_BUTTON
 315    */
 316   public static final AccessibleRole PUSH_BUTTON
 317     = new AccessibleRole("push button");
 318
 319   /**
 320    * A specialized button which can be on or off, with no separate indicator.
 321    *
 322    * @see #PUSH_BUTTON
 323    * @see #CHECK_BOX
 324    * @see #RADIO_BUTTON
 325    */
 326   public static final AccessibleRole TOGGLE_BUTTON
 327     = new AccessibleRole("toggle button");
 328
 329   /**
 330    * A choice which can be on or off, and has a separate indicator.
 331    *
 332    * @see #PUSH_BUTTON
 333    * @see #TOGGLE_BUTTON
 334    * @see #RADIO_BUTTON
 335    */
 336   public static final AccessibleRole CHECK_BOX
 337     = new AccessibleRole("check box");
 338
 339   /**
 340    * A specialized choice which toggles radio buttons in the group when it
 341    * is selected.
 342    *
 343    * @see #PUSH_BUTTON
 344    * @see #TOGGLE_BUTTON
 345    * @see #CHECK_BOX
 346    */
 347   public static final AccessibleRole RADIO_BUTTON
 348     = new AccessibleRole("radio button");
 349
 350   /** The header for a row of data. */
 351   public static final AccessibleRole ROW_HEADER
 352     = new AccessibleRole("row header");
 353
 354   /**
 355    * An object which allows an incremental view of a larger pane.
 356    *
 357    * @see #SCROLL_BAR
 358    * @see #VIEWPORT
 359    */
 360   public static final AccessibleRole SCROLL_PANE
 361     = new AccessibleRole("scroll pane");
 362
 363   /**
 364    * An object which allows selection of the view in a scroll pane.
 365    *
 366    * @see #SCROLL_PANE
 367    */
 368   public static final AccessibleRole SCROLL_BAR
 369     = new AccessibleRole("scroll bar");
 370
 371   /**
 372    * An object which represents the visual section in a scroll pane.
 373    *
 374    * @see #SCROLL_PANE
 375    */
 376   public static final AccessibleRole VIEWPORT
 377     = new AccessibleRole("viewport");
 378
 379   /** An object which allows selection in a bounded range. */
 380   public static final AccessibleRole SLIDER
 381     = new AccessibleRole("slider");
 382
 383   /**
 384    * A specialized pane which presents two other panels, and can often adjust
 385    * the divider between them.
 386    */
 387   public static final AccessibleRole SPLIT_PANE
 388     = new AccessibleRole("split pane");
 389
 390   /** An object for presenting data in rows and columns. */
 391   public static final AccessibleRole TABLE
 392     = new AccessibleRole("table");
 393
 394   /**
 395    * An object which represents text, usually editable by the user.
 396    *
 397    * @see #LABEL
 398    */
 399   public static final AccessibleRole TEXT
 400     = new AccessibleRole("text");
 401
 402   /**
 403    * An object which represents a hierachical view of data. Subnodes can
 404    * often be expanded or collapsed.
 405    */
 406   public static final AccessibleRole TREE
 407     = new AccessibleRole("tree");
 408
 409   /** A bar or pallete with buttons for common actions in an application. */
 410   public static final AccessibleRole TOOL_BAR
 411     = new AccessibleRole("tool bar");
 412
 413   /**
 414    * An object which provides information about another object. This is often
 415    * displayed as a "help bubble" when a mouse hovers over the other object.
 416    */
 417   public static final AccessibleRole TOOL_TIP
 418     = new AccessibleRole("tool tip");
 419
 420   /**
 421    * An AWT component with nothing else known about it.
 422    *
 423    * @see #SWING_COMPONENT
 424    * @see #UNKNOWN
 425    */
 426   public static final AccessibleRole AWT_COMPONENT
 427     = new AccessibleRole("AWT component");
 428
 429   /**
 430    * A swing component with nothing else known about it.
 431    *
 432    * @see #AWT_COMPONENT
 433    * @see #UNKNOWN
 434    */
 435   public static final AccessibleRole SWING_COMPONENT
 436     = new AccessibleRole("SWING component");
 437
 438   /**
 439    * An accessible object whose role is unknown.
 440    *
 441    * @see #AWT_COMPONENT
 442    * @see #SWING_COMPONENT
 443    */
 444   public static final AccessibleRole UNKNOWN
 445     = new AccessibleRole("unknown");
 446
 447   /** A component with multiple labels of status information. */
 448   public static final AccessibleRole STATUS_BAR
 449     = new AccessibleRole("statusbar");
 450
 451   /** A component which allows editing of Date and Time objects. */
 452   public static final AccessibleRole DATE_EDITOR
 453     = new AccessibleRole("dateeditor");
 454
 455   /** A component with spinner arrows for simple numbers. */
 456   public static final AccessibleRole SPIN_BOX
 457     = new AccessibleRole("spinbox");
 458
 459   /** A component for choosing fonts and their attributes. */
 460   public static final AccessibleRole FONT_CHOOSER
 461     = new AccessibleRole("fontchooser");
 462
 463   /** A component with a border to group other components. */
 464   public static final AccessibleRole GROUP_BOX
 465     = new AccessibleRole("groupbox");
 466
 467   /**
 468    * Create a new constant with a locale independent key. Follow the example,
 469    * keep the constructor private and make public constants instead.
 470    *
 471    * @param key the name of the role
 472    * @see #toDisplayString(String, Locale)
 473    */
 474   protected AccessibleRole(String key)
 475   {
 476     this.key = key;
 477   }
 478 } // class AccessibleRole