1/*
2 * Copyright (c) 2001, 2017, 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
26package javax.accessibility;
27
28/**
29 * Class {@code AccessibleExtendedTable} provides extended information about a
30 * user-interface component that presents data in a two-dimensional table
31 * format. Applications can determine if an object supports the
32 * {@code AccessibleExtendedTable} interface by first obtaining its
33 * {@code AccessibleContext} and then calling the
34 * {@link AccessibleContext#getAccessibleTable} method. If the return value is
35 * not {@code null} and the type of the return value is
36 * {@code 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 the table
47     *         cell offset from row == 0 and column == 0.
48     * @return the zero-based row of the table if one exists; otherwise -1
49     */
50    public int getAccessibleRow(int index);
51
52    /**
53     * Returns the column number of an index in the table.
54     *
55     * @param  index the zero-based index in the table. The index is the table
56     *         cell offset from row == 0 and column == 0.
57     * @return the zero-based column of the table if one exists; otherwise -1
58     */
59    public int getAccessibleColumn(int index);
60
61    /**
62     * Returns the index at a row and column in the table.
63     *
64     * @param  r zero-based row of the table
65     * @param  c zero-based column of the table
66     * @return the zero-based index in the table if one exists; otherwise -1.
67     *         The index is the table cell offset from row == 0 and column == 0.
68     */
69    public int getAccessibleIndex(int r, int c);
70}
71