javax.accessibility

Class AccessibleRole

public class AccessibleRole extends AccessibleBundle

The role of an accessible object. For example, this could be "button" or "table". This strongly typed "enumeration" supports localized strings. If the constants of this class are not adequate, new ones may be added in a similar matter, while avoiding a public constructor.

Since: 1.2

UNKNOWN: updated to 1.4

Field Summary
static AccessibleRoleALERT
The object alerts the user about something.
static AccessibleRoleAWT_COMPONENT
An AWT component with nothing else known about it.
static AccessibleRoleCANVAS
The object can be drawn into, and traps events.
static AccessibleRoleCHECK_BOX
A choice which can be on or off, and has a separate indicator.
static AccessibleRoleCOLOR_CHOOSER
A specialized dialog for choosing a color.
static AccessibleRoleCOLUMN_HEADER
The header for a column of data.
static AccessibleRoleCOMBO_BOX
A list of choices, which may optionally allow the user to create a new choice.
static AccessibleRoleDATE_EDITOR
A component which allows editing of Date and Time objects.
static AccessibleRoleDESKTOP_ICON
An iconified frame in a desktop.
static AccessibleRoleDESKTOP_PANE
A pane which supports internal frames and their icons.
static AccessibleRoleDIALOG
A top level window title bar and border.
static AccessibleRoleDIRECTORY_PANE
A pane for navigating through directories.
static AccessibleRoleEDITBAR
A formula for creating a value.
static AccessibleRoleFILE_CHOOSER
A specialized dialog that allows a user to select a file.
static AccessibleRoleFILLER
An object to fill space between other components.
static AccessibleRoleFONT_CHOOSER
A component for choosing fonts and their attributes.
static AccessibleRoleFOOTER
A text-based footer.
static AccessibleRoleFRAME
A top level window with title, menu bar, border, and so forth.
static AccessibleRoleGLASS_PANE
A pane guaranteed to be painted on top of panes beneath it.
static AccessibleRoleGROUP_BOX
A component with a border to group other components.
static AccessibleRoleHEADER
A text-based header.
static AccessibleRoleHYPERLINK
A hypertext anchor.
static AccessibleRoleICON
A small picture to decorate components.
static AccessibleRoleINTERNAL_FRAME
A frame-like object clipped by a desktop pane.
static AccessibleRoleLABEL
An object to label something in a graphic interface.
static AccessibleRoleLAYERED_PANE
A specialized pane that allows drawing children in layers.
static AccessibleRoleLIST
An object which presents a list of items for selection.
static AccessibleRoleLIST_ITEM
An object which represents an item in a list.
static AccessibleRoleMENU
An object usually in a menu bar which contains a list of actions to perform.
static AccessibleRoleMENU_BAR
An object usually at the top of a frame to list available menus.
static AccessibleRoleMENU_ITEM
An object usually in a menu with an action available for the user.
static AccessibleRoleOPTION_PANE
A specialized pane for use in a dialog.
static AccessibleRolePAGE_TAB
An object in a page tab list, which contains the panel to display when selected from the list.
static AccessibleRolePAGE_TAB_LIST
An object which presents a series of panels, usually via tabs along the top.
static AccessibleRolePANEL
A generic container to group objects.
static AccessibleRolePARAGRAPH
A text-based paragraph.
static AccessibleRolePASSWORD_TEXT
An object for passwords which should not be shown to the user.
static AccessibleRolePOPUP_MENU
A temporary window with a menu of options, which hides on selection.
static AccessibleRolePROGRESS_BAR
An object used to track amount of a task that has completed.
static AccessibleRolePROGRESS_MONITOR
Represents the current level of progress on a particular task.
static AccessibleRolePUSH_BUTTON
An object that can be manipulated to do something.
static AccessibleRoleRADIO_BUTTON
A specialized choice which toggles radio buttons in the group when it is selected.
static AccessibleRoleROOT_PANE
A specialized pane with a glass pane and layered pane as children.
static AccessibleRoleROW_HEADER
The header for a row of data.
static AccessibleRoleRULER
A ruler is a method of measuring the distance between two points.
static AccessibleRoleSCROLL_BAR
An object which allows selection of the view in a scroll pane.
static AccessibleRoleSCROLL_PANE
An object which allows an incremental view of a larger pane.
static AccessibleRoleSEPARATOR
An object usually in a menu which separates logical sections of items.
static AccessibleRoleSLIDER
An object which allows selection in a bounded range.
static AccessibleRoleSPIN_BOX
A component with spinner arrows for simple numbers.
static AccessibleRoleSPLIT_PANE
A specialized pane which presents two other panels, and can often adjust the divider between them.
static AccessibleRoleSTATUS_BAR
A component with multiple labels of status information.
static AccessibleRoleSWING_COMPONENT
A swing component with nothing else known about it.
static AccessibleRoleTABLE
An object for presenting data in rows and columns.
static AccessibleRoleTEXT
An object which represents text, usually editable by the user.
static AccessibleRoleTOGGLE_BUTTON
A specialized button which can be on or off, with no separate indicator.
static AccessibleRoleTOOL_BAR
A bar or pallete with buttons for common actions in an application.
static AccessibleRoleTOOL_TIP
An object which provides information about another object.
static AccessibleRoleTREE
An object which represents a hierachical view of data.
static AccessibleRoleUNKNOWN
An accessible object whose role is unknown.
static AccessibleRoleVIEWPORT
An object which represents the visual section in a scroll pane.
static AccessibleRoleWINDOW
A top level window with no title or border.
Constructor Summary
protected AccessibleRole(String key)
Create a new constant with a locale independent key.

Field Detail

ALERT

public static final AccessibleRole ALERT
The object alerts the user about something.

AWT_COMPONENT

public static final AccessibleRole AWT_COMPONENT
An AWT component with nothing else known about it.

See Also: SWING_COMPONENT UNKNOWN

CANVAS

public static final AccessibleRole CANVAS
The object can be drawn into, and traps events.

See Also: FRAME GLASS_PANE LAYERED_PANE

CHECK_BOX

public static final AccessibleRole CHECK_BOX
A choice which can be on or off, and has a separate indicator.

See Also: PUSH_BUTTON TOGGLE_BUTTON RADIO_BUTTON

COLOR_CHOOSER

public static final AccessibleRole COLOR_CHOOSER
A specialized dialog for choosing a color.

COLUMN_HEADER

public static final AccessibleRole COLUMN_HEADER
The header for a column of data.

COMBO_BOX

public static final AccessibleRole COMBO_BOX
A list of choices, which may optionally allow the user to create a new choice.

DATE_EDITOR

public static final AccessibleRole DATE_EDITOR
A component which allows editing of Date and Time objects.

DESKTOP_ICON

public static final AccessibleRole DESKTOP_ICON
An iconified frame in a desktop.

See Also: DESKTOP_PANE INTERNAL_FRAME

DESKTOP_PANE

public static final AccessibleRole DESKTOP_PANE
A pane which supports internal frames and their icons.

See Also: DESKTOP_ICON INTERNAL_FRAME

DIALOG

public static final AccessibleRole DIALOG
A top level window title bar and border. It is limited compared to a frame, and is often a secondary window.

See Also: FRAME WINDOW

DIRECTORY_PANE

public static final AccessibleRole DIRECTORY_PANE
A pane for navigating through directories.

See Also: FILE_CHOOSER

EDITBAR

public static final AccessibleRole EDITBAR
A formula for creating a value.

Since: 1.5

FILE_CHOOSER

public static final AccessibleRole FILE_CHOOSER
A specialized dialog that allows a user to select a file.

See Also: DIRECTORY_PANE

FILLER

public static final AccessibleRole FILLER
An object to fill space between other components.

FONT_CHOOSER

public static final AccessibleRole FONT_CHOOSER
A component for choosing fonts and their attributes.

FOOTER

public static final AccessibleRole FOOTER
A text-based footer.

Since: 1.5

FRAME

public static final AccessibleRole FRAME
A top level window with title, menu bar, border, and so forth. It is often the primary window of an application.

See Also: DIALOG CANVAS WINDOW

GLASS_PANE

public static final AccessibleRole GLASS_PANE
A pane guaranteed to be painted on top of panes beneath it.

See Also: ROOT_PANE LAYERED_PANE

GROUP_BOX

public static final AccessibleRole GROUP_BOX
A component with a border to group other components.

HEADER

public static final AccessibleRole HEADER
A text-based header.

Since: 1.5

HYPERLINK

public static final AccessibleRole HYPERLINK
A hypertext anchor.

ICON

public static final AccessibleRole ICON
A small picture to decorate components.

INTERNAL_FRAME

public static final AccessibleRole INTERNAL_FRAME
A frame-like object clipped by a desktop pane.

See Also: DESKTOP_ICON DESKTOP_PANE FRAME

LABEL

public static final AccessibleRole LABEL
An object to label something in a graphic interface.

LAYERED_PANE

public static final AccessibleRole LAYERED_PANE
A specialized pane that allows drawing children in layers. This is often used in menus and other visual components.

See Also: ROOT_PANE GLASS_PANE

LIST

public static final AccessibleRole LIST
An object which presents a list of items for selection. Often contained in a scroll pane.

See Also: SCROLL_PANE LIST_ITEM

LIST_ITEM

public static final AccessibleRole LIST_ITEM
An object which represents an item in a list. Often contained in a scroll pane.

See Also: SCROLL_PANE LIST

MENU

public static final AccessibleRole MENU
An object usually in a menu bar which contains a list of actions to perform. Such actions are usually associated with menu items or submenus.

See Also: MENU_BAR MENU_ITEM SEPARATOR RADIO_BUTTON CHECK_BOX POPUP_MENU

MENU_BAR

public static final AccessibleRole MENU_BAR
An object usually at the top of a frame to list available menus.

See Also: MENU POPUP_MENU LAYERED_PANE

MENU_ITEM

public static final AccessibleRole MENU_ITEM
An object usually in a menu with an action available for the user.

See Also: MENU_BAR SEPARATOR POPUP_MENU

OPTION_PANE

public static final AccessibleRole OPTION_PANE
A specialized pane for use in a dialog.

See Also: DIALOG

PAGE_TAB

public static final AccessibleRole PAGE_TAB
An object in a page tab list, which contains the panel to display when selected from the list.

See Also: PAGE_TAB_LIST

PAGE_TAB_LIST

public static final AccessibleRole PAGE_TAB_LIST
An object which presents a series of panels, usually via tabs along the top. Children are all page tabs.

See Also: PAGE_TAB

PANEL

public static final AccessibleRole PANEL
A generic container to group objects.

PARAGRAPH

public static final AccessibleRole PARAGRAPH
A text-based paragraph.

Since: 1.5

PASSWORD_TEXT

public static final AccessibleRole PASSWORD_TEXT
An object for passwords which should not be shown to the user.

POPUP_MENU

public static final AccessibleRole POPUP_MENU
A temporary window with a menu of options, which hides on selection.

See Also: MENU MENU_ITEM

PROGRESS_BAR

public static final AccessibleRole PROGRESS_BAR
An object used to track amount of a task that has completed.

PROGRESS_MONITOR

public static final AccessibleRole PROGRESS_MONITOR
Represents the current level of progress on a particular task.

Since: 1.5

PUSH_BUTTON

public static final AccessibleRole PUSH_BUTTON
An object that can be manipulated to do something.

See Also: CHECK_BOX TOGGLE_BUTTON RADIO_BUTTON

RADIO_BUTTON

public static final AccessibleRole RADIO_BUTTON
A specialized choice which toggles radio buttons in the group when it is selected.

See Also: PUSH_BUTTON TOGGLE_BUTTON CHECK_BOX

ROOT_PANE

public static final AccessibleRole ROOT_PANE
A specialized pane with a glass pane and layered pane as children.

See Also: GLASS_PANE LAYERED_PANE

ROW_HEADER

public static final AccessibleRole ROW_HEADER
The header for a row of data.

RULER

public static final AccessibleRole RULER
A ruler is a method of measuring the distance between two points.

Since: 1.5

SCROLL_BAR

public static final AccessibleRole SCROLL_BAR
An object which allows selection of the view in a scroll pane.

See Also: SCROLL_PANE

SCROLL_PANE

public static final AccessibleRole SCROLL_PANE
An object which allows an incremental view of a larger pane.

See Also: SCROLL_BAR VIEWPORT

SEPARATOR

public static final AccessibleRole SEPARATOR
An object usually in a menu which separates logical sections of items.

See Also: MENU MENU_ITEM

SLIDER

public static final AccessibleRole SLIDER
An object which allows selection in a bounded range.

SPIN_BOX

public static final AccessibleRole SPIN_BOX
A component with spinner arrows for simple numbers.

SPLIT_PANE

public static final AccessibleRole SPLIT_PANE
A specialized pane which presents two other panels, and can often adjust the divider between them.

STATUS_BAR

public static final AccessibleRole STATUS_BAR
A component with multiple labels of status information.

SWING_COMPONENT

public static final AccessibleRole SWING_COMPONENT
A swing component with nothing else known about it.

See Also: AWT_COMPONENT UNKNOWN

TABLE

public static final AccessibleRole TABLE
An object for presenting data in rows and columns.

TEXT

public static final AccessibleRole TEXT
An object which represents text, usually editable by the user.

See Also: LABEL

TOGGLE_BUTTON

public static final AccessibleRole TOGGLE_BUTTON
A specialized button which can be on or off, with no separate indicator.

See Also: PUSH_BUTTON CHECK_BOX RADIO_BUTTON

TOOL_BAR

public static final AccessibleRole TOOL_BAR
A bar or pallete with buttons for common actions in an application.

TOOL_TIP

public static final AccessibleRole TOOL_TIP
An object which provides information about another object. This is often displayed as a "help bubble" when a mouse hovers over the other object.

TREE

public static final AccessibleRole TREE
An object which represents a hierachical view of data. Subnodes can often be expanded or collapsed.

UNKNOWN

public static final AccessibleRole UNKNOWN
An accessible object whose role is unknown.

See Also: AWT_COMPONENT SWING_COMPONENT

VIEWPORT

public static final AccessibleRole VIEWPORT
An object which represents the visual section in a scroll pane.

See Also: SCROLL_PANE

WINDOW

public static final AccessibleRole WINDOW
A top level window with no title or border.

See Also: FRAME DIALOG

Constructor Detail

AccessibleRole

protected AccessibleRole(String key)
Create a new constant with a locale independent key. Follow the example, keep the constructor private and make public constants instead.

Parameters: key the name of the role

See Also: AccessibleRole