APIdia Launch Partner
Top Description Fields Constructors Methods
javax.accessibility

public Class AccessibleRole

extends AccessibleBundle
Class Inheritance

Class AccessibleRole determines the role of a component. The role of a component describes its generic function. (E.G., "push button," "table," or "list.")

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.

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.

Authors
Willie Walker, Peter Korn, Lynn Monsanto

Field Summary

Modifier and TypeField and Description
public static final AccessibleRole
ALERT

Object is used to alert the user about something.

public static final AccessibleRole
AWT_COMPONENT

An AWT component, but nothing else is known about it.

public static final AccessibleRole
CANVAS

Object that can be drawn into and is used to trap events.

public static final AccessibleRole
CHECK_BOX

A choice that can be checked or unchecked and provides a separate indicator for the current state.

public static final AccessibleRole
COLOR_CHOOSER

A specialized pane that lets the user choose a color.

public static final AccessibleRole
COLUMN_HEADER

The header for a column of data.

public static final AccessibleRole
COMBO_BOX

A list of choices the user can select from.

public static final AccessibleRole
DATE_EDITOR

A DATE_EDITOR is a component that allows users to edit java.util.Date and java.util.Time objects.

public static final AccessibleRole
DESKTOP_ICON

An iconified internal frame in a DESKTOP_PANE.

public static final AccessibleRole
DESKTOP_PANE

A pane that supports internal frames and iconified versions of those internal frames.

public static final AccessibleRole
DIALOG

A top level window with title bar and a border.

public static final AccessibleRole
DIRECTORY_PANE

A pane that allows the user to navigate through and select the contents of a directory.

public static final AccessibleRole
EDITBAR

A role indicating the object acts as a formula for calculating a value.

public 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.

public static final AccessibleRole
FILLER

An object that fills up space in a user interface.

public static final AccessibleRole
FONT_CHOOSER

A FONT_CHOOSER is a component that lets the user pick various attributes for fonts.

public static final AccessibleRole
FOOTER

A text footer.

public static final AccessibleRole
FRAME

A top level window with a title bar, border, menu bar, etc. It is often used as the primary window for an application.

public static final AccessibleRole
GLASS_PANE

A pane that is guaranteed to be painted on top of all panes beneath it.

public static final AccessibleRole
GROUP_BOX

A GROUP_BOX is a simple container that contains a border around it and contains components inside it.

public static final AccessibleRole
HEADER

A text header.

public static final AccessibleRole
HTML_CONTAINER

An object containing a collection of Accessibles that together represents HTML content.

public static final AccessibleRole
HYPERLINK

A hypertext anchor.

public static final AccessibleRole
ICON

A small fixed size picture, typically used to decorate components.

public static final AccessibleRole
INTERNAL_FRAME

A frame-like object that is clipped by a desktop pane.

public static final AccessibleRole
LABEL

An object used to present an icon or short string in an interface.

public static final AccessibleRole
LAYERED_PANE

A specialized pane that allows its children to be drawn in layers, providing a form of stacking order.

public 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.

public static final AccessibleRole
LIST_ITEM

An object that presents an element in a list.

public static final AccessibleRole
OPTION_PANE

A specialized pane whose primary use is inside a DIALOG.

public static final AccessibleRole
PAGE_TAB

An object that is a child of a page tab list.

public 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.

public static final AccessibleRole
PANEL

A generic container that is often used to group objects.

public static final AccessibleRole
PARAGRAPH

A text paragraph.

public 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.

public static final AccessibleRole
PROGRESS_BAR

An object used to indicate how much of a task has been completed.

public static final AccessibleRole
PROGRESS_MONITOR

A role indicating the object monitors the progress of some operation.

public static final AccessibleRole
PUSH_BUTTON

An object the user can manipulate to tell the application to do something.

public 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.

public static final AccessibleRole
ROOT_PANE

A specialized pane that has a glass pane and a layered pane as its children.

public static final AccessibleRole
ROW_HEADER

The header for a row of data.

public static final AccessibleRole
RULER

A ruler is an object used to measure distance.

public static final AccessibleRole
SCROLL_BAR

An object usually used to allow a user to incrementally view a large amount of data.

public static final AccessibleRole
SCROLL_PANE

An object that allows a user to incrementally view a large amount of information.

public static final AccessibleRole
SEPARATOR

An object usually contained in a menu to provide a visual and logical separation of the contents in a menu.

public static final AccessibleRole
SLIDER

An object that allows the user to select from a bounded range.

public static final AccessibleRole
SPIN_BOX

A SPIN_BOX is a simple spinner component and its main use is for simple numbers.

public static final AccessibleRole
SPLIT_PANE

A specialized panel that presents two other panels at the same time.

public static final AccessibleRole
STATUS_BAR

A STATUS_BAR is an simple component that can contain multiple labels of status information to the user.

public static final AccessibleRole
SWING_COMPONENT

A Swing component, but nothing else is known about it.

public static final AccessibleRole
TABLE

An object used to present information in terms of rows and columns.

public static final AccessibleRole
TEXT

An object that presents text to the user.

public 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.

public static final AccessibleRole
TOOL_BAR

A bar or palette usually composed of push buttons or toggle buttons.

public static final AccessibleRole
TOOL_TIP

An object that provides information about another object.

public static final AccessibleRole
TREE

An object used to present hierarchical information to the user.

public static final AccessibleRole
UNKNOWN

The object contains some Accessible information, but its role is not known.

public static final AccessibleRole
VIEWPORT

An object usually used in a scroll pane.

public static final AccessibleRole
WINDOW

A top level window with no title or border.

Inherited from javax.accessibility.AccessibleBundle:
key

Constructor Summary

AccessConstructor and Description
protected
AccessibleRole(String
the locale independent name of the role
key
)

Creates a new AccessibleRole using the given locale independent key.

Method Summary

Inherited from javax.accessibility.AccessibleBundle:
toDisplayStringtoDisplayStringtoDisplayStringtoString

Field Detail

ALERTback to summary
public static final AccessibleRole ALERT

Object is used to alert the user about something.

AWT_COMPONENTback to summary
public static final AccessibleRole AWT_COMPONENT

An AWT component, but nothing else is known about it.

See Also
SWING_COMPONENT, UNKNOWN
CANVASback to summary
public static final AccessibleRole CANVAS

Object that can be drawn into and is used to trap events.

See Also
FRAME, GLASS_PANE, LAYERED_PANE
CHECK_BOXback to summary
public static final AccessibleRole CHECK_BOX

A choice that can be checked or unchecked and provides a separate indicator for the current state.

See Also
PUSH_BUTTON, TOGGLE_BUTTON, RADIO_BUTTON
COLOR_CHOOSERback to summary
public static final AccessibleRole COLOR_CHOOSER

A specialized pane that lets the user choose a color.

COLUMN_HEADERback to summary
public static final AccessibleRole COLUMN_HEADER

The header for a column of data.

COMBO_BOXback to summary
public static final AccessibleRole COMBO_BOX

A list of choices the user can select from. Also optionally allows the user to enter a choice of their own.

DATE_EDITORback to summary
public static final AccessibleRole DATE_EDITOR

A DATE_EDITOR is a component that allows users to edit java.util.Date and java.util.Time objects.

DESKTOP_ICONback to summary
public static final AccessibleRole DESKTOP_ICON

An iconified internal frame in a DESKTOP_PANE.

See Also
DESKTOP_PANE, INTERNAL_FRAME
DESKTOP_PANEback to summary
public static final AccessibleRole DESKTOP_PANE

A pane that supports internal frames and iconified versions of those internal frames.

See Also
DESKTOP_ICON, INTERNAL_FRAME
DIALOGback to summary
public static final AccessibleRole DIALOG

A top level window with title bar and a border. A dialog is similar to a frame, but it has fewer properties and is often used as a secondary window for an application.

See Also
FRAME, WINDOW
DIRECTORY_PANEback to summary
public static final AccessibleRole DIRECTORY_PANE

A pane that allows the user to navigate through and select the contents of a directory. May be used by a file chooser.

See Also
FILE_CHOOSER
EDITBARback to summary
public static final AccessibleRole EDITBAR

A role indicating the object acts as a formula for calculating a value. An example is a formula in a spreadsheet cell.

Since
1.5
FILE_CHOOSERback to summary
public 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. May use the directory pane to show the contents of a directory.

See Also
DIRECTORY_PANE
FILLERback to summary
public static final AccessibleRole FILLER

An object that fills up space in a user interface. It is often used in interfaces to tweak the spacing between components, but serves no other purpose.

FONT_CHOOSERback to summary
public static final AccessibleRole FONT_CHOOSER

A FONT_CHOOSER is a component that lets the user pick various attributes for fonts.

FRAMEback to summary
public static final AccessibleRole FRAME

A top level window with a title bar, border, menu bar, etc. It is often used as the primary window for an application.

See Also
DIALOG, CANVAS, WINDOW
GLASS_PANEback to summary
public static final AccessibleRole GLASS_PANE

A pane that is guaranteed to be painted on top of all panes beneath it.

See Also
ROOT_PANE, CANVAS
GROUP_BOXback to summary
public static final AccessibleRole GROUP_BOX

A GROUP_BOX is a simple container that contains a border around it and contains components inside it.

HTML_CONTAINERback to summary
public static final AccessibleRole HTML_CONTAINER

An object containing a collection of Accessibles that together represents HTML content. The child Accessibles would include objects implementing AccessibleText, AccessibleHypertext, AccessibleIcon, and other interfaces.

Since
1.6
See Also
HYPERLINK, AccessibleText, AccessibleHypertext, AccessibleHyperlink, AccessibleIcon
ICONback to summary
public static final AccessibleRole ICON

A small fixed size picture, typically used to decorate components.

INTERNAL_FRAMEback to summary
public static final AccessibleRole INTERNAL_FRAME

A frame-like object that is clipped by a desktop pane. The desktop pane, internal frame, and desktop icon objects are often used to create multiple document interfaces within an application.

See Also
DESKTOP_ICON, DESKTOP_PANE, FRAME
LABELback to summary
public static final AccessibleRole LABEL

An object used to present an icon or short string in an interface.

LAYERED_PANEback to summary
public static final AccessibleRole LAYERED_PANE

A specialized pane that allows its children to be drawn in layers, providing a form of stacking order. This is usually the pane that holds the menu bar as well as the pane that contains most of the visual components in a window.

See Also
GLASS_PANE, ROOT_PANE
LISTback to summary
public 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. A list is usually contained within a scroll pane.

See Also
SCROLL_PANE, LIST_ITEM
LIST_ITEMback to summary
public static final AccessibleRole LIST_ITEM

An object that presents an element in a list. A list is usually contained within a scroll pane.

See Also
SCROLL_PANE, LIST
OPTION_PANEback to summary
public static final AccessibleRole OPTION_PANE

A specialized pane whose primary use is inside a DIALOG.

See Also
DIALOG
PAGE_TABback to summary
public static final AccessibleRole PAGE_TAB

An object that is a child of a page tab list. Its sole child is the panel that is to be presented to the user when the user selects the page tab from the list of tabs in the page tab list.

See Also
PAGE_TAB_LIST
PAGE_TAB_LISTback to summary
public 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. The most common mechanism is a list of tabs at the top of the panel. The children of a page tab list are all page tabs.

See Also
PAGE_TAB
PANELback to summary
public static final AccessibleRole PANEL

A generic container that is often used to group objects.

PARAGRAPHback to summary
public static final AccessibleRole PARAGRAPH

A text paragraph.

Since
1.5
PASSWORD_TEXTback to summary
public 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.

PROGRESS_BARback to summary
public static final AccessibleRole PROGRESS_BAR

An object used to indicate how much of a task has been completed.

PROGRESS_MONITORback to summary
public static final AccessibleRole PROGRESS_MONITOR

A role indicating the object monitors the progress of some operation.

Since
1.5
PUSH_BUTTONback to summary
public static final AccessibleRole PUSH_BUTTON

An object the user can manipulate to tell the application to do something.

See Also
CHECK_BOX, TOGGLE_BUTTON, RADIO_BUTTON
RADIO_BUTTONback to summary
public 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.

See Also
PUSH_BUTTON, TOGGLE_BUTTON, CHECK_BOX
ROOT_PANEback to summary
public static final AccessibleRole ROOT_PANE

A specialized pane that has a glass pane and a layered pane as its children.

See Also
GLASS_PANE, LAYERED_PANE
ROW_HEADERback to summary
public static final AccessibleRole ROW_HEADER

The header for a row of data.

RULERback to summary
public static final AccessibleRole RULER

A ruler is an object used to measure distance.

Since
1.5
SCROLL_BARback to summary
public static final AccessibleRole SCROLL_BAR

An object usually used to allow a user to incrementally view a large amount of data. Usually used only by a scroll pane.

See Also
SCROLL_PANE
SCROLL_PANEback to summary
public static final AccessibleRole SCROLL_PANE

An object that allows a user to incrementally view a large amount of information. Its children can include scroll bars and a viewport.

See Also
SCROLL_BAR, VIEWPORT
SEPARATORback to summary
public static final AccessibleRole SEPARATOR

An object usually contained in a menu to provide a visual and logical separation of the contents in a menu. For example, the "File" menu of an application might contain menu items for "Open," "Close," and "Exit," and will place a separator between "Close" and "Exit" menu items.

See Also
MENU, MENU_ITEM
SLIDERback to summary
public static final AccessibleRole SLIDER

An object that allows the user to select from a bounded range. For example, a slider might be used to select a number between 0 and 100.

SPIN_BOXback to summary
public static final AccessibleRole SPIN_BOX

A SPIN_BOX is a simple spinner component and its main use is for simple numbers.

SPLIT_PANEback to summary
public static final AccessibleRole SPLIT_PANE

A specialized panel that presents two other panels at the same time. Between the two panels is a divider the user can manipulate to make one panel larger and the other panel smaller.

STATUS_BARback to summary
public static final AccessibleRole STATUS_BAR

A STATUS_BAR is an simple component that can contain multiple labels of status information to the user.

SWING_COMPONENTback to summary
public static final AccessibleRole SWING_COMPONENT

A Swing component, but nothing else is known about it.

See Also
AWT_COMPONENT, UNKNOWN
TABLEback to summary
public static final AccessibleRole TABLE

An object used to present information in terms of rows and columns. An example might include a spreadsheet application.

TEXTback to summary
public static final AccessibleRole TEXT

An object that presents text to the user. The text is usually editable by the user as opposed to a label.

See Also
LABEL
TOGGLE_BUTTONback to summary
public 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.

See Also
PUSH_BUTTON, CHECK_BOX, RADIO_BUTTON
TOOL_BARback to summary
public static final AccessibleRole TOOL_BAR

A bar or palette usually composed of push buttons or toggle buttons. It is often used to provide the most frequently used functions for an application.

TOOL_TIPback to summary
public static final AccessibleRole TOOL_TIP

An object that provides information about another object. The 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.

TREEback to summary
public static final AccessibleRole TREE

An object used to present hierarchical information to the user. The individual nodes in the tree can be collapsed and expanded to provide selective disclosure of the tree's contents.

UNKNOWNback to summary
public static final AccessibleRole UNKNOWN

The object contains some Accessible information, but its role is not known.

See Also
AWT_COMPONENT, SWING_COMPONENT
VIEWPORTback to summary
public static final AccessibleRole VIEWPORT

An object usually used in a scroll pane. It represents the portion of the entire data that the user can see. As the user manipulates the scroll bars, the contents of the viewport can change.

See Also
SCROLL_PANE
WINDOWback to summary
public static final AccessibleRole WINDOW

A top level window with no title or border.

See Also
FRAME, DIALOG

Constructor Detail

AccessibleRoleback to summary
protected AccessibleRole(String key)

Creates a new 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 toDisplayString().

Parameters
key:String

the locale independent name of the role

See Also
AccessibleBundle#toDisplayString