role.js (9704B)
1 /* import-globals-from common.js */ 2 3 // ////////////////////////////////////////////////////////////////////////////// 4 // Role constants 5 6 const ROLE_ALERT = nsIAccessibleRole.ROLE_ALERT; 7 const ROLE_ARTICLE = nsIAccessibleRole.ROLE_ARTICLE; 8 const ROLE_ANIMATION = nsIAccessibleRole.ROLE_ANIMATION; 9 const ROLE_APPLICATION = nsIAccessibleRole.ROLE_APPLICATION; 10 const ROLE_APP_ROOT = nsIAccessibleRole.ROLE_APP_ROOT; 11 const ROLE_BLOCKQUOTE = nsIAccessibleRole.ROLE_BLOCKQUOTE; 12 const ROLE_BUTTONMENU = nsIAccessibleRole.ROLE_BUTTONMENU; 13 const ROLE_CANVAS = nsIAccessibleRole.ROLE_CANVAS; 14 const ROLE_CAPTION = nsIAccessibleRole.ROLE_CAPTION; 15 const ROLE_CELL = nsIAccessibleRole.ROLE_CELL; 16 const ROLE_CHECKBUTTON = nsIAccessibleRole.ROLE_CHECKBUTTON; 17 const ROLE_CHECK_MENU_ITEM = nsIAccessibleRole.ROLE_CHECK_MENU_ITEM; 18 const ROLE_CHROME_WINDOW = nsIAccessibleRole.ROLE_CHROME_WINDOW; 19 const ROLE_CODE = nsIAccessibleRole.ROLE_CODE; 20 const ROLE_COLUMNHEADER = nsIAccessibleRole.ROLE_COLUMNHEADER; 21 const ROLE_COMBOBOX = nsIAccessibleRole.ROLE_COMBOBOX; 22 const ROLE_COMBOBOX_LIST = nsIAccessibleRole.ROLE_COMBOBOX_LIST; 23 const ROLE_COMBOBOX_OPTION = nsIAccessibleRole.ROLE_COMBOBOX_OPTION; 24 const ROLE_COMMENT = nsIAccessibleRole.ROLE_COMMENT; 25 const ROLE_CONTENT_DELETION = nsIAccessibleRole.ROLE_CONTENT_DELETION; 26 const ROLE_CONTENT_INSERTION = nsIAccessibleRole.ROLE_CONTENT_INSERTION; 27 const ROLE_DATE_EDITOR = nsIAccessibleRole.ROLE_DATE_EDITOR; 28 const ROLE_DEFINITION = nsIAccessibleRole.ROLE_DEFINITION; 29 const ROLE_DEFINITION_LIST = nsIAccessibleRole.ROLE_DEFINITION_LIST; 30 const ROLE_DETAILS = nsIAccessibleRole.ROLE_DETAILS; 31 const ROLE_DIAGRAM = nsIAccessibleRole.ROLE_DIAGRAM; 32 const ROLE_DIALOG = nsIAccessibleRole.ROLE_DIALOG; 33 const ROLE_DOCUMENT = nsIAccessibleRole.ROLE_DOCUMENT; 34 const ROLE_EDITCOMBOBOX = nsIAccessibleRole.ROLE_EDITCOMBOBOX; 35 const ROLE_EMPHASIS = nsIAccessibleRole.ROLE_EMPHASIS; 36 const ROLE_ENTRY = nsIAccessibleRole.ROLE_ENTRY; 37 const ROLE_FIGURE = nsIAccessibleRole.ROLE_FIGURE; 38 const ROLE_FOOTNOTE = nsIAccessibleRole.ROLE_FOOTNOTE; 39 const ROLE_FLAT_EQUATION = nsIAccessibleRole.ROLE_FLAT_EQUATION; 40 const ROLE_FORM = nsIAccessibleRole.ROLE_FORM; 41 const ROLE_FORM_LANDMARK = nsIAccessibleRole.ROLE_FORM_LANDMARK; 42 const ROLE_GRAPHIC = nsIAccessibleRole.ROLE_GRAPHIC; 43 const ROLE_GRID = nsIAccessibleRole.ROLE_GRID; 44 const ROLE_GRID_CELL = nsIAccessibleRole.ROLE_GRID_CELL; 45 const ROLE_GROUPING = nsIAccessibleRole.ROLE_GROUPING; 46 const ROLE_HEADING = nsIAccessibleRole.ROLE_HEADING; 47 const ROLE_IMAGE_MAP = nsIAccessibleRole.ROLE_IMAGE_MAP; 48 const ROLE_INTERNAL_FRAME = nsIAccessibleRole.ROLE_INTERNAL_FRAME; 49 const ROLE_LABEL = nsIAccessibleRole.ROLE_LABEL; 50 const ROLE_LANDMARK = nsIAccessibleRole.ROLE_LANDMARK; 51 const ROLE_LINK = nsIAccessibleRole.ROLE_LINK; 52 const ROLE_LIST = nsIAccessibleRole.ROLE_LIST; 53 const ROLE_LISTBOX = nsIAccessibleRole.ROLE_LISTBOX; 54 const ROLE_LISTITEM = nsIAccessibleRole.ROLE_LISTITEM; 55 const ROLE_LISTITEM_MARKER = nsIAccessibleRole.ROLE_LISTITEM_MARKER; 56 const ROLE_MARK = nsIAccessibleRole.ROLE_MARK; 57 const ROLE_MATHML_MATH = nsIAccessibleRole.ROLE_MATHML_MATH; 58 const ROLE_MATHML_IDENTIFIER = nsIAccessibleRole.ROLE_MATHML_IDENTIFIER; 59 const ROLE_MATHML_NUMBER = nsIAccessibleRole.ROLE_MATHML_NUMBER; 60 const ROLE_MATHML_OPERATOR = nsIAccessibleRole.ROLE_MATHML_OPERATOR; 61 const ROLE_MATHML_TEXT = nsIAccessibleRole.ROLE_MATHML_TEXT; 62 const ROLE_MATHML_STRING_LITERAL = nsIAccessibleRole.ROLE_MATHML_STRING_LITERAL; 63 const ROLE_MATHML_GLYPH = nsIAccessibleRole.ROLE_MATHML_GLYPH; 64 const ROLE_MATHML_ROW = nsIAccessibleRole.ROLE_MATHML_ROW; 65 const ROLE_MATHML_FRACTION = nsIAccessibleRole.ROLE_MATHML_FRACTION; 66 const ROLE_MATHML_SQUARE_ROOT = nsIAccessibleRole.ROLE_MATHML_SQUARE_ROOT; 67 const ROLE_MATHML_ROOT = nsIAccessibleRole.ROLE_MATHML_ROOT; 68 const ROLE_MATHML_FENCED = nsIAccessibleRole.ROLE_MATHML_FENCED; 69 const ROLE_MATHML_ENCLOSED = nsIAccessibleRole.ROLE_MATHML_ENCLOSED; 70 const ROLE_MATHML_STYLE = nsIAccessibleRole.ROLE_MATHML_STYLE; 71 const ROLE_MATHML_SUB = nsIAccessibleRole.ROLE_MATHML_SUB; 72 const ROLE_MATHML_SUP = nsIAccessibleRole.ROLE_MATHML_SUP; 73 const ROLE_MATHML_SUB_SUP = nsIAccessibleRole.ROLE_MATHML_SUB_SUP; 74 const ROLE_MATHML_UNDER = nsIAccessibleRole.ROLE_MATHML_UNDER; 75 const ROLE_MATHML_OVER = nsIAccessibleRole.ROLE_MATHML_OVER; 76 const ROLE_MATHML_UNDER_OVER = nsIAccessibleRole.ROLE_MATHML_UNDER_OVER; 77 const ROLE_MATHML_MULTISCRIPTS = nsIAccessibleRole.ROLE_MATHML_MULTISCRIPTS; 78 const ROLE_MATHML_TABLE = nsIAccessibleRole.ROLE_MATHML_TABLE; 79 const ROLE_MATHML_LABELED_ROW = nsIAccessibleRole.ROLE_MATHML_LABELED_ROW; 80 const ROLE_MATHML_TABLE_ROW = nsIAccessibleRole.ROLE_MATHML_TABLE_ROW; 81 const ROLE_MATHML_CELL = nsIAccessibleRole.ROLE_MATHML_CELL; 82 const ROLE_MATHML_ACTION = nsIAccessibleRole.ROLE_MATHML_ACTION; 83 const ROLE_MATHML_ERROR = nsIAccessibleRole.ROLE_MATHML_ERROR; 84 const ROLE_MATHML_STACK = nsIAccessibleRole.ROLE_MATHML_STACK; 85 const ROLE_MATHML_LONG_DIVISION = nsIAccessibleRole.ROLE_MATHML_LONG_DIVISION; 86 const ROLE_MATHML_STACK_GROUP = nsIAccessibleRole.ROLE_MATHML_STACK_GROUP; 87 const ROLE_MATHML_STACK_ROW = nsIAccessibleRole.ROLE_MATHML_STACK_ROW; 88 const ROLE_MATHML_STACK_CARRIES = nsIAccessibleRole.ROLE_MATHML_STACK_CARRIES; 89 const ROLE_MATHML_STACK_CARRY = nsIAccessibleRole.ROLE_MATHML_STACK_CARRY; 90 const ROLE_MATHML_STACK_LINE = nsIAccessibleRole.ROLE_MATHML_STACK_LINE; 91 const ROLE_MENUBAR = nsIAccessibleRole.ROLE_MENUBAR; 92 const ROLE_MENUITEM = nsIAccessibleRole.ROLE_MENUITEM; 93 const ROLE_MENUPOPUP = nsIAccessibleRole.ROLE_MENUPOPUP; 94 const ROLE_METER = nsIAccessibleRole.ROLE_METER; 95 const ROLE_NAVIGATION = nsIAccessibleRole.ROLE_NAVIGATION; 96 const ROLE_NON_NATIVE_DOCUMENT = nsIAccessibleRole.ROLE_NON_NATIVE_DOCUMENT; 97 const ROLE_NOTHING = nsIAccessibleRole.ROLE_NOTHING; 98 const ROLE_NOTE = nsIAccessibleRole.ROLE_NOTE; 99 const ROLE_OPTION = nsIAccessibleRole.ROLE_OPTION; 100 const ROLE_OUTLINE = nsIAccessibleRole.ROLE_OUTLINE; 101 const ROLE_OUTLINEITEM = nsIAccessibleRole.ROLE_OUTLINEITEM; 102 const ROLE_PAGETAB = nsIAccessibleRole.ROLE_PAGETAB; 103 const ROLE_PAGETABLIST = nsIAccessibleRole.ROLE_PAGETABLIST; 104 const ROLE_PANE = nsIAccessibleRole.ROLE_PANE; 105 const ROLE_PARAGRAPH = nsIAccessibleRole.ROLE_PARAGRAPH; 106 const ROLE_PARENT_MENUITEM = nsIAccessibleRole.ROLE_PARENT_MENUITEM; 107 const ROLE_PASSWORD_TEXT = nsIAccessibleRole.ROLE_PASSWORD_TEXT; 108 const ROLE_PROGRESSBAR = nsIAccessibleRole.ROLE_PROGRESSBAR; 109 const ROLE_PROPERTYPAGE = nsIAccessibleRole.ROLE_PROPERTYPAGE; 110 const ROLE_PUSHBUTTON = nsIAccessibleRole.ROLE_PUSHBUTTON; 111 const ROLE_RADIOBUTTON = nsIAccessibleRole.ROLE_RADIOBUTTON; 112 const ROLE_RADIO_GROUP = nsIAccessibleRole.ROLE_RADIO_GROUP; 113 const ROLE_RADIO_MENU_ITEM = nsIAccessibleRole.ROLE_RADIO_MENU_ITEM; 114 const ROLE_REGION = nsIAccessibleRole.ROLE_REGION; 115 const ROLE_RICH_OPTION = nsIAccessibleRole.ROLE_RICH_OPTION; 116 const ROLE_ROW = nsIAccessibleRole.ROLE_ROW; 117 const ROLE_ROWHEADER = nsIAccessibleRole.ROLE_ROWHEADER; 118 const ROLE_SCROLLBAR = nsIAccessibleRole.ROLE_SCROLLBAR; 119 const ROLE_SEARCHBOX = nsIAccessibleRole.ROLE_SEARCHBOX; 120 const ROLE_SECTION = nsIAccessibleRole.ROLE_SECTION; 121 const ROLE_SEPARATOR = nsIAccessibleRole.ROLE_SEPARATOR; 122 const ROLE_SLIDER = nsIAccessibleRole.ROLE_SLIDER; 123 const ROLE_SPINBUTTON = nsIAccessibleRole.ROLE_SPINBUTTON; 124 const ROLE_STATICTEXT = nsIAccessibleRole.ROLE_STATICTEXT; 125 const ROLE_STATUSBAR = nsIAccessibleRole.ROLE_STATUSBAR; 126 const ROLE_STRONG = nsIAccessibleRole.ROLE_STRONG; 127 const ROLE_SUBSCRIPT = nsIAccessibleRole.ROLE_SUBSCRIPT; 128 const ROLE_SUGGESTION = nsIAccessibleRole.ROLE_SUGGESTION; 129 const ROLE_SUPERSCRIPT = nsIAccessibleRole.ROLE_SUPERSCRIPT; 130 const ROLE_SUMMARY = nsIAccessibleRole.ROLE_SUMMARY; 131 const ROLE_SWITCH = nsIAccessibleRole.ROLE_SWITCH; 132 const ROLE_TABLE = nsIAccessibleRole.ROLE_TABLE; 133 const ROLE_TERM = nsIAccessibleRole.ROLE_TERM; 134 const ROLE_TEXT = nsIAccessibleRole.ROLE_TEXT; 135 const ROLE_TEXT_CONTAINER = nsIAccessibleRole.ROLE_TEXT_CONTAINER; 136 const ROLE_TEXT_LEAF = nsIAccessibleRole.ROLE_TEXT_LEAF; 137 const ROLE_TIME = nsIAccessibleRole.ROLE_TIME; 138 const ROLE_TIME_EDITOR = nsIAccessibleRole.ROLE_TIME_EDITOR; 139 const ROLE_TOGGLE_BUTTON = nsIAccessibleRole.ROLE_TOGGLE_BUTTON; 140 const ROLE_TOOLBAR = nsIAccessibleRole.ROLE_TOOLBAR; 141 const ROLE_TOOLTIP = nsIAccessibleRole.ROLE_TOOLTIP; 142 const ROLE_TREE_TABLE = nsIAccessibleRole.ROLE_TREE_TABLE; 143 const ROLE_WHITESPACE = nsIAccessibleRole.ROLE_WHITESPACE; 144 145 // ////////////////////////////////////////////////////////////////////////////// 146 // Public methods 147 148 /** 149 * Test that the role of the given accessible is the role passed in. 150 * 151 * @param aAccOrElmOrID the accessible, DOM element or ID to be tested. 152 * @param aRole The role that is to be expected. 153 */ 154 function testRole(aAccOrElmOrID, aRole) { 155 var role = getRole(aAccOrElmOrID); 156 is(role, aRole, "Wrong role for " + prettyName(aAccOrElmOrID) + "!"); 157 } 158 159 /** 160 * Return the role of the given accessible. Return -1 if accessible could not 161 * be retrieved. 162 * 163 * @param aAccOrElmOrID [in] The accessible, DOM element or element ID the 164 * accessible role is being requested for. 165 */ 166 function getRole(aAccOrElmOrID) { 167 var acc = getAccessible(aAccOrElmOrID); 168 if (!acc) { 169 return -1; 170 } 171 172 var role = -1; 173 try { 174 role = acc.role; 175 } catch (e) { 176 ok(false, "Role for " + aAccOrElmOrID + " could not be retrieved!"); 177 } 178 179 return role; 180 } 181 182 /** 183 * Analogy of SimpleTest.is function used to check the role. 184 */ 185 function isRole(aIdentifier, aRole, aMsg) { 186 var role = getRole(aIdentifier); 187 if (role == -1) { 188 return; 189 } 190 191 if (role == aRole) { 192 ok(true, aMsg); 193 return; 194 } 195 196 var got = roleToString(role); 197 var expected = roleToString(aRole); 198 199 ok(false, aMsg + "got '" + got + "', expected '" + expected + "'"); 200 }