AccessibleRole (JavaFX 8)

java.lang.Object
- java.lang.Enum<AccessibleRole>
- - javafx.scene.AccessibleRole

All Implemented Interfaces:

Serializable, Comparable<AccessibleRole>
```
public enum AccessibleRole
extends Enum<AccessibleRole>
```
This enum describes the accessible role for a Node. The role is used by assistive technologies such as screen readers to decide the set of actions and attributes for a node. For example, when the screen reader needs the current value of a slider, it will request it using the value attribute. When the screen reader changes the value of the slider, it will use an action to set the current value of the slider. The slider must respond appropriately to both these requests.

Since:

JavaFX 8u40

See Also:

Node.setAccessibleRole(AccessibleRole), Node.getAccessibleRole(), AccessibleAttribute.ROLE, Node.queryAccessibleAttribute(AccessibleAttribute, Object...), Node.executeAccessibleAction(AccessibleAction, Object...)

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BUTTON` Button role.
`CHECK_BOX` Check Box role.
`CHECK_MENU_ITEM` Check Menu Item role.
`COMBO_BOX` Combo Box role.
`CONTEXT_MENU` Context Menu role.
`DATE_PICKER` Date Picker role.
`DECREMENT_BUTTON` Decrement Button role.
`HYPERLINK` Hyperlink role.
`IMAGE_VIEW` Image View role.
`INCREMENT_BUTTON` Increment Button role.
`LIST_ITEM` List Item role.
`LIST_VIEW` List View role.
`MENU` Menu role.
`MENU_BAR` Menu Bar role.
`MENU_BUTTON` Menu Button role.
`MENU_ITEM` Menu Item role.
`NODE` Node role.
`PAGE_ITEM` Page role.
`PAGINATION` Pagination role.
`PARENT` Parent role.
`PASSWORD_FIELD` Password Field role.
`PROGRESS_INDICATOR` Progress Indicator role.
`RADIO_BUTTON` Radio Button role.
`RADIO_MENU_ITEM` Radio Menu Item role.
`SCROLL_BAR` Scroll Bar role.
`SCROLL_PANE` Scroll Pane role.
`SLIDER` Slider role.
`SPINNER` Spinner role.
`SPLIT_MENU_BUTTON` Split Menu Button role.
`TAB_ITEM` Tab Item role.
`TAB_PANE` Tab Pane role.
`TABLE_CELL` Table Cell role.
`TABLE_COLUMN` Table Column role.
`TABLE_ROW` Table Row role.
`TABLE_VIEW` Table View role.
`TEXT` Text role.
`TEXT_AREA` Text Area role.
`TEXT_FIELD` Text Field role.
`THUMB` Thumb role.
`TITLED_PANE` Titled Pane role.
`TOGGLE_BUTTON` Toggle Button role.
`TOOL_BAR` Tool Bar role.
`TOOLTIP` Tooltip role.
`TREE_ITEM` Tree Item role.
`TREE_TABLE_CELL` Tree Table Cell role.
`TREE_TABLE_ROW` Tree Table Row role.
`TREE_TABLE_VIEW` Tree Table View role.
`TREE_VIEW` Tree View role.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`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
  - BUTTON
```
public static final AccessibleRole BUTTON
```
    Button role.
    Attributes:
    - AccessibleAttribute.TEXT
    Actions:
    - AccessibleAction.FIRE
  - CHECK_BOX
```
public static final AccessibleRole CHECK_BOX
```
    Check Box role.
    Attributes:
    Actions:
    - AccessibleAction.FIRE
  - CHECK_MENU_ITEM
```
public static final AccessibleRole CHECK_MENU_ITEM
```
    Check Menu Item role.
    Attributes:
    Actions:
    - AccessibleAction.FIRE
  - COMBO_BOX
```
public static final AccessibleRole COMBO_BOX
```
    Combo Box role.
    Attributes:
    Actions:
    - AccessibleAction.EXPAND
    - AccessibleAction.COLLAPSE
  - CONTEXT_MENU
```
public static final AccessibleRole CONTEXT_MENU
```
    Context Menu role.
    Attributes:
    - AccessibleAttribute.PARENT_MENU
    - AccessibleAttribute.VISIBLE
    Actions:
  - DATE_PICKER
```
public static final AccessibleRole DATE_PICKER
```
    Date Picker role.
    Attributes:
    - AccessibleAttribute.TEXT
    - AccessibleAttribute.DATE
    Actions:
  - DECREMENT_BUTTON
```
public static final AccessibleRole DECREMENT_BUTTON
```
    Decrement Button role.
    Attributes:
    - AccessibleAttribute.TEXT
    Actions:
    - AccessibleAction.FIRE
  - HYPERLINK
```
public static final AccessibleRole HYPERLINK
```
    Hyperlink role.
    - AccessibleAttribute.TEXT
    - AccessibleAttribute.VISITED
    Actions:
    - AccessibleAction.FIRE
  - INCREMENT_BUTTON
```
public static final AccessibleRole INCREMENT_BUTTON
```
    Increment Button role.
    Attributes:
    - AccessibleAttribute.TEXT
    Actions:
    - AccessibleAction.FIRE
  - IMAGE_VIEW
```
public static final AccessibleRole IMAGE_VIEW
```
    Image View role.
    Attributes:
    Actions:
    It is strongly recommended that a text description of the image be provided for each ImageView. This can be done by setting either Node.accessibleTextProperty() for the ImageView or by using AccessibleAttribute.LABELED_BY.
  - LIST_VIEW
```
public static final AccessibleRole LIST_VIEW
```
    List View role.
    Attributes:
    Actions:
    - AccessibleAction.SHOW_ITEM
    - AccessibleAction.SET_SELECTED_ITEMS
  - LIST_ITEM
```
public static final AccessibleRole LIST_ITEM
```
    List Item role.
    Attributes:
    Actions:
    - AccessibleAction.REQUEST_FOCUS
  - MENU
```
public static final AccessibleRole MENU
```
    Menu role.
    Attributes:
    Actions:
    - AccessibleAction.FIRE
  - MENU_BAR
```
public static final AccessibleRole MENU_BAR
```
    Menu Bar role.
    Attributes:
    Actions:
  - MENU_BUTTON
```
public static final AccessibleRole MENU_BUTTON
```
    Menu Button role.
    Attributes:
    - AccessibleAttribute.TEXT
    Actions:
    - AccessibleAction.FIRE
  - MENU_ITEM
```
public static final AccessibleRole MENU_ITEM
```
    Menu Item role.
    Attributes:
    Actions:
    - AccessibleAction.FIRE
  - NODE
```
public static final AccessibleRole NODE
```
    Node role.
    Attributes:
    Actions:
    - AccessibleAction.REQUEST_FOCUS
    Optional Attributes:
    Optional Actions:
    - AccessibleAction.SHOW_MENU
  - PAGE_ITEM
```
public static final AccessibleRole PAGE_ITEM
```
    Page role.
    Attributes:
    - AccessibleAttribute.TEXT
    - AccessibleAttribute.SELECTED
    Actions:
    - AccessibleAction.REQUEST_FOCUS
  - PAGINATION
```
public static final AccessibleRole PAGINATION
```
    Pagination role.
    Attributes:
    Actions:
  - PARENT
```
public static final AccessibleRole PARENT
```
    Parent role.
    Attributes:
    - AccessibleAttribute.CHILDREN
    Actions:
  - PASSWORD_FIELD
```
public static final AccessibleRole PASSWORD_FIELD
```
    Password Field role.
    Attributes:
    - AccessibleAttribute.TEXT - must return null or empty string
    Actions:
  - PROGRESS_INDICATOR
```
public static final AccessibleRole PROGRESS_INDICATOR
```
    Progress Indicator role.
    Attributes:
    Actions:
  - RADIO_BUTTON
```
public static final AccessibleRole RADIO_BUTTON
```
    Radio Button role.
    Attributes:
    - AccessibleAttribute.TEXT
    - AccessibleAttribute.SELECTED
    Actions:
    - AccessibleAction.FIRE
  - RADIO_MENU_ITEM
```
public static final AccessibleRole RADIO_MENU_ITEM
```
    Radio Menu Item role.
    Attributes:
    Actions:
    - AccessibleAction.FIRE
  - SLIDER
```
public static final AccessibleRole SLIDER
```
    Slider role.
    Attributes:
    Actions:
  - SPINNER
```
public static final AccessibleRole SPINNER
```
    Spinner role.
    Attributes:
    - AccessibleAttribute.TEXT
    Actions:
    - AccessibleAction.INCREMENT
    - AccessibleAction.DECREMENT
  - TEXT
```
public static final AccessibleRole TEXT
```
    Text role.
    Attributes:
    - AccessibleAttribute.TEXT
    - AccessibleAttribute.FONT
    Actions:
    - AccessibleAction.SET_TEXT
  - TEXT_AREA
```
public static final AccessibleRole TEXT_AREA
```
    Text Area role.
    Attributes:
    Actions:
    - AccessibleAction.SET_TEXT
    - AccessibleAction.SET_TEXT_SELECTION
  - TEXT_FIELD
```
public static final AccessibleRole TEXT_FIELD
```
    Text Field role.
    Attributes:
    Actions:
    - AccessibleAction.SET_TEXT
    - AccessibleAction.SET_TEXT_SELECTION
  - TOGGLE_BUTTON
```
public static final AccessibleRole TOGGLE_BUTTON
```
    Toggle Button role.
    Attributes:
    - AccessibleAttribute.TEXT
    - AccessibleAttribute.SELECTED
    Actions:
    - AccessibleAction.FIRE
  - TOOLTIP
```
public static final AccessibleRole TOOLTIP
```
    Tooltip role.
    Attributes:
    Actions:
  - SCROLL_BAR
```
public static final AccessibleRole SCROLL_BAR
```
    Scroll Bar role.
    Attributes:
    Actions:
  - SCROLL_PANE
```
public static final AccessibleRole SCROLL_PANE
```
    Scroll Pane role.
    Attributes:
    Actions:
  - SPLIT_MENU_BUTTON
```
public static final AccessibleRole SPLIT_MENU_BUTTON
```
    Split Menu Button role.
    Attributes:
    - AccessibleAttribute.TEXT
    - AccessibleAttribute.EXPANDED
    Actions:
  - TAB_ITEM
```
public static final AccessibleRole TAB_ITEM
```
    Tab Item role.
    Attributes:
    - AccessibleAttribute.TEXT
    - AccessibleAttribute.SELECTED
    Actions:
    - AccessibleAction.REQUEST_FOCUS
  - TAB_PANE
```
public static final AccessibleRole TAB_PANE
```
    Tab Pane role.
    Attributes:
    Actions:
  - TABLE_CELL
```
public static final AccessibleRole TABLE_CELL
```
    Table Cell role.
    Attributes:
    Actions:
    - AccessibleAction.REQUEST_FOCUS
  - TABLE_COLUMN
```
public static final AccessibleRole TABLE_COLUMN
```
    Table Column role.
    Attributes:
    - AccessibleAttribute.TEXT
    - AccessibleAttribute.INDEX
    Actions:
  - TABLE_ROW
```
public static final AccessibleRole TABLE_ROW
```
    Table Row role.
    Attributes:
    - AccessibleAttribute.TEXT
    - AccessibleAttribute.INDEX
    Actions:
  - TABLE_VIEW
```
public static final AccessibleRole TABLE_VIEW
```
    Table View role.
    Attributes:
    Actions:
    - AccessibleAction.SHOW_ITEM
    - AccessibleAction.SET_SELECTED_ITEMS
  - THUMB
```
public static final AccessibleRole THUMB
```
    Thumb role.
    Attributes:
    - AccessibleAttribute.VALUE
    Actions:
  - TITLED_PANE
```
public static final AccessibleRole TITLED_PANE
```
    Titled Pane role.
    Attributes:
    - AccessibleAttribute.TEXT
    - AccessibleAttribute.EXPANDED
    Actions:
    - AccessibleAction.EXPAND
    - AccessibleAction.COLLAPSE
  - TOOL_BAR
```
public static final AccessibleRole TOOL_BAR
```
    Tool Bar role.
    Attributes:
    - AccessibleAttribute.OVERFLOW_BUTTON
    Actions:
  - TREE_ITEM
```
public static final AccessibleRole TREE_ITEM
```
    Tree Item role.
    Attributes:
    Actions:
  - TREE_TABLE_CELL
```
public static final AccessibleRole TREE_TABLE_CELL
```
    Tree Table Cell role.
    Attributes:
    Actions:
    - AccessibleAction.REQUEST_FOCUS
  - TREE_TABLE_ROW
```
public static final AccessibleRole TREE_TABLE_ROW
```
    Tree Table Row role.
    Attributes:
    Actions:
    - AccessibleAction.EXPAND
    - AccessibleAction.COLLAPSE
  - TREE_TABLE_VIEW
```
public static final AccessibleRole TREE_TABLE_VIEW
```
    Tree Table View role.
    Attributes:
    Actions:
    - AccessibleAction.SHOW_ITEM
    - AccessibleAction.SET_SELECTED_ITEMS
  - TREE_VIEW
```
public static final AccessibleRole TREE_VIEW
```
    Tree View role.
    Attributes:
    Actions:
    - AccessibleAction.SHOW_ITEM
    - AccessibleAction.SET_SELECTED_ITEMS
- 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

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 2008, 2017, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Enum AccessibleRole

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

BUTTON

CHECK_BOX

CHECK_MENU_ITEM

COMBO_BOX

CONTEXT_MENU

DATE_PICKER

DECREMENT_BUTTON

HYPERLINK

INCREMENT_BUTTON

IMAGE_VIEW

LIST_VIEW

LIST_ITEM

MENU

MENU_BAR

MENU_BUTTON

MENU_ITEM

NODE

PAGE_ITEM

PAGINATION

PARENT

PASSWORD_FIELD

PROGRESS_INDICATOR

RADIO_BUTTON

RADIO_MENU_ITEM

SLIDER

SPINNER

TEXT

TEXT_AREA

TEXT_FIELD

TOGGLE_BUTTON

TOOLTIP

SCROLL_BAR

SCROLL_PANE

SPLIT_MENU_BUTTON

TAB_ITEM

TAB_PANE

TABLE_CELL

TABLE_COLUMN

TABLE_ROW

TABLE_VIEW

THUMB

TITLED_PANE

TOOL_BAR

TREE_ITEM

TREE_TABLE_CELL

TREE_TABLE_ROW

TREE_TABLE_VIEW

TREE_VIEW

Method Detail

values

valueOf