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

Field Summary

static AccessibleRole
ALERT
The object alerts the user about something.
static AccessibleRole
AWT_COMPONENT
An AWT component with nothing else known about it.
static AccessibleRole
CANVAS
The object can be drawn into, and traps events.
static AccessibleRole
CHECK_BOX
A choice which can be on or off, and has a separate indicator.
static AccessibleRole
COLOR_CHOOSER
A specialized dialog for choosing a color.
static AccessibleRole
COLUMN_HEADER
The header for a column of data.
static AccessibleRole
COMBO_BOX
A list of choices, which may optionally allow the user to create a new choice.
static AccessibleRole
DATE_EDITOR
A component which allows editing of Date and Time objects.
static AccessibleRole
DESKTOP_ICON
An iconified frame in a desktop.
static AccessibleRole
DESKTOP_PANE
A pane which supports internal frames and their icons.
static AccessibleRole
DIALOG
A top level window title bar and border.
static AccessibleRole
DIRECTORY_PANE
A pane for navigating through directories.
static AccessibleRole
EDITBAR
A formula for creating a value.
static AccessibleRole
FILE_CHOOSER
A specialized dialog that allows a user to select a file.
static AccessibleRole
FILLER
An object to fill space between other components.
static AccessibleRole
FONT_CHOOSER
A component for choosing fonts and their attributes.
static AccessibleRole
FOOTER
A text-based footer.
static AccessibleRole
FRAME
A top level window with title, menu bar, border, and so forth.
static AccessibleRole
GLASS_PANE
A pane guaranteed to be painted on top of panes beneath it.
static AccessibleRole
GROUP_BOX
A component with a border to group other components.
static AccessibleRole
HEADER
A text-based header.
static AccessibleRole
HTML_CONTAINER
A HTML container is an accessible object which contains other accessible objects that together form some HTML content.
static AccessibleRole
HYPERLINK
A hypertext anchor.
static AccessibleRole
ICON
A small picture to decorate components.
static AccessibleRole
INTERNAL_FRAME
A frame-like object clipped by a desktop pane.
static AccessibleRole
LABEL
An object to label something in a graphic interface.
static AccessibleRole
LAYERED_PANE
A specialized pane that allows drawing children in layers.
static AccessibleRole
LIST
An object which presents a list of items for selection.
static AccessibleRole
LIST_ITEM
An object which represents an item in a list.
static AccessibleRole
MENU
An object usually in a menu bar which contains a list of actions to perform.
static AccessibleRole
MENU_BAR
An object usually at the top of a frame to list available menus.
static AccessibleRole
MENU_ITEM
An object usually in a menu with an action available for the user.
static AccessibleRole
OPTION_PANE
A specialized pane for use in a dialog.
static AccessibleRole
PAGE_TAB
An object in a page tab list, which contains the panel to display when selected from the list.
static AccessibleRole
PAGE_TAB_LIST
An object which presents a series of panels, usually via tabs along the top.
static AccessibleRole
PANEL
A generic container to group objects.
static AccessibleRole
PARAGRAPH
A text-based paragraph.
static AccessibleRole
PASSWORD_TEXT
An object for passwords which should not be shown to the user.
static AccessibleRole
POPUP_MENU
A temporary window with a menu of options, which hides on selection.
static AccessibleRole
PROGRESS_BAR
An object used to track amount of a task that has completed.
static AccessibleRole
PROGRESS_MONITOR
Represents the current level of progress on a particular task.
static AccessibleRole
PUSH_BUTTON
An object that can be manipulated to do something.
static AccessibleRole
RADIO_BUTTON
A specialized choice which toggles radio buttons in the group when it is selected.
static AccessibleRole
ROOT_PANE
A specialized pane with a glass pane and layered pane as children.
static AccessibleRole
ROW_HEADER
The header for a row of data.
static AccessibleRole
RULER
A ruler is a method of measuring the distance between two points.
static AccessibleRole
SCROLL_BAR
An object which allows selection of the view in a scroll pane.
static AccessibleRole
SCROLL_PANE
An object which allows an incremental view of a larger pane.
static AccessibleRole
SEPARATOR
An object usually in a menu which separates logical sections of items.
static AccessibleRole
SLIDER
An object which allows selection in a bounded range.
static AccessibleRole
SPIN_BOX
A component with spinner arrows for simple numbers.
static AccessibleRole
SPLIT_PANE
A specialized pane which presents two other panels, and can often adjust the divider between them.
static AccessibleRole
STATUS_BAR
A component with multiple labels of status information.
static AccessibleRole
SWING_COMPONENT
A swing component with nothing else known about it.
static AccessibleRole
TABLE
An object for presenting data in rows and columns.
static AccessibleRole
TEXT
An object which represents text, usually editable by the user.
static AccessibleRole
TOGGLE_BUTTON
A specialized button which can be on or off, with no separate indicator.
static AccessibleRole
TOOL_BAR
A bar or pallete with buttons for common actions in an application.
static AccessibleRole
TOOL_TIP
An object which provides information about another object.
static AccessibleRole
TREE
An object which represents a hierachical view of data.
static AccessibleRole
UNKNOWN
An accessible object whose role is unknown.
static AccessibleRole
VIEWPORT
An object which represents the visual section in a scroll pane.
static AccessibleRole
WINDOW
A top level window with no title or border.

Fields inherited from class javax.accessibility.AccessibleBundle

key

Constructor Summary

AccessibleRole(String key)
Create a new constant with a locale independent key.

Method Summary

Methods inherited from class javax.accessibility.AccessibleBundle

toDisplayString, toDisplayString, toDisplayString, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

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.

CANVAS

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

CHECK_BOX

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

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.

DESKTOP_PANE

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

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.

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.

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

HTML_CONTAINER

public static final AccessibleRole HTML_CONTAINER
A HTML container is an accessible object which contains other accessible objects that together form some HTML content. For example, the content may be a sequence of text containing a link, which would be represent as two children, one an AccessibleText object holding the normal text and the other an AccessibleHypertext object representing the link.
Since:
1.6

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.

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.

LIST

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

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.

MENU_BAR

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

MENU_ITEM

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

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.

RADIO_BUTTON

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

ROOT_PANE

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

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.

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.

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.

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.

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 Details

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

AccessibleRole.java -- the primary role of an accessible object Copyright (C) 2002, 2005 Free Software Foundation This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.