com.hp.lft.sdk.uiapro

Enum AccessibleRole

Supported in UFT Developer version 24.2 and later

UIA Pro is supported as a technical preview.

    • Enum Constant Summary

      Enum Constant and Description
      Alert
      The object represents an alert or a condition that a user should be notified about.
      Animation
      The object represents an animation control whose content changes over time, such as a control that displays a series of bitmap frames.
      Application
      The object represents a main window for an application.
      Border
      The object represents a window border.
      ButtonDropDown
      The object represents a button that expands a list of items.
      ButtonDropDownGrid
      The object represents a button that expands a grid.
      ButtonMenu
      The object represents a button that expands a menu.
      Caret
      The object represents the system's caret.
      Cell
      The object represents a cell within a table.
      Character
      The object represents a cartoon-like graphic object, such as Microsoft Office Assistant, which is displayed to provide help to users of an application.
      Chart
      The object represents a graphical image used to chart data.
      CheckButton
      The object represents a checkbox control: an option that is selected or cleared independently of other options.
      Client
      The object represents a window's client area.
      Clock
      The object represents a control that displays time.
      Column
      The object represents a column of cells within a table.
      ColumnHeader
      The object represents a column header, providing a visual label for a column in a table.
      ComboBox
      The object represents a combo box: an edit control with an associated list box that provides a set of predefined choices.
      Cursor
      The object represents the system's mouse pointer.
      Diagram
      The object represents a graphical image that is used to diagram data.
      Dial
      The object represents a dial or knob.
      Dialog
      The object represents a dialog box or message box.
      Document
      The object represents a document window.
      DropList
      The object represents the calendar control, SysDateTimePick32.
      Equation
      The object represents a mathematical equation.
      Graphic
      The object represents a picture.
      Grip
      The object represents a special mouse pointer that allows a user to manipulate user interface elements such as windows.
      Grouping
      The object logically groups other objects.
      HelpBalloon
      The object displays a help topic in the form of a tooltip or help balloon.
      HotKeyField
      The object represents a keyboard shortcut field that allows the user to enter a combination or sequence of keystrokes.
      Indicator
      The object represents an indicator, such as a pointer graphic, that points to the current item.
      IpAddress
      The object represents an edit control that is designed for an IP address.
      Link
      The object represents a link to something else.
      List
      The object represents a list box, allowing the user to select one or more items.
      ListItem
      The object represents an item in a list box or in the list portion of a combo box, drop-down list box, or drop-down combo box.
      MenuBar
      The object represents the menu bar (positioned beneath the title bar of a window) from which users select menus.
      MenuItem
      The object represents a menu item: a menu entry that the user can choose to carry out a command, select an option, or display another menu.
      MenuPopup
      The object represents a menu: a list of options, each with a specific action.
      Outline
      The object represents an outline or a tree structure, such as a tree view control, that displays a hierarchical list and allows the user to expand and collapse branches.
      OutlineButton
      The object represents an item that navigates like an outline item.
      OutlineItem
      The object represents an item that navigates like an outline item.
      PageTab
      The object represents a page tab.
      PageTabList
      The object represents a container of page tab controls.
      Pane
      The object represents a pane within a frame or a document window.
      ProgressBar
      The object represents a progress bar, which dynamically shows how much of an operation in progress has completed.
      PropertyPage
      The object represents a property sheet.
      PushButton
      The object represents a push-button control.
      RadioButton
      The object represents an option button (formerly, a radio button).
      Row
      The object represents a row of cells within a table.
      RowHeader
      The object represents a row header, which provides a visual label for a table row.
      ScrollBar
      The object represents a vertical or horizontal scroll bar, which is part of the client area or is used in a control.
      Separator
      The object is used to visually divide a space into two regions.
      Slider
      The object represents a slider, which allows the user to adjust a setting in particular increments between minimum and maximum values.
      Sound
      The object represents a system sound, which is associated with various system events.
      SpinButton
      The object represents a spin box, which is a control that allows the user to increment or decrement the value displayed in a separate "buddy" control that is associated with the spin box.
      SplitButton
      The object represents a button on a toolbar that has a drop-down list icon that is directly adjacent to the button.
      StaticText
      The object represents read-only text, such as labels for other controls or instructions in a dialog box.
      StatusBar
      The object represents a status bar, which is an area at the bottom of a window and which displays information about the current operation, state of the application, or selected object.
      Table
      The object represents a table that contains rows and columns of cells, and, optionally, row headers and column headers.
      Text
      The object represents selectable text that allows edits or is designated as read-only.
      TitleBar
      The object represents a title or caption bar for a window.
      ToolBar
      The object represents a toolbar, which is a grouping of controls that provides easy access to frequently used features.
      ToolTip
      The object represents a tooltip that provides helpful hints.
      WhiteSpace
      The object represents blank space between other objects.
      Window
      The object represents the window frame, which contains child objects such as a title bar, client, and other objects of a window.
    • Enum Constant Detail

      • TitleBar

        public static final AccessibleRole TitleBar
        The object represents a title or caption bar for a window.
      • MenuBar

        public static final AccessibleRole MenuBar
        The object represents the menu bar (positioned beneath the title bar of a window) from which users select menus.
      • ScrollBar

        public static final AccessibleRole ScrollBar
        The object represents a vertical or horizontal scroll bar, which is part of the client area or is used in a control.
      • Grip

        public static final AccessibleRole Grip
        The object represents a special mouse pointer that allows a user to manipulate user interface elements such as windows. One example of this involves resizing a window by dragging its lower-right corner.
      • Sound

        public static final AccessibleRole Sound
        The object represents a system sound, which is associated with various system events.
      • Cursor

        public static final AccessibleRole Cursor
        The object represents the system's mouse pointer.
      • Caret

        public static final AccessibleRole Caret
        The object represents the system's caret.
      • Alert

        public static final AccessibleRole Alert
        The object represents an alert or a condition that a user should be notified about. This role is used only for objects that embody an alert but are not associated with another user interface element, such as a message box, graphic, text, or sound.
      • Window

        public static final AccessibleRole Window
        The object represents the window frame, which contains child objects such as a title bar, client, and other objects of a window.
      • Client

        public static final AccessibleRole Client
        The object represents a window's client area. Microsoft Active Accessibility uses this role as a default if there is a question about the role of a UI element.
      • MenuPopup

        public static final AccessibleRole MenuPopup
        The object represents a menu: a list of options, each with a specific action. All menu types must have a role, including the drop-down menus which are displayed when selected from a menu bar; and shortcut menus, which are displayed by clicking the right mouse button.
      • MenuItem

        public static final AccessibleRole MenuItem
        The object represents a menu item: a menu entry that the user can choose to carry out a command, select an option, or display another menu. Functionally, a menu item is equivalent to a push button, a radio button, a checkbox, or a menu.
      • ToolTip

        public static final AccessibleRole ToolTip
        The object represents a tooltip that provides helpful hints.
      • Application

        public static final AccessibleRole Application
        The object represents a main window for an application.
      • Document

        public static final AccessibleRole Document
        The object represents a document window. A document window is always contained within an application window. This role applies only to MDI windows and refers to the object that contains the MDI title bar.
      • Pane

        public static final AccessibleRole Pane
        The object represents a pane within a frame or a document window. Users can navigate between panes and within the contents of the current pane, but cannot navigate between items in different panes. Thus, panes represent a grouping level that is lower than frames or document windows, but higher than individual controls. The user navigates between panes by pressing TAB, F6, or CTRL+TAB, depending on the context.
      • Chart

        public static final AccessibleRole Chart
        The object represents a graphical image used to chart data.
      • Dialog

        public static final AccessibleRole Dialog
        The object represents a dialog box or message box.
      • Border

        public static final AccessibleRole Border
        The object represents a window border. The entire border is represented by a single object rather than by separate objects for each side.
      • Grouping

        public static final AccessibleRole Grouping
        The object logically groups other objects. There is not always a parent-child relationship between the grouping object and the objects it contains.
      • Separator

        public static final AccessibleRole Separator
        The object is used to visually divide a space into two regions. Examples of separator objects include a separator menu item, and a bar that divides split panes within a window.
      • ToolBar

        public static final AccessibleRole ToolBar
        The object represents a toolbar, which is a grouping of controls that provides easy access to frequently used features.
      • StatusBar

        public static final AccessibleRole StatusBar
        The object represents a status bar, which is an area at the bottom of a window and which displays information about the current operation, state of the application, or selected object. The status bar has multiple fields, which display different kinds of information.
      • Table

        public static final AccessibleRole Table
        The object represents a table that contains rows and columns of cells, and, optionally, row headers and column headers.
      • ColumnHeader

        public static final AccessibleRole ColumnHeader
        The object represents a column header, providing a visual label for a column in a table.
      • RowHeader

        public static final AccessibleRole RowHeader
        The object represents a row header, which provides a visual label for a table row.
      • Column

        public static final AccessibleRole Column
        The object represents a column of cells within a table.
      • Row

        public static final AccessibleRole Row
        The object represents a row of cells within a table.
      • Cell

        public static final AccessibleRole Cell
        The object represents a cell within a table.
      • Link

        public static final AccessibleRole Link
        The object represents a link to something else. This object might look like text or a graphic, but it acts like a button.
      • HelpBalloon

        public static final AccessibleRole HelpBalloon
        The object displays a help topic in the form of a tooltip or help balloon.
      • Character

        public static final AccessibleRole Character
        The object represents a cartoon-like graphic object, such as Microsoft Office Assistant, which is displayed to provide help to users of an application.
      • List

        public static final AccessibleRole List
        The object represents a list box, allowing the user to select one or more items.
      • ListItem

        public static final AccessibleRole ListItem
        The object represents an item in a list box or in the list portion of a combo box, drop-down list box, or drop-down combo box.
      • Outline

        public static final AccessibleRole Outline
        The object represents an outline or a tree structure, such as a tree view control, that displays a hierarchical list and allows the user to expand and collapse branches.
      • OutlineItem

        public static final AccessibleRole OutlineItem
        The object represents an item that navigates like an outline item. The UP and DOWN ARROW keys are used to navigate through the outline. However, instead of expanding and collapsing when the LEFT and RIGHT ARROW key is pressed, these menus expand or collapse when the SPACEBAR or ENTER key is pressed and the item has focus.
      • PageTab

        public static final AccessibleRole PageTab
        The object represents a page tab. The only child of a page tab control is a ROLE_SYSTEM_GROUPING object that has the contents of the associated page.
      • PropertyPage

        public static final AccessibleRole PropertyPage
        The object represents a property sheet.
      • Indicator

        public static final AccessibleRole Indicator
        The object represents an indicator, such as a pointer graphic, that points to the current item.
      • Graphic

        public static final AccessibleRole Graphic
        The object represents a picture.
      • StaticText

        public static final AccessibleRole StaticText
        The object represents read-only text, such as labels for other controls or instructions in a dialog box. Static text cannot be modified or selected.
      • Text

        public static final AccessibleRole Text
        The object represents selectable text that allows edits or is designated as read-only.
      • PushButton

        public static final AccessibleRole PushButton
        The object represents a push-button control.
      • CheckButton

        public static final AccessibleRole CheckButton
        The object represents a checkbox control: an option that is selected or cleared independently of other options.
      • RadioButton

        public static final AccessibleRole RadioButton
        The object represents an option button (formerly, a radio button). It is one of a group of mutually exclusive options. All objects that share the same parent and that have this attribute are assumed to be part of a single mutually exclusive group. To divide these objects into separate groups, use ROLE_SYSTEM_GROUPING objects.
      • ComboBox

        public static final AccessibleRole ComboBox
        The object represents a combo box: an edit control with an associated list box that provides a set of predefined choices.
      • DropList

        public static final AccessibleRole DropList
        The object represents the calendar control, SysDateTimePick32. The Microsoft Active Accessibility runtime component uses this role to indicate that either a date or a calendar control has been found.
      • ProgressBar

        public static final AccessibleRole ProgressBar
        The object represents a progress bar, which dynamically shows how much of an operation in progress has completed. This control takes no user input.
      • Dial

        public static final AccessibleRole Dial
        The object represents a dial or knob.
      • HotKeyField

        public static final AccessibleRole HotKeyField
        The object represents a keyboard shortcut field that allows the user to enter a combination or sequence of keystrokes.
      • Slider

        public static final AccessibleRole Slider
        The object represents a slider, which allows the user to adjust a setting in particular increments between minimum and maximum values.
      • SpinButton

        public static final AccessibleRole SpinButton
        The object represents a spin box, which is a control that allows the user to increment or decrement the value displayed in a separate "buddy" control that is associated with the spin box.
      • Diagram

        public static final AccessibleRole Diagram
        The object represents a graphical image that is used to diagram data.
      • Animation

        public static final AccessibleRole Animation
        The object represents an animation control whose content changes over time, such as a control that displays a series of bitmap frames. Animation controls are displayed when files are copied or when some other time-consuming task is performed.
      • Equation

        public static final AccessibleRole Equation
        The object represents a mathematical equation.
      • ButtonDropDown

        public static final AccessibleRole ButtonDropDown
        The object represents a button that expands a list of items.
      • ButtonMenu

        public static final AccessibleRole ButtonMenu
        The object represents a button that expands a menu.
      • ButtonDropDownGrid

        public static final AccessibleRole ButtonDropDownGrid
        The object represents a button that expands a grid.
      • WhiteSpace

        public static final AccessibleRole WhiteSpace
        The object represents blank space between other objects.
      • PageTabList

        public static final AccessibleRole PageTabList
        The object represents a container of page tab controls.
      • Clock

        public static final AccessibleRole Clock
        The object represents a control that displays time.
      • SplitButton

        public static final AccessibleRole SplitButton
        The object represents a button on a toolbar that has a drop-down list icon that is directly adjacent to the button.
      • IpAddress

        public static final AccessibleRole IpAddress
        The object represents an edit control that is designed for an IP address.
      • OutlineButton

        public static final AccessibleRole OutlineButton
        The object represents an item that navigates like an outline item. The UP and DOWN ARROW keys are used to navigate through the outline. However, instead of expanding and collapsing when the LEFT and RIGHT ARROW key is pressed, these menus expand or collapse when the SPACEBAR or ENTER key is pressed and the item has focus.
    • 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
      • getValue

        public Integer getValue()
        Returns the integer value representing the AccessibleRole value.
        Specified by:
        getValue in interface com.hp.lft.sdk.internal.EnumValueProvider<Integer>
        Returns:
        the integer value representing the AccessibleRole value.