Class Role

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ALERT
      A message with important, and usually time-sensitive, information.
      static java.lang.String ALERTDIALOG
      A type of dialog that contains an alert message, where initial focus goes to an element within the dialog.
      static java.lang.String ANY
      ARIA global states and properties can be used on any HTML element.
      static java.lang.String APPLICATION
      A region declared as a web application, as opposed to a web document.
      static java.lang.String ARTICLE
      A section of a page that consists of a composition that forms an independent part of a document, page, or site.
      static java.lang.String BANNER
      A region that contains mostly site-oriented content, rather than page-specific content.
      static java.lang.String BUTTON
      An input that allows for user-triggered actions when clicked or pressed.
      static java.lang.String CHECKBOX
      A checkable input that has three possible values: true, false, or mixed.
      static java.lang.String COLUMNHEADER
      A cell containing header information for a column.
      static java.lang.String COMBOBOX
      A presentation of a select; usually similar to a textbox where users can type ahead to select an option, or type to enter arbitrary text as a new item in the list.
      static java.lang.String COMPLEMENTARY
      A supporting section of the document, designed to be complementary to the main content at a similar level in the DOM hierarchy, but remains meaningful when separated from the main content.
      static java.lang.String CONTENTINFO
      A large perceivable region that contains information about the parent document.
      static java.lang.String DEFINITION
      A definition of a term or concept.
      static java.lang.String DIALOG
      A dialog is an application window that is designed to interrupt the current processing of an application in order to prompt the user to enter information or require a response.
      static java.lang.String DIRECTORY
      A list of references to members of a group, such as a static table of contents.
      static java.lang.String DOCUMENT
      A region containing related information that is declared as document content, as opposed to a web application.
      static java.lang.String FORM
      A landmark region that contains a collection of items and objects that, as a whole, combine to create a form.
      static java.lang.String GRID
      A grid is an interactive control which contains cells of tabular data arranged in rows and columns, like a table.
      static java.lang.String GRIDCELL
      A cell in a grid or treegrid.
      static java.lang.String GROUP
      A set of user interface objects which are not intended to be included in a page summary or table of contents by assistive technologies.
      static java.lang.String HEADING
      A heading for a section of the page.
      static java.lang.String IMG
      A container for a collection of elements that form an image.
      static java.lang.String LINK
      An interactive reference to an internal or external resource that, when activated, causes the user agent to navigate to that resource.
      static java.lang.String LIST
      A group of non-interactive list items.
      static java.lang.String LISTBOX
      A widget that allows the user to select one or more items from a list of choices.
      static java.lang.String LISTITEM
      A single item in a list or directory.
      static java.lang.String LOG
      A type of live region where new information is added in meaningful order and old information may disappear.
      static java.lang.String MAIN
      The main content of a document.
      static java.lang.String MARQUEE
      A type of live region where non-essential information changes frequently.
      static java.lang.String MATH
      Content that represents a mathematical expression.
      static java.lang.String MENU
      A type of widget that offers a list of choices to the user.
      static java.lang.String MENUBAR
      A presentation of menu that usually remains visible and is usually presented horizontally.
      static java.lang.String MENUITEM
      An option in a group of choices contained by a menu or menubar.
      static java.lang.String MENUITEMCHECKBOX
      A checkable menuitem that has three possible values: true, false, or mixed.
      static java.lang.String MENUITEMRADIO
      A checkable menuitem in a group of menuitemradio roles, only one of which can be checked at a time.
      static java.lang.String NAVIGATION
      A collection of navigational elements (usually links) for navigating the document or related documents.
      static java.lang.String NOTE
      A section whose content is parenthetic or ancillary to the main content of the resource.
      static java.lang.String OPTION
      A selectable item in a select list.
      static java.lang.String PRESENTATION
      An element whose implicit native role semantics will not be mapped to the accessibility API.
      static java.lang.String PROGRESSBAR
      An element that displays the progress status for tasks that take a long time.
      static java.lang.String RADIO
      A checkable input in a group of radio roles, only one of which can be checked at a time.
      static java.lang.String RADIOGROUP
      A group of radio buttons.
      static java.lang.String REGION
      A large perceivable section of a web page or document, that the author feels is important enough to be included in a page summary or table of contents, for example, an area of the page containing live sporting event statistics.
      static java.lang.String ROW
      A row of cells in a grid.
      static java.lang.String ROWGROUP
      A group containing one or more row elements in a grid.
      static java.lang.String ROWHEADER
      A cell containing header information for a row in a grid.
      static java.lang.String SCROLLBAR
      A graphical object that controls the scrolling of content within a viewing area, regardless of whether the content is fully displayed within the viewing area.
      static java.lang.String SEARCH
      A landmark region that contains a collection of items and objects that, as a whole, combine to create a search facility.
      static java.lang.String SEPARATOR
      A divider that separates and distinguishes sections of content or groups of menuitems.
      static java.lang.String SLIDER
      A user input where the user selects a value from within a given range.
      static java.lang.String SPINBUTTON
      A form of range that expects the user to select from among discrete choices.
      static java.lang.String STATUS
      A container whose content is advisory information for the user but is not important enough to justify an alert, often but not necessarily presented as a status bar.
      static java.lang.String TAB
      A grouping label providing a mechanism for selecting the tab content that is to be rendered to the user.
      static java.lang.String TABLIST
      A list of tab elements, which are references to tabpanel elements.
      static java.lang.String TABPANEL
      A container for the resources associated with a tab, where each tab is contained in a tablist.
      static java.lang.String TEXTBOX
      Input that allows free-form text as its value.
      static java.lang.String TIMER
      A type of live region containing a numerical counter which indicates an amount of elapsed time from a start point, or the time remaining until an end point.
      static java.lang.String TOOLBAR
      A collection of commonly used function buttons represented in compact visual form.
      static java.lang.String TOOLTIP
      A contextual popup that displays a description for an element.
      static java.lang.String TREE
      A type of list that may contain sub-level nested groups that can be collapsed and expanded.
      static java.lang.String TREEGRID
      A grid whose rows can be expanded and collapsed in the same manner as for a tree.
      static java.lang.String TREEITEM
      An option item of a tree.
    • Constructor Summary

      Constructors 
      Constructor Description
      Role​(java.lang.String value)  
    • Field Detail

      • ANY

        public static final java.lang.String ANY
        ARIA global states and properties can be used on any HTML element.
        See Also:
        Constant Field Values
      • ALERT

        public static final java.lang.String ALERT
        A message with important, and usually time-sensitive, information.
        See Also:
        Constant Field Values
      • ALERTDIALOG

        public static final java.lang.String ALERTDIALOG
        A type of dialog that contains an alert message, where initial focus goes to an element within the dialog.
        See Also:
        Constant Field Values
      • APPLICATION

        public static final java.lang.String APPLICATION
        A region declared as a web application, as opposed to a web document.
        See Also:
        Constant Field Values
      • ARTICLE

        public static final java.lang.String ARTICLE
        A section of a page that consists of a composition that forms an independent part of a document, page, or site.
        See Also:
        Constant Field Values
      • BANNER

        public static final java.lang.String BANNER
        A region that contains mostly site-oriented content, rather than page-specific content.
        See Also:
        Constant Field Values
      • BUTTON

        public static final java.lang.String BUTTON
        An input that allows for user-triggered actions when clicked or pressed.
        See Also:
        Constant Field Values
      • CHECKBOX

        public static final java.lang.String CHECKBOX
        A checkable input that has three possible values: true, false, or mixed.
        See Also:
        Constant Field Values
      • COLUMNHEADER

        public static final java.lang.String COLUMNHEADER
        A cell containing header information for a column.
        See Also:
        Constant Field Values
      • COMBOBOX

        public static final java.lang.String COMBOBOX
        A presentation of a select; usually similar to a textbox where users can type ahead to select an option, or type to enter arbitrary text as a new item in the list. See related listbox.
        See Also:
        Constant Field Values
      • COMPLEMENTARY

        public static final java.lang.String COMPLEMENTARY
        A supporting section of the document, designed to be complementary to the main content at a similar level in the DOM hierarchy, but remains meaningful when separated from the main content.
        See Also:
        Constant Field Values
      • CONTENTINFO

        public static final java.lang.String CONTENTINFO
        A large perceivable region that contains information about the parent document.
        See Also:
        Constant Field Values
      • DEFINITION

        public static final java.lang.String DEFINITION
        A definition of a term or concept.
        See Also:
        Constant Field Values
      • DIALOG

        public static final java.lang.String DIALOG
        A dialog is an application window that is designed to interrupt the current processing of an application in order to prompt the user to enter information or require a response.
        See Also:
        Constant Field Values
      • DIRECTORY

        public static final java.lang.String DIRECTORY
        A list of references to members of a group, such as a static table of contents.
        See Also:
        Constant Field Values
      • DOCUMENT

        public static final java.lang.String DOCUMENT
        A region containing related information that is declared as document content, as opposed to a web application.
        See Also:
        Constant Field Values
      • FORM

        public static final java.lang.String FORM
        A landmark region that contains a collection of items and objects that, as a whole, combine to create a form.
        See Also:
        Constant Field Values
      • GRID

        public static final java.lang.String GRID
        A grid is an interactive control which contains cells of tabular data arranged in rows and columns, like a table.
        See Also:
        Constant Field Values
      • GRIDCELL

        public static final java.lang.String GRIDCELL
        A cell in a grid or treegrid.
        See Also:
        Constant Field Values
      • GROUP

        public static final java.lang.String GROUP
        A set of user interface objects which are not intended to be included in a page summary or table of contents by assistive technologies.
        See Also:
        Constant Field Values
      • HEADING

        public static final java.lang.String HEADING
        A heading for a section of the page.
        See Also:
        Constant Field Values
      • IMG

        public static final java.lang.String IMG
        A container for a collection of elements that form an image.
        See Also:
        Constant Field Values
      • LINK

        public static final java.lang.String LINK
        An interactive reference to an internal or external resource that, when activated, causes the user agent to navigate to that resource.
        See Also:
        Constant Field Values
      • LIST

        public static final java.lang.String LIST
        A group of non-interactive list items.
        See Also:
        Constant Field Values
      • LISTBOX

        public static final java.lang.String LISTBOX
        A widget that allows the user to select one or more items from a list of choices.
        See Also:
        Constant Field Values
      • LISTITEM

        public static final java.lang.String LISTITEM
        A single item in a list or directory.
        See Also:
        Constant Field Values
      • LOG

        public static final java.lang.String LOG
        A type of live region where new information is added in meaningful order and old information may disappear.
        See Also:
        Constant Field Values
      • MAIN

        public static final java.lang.String MAIN
        The main content of a document.
        See Also:
        Constant Field Values
      • MARQUEE

        public static final java.lang.String MARQUEE
        A type of live region where non-essential information changes frequently.
        See Also:
        Constant Field Values
      • MATH

        public static final java.lang.String MATH
        Content that represents a mathematical expression.
        See Also:
        Constant Field Values
      • MENU

        public static final java.lang.String MENU
        A type of widget that offers a list of choices to the user.
        See Also:
        Constant Field Values
      • MENUBAR

        public static final java.lang.String MENUBAR
        A presentation of menu that usually remains visible and is usually presented horizontally.
        See Also:
        Constant Field Values
      • MENUITEM

        public static final java.lang.String MENUITEM
        An option in a group of choices contained by a menu or menubar.
        See Also:
        Constant Field Values
      • MENUITEMCHECKBOX

        public static final java.lang.String MENUITEMCHECKBOX
        A checkable menuitem that has three possible values: true, false, or mixed.
        See Also:
        Constant Field Values
      • MENUITEMRADIO

        public static final java.lang.String MENUITEMRADIO
        A checkable menuitem in a group of menuitemradio roles, only one of which can be checked at a time.
        See Also:
        Constant Field Values
      • NAVIGATION

        public static final java.lang.String NAVIGATION
        A collection of navigational elements (usually links) for navigating the document or related documents.
        See Also:
        Constant Field Values
      • NOTE

        public static final java.lang.String NOTE
        A section whose content is parenthetic or ancillary to the main content of the resource.
        See Also:
        Constant Field Values
      • OPTION

        public static final java.lang.String OPTION
        A selectable item in a select list.
        See Also:
        Constant Field Values
      • PRESENTATION

        public static final java.lang.String PRESENTATION
        An element whose implicit native role semantics will not be mapped to the accessibility API.
        See Also:
        Constant Field Values
      • PROGRESSBAR

        public static final java.lang.String PROGRESSBAR
        An element that displays the progress status for tasks that take a long time.
        See Also:
        Constant Field Values
      • RADIO

        public static final java.lang.String RADIO
        A checkable input in a group of radio roles, only one of which can be checked at a time.
        See Also:
        Constant Field Values
      • RADIOGROUP

        public static final java.lang.String RADIOGROUP
        A group of radio buttons.
        See Also:
        Constant Field Values
      • REGION

        public static final java.lang.String REGION
        A large perceivable section of a web page or document, that the author feels is important enough to be included in a page summary or table of contents, for example, an area of the page containing live sporting event statistics.
        See Also:
        Constant Field Values
      • ROW

        public static final java.lang.String ROW
        A row of cells in a grid.
        See Also:
        Constant Field Values
      • ROWGROUP

        public static final java.lang.String ROWGROUP
        A group containing one or more row elements in a grid.
        See Also:
        Constant Field Values
      • ROWHEADER

        public static final java.lang.String ROWHEADER
        A cell containing header information for a row in a grid.
        See Also:
        Constant Field Values
      • SCROLLBAR

        public static final java.lang.String SCROLLBAR
        A graphical object that controls the scrolling of content within a viewing area, regardless of whether the content is fully displayed within the viewing area.
        See Also:
        Constant Field Values
      • SEARCH

        public static final java.lang.String SEARCH
        A landmark region that contains a collection of items and objects that, as a whole, combine to create a search facility.
        See Also:
        Constant Field Values
      • SEPARATOR

        public static final java.lang.String SEPARATOR
        A divider that separates and distinguishes sections of content or groups of menuitems.
        See Also:
        Constant Field Values
      • SLIDER

        public static final java.lang.String SLIDER
        A user input where the user selects a value from within a given range.
        See Also:
        Constant Field Values
      • SPINBUTTON

        public static final java.lang.String SPINBUTTON
        A form of range that expects the user to select from among discrete choices.
        See Also:
        Constant Field Values
      • STATUS

        public static final java.lang.String STATUS
        A container whose content is advisory information for the user but is not important enough to justify an alert, often but not necessarily presented as a status bar.
        See Also:
        Constant Field Values
      • TAB

        public static final java.lang.String TAB
        A grouping label providing a mechanism for selecting the tab content that is to be rendered to the user.
        See Also:
        Constant Field Values
      • TABLIST

        public static final java.lang.String TABLIST
        A list of tab elements, which are references to tabpanel elements.
        See Also:
        Constant Field Values
      • TABPANEL

        public static final java.lang.String TABPANEL
        A container for the resources associated with a tab, where each tab is contained in a tablist.
        See Also:
        Constant Field Values
      • TEXTBOX

        public static final java.lang.String TEXTBOX
        Input that allows free-form text as its value.
        See Also:
        Constant Field Values
      • TIMER

        public static final java.lang.String TIMER
        A type of live region containing a numerical counter which indicates an amount of elapsed time from a start point, or the time remaining until an end point.
        See Also:
        Constant Field Values
      • TOOLBAR

        public static final java.lang.String TOOLBAR
        A collection of commonly used function buttons represented in compact visual form.
        See Also:
        Constant Field Values
      • TOOLTIP

        public static final java.lang.String TOOLTIP
        A contextual popup that displays a description for an element.
        See Also:
        Constant Field Values
      • TREE

        public static final java.lang.String TREE
        A type of list that may contain sub-level nested groups that can be collapsed and expanded.
        See Also:
        Constant Field Values
      • TREEGRID

        public static final java.lang.String TREEGRID
        A grid whose rows can be expanded and collapsed in the same manner as for a tree.
        See Also:
        Constant Field Values
      • TREEITEM

        public static final java.lang.String TREEITEM
        An option item of a tree. This is an element within a tree that may be expanded or collapsed if it contains a sub-level group of treeitems.
        See Also:
        Constant Field Values
    • Constructor Detail

      • Role

        public Role​(java.lang.String value)
        Parameters:
        value - the value for the attribute
        Since:
        2.0.1
    • Method Detail

      • setValue

        public void setValue​(java.lang.String value)
        sets the value for this attribute
        Parameters:
        value - the value for the attribute.
        Since:
        2.0.1
      • getValue

        public java.lang.String getValue​()
        gets the value of this attribute
        Returns:
        the value of the attribute
        Since:
        2.0.1
      • init

        protected void init​()
        invokes only once per object
        Since:
        2.0.1