public class AccessibleRole extends AccessibleBundle
AccessibleRole
determines the role of a component. The role of a component describes its generic function. (E.G., "push button," "table," or "list.") The AccessibleBundle.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.
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.
Modifier and Type | Field | Description |
---|---|---|
static final AccessibleRole |
ALERT |
Object is used to alert the user about something. |
static final AccessibleRole |
AWT_COMPONENT |
An AWT component, but nothing else is known about it. |
static final AccessibleRole |
CANVAS |
Object that can be drawn into and is used to trap events. |
static final AccessibleRole |
CHECK_BOX |
A choice that can be checked or unchecked and provides a separate indicator for the current state. |
static final AccessibleRole |
COLOR_CHOOSER |
A specialized pane that lets the user choose a color. |
static final AccessibleRole |
COLUMN_HEADER |
The header for a column of data. |
static final AccessibleRole |
COMBO_BOX |
A list of choices the user can select from. |
static final AccessibleRole |
DATE_EDITOR |
A DATE_EDITOR is a component that allows users to edit java.util.Date and java.util.Time objects. |
static final AccessibleRole |
DESKTOP_ICON |
An iconified internal frame in a DESKTOP_PANE . |
static final AccessibleRole |
DESKTOP_PANE |
A pane that supports internal frames and iconified versions of those internal frames. |
static final AccessibleRole |
DIALOG |
A top level window with title bar and a border. |
static final AccessibleRole |
DIRECTORY_PANE |
A pane that allows the user to navigate through and select the contents of a directory. |
static final AccessibleRole |
EDITBAR |
A role indicating the object acts as a formula for calculating a value. |
static final AccessibleRole |
FILE_CHOOSER |
A specialized dialog that displays the files in the directory and lets the user select a file, browse a different directory, or specify a filename. |
static final AccessibleRole |
FILLER |
An object that fills up space in a user interface. |
static final AccessibleRole |
FONT_CHOOSER |
A FONT_CHOOSER is a component that lets the user pick various attributes for fonts. |
static final AccessibleRole |
FOOTER |
A text footer. |
static final AccessibleRole |
FRAME |
A top level window with a title bar, border, menu bar, etc. |
static final AccessibleRole |
GLASS_PANE |
A pane that is guaranteed to be painted on top of all panes beneath it. |
static final AccessibleRole |
GROUP_BOX |
A GROUP_BOX is a simple container that contains a border around it and contains components inside it. |
static final AccessibleRole |
HEADER |
A text header. |
static final AccessibleRole |
HTML_CONTAINER |
An object containing a collection of Accessibles that together represents HTML content. |
static final AccessibleRole |
HYPERLINK |
A hypertext anchor. |
static final AccessibleRole |
ICON |
A small fixed size picture, typically used to decorate components. |
static final AccessibleRole |
INTERNAL_FRAME |
A frame-like object that is clipped by a desktop pane. |
static final AccessibleRole |
LABEL |
An object used to present an icon or short string in an interface. |
static final AccessibleRole |
LAYERED_PANE |
A specialized pane that allows its children to be drawn in layers, providing a form of stacking order. |
static final AccessibleRole |
LIST |
An object that presents a list of objects to the user and allows the user to select one or more of them. |
static final AccessibleRole |
LIST_ITEM |
An object that presents an element in a list. |
static final AccessibleRole |
MENU |
An object usually found inside a menu bar that contains a list of actions the user can choose from. |
static final AccessibleRole |
MENU_BAR |
An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from. |
static final AccessibleRole |
MENU_ITEM |
An object usually contained in a menu that presents an action the user can choose. |
static final AccessibleRole |
OPTION_PANE |
A specialized pane whose primary use is inside a DIALOG . |
static final AccessibleRole |
PAGE_TAB |
An object that is a child of a page tab list. |
static final AccessibleRole |
PAGE_TAB_LIST |
An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object. |
static final AccessibleRole |
PANEL |
A generic container that is often used to group objects. |
static final AccessibleRole |
PARAGRAPH |
A text paragraph. |
static final AccessibleRole |
PASSWORD_TEXT |
A text object used for passwords, or other places where the text contents is not shown visibly to the user. |
static final AccessibleRole |
POPUP_MENU |
A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices. |
static final AccessibleRole |
PROGRESS_BAR |
An object used to indicate how much of a task has been completed. |
static final AccessibleRole |
PROGRESS_MONITOR |
A role indicating the object monitors the progress of some operation. |
static final AccessibleRole |
PUSH_BUTTON |
An object the user can manipulate to tell the application to do something. |
static final AccessibleRole |
RADIO_BUTTON |
A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked. |
static final AccessibleRole |
ROOT_PANE |
A specialized pane that has a glass pane and a layered pane as its children. |
static final AccessibleRole |
ROW_HEADER |
The header for a row of data. |
static final AccessibleRole |
RULER |
A ruler is an object used to measure distance. |
static final AccessibleRole |
SCROLL_BAR |
An object usually used to allow a user to incrementally view a large amount of data. |
static final AccessibleRole |
SCROLL_PANE |
An object that allows a user to incrementally view a large amount of information. |
static final AccessibleRole |
SEPARATOR |
An object usually contained in a menu to provide a visual and logical separation of the contents in a menu. |
static final AccessibleRole |
SLIDER |
An object that allows the user to select from a bounded range. |
static final AccessibleRole |
SPIN_BOX |
A SPIN_BOX is a simple spinner component and its main use is for simple numbers. |
static final AccessibleRole |
SPLIT_PANE |
A specialized panel that presents two other panels at the same time. |
static final AccessibleRole |
STATUS_BAR |
A STATUS_BAR is an simple component that can contain multiple labels of status information to the user. |
static final AccessibleRole |
SWING_COMPONENT |
A Swing component, but nothing else is known about it. |
static final AccessibleRole |
TABLE |
An object used to present information in terms of rows and columns. |
static final AccessibleRole |
TEXT |
An object that presents text to the user. |
static final AccessibleRole |
TOGGLE_BUTTON |
A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state. |
static final AccessibleRole |
TOOL_BAR |
A bar or palette usually composed of push buttons or toggle buttons. |
static final AccessibleRole |
TOOL_TIP |
An object that provides information about another object. |
static final AccessibleRole |
TREE |
An object used to present hierarchical information to the user. |
static final AccessibleRole |
UNKNOWN |
The object contains some Accessible information, but its role is not known. |
static final AccessibleRole |
VIEWPORT |
An object usually used in a scroll pane. |
static final AccessibleRole |
WINDOW |
A top level window with no title or border. |
key
Modifier | Constructor | Description |
---|---|---|
protected |
Creates a new AccessibleRole using the given locale independent key. |
toDisplayString, toDisplayString, toDisplayString, toString
public static final AccessibleRole ALERT
public static final AccessibleRole COLUMN_HEADER
public static final AccessibleRole CANVAS
public static final AccessibleRole COMBO_BOX
public static final AccessibleRole DESKTOP_ICON
DESKTOP_PANE
.public static final AccessibleRole HTML_CONTAINER
Accessibles
that together represents HTML
content. The child Accessibles
would include objects implementing AccessibleText
, AccessibleHypertext
, AccessibleIcon
, and other interfaces.public static final AccessibleRole INTERNAL_FRAME
public static final AccessibleRole DESKTOP_PANE
public static final AccessibleRole OPTION_PANE
DIALOG
.public static final AccessibleRole WINDOW
public static final AccessibleRole FRAME
public static final AccessibleRole DIALOG
public static final AccessibleRole COLOR_CHOOSER
public static final AccessibleRole DIRECTORY_PANE
public static final AccessibleRole FILE_CHOOSER
public static final AccessibleRole FILLER
public static final AccessibleRole HYPERLINK
public static final AccessibleRole ICON
public static final AccessibleRole LABEL
public static final AccessibleRole ROOT_PANE
public static final AccessibleRole GLASS_PANE
public static final AccessibleRole LAYERED_PANE
public static final AccessibleRole LIST
public static final AccessibleRole LIST_ITEM
public static final AccessibleRole MENU_BAR
public static final AccessibleRole POPUP_MENU
public static final AccessibleRole MENU
public static final AccessibleRole MENU_ITEM
public static final AccessibleRole SEPARATOR
public static final AccessibleRole PAGE_TAB_LIST
public static final AccessibleRole PAGE_TAB
public static final AccessibleRole PANEL
public static final AccessibleRole PROGRESS_BAR
public static final AccessibleRole PASSWORD_TEXT
public static final AccessibleRole PUSH_BUTTON
public static final AccessibleRole TOGGLE_BUTTON
public static final AccessibleRole CHECK_BOX
public static final AccessibleRole RADIO_BUTTON
public static final AccessibleRole ROW_HEADER
public static final AccessibleRole SCROLL_PANE
public static final AccessibleRole SCROLL_BAR
public static final AccessibleRole VIEWPORT
public static final AccessibleRole SLIDER
public static final AccessibleRole SPLIT_PANE
public static final AccessibleRole TABLE
public static final AccessibleRole TEXT
public static final AccessibleRole TREE
public static final AccessibleRole TOOL_BAR
public static final AccessibleRole TOOL_TIP
accessibleDescription
property of the tool tip is often displayed to the user in a small "help bubble" when the user causes the mouse to hover over the object associated with the tool tip.public static final AccessibleRole AWT_COMPONENT
public static final AccessibleRole SWING_COMPONENT
public static final AccessibleRole UNKNOWN
Accessible
information, but its role is not known.public static final AccessibleRole STATUS_BAR
STATUS_BAR
is an simple component that can contain multiple labels of status information to the user.public static final AccessibleRole DATE_EDITOR
DATE_EDITOR
is a component that allows users to edit java.util.Date
and java.util.Time
objects.public static final AccessibleRole SPIN_BOX
SPIN_BOX
is a simple spinner component and its main use is for simple numbers.public static final AccessibleRole FONT_CHOOSER
FONT_CHOOSER
is a component that lets the user pick various attributes for fonts.public static final AccessibleRole GROUP_BOX
GROUP_BOX
is a simple container that contains a border around it and contains components inside it.public static final AccessibleRole HEADER
public static final AccessibleRole FOOTER
public static final AccessibleRole PARAGRAPH
public static final AccessibleRole RULER
public static final AccessibleRole EDITBAR
public static final AccessibleRole PROGRESS_MONITOR
protected AccessibleRole(String key)
AccessibleRole
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. The key String
should be a locale independent key for the role. It is not intended to be used as the actual String
to display to the user. To get the localized string, use AccessibleBundle.toDisplayString()
.
key
- the locale independent name of the role
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/accessibility/AccessibleRole.html