Showing the changes to java/pkg/javax/accessibility/AccessibleTable.java (1 of 18352 files). Show all
Unified · Split
| @@ -0,0 +1,218 @@ | ||
| 1 | +/* | |
| 2 | + * Copyright (c) 1999, 2006, Oracle and/or its affiliates. All rights reserved. | |
| 3 | + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
| 4 | + * | |
| 5 | + * This code is free software; you can redistribute it and/or modify it | |
| 6 | + * under the terms of the GNU General Public License version 2 only, as | |
| 7 | + * published by the Free Software Foundation. Oracle designates this | |
| 8 | + * particular file as subject to the "Classpath" exception as provided | |
| 9 | + * by Oracle in the LICENSE file that accompanied this code. | |
| 10 | + * | |
| 11 | + * This code is distributed in the hope that it will be useful, but WITHOUT | |
| 12 | + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 13 | + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 14 | + * version 2 for more details (a copy is included in the LICENSE file that | |
| 15 | + * accompanied this code). | |
| 16 | + * | |
| 17 | + * You should have received a copy of the GNU General Public License version | |
| 18 | + * 2 along with this work; if not, write to the Free Software Foundation, | |
| 19 | + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | |
| 20 | + * | |
| 21 | + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | |
| 22 | + * or visit www.oracle.com if you need additional information or have any | |
| 23 | + * questions. | |
| 24 | + */ | |
| 25 | + | |
| 26 | +package javax.accessibility; | |
| 27 | + | |
| 28 | +/** | |
| 29 | + * Class AccessibleTable describes a user-interface component that | |
| 30 | + * presents data in a two-dimensional table format. | |
| 31 | + * | |
| 32 | + * @author Lynn Monsanto | |
| 33 | + * @since 1.3 | |
| 34 | + */ | |
| 35 | +public interface AccessibleTable { | |
| 36 | + | |
| 37 | + /** | |
| 38 | + * Returns the caption for the table. | |
| 39 | + * | |
| 40 | + * @return the caption for the table | |
| 41 | + */ | |
| 42 | + public Accessible getAccessibleCaption(); | |
| 43 | + | |
| 44 | + /** | |
| 45 | + * Sets the caption for the table. | |
| 46 | + * | |
| 47 | + * @param a the caption for the table | |
| 48 | + */ | |
| 49 | + public void setAccessibleCaption(Accessible a); | |
| 50 | + | |
| 51 | + /** | |
| 52 | + * Returns the summary description of the table. | |
| 53 | + * | |
| 54 | + * @return the summary description of the table | |
| 55 | + */ | |
| 56 | + public Accessible getAccessibleSummary(); | |
| 57 | + | |
| 58 | + /** | |
| 59 | + * Sets the summary description of the table | |
| 60 | + * | |
| 61 | + * @param a the summary description of the table | |
| 62 | + */ | |
| 63 | + public void setAccessibleSummary(Accessible a); | |
| 64 | + | |
| 65 | + /** | |
| 66 | + * Returns the number of rows in the table. | |
| 67 | + * | |
| 68 | + * @return the number of rows in the table | |
| 69 | + */ | |
| 70 | + public int getAccessibleRowCount(); | |
| 71 | + | |
| 72 | + /** | |
| 73 | + * Returns the number of columns in the table. | |
| 74 | + * | |
| 75 | + * @return the number of columns in the table | |
| 76 | + */ | |
| 77 | + public int getAccessibleColumnCount(); | |
| 78 | + | |
| 79 | + /** | |
| 80 | + * Returns the Accessible at a specified row and column | |
| 81 | + * in the table. | |
| 82 | + * | |
| 83 | + * @param r zero-based row of the table | |
| 84 | + * @param c zero-based column of the table | |
| 85 | + * @return the Accessible at the specified row and column | |
| 86 | + */ | |
| 87 | + public Accessible getAccessibleAt(int r, int c); | |
| 88 | + | |
| 89 | + /** | |
| 90 | + * Returns the number of rows occupied by the Accessible at | |
| 91 | + * a specified row and column in the table. | |
| 92 | + * | |
| 93 | + * @return the number of rows occupied by the Accessible at a | |
| 94 | + * given specified (row, column) | |
| 95 | + */ | |
| 96 | + public int getAccessibleRowExtentAt(int r, int c); | |
| 97 | + | |
| 98 | + /** | |
| 99 | + * Returns the number of columns occupied by the Accessible at | |
| 100 | + * a specified row and column in the table. | |
| 101 | + * | |
| 102 | + * @return the number of columns occupied by the Accessible at a | |
| 103 | + * given specified row and column | |
| 104 | + */ | |
| 105 | + public int getAccessibleColumnExtentAt(int r, int c); | |
| 106 | + | |
| 107 | + /** | |
| 108 | + * Returns the row headers as an AccessibleTable. | |
| 109 | + * | |
| 110 | + * @return an AccessibleTable representing the row | |
| 111 | + * headers | |
| 112 | + */ | |
| 113 | + public AccessibleTable getAccessibleRowHeader(); | |
| 114 | + | |
| 115 | + /** | |
| 116 | + * Sets the row headers. | |
| 117 | + * | |
| 118 | + * @param table an AccessibleTable representing the | |
| 119 | + * row headers | |
| 120 | + */ | |
| 121 | + public void setAccessibleRowHeader(AccessibleTable table); | |
| 122 | + | |
| 123 | + /** | |
| 124 | + * Returns the column headers as an AccessibleTable. | |
| 125 | + * | |
| 126 | + * @return an AccessibleTable representing the column | |
| 127 | + * headers | |
| 128 | + */ | |
| 129 | + public AccessibleTable getAccessibleColumnHeader(); | |
| 130 | + | |
| 131 | + /** | |
| 132 | + * Sets the column headers. | |
| 133 | + * | |
| 134 | + * @param table an AccessibleTable representing the | |
| 135 | + * column headers | |
| 136 | + */ | |
| 137 | + public void setAccessibleColumnHeader(AccessibleTable table); | |
| 138 | + | |
| 139 | + /** | |
| 140 | + * Returns the description of the specified row in the table. | |
| 141 | + * | |
| 142 | + * @param r zero-based row of the table | |
| 143 | + * @return the description of the row | |
| 144 | + */ | |
| 145 | + public Accessible getAccessibleRowDescription(int r); | |
| 146 | + | |
| 147 | + /** | |
| 148 | + * Sets the description text of the specified row of the table. | |
| 149 | + * | |
| 150 | + * @param r zero-based row of the table | |
| 151 | + * @param a the description of the row | |
| 152 | + */ | |
| 153 | + public void setAccessibleRowDescription(int r, Accessible a); | |
| 154 | + | |
| 155 | + /** | |
| 156 | + * Returns the description text of the specified column in the table. | |
| 157 | + * | |
| 158 | + * @param c zero-based column of the table | |
| 159 | + * @return the text description of the column | |
| 160 | + */ | |
| 161 | + public Accessible getAccessibleColumnDescription(int c); | |
| 162 | + | |
| 163 | + /** | |
| 164 | + * Sets the description text of the specified column in the table. | |
| 165 | + * | |
| 166 | + * @param c zero-based column of the table | |
| 167 | + * @param a the text description of the column | |
| 168 | + */ | |
| 169 | + public void setAccessibleColumnDescription(int c, Accessible a); | |
| 170 | + | |
| 171 | + /** | |
| 172 | + * Returns a boolean value indicating whether the accessible at | |
| 173 | + * a specified row and column is selected. | |
| 174 | + * | |
| 175 | + * @param r zero-based row of the table | |
| 176 | + * @param c zero-based column of the table | |
| 177 | + * @return the boolean value true if the accessible at the | |
| 178 | + * row and column is selected. Otherwise, the boolean value | |
| 179 | + * false | |
| 180 | + */ | |
| 181 | + public boolean isAccessibleSelected(int r, int c); | |
| 182 | + | |
| 183 | + /** | |
| 184 | + * Returns a boolean value indicating whether the specified row | |
| 185 | + * is selected. | |
| 186 | + * | |
| 187 | + * @param r zero-based row of the table | |
| 188 | + * @return the boolean value true if the specified row is selected. | |
| 189 | + * Otherwise, false. | |
| 190 | + */ | |
| 191 | + public boolean isAccessibleRowSelected(int r); | |
| 192 | + | |
| 193 | + /** | |
| 194 | + * Returns a boolean value indicating whether the specified column | |
| 195 | + * is selected. | |
| 196 | + * | |
| 197 | + * @param c zero-based column of the table | |
| 198 | + * @return the boolean value true if the specified column is selected. | |
| 199 | + * Otherwise, false. | |
| 200 | + */ | |
| 201 | + public boolean isAccessibleColumnSelected(int c); | |
| 202 | + | |
| 203 | + /** | |
| 204 | + * Returns the selected rows in a table. | |
| 205 | + * | |
| 206 | + * @return an array of selected rows where each element is a | |
| 207 | + * zero-based row of the table | |
| 208 | + */ | |
| 209 | + public int [] getSelectedAccessibleRows(); | |
| 210 | + | |
| 211 | + /** | |
| 212 | + * Returns the selected columns in a table. | |
| 213 | + * | |
| 214 | + * @return an array of selected columns where each element is a | |
| 215 | + * zero-based column of the table | |
| 216 | + */ | |
| 217 | + public int [] getSelectedAccessibleColumns(); | |
| 218 | +} | |