English:

The Free and Open Productivity Suite
New: Apache OpenOffice 4.1.0 released!

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: accessibility ::

constants group AccessibleRole
Description
Collection of roles.

This collection of constans defines the set of possible roles of classes implementing the XAccessible interface according to the java class javax.accessibility.AccessibleRole. The role of an object describes its generic function like 'button', 'menu', or 'text'. You can obtain an object's role by calling the getAccessibleRole method of the XAccessibleContext interface.

We are using constants instead of a more typesafe enum. The reason for this is that IDL enums may not be extended. Therefore, in order to include future extensions to the set of roles we have to use constants here.

For some roles there exist two labels with the same value. Please use the one with the underscrores. The other ones are somewhat deprecated and will be removed in the future.

Since
OOo 1.1.2
See also
XAccessibleContext

Constants
UNKNOWN Unknown role.  
ALERT Object is used to alert the user about something.  
COLUMN_HEADER The header for a column of data.  
CANVAS Object that can be drawn into and is used to trap events.  
CHECK_BOX Check box role.  
CHECK_MENU_ITEM This role is used for check buttons that are menu items.  
COLOR_CHOOSER A specialized dialog that lets the user choose a color.  
COMBO_BOX Combo box role.  
DATE_EDITOR Date editor role.  
DESKTOP_ICON An iconified internal frame in a DESKTOP_PANE.  
DESKTOP_PANE Desktop pane role.  
DIRECTORY_PANE Directory pane role.  
DIALOG Dialog box role.  
DOCUMENT View of a document.  
EMBEDDED_OBJECT Embeded (OLE) object.  
END_NOTE Text that is used as an endnote (footnote at the end of a chapter or section.  
FILE_CHOOSER File chooser role.  
FILLER Filler role.  
FONT_CHOOSER Font chooser role.  
FOOTER Footer of a document page.  
FOOTNOTE Text that is used as a footnote.  
FRAME Frame role.  
GLASS_PANE Glass pane role.  
GRAPHIC Graphical object.  
GROUP_BOX Group box role.  
HEADER Header of a document page.  
HEADING Chapter or section heading.  
HYPER_LINK A hypertext anchor.  
ICON A small fixed size picture, typically used to decorate components.  
INTERNAL_FRAME Internal frame role.  
LABEL An object used to present an icon or short string in an interface.  
LAYERED_PANE layered pane role.  
LIST List role.  
LIST_ITEM List item role.  
MENU Menu role.  
MENU_BAR Menu bar role.  
MENU_ITEM Menu item role.  
OPTION_PANE A specialized pane whose primary use is inside a DIALOG.  
PAGE_TAB Page tab role.  
PAGE_TAB_LIST Page tab list role.  
PANEL A generic container that is often used to group objects.  
PARAGRAPH Paragraph of text.  
PASSWORD_TEXT Password text role.  
POPUP_MENU Popup menu role.  
PUSH_BUTTON Push button role.  
PROGRESS_BAR An object used to indicate how much of a task has been completed.  
RADIO_BUTTON Radio button role.  
RADIO_MENU_ITEM This role is used for radio buttons that are menu items.  
ROW_HEADER The header for a row of data.  
ROOT_PANE Root pane role.  
SCROLL_BAR Scroll bar role.  
SCROLL_PANE Scroll pane role.  
SHAPE Object with graphical representation used to represent content on draw pages.  
SEPARATOR Separator role.  
SLIDER Slider role.  
SPIN_BOX Spin box role.  
SPLIT_PANE Split pane role.  
STATUS_BAR Status bar role.  
TABLE Table component.  
TABLE_CELL Single cell in a table.  
TEXT Text role.  
TEXT_FRAME Collection of objects that constitute a logical text entity.  
TOGGLE_BUTTON Toggle button role.  
TOOL_BAR Tool bar role.  
TOOL_TIP Tool tip role.  
TREE Tree role.  
VIEW_PORT Viewport role.  
WINDOW A top level window with no title or border.  
BUTTON_DROPDOWN Button dropdown role  
BUTTON_MENU Button menu role  
CAPTION Caption role  
CHART Chart role  
EDIT_BAR Edit bar role  
FORM Form role  
IMAGE_MAP Image map role  
NOTE Note role  
PAGE Page role  
RULER Ruler role  
SECTION Section role  
TREE_ITEM Tree item role  
TREE_TABLE Tree table role  
COMMENT Comment role  
COMMENT_END Comment end role  
Constants' Details
UNKNOWN
const short UNKNOWN = 0;
Description
Unknown role.

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

ALERT
const short ALERT = 1;
Description
Object is used to alert the user about something.
COLUMN_HEADER
const short COLUMN_HEADER = 2;
Description
The header for a column of data.
CANVAS
const short CANVAS = 3;
Description
Object that can be drawn into and is used to trap events.

See alse FRAME, GLASS_PANE, and LAYERED_PANE.

CHECK_BOX
const short CHECK_BOX = 4;
Description
Check box role.

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

See also PUSH_BUTTON, TOGGLE_BUTTON, and RADIO_BUTTON.

CHECK_MENU_ITEM
const short CHECK_MENU_ITEM = 5;
Description
This role is used for check buttons that are menu items.
See also
CHECK_BOX,
MENU_ITEM
COLOR_CHOOSER
const short COLOR_CHOOSER = 6;
Description
A specialized dialog that lets the user choose a color.
COMBO_BOX
const short COMBO_BOX = 7;
Description
Combo box role.

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

DATE_EDITOR
const short DATE_EDITOR = 8;
Description
Date editor role.

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

DESKTOP_ICON
const short DESKTOP_ICON = 9;
Description
An iconified internal frame in a DESKTOP_PANE.

See also DESKTOP_PANE and INTERNAL_FRAME.

DESKTOP_PANE
const short DESKTOP_PANE = 10;
Description
Desktop pane role.

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

DIRECTORY_PANE
const short DIRECTORY_PANE = 11;
Description
Directory pane role.

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.

DIALOG
const short DIALOG = 12;
Description
Dialog box role.

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 and WINDOW.

DOCUMENT
const short DOCUMENT = 13;
Description
View of a document.

The view of an actual document. Its content depends on the documen type.

EMBEDDED_OBJECT
const short EMBEDDED_OBJECT = 14;
Description
Embeded (OLE) object.
END_NOTE
const short END_NOTE = 15;
Description
Text that is used as an endnote (footnote at the end of a chapter or section.
FILE_CHOOSER
const short FILE_CHOOSER = 16;
Description
File chooser role.

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.

FILLER
const short FILLER = 17;
Description
Filler role.

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_CHOOSER
const short FONT_CHOOSER = 18;
Description
Font chooser role.

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

FOOTER
const short FOOTER = 19;
Description
Footer of a document page.
See also
HEADER
FOOTNOTE
const short FOOTNOTE = 20;
Description
Text that is used as a footnote.
FRAME
const short FRAME = 21;
Description
Frame role.

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, and WINDOW.

GLASS_PANE
const short GLASS_PANE = 22;
Description
Glass pane role.

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

See also ROOT_PANE and CANVAS.

GRAPHIC
const short GRAPHIC = 23;
Description
Graphical object.
GROUP_BOX
const short GROUP_BOX = 24;
Description
Group box role.

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

HEADER
const short HEADER = 25;
Description
Header of a document page.
See also
FOOTER
HEADING
const short HEADING = 26;
Description
Chapter or section heading.
HYPER_LINK
const short HYPER_LINK = 27;
Description
A hypertext anchor.
ICON
const short ICON = 28;
Description
A small fixed size picture, typically used to decorate components.
INTERNAL_FRAME
const short INTERNAL_FRAME = 29;
Description
Internal frame role.

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, and FRAME.

LABEL
const short LABEL = 30;
Description
An object used to present an icon or short string in an interface.
LAYERED_PANE
const short LAYERED_PANE = 31;
Description
layered pane role.

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 and ROOT_PANE.

LIST
const short LIST = 32;
Description
List role.

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 and LIST_ITEM.

LIST_ITEM
const short LIST_ITEM = 33;
Description
List item role.

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

See also SCROLL_PANE and LIST.

MENU
const short MENU = 34;
Description
Menu role.

An object usually found inside a menu bar that contains a list of actions the user can choose from. A menu can have any object as its children, but most often they are menu items, other menus, or rudimentary objects such as radio buttons, check boxes, or separators. For example, an application may have an "Edit" menu that contains menu items for "Cut" and "Paste."

See also MENU_BAR, MENU_ITEM, SEPARATOR, RADIO_BUTTON, CHECK_BOX, and POPUP_MENU.

MENU_BAR
const short MENU_BAR = 35;
Description
Menu bar role.

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. For example, a menu bar might contain menus for "File," "Edit," and "Help."

See also MENU, POPUP_MENU, and LAYERED_PANE.

MENU_ITEM
const short MENU_ITEM = 36;
Description
Menu item role.

An object usually contained in a menu that presents an action the user can choose. For example, the "Cut" menu item in an "Edit" menu would be an action the user can select to cut the selected area of text in a document.

See also MENUBAR, SEPARATOR, and POPUP_MENU.

OPTION_PANE
const short OPTION_PANE = 37;
Description
A specialized pane whose primary use is inside a DIALOG.

See also DIALOG.

PAGE_TAB
const short PAGE_TAB = 38;
Description
Page tab role.

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_LIST
const short PAGE_TAB_LIST = 39;
Description
Page tab list role.

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.

PANEL
const short PANEL = 40;
Description
A generic container that is often used to group objects.
PARAGRAPH
const short PARAGRAPH = 41;
Description
Paragraph of text.
PASSWORD_TEXT
const short PASSWORD_TEXT = 42;
Description
Password text role.

A text object used for passwords, or other places where the text contents is not shown visibly to the user.

POPUP_MENU
const short POPUP_MENU = 43;
Description
Popup menu role.

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.

See also MENU and MENU_ITEM.

PUSH_BUTTON
const short PUSH_BUTTON = 44;
Description
Push button role.

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

See also CHECK_BOX, TOGGLE_BUTTON, RADIO_BUTTON, BUTTON_MENU and BUTTON_DROPDOWN.

PROGRESS_BAR
const short PROGRESS_BAR = 45;
Description
An object used to indicate how much of a task has been completed.
RADIO_BUTTON
const short RADIO_BUTTON = 46;
Description
Radio button role.

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, and CHECK_BOX.

RADIO_MENU_ITEM
const short RADIO_MENU_ITEM = 47;
Description
This role is used for radio buttons that are menu items.
See also
RADIO_BUTTON,
MENU_ITEM
ROW_HEADER
const short ROW_HEADER = 48;
Description
The header for a row of data.
ROOT_PANE
const short ROOT_PANE = 49;
Description
Root pane role.

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

See also GLASS_PANE and LAYERED_PANE.

SCROLL_BAR
const short SCROLL_BAR = 50;
Description
Scroll bar role.

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

Ssee also SCROLL_PANE.

SCROLL_PANE
const short SCROLL_PANE = 51;
Description
Scroll pane role.

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 and VIEW_PORT.

SHAPE
const short SHAPE = 52;
Description
Object with graphical representation used to represent content on draw pages.
See also
::com::sun::star::drawing::AccessibleShape
SEPARATOR
const short SEPARATOR = 53;
Description
Separator role.

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 and MENU_ITEM.

SLIDER
const short SLIDER = 54;
Description
Slider role.

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_BOX
const short SPIN_BOX = 55;
Description
Spin box role.

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

SPLIT_PANE
const short SPLIT_PANE = 56;
Description
Split pane role.

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_BAR
const short STATUS_BAR = 57;
Description
Status bar role.

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

TABLE
const short TABLE = 58;
Description
Table component.

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

TABLE_CELL
const short TABLE_CELL = 59;
Description
Single cell in a table.
TEXT
const short TEXT = 60;
Description
Text role.

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

See also LABEL.

TEXT_FRAME
const short TEXT_FRAME = 61;
Description
Collection of objects that constitute a logical text entity.
TOGGLE_BUTTON
const short TOGGLE_BUTTON = 62;
Description
Toggle button role.

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 and RADIO_BUTTON.

TOOL_BAR
const short TOOL_BAR = 63;
Description
Tool bar role.

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_TIP
const short TOOL_TIP = 64;
Description
Tool tip role.

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.

TREE
const short TREE = 65;
Description
Tree role.

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.

VIEW_PORT
const short VIEW_PORT = 66;
Description
Viewport role.

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.

WINDOW
const short WINDOW = 67;
Description
A top level window with no title or border.

See also FRAME and DIALOG.

BUTTON_DROPDOWN
const short BUTTON_DROPDOWN = 68;
Description
Button dropdown role

The object represents a button that drops down a list of items.

See also PUSH_BUTTON and BUTTON_MENU.

Since
OOo 3.0
BUTTON_MENU
const short BUTTON_MENU = 69;
Description
Button menu role

The object represents a button that drops down a menu.

See also PUSH_BUTTON and BUTTON_DROPDOWN.

Since
OOo 3.0
CAPTION
const short CAPTION = 70;
Description
Caption role

The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image.

.
Since
OOo 3.0
CHART
const short CHART = 71;
Description
Chart role

The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented.

Since
OOo 3.0
EDIT_BAR
const short EDIT_BAR = 72;
Description
Edit bar role

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

Since
OOo 3.0
FORM
const short FORM = 73;
Description
Form role

The object is a container for form controls, for instance as part of a web form or user-input form within a document.

Since
OOo 3.0
IMAGE_MAP
const short IMAGE_MAP = 74;
Description
Image map role

Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document.

Since
OOo 3.0
NOTE
const short NOTE = 75;
Description
Note role

An embedded note which is not visible until activated.

Since
OOo 3.0
PAGE
const short PAGE = 76;
Description
Page role

An object representing a page of document content. It is used in documents which are accessed by the user on a page by page basis.

Since
OOo 3.0
RULER
const short RULER = 77;
Description
Ruler role

An object which describes margins and tab stops, etc. for text objects which it controls.

Since
OOo 3.0
SECTION
const short SECTION = 78;
Description
Section role

The object is a containing instance of document content which constitutes a particular 'logical' section of the document.

Since
OOo 3.0
TREE_ITEM
const short TREE_ITEM = 79;
Description
Tree item role

An object that presents an element in a tree

See also TREE and TREE_TABLE.

Since
OOo 3.0
TREE_TABLE
const short TREE_TABLE = 80;
Description
Tree table role

An object which represents both hierarchical and tabular information.

Since
OOo 3.0
COMMENT
const short COMMENT = 81;
Description
Comment role

An object which represents a comment.

A comment is anchored at a certain content position in the document and annotates this document content position or a certain text range of the document content. In the OpenDocument file format a comment is known as an annotation.

See also COMMENT_END.

Since
OOo 3.2
COMMENT_END
const short COMMENT_END = 82;
Description
Comment end role

An invisible object which represents the end position of a text range which is annotated by a comment - see COMMENT.

This object and the corresponding object representing the comment shall be in relation of type MEMBER_OF.

Since
OOo 3.2
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.