Package limn.accessibility

Enum Class Accessible.Role

java.lang.Object
java.lang.Enum<Accessible.Role>
limn.accessibility.Accessible.Role
All Implemented Interfaces:
Serializable, Comparable<Accessible.Role>, Constable
Enclosing class:
Accessible
public static enum Accessible.Role extends Enum<Accessible.Role>
What a node is. Not a string and not a per-platform constant: each bridge maps this to its own platform's control type, so every degradation is visible in one file per platform.

Three constants exist only because a platform would otherwise be told something untrue. SWITCH is not CHECK_BOX, because the three platforms have three different answers for it and a single constant would collapse them. HEADING exists because a label carrying a title's typographic role is a heading and every platform has one. RADIO_MENU_ITEM exists because a single-selection menu group built out of check items reports independent checkboxes, which is a lie this constant retires.

A 1.x minor release may add constants to this enum: a switch over it needs a default branch.

  • Enum Constant Details

    • WINDOW

      public static final Accessible.Role WINDOW
      A top-level window.

    • DIALOG

      public static final Accessible.Role DIALOG
      A dialog, in its own window or as an in-scene overlay.

    • ALERT

      public static final Accessible.Role ALERT
      A message that demands attention rather than a dialog that awaits input.

    • GROUP

      public static final Accessible.Role GROUP
      A grouping box with no behaviour of its own; the role a described container takes.

    • SCROLL_PANE

      public static final Accessible.Role SCROLL_PANE
      A scrolling viewport.

    • SCROLL_BAR

      public static final Accessible.Role SCROLL_BAR
      A scroll bar.

    • SPLIT_PANE

      public static final Accessible.Role SPLIT_PANE
      A pane split by a draggable divider.

    • SPLITTER

      public static final Accessible.Role SPLITTER
      The draggable divider of a SPLIT_PANE. Its box is the band a pointer grabs, which may reach over the edges of the siblings it divides, and a point in that band is the splitter's whatever order the siblings are published in: that is where the pointer drags it.

    • TOOL_BAR

      public static final Accessible.Role TOOL_BAR
      A bar of commands.

    • CHECK_MENU_ITEM

      public static final Accessible.Role CHECK_MENU_ITEM
      A row of a menu that carries an independent checked state.

    • RADIO_MENU_ITEM

      public static final Accessible.Role RADIO_MENU_ITEM
      A row of a menu that is one option of a single-selection group.

    • SEPARATOR

      public static final Accessible.Role SEPARATOR
      A rule between groups of items.

    • BUTTON

      public static final Accessible.Role BUTTON
      A push button.

    • TOGGLE_BUTTON

      public static final Accessible.Role TOGGLE_BUTTON
      A button that stays pressed.

    • CHECK_BOX

      public static final Accessible.Role CHECK_BOX
      A checkbox.

    • SWITCH

      public static final Accessible.Role SWITCH
      A switch: a checkbox whose platform presentation is an on/off control.

    • RADIO_BUTTON

      public static final Accessible.Role RADIO_BUTTON
      One option of a single-selection group.

    • RADIO_GROUP

      public static final Accessible.Role RADIO_GROUP
      The group a RADIO_BUTTON belongs to.

    • LABEL

      public static final Accessible.Role LABEL
      Static text.

    • HEADING

      public static final Accessible.Role HEADING
      Static text that titles the section under it.

    • IMAGE

      public static final Accessible.Role IMAGE
      A picture.

    • VIDEO

      public static final Accessible.Role VIDEO
      A video surface.

    • CANVAS

      public static final Accessible.Role CANVAS
      A surface a widget draws itself, whose content the tree cannot describe.

    • CHART

      public static final Accessible.Role CHART
      A chart.

    • CHART_SERIES

      public static final Accessible.Role CHART_SERIES
      One data series of a CHART.

    • PROGRESS_BAR

      public static final Accessible.Role PROGRESS_BAR
      A progress indicator.

    • SLIDER

      public static final Accessible.Role SLIDER
      A slider.

    • SPIN_BUTTON

      public static final Accessible.Role SPIN_BUTTON
      A number field with increment and decrement.

    • TEXT_FIELD

      public static final Accessible.Role TEXT_FIELD
      A single-line text field.

    • TEXT_AREA

      public static final Accessible.Role TEXT_AREA
      A multi-line text field.

    • PASSWORD_FIELD

      public static final Accessible.Role PASSWORD_FIELD
      A text field whose content is masked.

    • SEARCH_FIELD

      public static final Accessible.Role SEARCH_FIELD
      A text field that runs a search.

    • COMBO_BOX

      public static final Accessible.Role COMBO_BOX
      A control that chooses one option from a list it can open.

    • LIST

      public static final Accessible.Role LIST
      A list.

    • LIST_ITEM

      public static final Accessible.Role LIST_ITEM
      One row of a LIST.

    • TAB_LIST

      public static final Accessible.Role TAB_LIST
      The strip of tabs above a tabbed pane.

    • TAB

      public static final Accessible.Role TAB
      One tab of a TAB_LIST.

    • TAB_PANEL

      public static final Accessible.Role TAB_PANEL
      The content a TAB selects.

    • COLOR_CHOOSER

      public static final Accessible.Role COLOR_CHOOSER
      A colour picker.

    • TABLE

      public static final Accessible.Role TABLE
      A grid of rows and columns over data.

    • COLUMN_HEADER

      public static final Accessible.Role COLUMN_HEADER
      The header cell of one column of a TABLE.

    • ROW

      public static final Accessible.Role ROW
      One data row of a TABLE.

    • CELL

      public static final Accessible.Role CELL
      One cell of a ROW.

    • TREE

      public static final Accessible.Role TREE
      An outline of rows at a depth, where a row can open onto its children.

    • TREE_ITEM

      public static final Accessible.Role TREE_ITEM
      One row of a TREE.

    • UNKNOWN

      public static final Accessible.Role UNKNOWN
      Nothing better applies. A focusable node that publishes this is a defect: the toolkit logs a warning naming the class, once per class.

  • Method Details

    • values

      public static Accessible.Role[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Accessible.Role valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null