com.sap.ui.core.client
Enum AccessibleRole

java.lang.Object
  java.lang.Enum<AccessibleRole>
      com.sap.ui.core.client.AccessibleRole

All Implemented Interfaces:

Serializable, Comparable<AccessibleRole>

public enum AccessibleRole
extends Enum<AccessibleRole>

The enum AccessibleRole is the GWT wrapper for the Phoenix type: com.sap.ui.core.client.AccessibleRole.
Defines the Accessible Roles for ARIA Support. This Enumeration is used with the AccessibleRole control property. For more information, goto "Roles for Accessible Rich Internet Applications (WAI-ARIA Roles)" at the www.w3.org homepage.

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR

Enum Constant Summary

Alert
A message with an alert or error information.

AlertDialog
A separate window with an alert or error information.

Application
A software unit executing a set of tasks for the user.

Banner
Usually defined as the advertisement at the top of a web page.

Button
Allows user-triggered actions.

Checkbox
A control that has three possible values: true, false, mixed.

ColumnHeader
A table cell containing header information for a column.

Combobox
Allows selecting an item from a list, or to enter data directly in the input field.

ContentInfo
Information about the content on the page.

Definition
The content of the associated element represents a definition.

Description
Descriptive content for a page element.

Dialog
A small window that is designed to interrupt the current application processing in order to inform the user and to get some response.

Directory
A list of references to members of a single group.

Document
Content that contains related information, such as a book.

Grid
Contains cells of tabular data arranged in rows and columns, for example in a table.

GridCell
A table cell in a grid where the cells can be active, editable, and selectable.

Group
A section of user interface objects.

Heading
A heading for a section of the page.

Img
A container for a collection of elements that form an image.

Link
An interactive reference to a resource.

List
A container for non-interactive list items Which are the list's children.

Listbox
A widget that allows the user to select one or more items from a list.

ListItem
A single item in a list.

Log
An area where new information is added, or old information disappears.

Main
Defines the main content of a document.

Marquee
Is used to scroll text across the page.

Menu
Offers a list of choices to the user.

Menubar
A container for menu items where each item may activate a submenu.

MenuItem
A child in a menu.

MenuItemCheckbox
A checkable menu item (tri-state).

MenuItemRadio
A menu item which is part of a group of menuitemradio roles.

Navigation
A collection of links suitable for use when navigating the document or related documents.

None
No explicit role is applicable.

Note
The content is parenthetic or ancillary to the main content of the resource.

Option
A selectable item in a list represented by a select.

Presentation
An element whose role is presentational does not need to be mapped to the accessibility API.

ProgressBar
Shows the execution progress in applications providing functions that take a long time.

Radio
An option in single-select list.

RadioGroup
A group of radio controls.

Region
A large section on the web page.

Row
A row of table cells.

RowHeader
A table cell containing header information for a row.

Search
A search section of a web document.

Secondary
A unique section of the document.

SeeAlso
Indicates that the element contains content that is related to the main content of the page.

Separator
A line or bar that separates sections of content.

Slider
A user input where the user selects an input in a given range.

SpinButton
Allows users to select a value from a list of given entries where exactly one value is displayed at runtime, and the other ones can be displayed by scrolling using the arrow up and arrow down key.

Status
A container for processing advisory information.

Tab
A header for a tab panel.

Tablist
A list of tabs which are references to tab panels.

Tabpanel
A container for the resources associated with a tab.

Textbox
Inputs that allow free-form text as their value.

Timer
A numerical counter which indicates an amount of elapsed time from a start point, or of the time remaining until a certain end point.

Toolbar
A collection of commonly used functions represented in compact visual form.

Tooltip
A popup that displays a description for an element when the user passes over or rests on that element.

Tree
A form of a list (tree) having groups (subtrees) inside groups (subtrees), where the sub trees can be collapsed and expanded.

TreeGrid
A grid whose rows are expandable and collapsable in the same manner as the ones of trees.

TreeItem
A tree node

Method Summary

static AccessibleRole	valueOf(String name) Returns the enum constant of this type with the specified name.
static AccessibleRole[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

None

public static final AccessibleRole None

No explicit role is applicable. An AccsessibleName should be specified for the Control.

Alert

public static final AccessibleRole Alert

A message with an alert or error information.

AlertDialog

public static final AccessibleRole AlertDialog

A separate window with an alert or error information.

Application

public static final AccessibleRole Application

A software unit executing a set of tasks for the user.

Banner

public static final AccessibleRole Banner

Usually defined as the advertisement at the top of a web page. The banner content typically contains the site or company logo, or other key advertisements.

Button

public static final AccessibleRole Button

Allows user-triggered actions.

Checkbox

public static final AccessibleRole Checkbox

A control that has three possible values: true, false, mixed.

ColumnHeader

public static final AccessibleRole ColumnHeader

A table cell containing header information for a column.

Combobox

public static final AccessibleRole Combobox

Allows selecting an item from a list, or to enter data directly in the input field.

ContentInfo

public static final AccessibleRole ContentInfo

Information about the content on the page. Examples are footnotes, copyrights, or links to privacy statements.

Definition

public static final AccessibleRole Definition

The content of the associated element represents a definition. If there is a definition element within the content, this one represents the term being defined.

Description

public static final AccessibleRole Description

Descriptive content for a page element.

Dialog

public static final AccessibleRole Dialog

A small window that is designed to interrupt the current application processing in order to inform the user and to get some response.

Directory

public static final AccessibleRole Directory

A list of references to members of a single group.

Document

public static final AccessibleRole Document

Content that contains related information, such as a book.

Grid

public static final AccessibleRole Grid

Contains cells of tabular data arranged in rows and columns, for example in a table.

GridCell

public static final AccessibleRole GridCell

A table cell in a grid where the cells can be active, editable, and selectable. Cells may have functional relationships to controls, for example.

Group

public static final AccessibleRole Group

A section of user interface objects.

Heading

public static final AccessibleRole Heading

A heading for a section of the page.

Img

public static final AccessibleRole Img

A container for a collection of elements that form an image.

Link

public static final AccessibleRole Link

An interactive reference to a resource.

List

public static final AccessibleRole List

A container for non-interactive list items Which are the list's children.

Listbox

public static final AccessibleRole Listbox

A widget that allows the user to select one or more items from a list. The items within the list are static and can contain images.

ListItem

public static final AccessibleRole ListItem

A single item in a list.

Log

public static final AccessibleRole Log

An area where new information is added, or old information disappears. Information types are chat logs, messaging, or error logs, for example. The log contains a sequence: New information is always added to the end of the log.

Main

public static final AccessibleRole Main

Defines the main content of a document.

Marquee

public static final AccessibleRole Marquee

Is used to scroll text across the page.

Menu

public static final AccessibleRole Menu

Offers a list of choices to the user.

Menubar

public static final AccessibleRole Menubar

A container for menu items where each item may activate a submenu.

MenuItem

public static final AccessibleRole MenuItem

A child in a menu.

MenuItemCheckbox

public static final AccessibleRole MenuItemCheckbox

A checkable menu item (tri-state).

MenuItemRadio

public static final AccessibleRole MenuItemRadio

A menu item which is part of a group of menuitemradio roles.

Navigation

public static final AccessibleRole Navigation

A collection of links suitable for use when navigating the document or related documents.

Note

public static final AccessibleRole Note

The content is parenthetic or ancillary to the main content of the resource.

Option

public static final AccessibleRole Option

A selectable item in a list represented by a select.

Presentation

public static final AccessibleRole Presentation

An element whose role is presentational does not need to be mapped to the accessibility API.

ProgressBar

public static final AccessibleRole ProgressBar

Shows the execution progress in applications providing functions that take a long time.

Radio

public static final AccessibleRole Radio

An option in single-select list. Only one radio control in a radiogroup can be selected at the same time.

RadioGroup

public static final AccessibleRole RadioGroup

A group of radio controls.

Region

public static final AccessibleRole Region

A large section on the web page.

Row

public static final AccessibleRole Row

A row of table cells.

RowHeader

public static final AccessibleRole RowHeader

A table cell containing header information for a row.

Search

public static final AccessibleRole Search

A search section of a web document. In many cases, this is a form used to submit search requests about the site, or a more general Internet wide search service.

Secondary

public static final AccessibleRole Secondary

A unique section of the document. In the case of a portal, this may include time display, weather forecast, or stock price.

SeeAlso

public static final AccessibleRole SeeAlso

Indicates that the element contains content that is related to the main content of the page.

Separator

public static final AccessibleRole Separator

A line or bar that separates sections of content.

Slider

public static final AccessibleRole Slider

A user input where the user selects an input in a given range. This form of range expects an analogous keyboard interface.

SpinButton

public static final AccessibleRole SpinButton

Allows users to select a value from a list of given entries where exactly one value is displayed at runtime, and the other ones can be displayed by scrolling using the arrow up and arrow down key.

Status

public static final AccessibleRole Status

A container for processing advisory information.

Tab

public static final AccessibleRole Tab

A header for a tab panel.

Tablist

public static final AccessibleRole Tablist

A list of tabs which are references to tab panels.

Tabpanel

public static final AccessibleRole Tabpanel

A container for the resources associated with a tab.

Textbox

public static final AccessibleRole Textbox

Inputs that allow free-form text as their value.

Timer

public static final AccessibleRole Timer

A numerical counter which indicates an amount of elapsed time from a start point, or of the time remaining until a certain end point.

Toolbar

public static final AccessibleRole Toolbar

A collection of commonly used functions represented in compact visual form.

Tooltip

public static final AccessibleRole Tooltip

A popup that displays a description for an element when the user passes over or rests on that element. Supplement to the normal tooltip processing of the user agent.

Tree

public static final AccessibleRole Tree

A form of a list (tree) having groups (subtrees) inside groups (subtrees), where the sub trees can be collapsed and expanded.

TreeGrid

public static final AccessibleRole TreeGrid

A grid whose rows are expandable and collapsable in the same manner as the ones of trees.

TreeItem

public static final AccessibleRole TreeItem

A tree node

Method Detail

values

public static AccessibleRole[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AccessibleRole c : AccessibleRole.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AccessibleRole valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null