KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > accessibility > AccessibleTable


1 /*
2  * @(#)AccessibleTable.java 1.9 03/12/19
3  *
4  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6  */

7
8 package javax.accessibility;
9
10 /**
11  * Class AccessibleTable describes a user-interface component that
12  * presents data in a two-dimensional table format.
13  *
14  * @version 1.2 10/12/99
15  * @author Lynn Monsanto
16  */

17 public interface AccessibleTable {
18
19     /**
20      * Returns the caption for the table.
21      *
22      * @return the caption for the table
23      */

24     public Accessible JavaDoc getAccessibleCaption();
25
26     /**
27      * Sets the caption for the table.
28      *
29      * @param a the caption for the table
30      */

31     public void setAccessibleCaption(Accessible JavaDoc a);
32
33     /**
34      * Returns the summary description of the table.
35      *
36      * @return the summary description of the table
37      */

38     public Accessible JavaDoc getAccessibleSummary();
39
40     /**
41      * Sets the summary description of the table
42      *
43      * @param a the summary description of the table
44      */

45     public void setAccessibleSummary(Accessible JavaDoc a);
46
47     /**
48      * Returns the number of rows in the table.
49      *
50      * @return the number of rows in the table
51      */

52     public int getAccessibleRowCount();
53
54     /**
55      * Returns the number of columns in the table.
56      *
57      * @return the number of columns in the table
58      */

59     public int getAccessibleColumnCount();
60
61     /**
62      * Returns the Accessible at a specified row and column
63      * in the table.
64      *
65      * @param r zero-based row of the table
66      * @param c zero-based column of the table
67      * @return the Accessible at the specified row and column
68      */

69     public Accessible JavaDoc getAccessibleAt(int r, int c);
70
71     /**
72      * Returns the number of rows occupied by the Accessible at
73      * a specified row and column in the table.
74      *
75      * @return the number of rows occupied by the Accessible at a
76      * given specified (row, column)
77      */

78     public int getAccessibleRowExtentAt(int r, int c);
79
80     /**
81      * Returns the number of columns occupied by the Accessible at
82      * a specified row and column in the table.
83      *
84      * @return the number of columns occupied by the Accessible at a
85      * given specified row and column
86      */

87     public int getAccessibleColumnExtentAt(int r, int c);
88
89     /**
90      * Returns the row headers as an AccessibleTable.
91      *
92      * @return an AccessibleTable representing the row
93      * headers
94      */

95     public AccessibleTable JavaDoc getAccessibleRowHeader();
96
97     /**
98      * Sets the row headers.
99      *
100      * @param table an AccessibleTable representing the
101      * row headers
102      */

103     public void setAccessibleRowHeader(AccessibleTable JavaDoc table);
104
105     /**
106      * Returns the column headers as an AccessibleTable.
107      *
108      * @return an AccessibleTable representing the column
109      * headers
110      */

111     public AccessibleTable JavaDoc getAccessibleColumnHeader();
112
113     /**
114      * Sets the column headers.
115      *
116      * @param table an AccessibleTable representing the
117      * column headers
118      */

119     public void setAccessibleColumnHeader(AccessibleTable JavaDoc table);
120
121     /**
122      * Returns the description of the specified row in the table.
123      *
124      * @param r zero-based row of the table
125      * @return the description of the row
126      */

127     public Accessible JavaDoc getAccessibleRowDescription(int r);
128
129     /**
130      * Sets the description text of the specified row of the table.
131      *
132      * @param r zero-based row of the table
133      * @param a the description of the row
134      */

135     public void setAccessibleRowDescription(int r, Accessible JavaDoc a);
136
137     /**
138      * Returns the description text of the specified column in the table.
139      *
140      * @param c zero-based column of the table
141      * @return the text description of the column
142      */

143     public Accessible JavaDoc getAccessibleColumnDescription(int c);
144
145     /**
146      * Sets the description text of the specified column in the table.
147      *
148      * @param c zero-based column of the table
149      * @param a the text description of the column
150      */

151     public void setAccessibleColumnDescription(int c, Accessible JavaDoc a);
152
153     /**
154      * Returns a boolean value indicating whether the accessible at
155      * a specified row and column is selected.
156      *
157      * @param r zero-based row of the table
158      * @param c zero-based column of the table
159      * @return the boolean value true if the accessible at the
160      * row and column is selected. Otherwise, the boolean value
161      * false
162      */

163     public boolean isAccessibleSelected(int r, int c);
164
165     /**
166      * Returns a boolean value indicating whether the specified row
167      * is selected.
168      *
169      * @param r zero-based row of the table
170      * @return the boolean value true if the specified row is selected.
171      * Otherwise, false.
172      */

173     public boolean isAccessibleRowSelected(int r);
174
175     /**
176      * Returns a boolean value indicating whether the specified column
177      * is selected.
178      *
179      * @param c zero-based column of the table
180      * @return the boolean value true if the specified column is selected.
181      * Otherwise, false.
182      */

183     public boolean isAccessibleColumnSelected(int c);
184
185     /**
186      * Returns the selected rows in a table.
187      *
188      * @return an array of selected rows where each element is a
189      * zero-based row of the table
190      */

191     public int [] getSelectedAccessibleRows();
192
193     /**
194      * Returns the selected columns in a table.
195      *
196      * @return an array of selected columns where each element is a
197      * zero-based column of the table
198      */

199     public int [] getSelectedAccessibleColumns();
200 }
201
202
203
Popular Tags