scalafx/scalafx.scene/AccessibleRole

AccessibleRole

object AccessibleRole extends SFXEnumDelegateCompanion[AccessibleRole, AccessibleRole]

This enum describes the accessible role for a Node.

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.

Wraps http://docs.oracle.com/javase/8/javafx/api/javafx/scene/AccessibleRole.html

Companion
class
trait Sum
trait Mirror
class Object
trait Matchable
class Any

Type members

Classlikes

case object Button extends AccessibleRole

Button role.

Button role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

Actions:

  • [[AccessibleAction#FIRE]]
case object CheckBox extends AccessibleRole

Check Box role.

Check Box role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#SELECTED]]

  • [[AccessibleAttribute#INDETERMINATE]]

Actions:

  • [[AccessibleAction#FIRE]]
case object CheckMenuItem extends AccessibleRole

Check Menu Item role.

Check Menu Item role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#ACCELERATOR]]

  • [[AccessibleAttribute#MNEMONIC]]

  • [[AccessibleAttribute#DISABLED]]

  • [[AccessibleAttribute#SELECTED]]

Actions:

  • [[AccessibleAction#FIRE]]
case object ComboBox extends AccessibleRole

Combo Box role.

Combo Box role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#EXPANDED]]

  • [[AccessibleAttribute#EDITABLE]]

Actions:

  • [[AccessibleAction#EXPAND]]

  • [[AccessibleAction#COLLAPSE]]

case object ContextMenu extends AccessibleRole

Context Menu role.

Context Menu role.

Attributes:

  • [[AccessibleAttribute#PARENT_MENU]]

  • [[AccessibleAttribute#VISIBLE]]

Actions:

case object DatePicker extends AccessibleRole

Date Picker role.

Date Picker role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#DATE]]

Actions:

case object DecrementButton extends AccessibleRole

Decrement Button role.

Decrement Button role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

Actions:

  • [[AccessibleAction#FIRE]]
case object Hyperlink extends AccessibleRole

Hyperlink role.

Hyperlink role.

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#VISITED]]

Actions:

  • [[AccessibleAction#FIRE]]
case object ImageView extends AccessibleRole

Image View role.

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]].

case object IncrementButton extends AccessibleRole

Increment Button role.

Increment Button role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

Actions:

  • [[AccessibleAction#FIRE]]
case object ListItem extends AccessibleRole

List Item role.

List Item role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#INDEX]]

  • [[AccessibleAttribute#SELECTED]]

Actions:

  • [[AccessibleAction#REQUEST_FOCUS]]
case object ListView extends AccessibleRole

List View role.

List View role.

Attributes:

  • [[AccessibleAttribute#ITEM_AT_INDEX]]

  • [[AccessibleAttribute#ITEM_COUNT]]

  • [[AccessibleAttribute#SELECTED_ITEMS]]

  • [[AccessibleAttribute#MULTIPLE_SELECTION]]

  • [[AccessibleAttribute#VERTICAL_SCROLLBAR]]

  • [[AccessibleAttribute#HORIZONTAL_SCROLLBAR]]

  • [[AccessibleAttribute#FOCUS_ITEM]]

Actions:

  • [[AccessibleAction#SHOW_ITEM]]

  • [[AccessibleAction#SET_SELECTED_ITEMS]]

case object Menu extends AccessibleRole

Menu role.

Menu role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#ACCELERATOR]]

  • [[AccessibleAttribute#MNEMONIC]]

  • [[AccessibleAttribute#DISABLED]]

  • [[AccessibleAttribute#SUBMENU]]

Actions:

  • [[AccessibleAction#FIRE]]
case object MenuBar extends AccessibleRole

Menu Bar role.

Menu Bar role.

Attributes:

Actions:

case object MenuButton extends AccessibleRole

Menu Button role.

Menu Button role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

Actions:

  • [[AccessibleAction#FIRE]]
case object MenuItem extends AccessibleRole

Menu Item role.

Menu Item role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#ACCELERATOR]]

  • [[AccessibleAttribute#MNEMONIC]]

  • [[AccessibleAttribute#DISABLED]]

Actions:

  • [[AccessibleAction#FIRE]]
case object Node extends AccessibleRole

Node role.

Node role.

Attributes:

  • [[AccessibleAttribute#ROLE]]

  • [[AccessibleAttribute#PARENT]]

  • [[AccessibleAttribute#SCENE]]

  • [[AccessibleAttribute#BOUNDS]]

  • [[AccessibleAttribute#DISABLED]]

  • [[AccessibleAttribute#FOCUSED]]

  • [[AccessibleAttribute#VISIBLE]]

Actions:

  • [[AccessibleAction#REQUEST_FOCUS]]

Optional Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#LABELED_BY]]

  • [[AccessibleAttribute#ROLE_DESCRIPTION]]

  • [[AccessibleAttribute#HELP]]

Optional Actions:

  • [[AccessibleAction#SHOW_MENU]]
case object PageItem extends AccessibleRole

Page role.

Page role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#SELECTED]]

Actions:

  • [[AccessibleAction#REQUEST_FOCUS]]
case object Pagination extends AccessibleRole

Pagination role.

Pagination role.

Attributes:

  • [[AccessibleAttribute#ITEM_AT_INDEX]]

  • [[AccessibleAttribute#ITEM_COUNT]]

  • [[AccessibleAttribute#FOCUS_ITEM]]

Actions:

case object Parent extends AccessibleRole

Parent role.

Parent role.

Attributes:

  • [[AccessibleAttribute#CHILDREN]]

Actions:

case object PasswordField extends AccessibleRole

Password Field role.

Password Field role.

Attributes:

  • [[AccessibleAttribute#TEXT]] - must return null or empty string

Actions:

case object ProgressIndicator extends AccessibleRole

Progress Indicator role.

Progress Indicator role.

Attributes:

  • [[AccessibleAttribute#VALUE]]

  • [[AccessibleAttribute#MIN_VALUE]]

  • [[AccessibleAttribute#MAX_VALUE]]

  • [[AccessibleAttribute#INDETERMINATE]]

Actions:

case object RadioButton extends AccessibleRole

Radio Button role.

Radio Button role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#SELECTED]]

Actions:

  • [[AccessibleAction#FIRE]]
case object RadioMenuItem extends AccessibleRole

Radio Menu Item role.

Radio Menu Item role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#ACCELERATOR]]

  • [[AccessibleAttribute#MNEMONIC]]

  • [[AccessibleAttribute#DISABLED]]

  • [[AccessibleAttribute#SELECTED]]

Actions:

  • [[AccessibleAction#FIRE]]
case object ScrollBar extends AccessibleRole

Scroll Bar role.

Scroll Bar role.

Attributes:

  • [[AccessibleAttribute#VALUE]]

  • [[AccessibleAttribute#MAX_VALUE]]

  • [[AccessibleAttribute#MIN_VALUE]]

  • [[AccessibleAttribute#ORIENTATION]]

Actions:

  • [[AccessibleAction#INCREMENT]]

  • [[AccessibleAction#DECREMENT]]

  • [[AccessibleAction#BLOCK_INCREMENT]]

  • [[AccessibleAction#BLOCK_DECREMENT]]

  • [[AccessibleAction#SET_VALUE]]

case object ScrollPane extends AccessibleRole

Scroll Pane role.

Scroll Pane role.

Attributes:

  • [[AccessibleAttribute#CONTENTS]]

  • [[AccessibleAttribute#HORIZONTAL_SCROLLBAR]]

  • [[AccessibleAttribute#VERTICAL_SCROLLBAR]]

Actions:

case object Slider extends AccessibleRole

Slider role.

Slider role.

Attributes:

  • [[AccessibleAttribute#VALUE]]

  • [[AccessibleAttribute#MIN_VALUE]]

  • [[AccessibleAttribute#MAX_VALUE]]

  • [[AccessibleAttribute#ORIENTATION]]

Actions:

  • [[AccessibleAction#INCREMENT]]

  • [[AccessibleAction#DECREMENT]]

  • [[AccessibleAction#SET_VALUE]]

case object Spinner extends AccessibleRole

Spinner role.

Spinner role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

Actions:

  • [[AccessibleAction#INCREMENT]]

  • [[AccessibleAction#DECREMENT]]

case object SplitMenuButton extends AccessibleRole

Split Menu Button role.

Split Menu Button role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#EXPANDED]]

Actions:

  • [[AccessibleAction#FIRE]]

  • [[AccessibleAction#EXPAND]]

  • [[AccessibleAction#COLLAPSE]]

case object TabItem extends AccessibleRole

Tab Item role.

Tab Item role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#SELECTED]]

Actions:

  • [[AccessibleAction#REQUEST_FOCUS]]
case object TabPane extends AccessibleRole

Tab Pane role.

Tab Pane role.

Attributes:

  • [[AccessibleAttribute#ITEM_AT_INDEX]]

  • [[AccessibleAttribute#ITEM_COUNT]]

  • [[AccessibleAttribute#FOCUS_ITEM]]

Actions:

case object TableCell extends AccessibleRole

Table Cell role.

Table Cell role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#ROW_INDEX]]

  • [[AccessibleAttribute#COLUMN_INDEX]]

  • [[AccessibleAttribute#SELECTED]]

Actions:

  • [[AccessibleAction#REQUEST_FOCUS]]
case object TableColumn extends AccessibleRole

Table Column role.

Table Column role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#INDEX]]

Actions:

case object TableRow extends AccessibleRole

Table Row role.

Table Row role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#INDEX]]

Actions:

case object TableView extends AccessibleRole

Table View role.

Table View role.

Attributes:

  • [[AccessibleAttribute#ROW_COUNT]]

  • [[AccessibleAttribute#ROW_AT_INDEX]]

  • [[AccessibleAttribute#COLUMN_COUNT]]

  • [[AccessibleAttribute#COLUMN_AT_INDEX]]

  • [[AccessibleAttribute#SELECTED_ITEMS]]

  • [[AccessibleAttribute#CELL_AT_ROW_COLUMN]]

  • [[AccessibleAttribute#HEADER]]

  • [[AccessibleAttribute#MULTIPLE_SELECTION]]

  • [[AccessibleAttribute#VERTICAL_SCROLLBAR]]

  • [[AccessibleAttribute#HORIZONTAL_SCROLLBAR]]

  • [[AccessibleAttribute#FOCUS_ITEM]]

Actions:

  • [[AccessibleAction#SHOW_ITEM]]

  • [[AccessibleAction#SET_SELECTED_ITEMS]]

case object Text extends AccessibleRole

Text role.

Text role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#FONT]]

Actions:

  • [[AccessibleAction#SET_TEXT]]
case object TextArea extends AccessibleRole

Text Area role.

Text Area role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#FONT]]

  • [[AccessibleAttribute#EDITABLE]]

  • [[AccessibleAttribute#SELECTION_START]]

  • [[AccessibleAttribute#SELECTION_END]]

  • [[AccessibleAttribute#CARET_OFFSET]]

  • [[AccessibleAttribute#OFFSET_AT_POINT]]

  • [[AccessibleAttribute#LINE_START]]

  • [[AccessibleAttribute#LINE_END]]

  • [[AccessibleAttribute#LINE_FOR_OFFSET]]

  • [[AccessibleAttribute#BOUNDS_FOR_RANGE]]

Actions:

  • [[AccessibleAction#SET_TEXT]]

  • [[AccessibleAction#SET_TEXT_SELECTION]]

case object TextField extends AccessibleRole

Text Field role.

Text Field role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#FONT]]

  • [[AccessibleAttribute#EDITABLE]]

  • [[AccessibleAttribute#SELECTION_START]]

  • [[AccessibleAttribute#SELECTION_END]]

  • [[AccessibleAttribute#CARET_OFFSET]]

  • [[AccessibleAttribute#OFFSET_AT_POINT]]

  • [[AccessibleAttribute#BOUNDS_FOR_RANGE]]

Actions:

  • [[AccessibleAction#SET_TEXT]]

  • [[AccessibleAction#SET_TEXT_SELECTION]]

case object Thumb extends AccessibleRole

Thumb role.

Thumb role.

Attributes:

  • [[AccessibleAttribute#VALUE]]

Actions:

case object TitledPane extends AccessibleRole

Titled Pane role.

Titled Pane role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#EXPANDED]]

Actions:

  • [[AccessibleAction#EXPAND]]

  • [[AccessibleAction#COLLAPSE]]

case object ToggleButton extends AccessibleRole

Toggle Button role.

Toggle Button role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#SELECTED]]

Actions:

  • [[AccessibleAction#FIRE]]
case object ToolBar extends AccessibleRole

Tool Bar role.

Tool Bar role.

Attributes:

  • [[AccessibleAttribute#OVERFLOW_BUTTON]]

Actions:

case object Tooltip extends AccessibleRole

Tooltip role.

Tooltip role.

Attributes:

Actions:

case object TreeItem extends AccessibleRole

Tree Item role.

Tree Item role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#INDEX]]

  • [[AccessibleAttribute#SELECTED]]

  • [[AccessibleAttribute#EXPANDED]]

  • [[AccessibleAttribute#LEAF]]

  • [[AccessibleAttribute#DISCLOSURE_LEVEL]]

  • [[AccessibleAttribute#TREE_ITEM_COUNT]]

  • [[AccessibleAttribute#TREE_ITEM_AT_INDEX]]

  • [[AccessibleAttribute#TREE_ITEM_PARENT]]

Actions:

  • [[AccessibleAction#EXPAND]]

  • [[AccessibleAction#COLLAPSE]]

  • [[AccessibleAction#REQUEST_FOCUS]]

case object TreeTableCell extends AccessibleRole

Tree Table Cell role.

Tree Table Cell role.

Attributes:

  • [[AccessibleAttribute#TEXT]]

  • [[AccessibleAttribute#SELECTED]]

  • [[AccessibleAttribute#ROW_INDEX]]

  • [[AccessibleAttribute#COLUMN_INDEX]]

Actions:

  • [[AccessibleAction#REQUEST_FOCUS]]
case object TreeTableRow extends AccessibleRole

Tree Table Row role.

Tree Table Row role.

Attributes:

  • [[AccessibleAttribute#INDEX]]

  • [[AccessibleAttribute#EXPANDED]]

  • [[AccessibleAttribute#LEAF]]

  • [[AccessibleAttribute#DISCLOSURE_LEVEL]]

  • [[AccessibleAttribute#TREE_ITEM_COUNT]]

  • [[AccessibleAttribute#TREE_ITEM_AT_INDEX]]

  • [[AccessibleAttribute#TREE_ITEM_PARENT]]

Actions:

  • [[AccessibleAction#EXPAND]]

  • [[AccessibleAction#COLLAPSE]]

case object TreeTableView extends AccessibleRole

Tree Table View role.

Tree Table View role.

Attributes:

  • [[AccessibleAttribute#ROW_COUNT]]

  • [[AccessibleAttribute#ROW_AT_INDEX]]

  • [[AccessibleAttribute#COLUMN_COUNT]]

  • [[AccessibleAttribute#COLUMN_AT_INDEX]]

  • [[AccessibleAttribute#SELECTED_ITEMS]]

  • [[AccessibleAttribute#CELL_AT_ROW_COLUMN]]

  • [[AccessibleAttribute#HEADER]]

  • [[AccessibleAttribute#MULTIPLE_SELECTION]]

  • [[AccessibleAttribute#VERTICAL_SCROLLBAR]]

  • [[AccessibleAttribute#HORIZONTAL_SCROLLBAR]]

  • [[AccessibleAttribute#FOCUS_ITEM]]

Actions:

  • [[AccessibleAction#SHOW_ITEM]]

  • [[AccessibleAction#SET_SELECTED_ITEMS]]

case object TreeView extends AccessibleRole

Tree View role.

Tree View role.

Attributes:

  • [[AccessibleAttribute#ROW_COUNT]]

  • [[AccessibleAttribute#ROW_AT_INDEX]]

  • [[AccessibleAttribute#SELECTED_ITEMS]]

  • [[AccessibleAttribute#MULTIPLE_SELECTION]]

  • [[AccessibleAttribute#VERTICAL_SCROLLBAR]]

  • [[AccessibleAttribute#HORIZONTAL_SCROLLBAR]]

  • [[AccessibleAttribute#FOCUS_ITEM]]

Actions:

  • [[AccessibleAction#SHOW_ITEM]]

  • [[AccessibleAction#SET_SELECTED_ITEMS]]

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Inherited from
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Inherited from
Mirror

Value members

Inherited methods

def apply(e: AccessibleRole): AccessibleRole

Converts a JavaFX enum to its respective SFXEnumDelegate.

Converts a JavaFX enum to its respective SFXEnumDelegate.

Value Params
e

JavaFX enum

Returns

[[scalafx.delegate.SFXEnumDelegate]] equivalent to argument.

Inherited from
SFXEnumDelegateCompanion
def apply(name: String): AccessibleRole

Returns the enum constant of this type with the specified name.

Returns the enum constant of this type with the specified name.

Value Params
name

the name of the constant to return

Throws
IllegalArgumentException

If the specified enum type has no constant with the specified name, or the specified class object does not represent an enum type.

Inherited from
SFXEnumDelegateCompanion
def jfxEnum2sfx(e: AccessibleRole): AccessibleRole

Converts a JavaFX enum to its respective SFXEnumDelegate.

Converts a JavaFX enum to its respective SFXEnumDelegate.

Value Params
e

JavaFX enum

Returns

[[scalafx.delegate.SFXEnumDelegate]] equivalent to argument.

Inherited from
SFXEnumDelegateCompanion

Inherited fields

lazy val values: List[AccessibleRole]

Returns a List containing the constants of this enum type, in the order they are declared.

Returns a List containing the constants of this enum type, in the order they are declared.

Inherited from
SFXEnumDelegateCompanion

Implicits

Inherited implicits

implicit def sfxEnum2jfx(s: AccessibleRole): AccessibleRole

Converts a SFXEnumDelegate to its respective JavaFX Enum.

Converts a SFXEnumDelegate to its respective JavaFX Enum.

Value Params
s

SFXEnumDelegate instance

Returns

Delegated enum

Inherited from
SFXEnumDelegateCompanion