blob: 24fe2c4969d30e098a57dc22e0a6474401bc2183 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 2001-2006 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25package javax.accessibility;
26
27/**
28 * Class AccessibleExtendedTable provides extended information about
29 * a user-interface component that presents data in a two-dimensional
30 * table format.
31 * Applications can determine if an object supports the
32 * AccessibleExtendedTable interface by first obtaining its
33 * AccessibleContext and then calling the
34 * {@link AccessibleContext#getAccessibleTable} method.
35 * If the return value is not null and the type of the return value is
36 * AccessibleExtendedTable, the object supports this interface.
37 *
38 * @author Lynn Monsanto
39 * @since 1.4
40 */
41public interface AccessibleExtendedTable extends AccessibleTable {
42
43 /**
44 * Returns the row number of an index in the table.
45 *
46 * @param index the zero-based index in the table. The index is
47 * the table cell offset from row == 0 and column == 0.
48 * @return the zero-based row of the table if one exists;
49 * otherwise -1.
50 */
51 public int getAccessibleRow(int index);
52
53 /**
54 * Returns the column number of an index in the table.
55 *
56 * @param index the zero-based index in the table. The index is
57 * the table cell offset from row == 0 and column == 0.
58 * @return the zero-based column of the table if one exists;
59 * otherwise -1.
60 */
61 public int getAccessibleColumn(int index);
62
63 /*
64 * Returns the index at a row and column in the table.
65 *
66 * @param r zero-based row of the table
67 * @param c zero-based column of the table
68 * @return the zero-based index in the table if one exists;
69 * otherwise -1. The index is the table cell offset from
70 * row == 0 and column == 0.
71 */
72 public int getAccessibleIndex(int r, int c);
73}