View Javadoc
1   /*
2    * Copyright (c) 1999, 2013, 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       * @param r zero-based row of the table
94       * @param c zero-based column of the table
95       * @return the number of rows occupied by the Accessible at a
96       * given specified (row, column)
97       */
98      public int getAccessibleRowExtentAt(int r, int c);
99  
100     /**
101      * Returns the number of columns occupied by the Accessible at
102      * a specified row and column in the table.
103      *
104      * @param r zero-based row of the table
105      * @param c zero-based column of the table
106      * @return the number of columns occupied by the Accessible at a
107      * given specified row and column
108      */
109     public int getAccessibleColumnExtentAt(int r, int c);
110 
111     /**
112      * Returns the row headers as an AccessibleTable.
113      *
114      * @return an AccessibleTable representing the row
115      * headers
116      */
117     public AccessibleTable getAccessibleRowHeader();
118 
119     /**
120      * Sets the row headers.
121      *
122      * @param table an AccessibleTable representing the
123      * row headers
124      */
125     public void setAccessibleRowHeader(AccessibleTable table);
126 
127     /**
128      * Returns the column headers as an AccessibleTable.
129      *
130      * @return an AccessibleTable representing the column
131      * headers
132      */
133     public AccessibleTable getAccessibleColumnHeader();
134 
135     /**
136      * Sets the column headers.
137      *
138      * @param table an AccessibleTable representing the
139      * column headers
140      */
141     public void setAccessibleColumnHeader(AccessibleTable table);
142 
143     /**
144      * Returns the description of the specified row in the table.
145      *
146      * @param r zero-based row of the table
147      * @return the description of the row
148      */
149     public Accessible getAccessibleRowDescription(int r);
150 
151     /**
152      * Sets the description text of the specified row of the table.
153      *
154      * @param r zero-based row of the table
155      * @param a the description of the row
156      */
157     public void setAccessibleRowDescription(int r, Accessible a);
158 
159     /**
160      * Returns the description text of the specified column in the table.
161      *
162      * @param c zero-based column of the table
163      * @return the text description of the column
164      */
165     public Accessible getAccessibleColumnDescription(int c);
166 
167     /**
168      * Sets the description text of the specified column in the table.
169      *
170      * @param c zero-based column of the table
171      * @param a the text description of the column
172      */
173     public void setAccessibleColumnDescription(int c, Accessible a);
174 
175     /**
176      * Returns a boolean value indicating whether the accessible at
177      * a specified row and column is selected.
178      *
179      * @param r zero-based row of the table
180      * @param c zero-based column of the table
181      * @return the boolean value true if the accessible at the
182      * row and column is selected. Otherwise, the boolean value
183      * false
184      */
185     public boolean isAccessibleSelected(int r, int c);
186 
187     /**
188      * Returns a boolean value indicating whether the specified row
189      * is selected.
190      *
191      * @param r zero-based row of the table
192      * @return the boolean value true if the specified row is selected.
193      * Otherwise, false.
194      */
195     public boolean isAccessibleRowSelected(int r);
196 
197     /**
198      * Returns a boolean value indicating whether the specified column
199      * is selected.
200      *
201      * @param c zero-based column of the table
202      * @return the boolean value true if the specified column is selected.
203      * Otherwise, false.
204      */
205     public boolean isAccessibleColumnSelected(int c);
206 
207     /**
208      * Returns the selected rows in a table.
209      *
210      * @return an array of selected rows where each element is a
211      * zero-based row of the table
212      */
213     public int [] getSelectedAccessibleRows();
214 
215     /**
216      * Returns the selected columns in a table.
217      *
218      * @return an array of selected columns where each element is a
219      * zero-based column of the table
220      */
221     public int [] getSelectedAccessibleColumns();
222 }