APIdia Launch Partner
Top Description Inners Fields Constructors Methods
javafx.scene

public final Enum AccessibleAttribute

extends Enum<AccessibleAttribute>
Class Inheritance
Imports
java.time.LocalDate, javafx.collections.ObservableList, javafx.geometry.Bounds, .Orientation, javafx.scene.input.KeyCombination, javafx.scene.text.Font
This enum describes the attributes that an assistive technology such as a screen reader can request from the scene graph. The AccessibleRole dictates the set of attributes that the screen reader will request for a particular control. For example, a slider is expected to return a double that represents the current value.

Attributes may have any number of parameters, depending on the particular attribute.

When the value of an attribute is changed by a node, it must notify the assistive technology using Node#notifyAccessibleAttributeChanged(AccessibleAttribute). This will allow the screen reader to inform the user that a value has changed. The most common form of notification is focus change.

Since
JavaFX 8u40
See Also
Node#queryAccessibleAttribute(AccessibleAttribute, Object...), Node#notifyAccessibleAttributeChanged(AccessibleAttribute), AccessibleRole, AccessibleAttribute#ROLE

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
AccessibleAttribute.ToggleState

This enum describes the values for TOGGLE_STATE attribute.

Field Summary

Modifier and TypeField and Description
public static final AccessibleAttribute
ACCELERATOR

Returns the accelerator for the node.

public static final AccessibleAttribute
BOUNDS

Returns the bounds for the node, in screen coordinates.

public static final AccessibleAttribute
BOUNDS_FOR_RANGE

Returns the array of bounding rectangles for the given character range, in screen coordinates.

public static final AccessibleAttribute
CARET_OFFSET

Returns the caret offset for the node.

public static final AccessibleAttribute
CELL_AT_ROW_COLUMN

Returns the cell at the given row and column indices.

public static final AccessibleAttribute
CHILDREN

Returns the children for the node.

public static final AccessibleAttribute
COLUMN_AT_INDEX

Returns the column at the given index.

public static final AccessibleAttribute
COLUMN_COUNT

Returns the column count for the node.

public static final AccessibleAttribute
COLUMN_INDEX

Returns the column index for the node.

public static final AccessibleAttribute
CONTENTS

Returns the contents of the node.

public static final AccessibleAttribute
DATE

Returns the local date for the node.

public static final AccessibleAttribute
DISABLED

Returns true if the node is disabled, otherwise false.

public static final AccessibleAttribute
DISCLOSURE_LEVEL

Returns the depth of a row in the disclosure hierarchy.

public static final AccessibleAttribute
EDITABLE

Returns true if the node is editable, otherwise false.

public static final AccessibleAttribute
EXPANDED

Returns true if the node is expanded, otherwise false.

public static final AccessibleAttribute
FOCUS_ITEM

Returns the focus item.

public static final AccessibleAttribute
FOCUS_NODE

Returns the focus node.

public static final AccessibleAttribute
FOCUSED

Returns true if the node is focused, otherwise false.

public static final AccessibleAttribute
FONT

Returns the font for the node.

public static final AccessibleAttribute
HEADER

Returns the header for the node.

public static final AccessibleAttribute
HELP

Returns the help text for the node.

public static final AccessibleAttribute
HORIZONTAL_SCROLLBAR

Returns the horizontal scroll bar for the node.

public static final AccessibleAttribute
INDETERMINATE

Returns true of the node is indeterminate, otherwise false.

public static final AccessibleAttribute
INDEX

Returns the index for the node.

public static final AccessibleAttribute
ITEM_AT_INDEX

Returns the item at the given index.

public static final AccessibleAttribute
ITEM_COUNT

Returns the item count for the node.

public static final AccessibleAttribute
LABELED_BY

Returns the node that is the label for this node.

public static final AccessibleAttribute
LEAF

Returns true if the node is a leaf element, otherwise false.

public static final AccessibleAttribute
LINE_END

Returns the line end offset of the given line index.

public static final AccessibleAttribute
LINE_FOR_OFFSET

Returns the line index of the given character offset.

public static final AccessibleAttribute
LINE_START

Returns the line start offset of the given line index.

public static final AccessibleAttribute
MAX_VALUE

Returns the maximum value for the node.

public static final AccessibleAttribute
MIN_VALUE

Returns the minimum value for the node.

public static final AccessibleAttribute
MNEMONIC

Returns the mnemonic for the node.

public static final AccessibleAttribute
MULTIPLE_SELECTION

Returns true if the node allows for multiple selection, otherwise false.

public static final AccessibleAttribute
NODE_AT_POINT

Returns the node at the given location.

public static final AccessibleAttribute
OFFSET_AT_POINT

Returns the character offset at the given location.

public static final AccessibleAttribute
ORIENTATION

Returns the orientation of the node.

public static final AccessibleAttribute
OVERFLOW_BUTTON

Return the overflow button for the node.

public static final AccessibleAttribute
PARENT

Returns the parent for the node.

public static final AccessibleAttribute
PARENT_MENU

Returns the parent menu for the node.

private Class<?>
returnClass

public static final AccessibleAttribute
ROLE

Returns the role for the node.

public static final AccessibleAttribute
ROLE_DESCRIPTION

Returns the role description for the node.

public static final AccessibleAttribute
ROW_AT_INDEX

Returns the row at the given index.

public static final AccessibleAttribute
ROW_COUNT

Returns the row count for the node.

public static final AccessibleAttribute
ROW_INDEX

Returns the row index of the node.

public static final AccessibleAttribute
SCENE

Returns the scene for the node.

public static final AccessibleAttribute
SELECTED

Returns true if the node is selected, otherwise false.

public static final AccessibleAttribute
SELECTED_ITEMS

Returns the list of selected items for the node.

public static final AccessibleAttribute
SELECTION_END

Returns the text selection end offset for the node.

public static final AccessibleAttribute
SELECTION_START

Returns the text selection start offset for the node.

public static final AccessibleAttribute
TEXT

Returns the text for the node.

public static final AccessibleAttribute
TOGGLE_STATE

Returns toggle state of CheckBox of CheckBoxTreeItem.

public static final AccessibleAttribute
TREE_ITEM_AT_INDEX

Returns a tree item at the given index, relative to its TREE_ITEM_PARENT.

public static final AccessibleAttribute
TREE_ITEM_COUNT

Returns the tree item count for the node, relative to its TREE_ITEM_PARENT.

public static final AccessibleAttribute
TREE_ITEM_PARENT

Returns the parent item for the item, or null if the item is the root.

public static final AccessibleAttribute
VALUE

Returns the value for the node.

public static final AccessibleAttribute
VALUE_STRING

Returns the value as string for the node.

public static final AccessibleAttribute
VERTICAL_SCROLLBAR

Returns the vertical scroll bar for the node.

public static final AccessibleAttribute
VISIBLE

Returns true if node is visible, otherwise false.

public static final AccessibleAttribute
VISITED

Returns true if the node has been visited, otherwise false.

Constructor Summary

AccessConstructor and Description
private
AccessibleAttribute(Class<?> returnClass)

Method Summary

Modifier and TypeMethod and Description
public Class<?>

Returns:

the type of AccessibleAttribute
getReturnType()

Gets the type of AccessibleAttribute.

public static AccessibleAttribute
valueOf(String name)

public static AccessibleAttribute[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ACCELERATORback to summary
public static final AccessibleAttribute ACCELERATOR

Returns the accelerator for the node.

  • Used by: Menu, MenuItem, RadioMenuItem, and others
  • Needs notify: no
  • Return Type: KeyCombination
  • Parameters:
BOUNDSback to summary
public static final AccessibleAttribute BOUNDS

Returns the bounds for the node, in screen coordinates.

  • Used by: Node
  • Needs notify: no
  • Return Type: Bounds in screen coordinates
  • Parameters:
BOUNDS_FOR_RANGEback to summary
public static final AccessibleAttribute BOUNDS_FOR_RANGE

Returns the array of bounding rectangles for the given character range, in screen coordinates.

  • Used by: TextField and TextArea
  • Needs notify: no
  • Return Type: Bounds[] in screen coordinates
  • Parameters:
CARET_OFFSETback to summary
public static final AccessibleAttribute CARET_OFFSET

Returns the caret offset for the node.

  • Used by: TextField and TextArea
  • Needs notify: no
  • Return Type: Integer
  • Parameters:
CELL_AT_ROW_COLUMNback to summary
public static final AccessibleAttribute CELL_AT_ROW_COLUMN

Returns the cell at the given row and column indices.

  • Used by: TableView and TreeTableView
  • Needs notify: no
  • Return Type: Node
  • Parameters:
CHILDRENback to summary
public static final AccessibleAttribute CHILDREN

Returns the children for the node.

COLUMN_AT_INDEXback to summary
public static final AccessibleAttribute COLUMN_AT_INDEX

Returns the column at the given index.

  • Used by: TableView and TreeTableView
  • Needs notify: no
  • Return Type: Node
  • Parameters:
COLUMN_COUNTback to summary
public static final AccessibleAttribute COLUMN_COUNT

Returns the column count for the node.

  • Used by: TableView and TreeTableView
  • Needs notify: no
  • Return Type: Integer
  • Parameters:
COLUMN_INDEXback to summary
public static final AccessibleAttribute COLUMN_INDEX

Returns the column index for the node.

  • Used by: TableCell and TreeTableCell
  • Needs notify: no
  • Return Type: Integer
  • Parameters:
CONTENTSback to summary
public static final AccessibleAttribute CONTENTS

Returns the contents of the node.

  • Used by: ScrollPane
  • Needs notify: no
  • Return Type: Node
  • Parameters:
DATEback to summary
public static final AccessibleAttribute DATE

Returns the local date for the node.

  • Used by: DatePicker
  • Needs notify: no
  • Return Type: LocalDate
  • Parameters:
DISABLEDback to summary
public static final AccessibleAttribute DISABLED

Returns true if the node is disabled, otherwise false.

  • Used by: Node
  • Needs notify: no
  • Return Type: Boolean
  • Parameters:
DISCLOSURE_LEVELback to summary
public static final AccessibleAttribute DISCLOSURE_LEVEL

Returns the depth of a row in the disclosure hierarchy.

  • Used by: TreeItem and TreeTableRow
  • Needs notify: no
  • Return Type: Integer
  • Parameters:
EDITABLEback to summary
public static final AccessibleAttribute EDITABLE

Returns true if the node is editable, otherwise false.

  • Used by: TextField, ComboBox, and others
  • Needs notify: no
  • Return Type: Boolean
  • Parameters:
EXPANDEDback to summary
public static final AccessibleAttribute EXPANDED

Returns true if the node is expanded, otherwise false.

  • Used by: TreeItem, TitledPane, and others
  • Needs notify: yes
  • Return Type: Boolean
  • Parameters:
FOCUS_ITEMback to summary
public static final AccessibleAttribute FOCUS_ITEM

Returns the focus item.

Used for controls such as TabPane, TableView, ListView where the assistive technology focus is different from the normal focus node. For example, a table control will have focus, while a cell inside the table might have the screen reader focus.

  • Used by: ListView, TabPane, and others
  • Needs notify: yes
  • Return Type: Node
  • Parameters:
FOCUS_NODEback to summary
public static final AccessibleAttribute FOCUS_NODE

Returns the focus node. Type: Node

When this attribute is requested from the Scene, the default implementation returns Scene#focusOwnerProperty().

  • Used by: Scene
  • Needs notify: yes
  • Return Type: Node
  • Parameters:
FOCUSEDback to summary
public static final AccessibleAttribute FOCUSED

Returns true if the node is focused, otherwise false.

  • Used by: Node
  • Needs notify: no
  • Return Type: Boolean
  • Parameters:
FONTback to summary
public static final AccessibleAttribute FONT

Returns the font for the node.

  • Used by: TextField and TextArea
  • Needs notify: no
  • Return Type: Font
  • Parameters:
HELPback to summary
public static final AccessibleAttribute HELP

Returns the help text for the node.

  • Used by: Node
  • Needs notify: no
  • Return Type: String
  • Parameters:
HORIZONTAL_SCROLLBARback to summary
public static final AccessibleAttribute HORIZONTAL_SCROLLBAR

Returns the horizontal scroll bar for the node.

  • Used by: ListView, ScrollPane, and others
  • Needs notify: no
  • Return Type: Node
  • Parameters:
INDETERMINATEback to summary
public static final AccessibleAttribute INDETERMINATE

Returns true of the node is indeterminate, otherwise false.

  • Used by: CheckBox and ProgressIndicator
  • Needs notify: yes
  • Return Type: Boolean
  • Parameters:
INDEXback to summary
public static final AccessibleAttribute INDEX

Returns the index for the node.

  • Used by: ListItem, TableRow, and others
  • Needs notify: no
  • Return Type: Integer
  • Parameters:
ITEM_AT_INDEXback to summary
public static final AccessibleAttribute ITEM_AT_INDEX

Returns the item at the given index.

  • Used by: TabPane, ListView, and others
  • Needs notify: no
  • Return Type: Node
  • Parameters:
ITEM_COUNTback to summary
public static final AccessibleAttribute ITEM_COUNT

Returns the item count for the node.

  • Used by: TabPane, ListView, and others
  • Needs notify: no
  • Return Type: Integer
  • Parameters:
LABELED_BYback to summary
public static final AccessibleAttribute LABELED_BY

Returns the node that is the label for this node.

When labelFor is set, the default implementation of LABELED_BY uses this relationship to return the appropriate node to the screen reader.

  • Used by: Node
  • Needs notify: no
  • Return Type: Node
  • Parameters:
LEAFback to summary
public static final AccessibleAttribute LEAF

Returns true if the node is a leaf element, otherwise false.

  • Used by: TreeItem and TreeTableRow
  • Needs notify: no
  • Return Type: Boolean
  • Parameters:
LINE_ENDback to summary
public static final AccessibleAttribute LINE_END

Returns the line end offset of the given line index.

  • Used by: TextArea
  • Needs notify: no
  • Return Type: Integer
  • Parameters:
LINE_FOR_OFFSETback to summary
public static final AccessibleAttribute LINE_FOR_OFFSET

Returns the line index of the given character offset.

  • Used by: TextArea
  • Needs notify: no
  • Return Type: Integer
  • Parameters:
LINE_STARTback to summary
public static final AccessibleAttribute LINE_START

Returns the line start offset of the given line index.

  • Used by: TextArea
  • Needs notify: no
  • Return Type: Integer
  • Parameters:
MAX_VALUEback to summary
public static final AccessibleAttribute MAX_VALUE

Returns the maximum value for the node.

  • Used by: Slider, ScrollBar, and others
  • Needs notify: no
  • Return Type: Double
  • Parameters:
MIN_VALUEback to summary
public static final AccessibleAttribute MIN_VALUE

Returns the minimum value for the node.

  • Used by: Slider, ScrollBar, and others
  • Needs notify: no
  • Return Type: Double
  • Parameters:
MNEMONICback to summary
public static final AccessibleAttribute MNEMONIC

Returns the mnemonic for the node.

  • Used by: Menu, MenuItem, CheckMenuItem, and others
  • Needs notify: no
  • Return Type: String
  • Parameters:
MULTIPLE_SELECTIONback to summary
public static final AccessibleAttribute MULTIPLE_SELECTION

Returns true if the node allows for multiple selection, otherwise false.

  • Used by: ListView, TableView, and others
  • Needs notify: no
  • Return Type: Boolean
  • Parameters:
NODE_AT_POINTback to summary
public static final AccessibleAttribute NODE_AT_POINT

Returns the node at the given location.

OFFSET_AT_POINTback to summary
public static final AccessibleAttribute OFFSET_AT_POINT

Returns the character offset at the given location.

ORIENTATIONback to summary
public static final AccessibleAttribute ORIENTATION

Returns the orientation of the node.

OVERFLOW_BUTTONback to summary
public static final AccessibleAttribute OVERFLOW_BUTTON

Return the overflow button for the node.

  • Used by: Toolbar
  • Needs notify: no
  • Return Type: Node
  • Parameters:
PARENTback to summary
public static final AccessibleAttribute PARENT

Returns the parent for the node.

  • Used by: Node
  • Needs notify: yes
  • Return Type: Parent
  • Parameters:
PARENT_MENUback to summary
public static final AccessibleAttribute PARENT_MENU

Returns the parent menu for the node.

  • Used by: ContextMenu
  • Needs notify: no
  • Return Type: Node
  • Parameters:
returnClassback to summary
private Class<?> returnClass
ROLEback to summary
public static final AccessibleAttribute ROLE

Returns the role for the node.

  • Used by: Node
  • Needs notify: no
  • Return Type: AccessibleRole
  • Parameters:
ROLE_DESCRIPTIONback to summary
public static final AccessibleAttribute ROLE_DESCRIPTION

Returns the role description for the node.

  • Used by: Node
  • Needs notify: no
  • Return Type: String
  • Parameters:
ROW_AT_INDEXback to summary
public static final AccessibleAttribute ROW_AT_INDEX

Returns the row at the given index.

  • Used by: TableView, TreeView, and TreeTableView
  • Needs notify: no
  • Return Type: Node
  • Parameters:
ROW_COUNTback to summary
public static final AccessibleAttribute ROW_COUNT

Returns the row count for the node.

  • Used by: TableView, TreeView, and TreeTableView
  • Needs notify: no
  • Return Type: Integer
  • Parameters:
ROW_INDEXback to summary
public static final AccessibleAttribute ROW_INDEX

Returns the row index of the node.

  • Used by: TableCell, TreeItem, and TreeTableCell
  • Needs notify: no
  • Return Type: Integer
  • Parameters:
SCENEback to summary
public static final AccessibleAttribute SCENE

Returns the scene for the node.

  • Used by: Node
  • Needs notify: no
  • Return Type: Scene
  • Parameters:
SELECTEDback to summary
public static final AccessibleAttribute SELECTED

Returns true if the node is selected, otherwise false.

  • Used by: CheckBox, TreeItem, and others
  • Needs notify: no
  • Return Type: Boolean
  • Parameters:
SELECTED_ITEMSback to summary
public static final AccessibleAttribute SELECTED_ITEMS

Returns the list of selected items for the node.

SELECTION_ENDback to summary
public static final AccessibleAttribute SELECTION_END

Returns the text selection end offset for the node. Selection end corresponds to the larger position in the selection range.

  • Used by: TextField and TextArea
  • Needs notify: yes
  • Return Type: Integer
  • Parameters:
SELECTION_STARTback to summary
public static final AccessibleAttribute SELECTION_START

Returns the text selection start offset for the node. Selection start corresponds to the smaller position in the selection range.

  • Used by: TextField and TextArea
  • Needs notify: yes
  • Return Type: Integer
  • Parameters:
TEXTback to summary
public static final AccessibleAttribute TEXT

Returns the text for the node. E.g.

  • ComboBox returns a string representation of the current selected item.
  • TextField returns the contents of the text field.
  • Used by: Node
  • Needs notify: yes
  • Return Type: String
  • Parameters:
TOGGLE_STATEback to summary
public static final AccessibleAttribute TOGGLE_STATE

Returns toggle state of CheckBox of CheckBoxTreeItem.

Since
21
See Also
ToggleState
TREE_ITEM_AT_INDEXback to summary
public static final AccessibleAttribute TREE_ITEM_AT_INDEX

Returns a tree item at the given index, relative to its TREE_ITEM_PARENT.

  • Used by: TreeItem and TreeTableRow
  • Needs notify: no
  • Return Type: Node
  • Parameters:
TREE_ITEM_COUNTback to summary
public static final AccessibleAttribute TREE_ITEM_COUNT

Returns the tree item count for the node, relative to its TREE_ITEM_PARENT.

  • Used by: TreeItem and TreeTableRow
  • Needs notify: no
  • Return Type: Integer
  • Parameters:
TREE_ITEM_PARENTback to summary
public static final AccessibleAttribute TREE_ITEM_PARENT

Returns the parent item for the item, or null if the item is the root.

  • Used by: TreeItem and TreeTableRow
  • Needs notify: no
  • Return Type: Node
  • Parameters:
VALUEback to summary
public static final AccessibleAttribute VALUE

Returns the value for the node.

  • Used by: Slider, ScrollBar, Thumb, and others
  • Needs notify: yes
  • Return Type: Double
  • Parameters:
VALUE_STRINGback to summary
public static final AccessibleAttribute VALUE_STRING

Returns the value as string for the node.

  • Used by: Spinner
  • Needs notify: yes
  • Return Type: String
  • Parameters:
Since
22
VERTICAL_SCROLLBARback to summary
public static final AccessibleAttribute VERTICAL_SCROLLBAR

Returns the vertical scroll bar for the node.

  • Used by: ListView, ScrollPane, and others
  • Needs notify: no
  • Return Type: Node
  • Parameters:
VISIBLEback to summary
public static final AccessibleAttribute VISIBLE

Returns true if node is visible, otherwise false.

  • Used by: Node and ContextMenu
  • Needs notify: yes
  • Return Type: Boolean
  • Parameters:
VISITEDback to summary
public static final AccessibleAttribute VISITED

Returns true if the node has been visited, otherwise false.

  • Used by: Hyperlink
  • Needs notify: no
  • Return Type: Boolean
  • Parameters:

Constructor Detail

AccessibleAttributeback to summary
private AccessibleAttribute(Class<?> returnClass)

Method Detail

getReturnTypeback to summary
public Class<?> getReturnType()

Gets the type of AccessibleAttribute.

Returns:Class<?>

the type of AccessibleAttribute

valueOfback to summary
public static AccessibleAttribute valueOf(String name)
valuesback to summary
public static AccessibleAttribute[] values()
javafx.scene back to summary

public final Enum AccessibleAttribute.ToggleState

extends Enum<AccessibleAttribute.ToggleState>
Class Inheritance
This enum describes the values for TOGGLE_STATE attribute.
Since
21

Field Summary

Modifier and TypeField and Description
public static final AccessibleAttribute.ToggleState
CHECKED

Indicates that the toggle control is selected.

public static final AccessibleAttribute.ToggleState
INDETERMINATE

Indicates that the toggle state of the control cannot be determined.

public static final AccessibleAttribute.ToggleState
UNCHECKED

Indicates that the toggle control is not selected.

Constructor Summary

AccessConstructor and Description
private
ToggleState()

Method Summary

Modifier and TypeMethod and Description
public static AccessibleAttribute.ToggleState
valueOf(String name)

public static AccessibleAttribute.ToggleState[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CHECKEDback to summary
public static final AccessibleAttribute.ToggleState CHECKED

Indicates that the toggle control is selected.

INDETERMINATEback to summary
public static final AccessibleAttribute.ToggleState INDETERMINATE

Indicates that the toggle state of the control cannot be determined.

UNCHECKEDback to summary
public static final AccessibleAttribute.ToggleState UNCHECKED

Indicates that the toggle control is not selected.

Constructor Detail

ToggleStateback to summary
private ToggleState()

Method Detail

valueOfback to summary
public static AccessibleAttribute.ToggleState valueOf(String name)
valuesback to summary
public static AccessibleAttribute.ToggleState[] values()