jdk/src/share/classes/javax/accessibility/AccessibleExtendedTable.java
author darcy
Tue, 06 Aug 2013 16:45:43 -0700
changeset 19215 42891cf030cb
parent 5506 202f599c92aa
permissions -rw-r--r--
8022453: Fix doclint issues in javax.accessibility Reviewed-by: prr
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
19215
42891cf030cb 8022453: Fix doclint issues in javax.accessibility
darcy
parents: 5506
diff changeset
     2
 * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
package javax.accessibility;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
  * Class AccessibleExtendedTable provides extended information about
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
  * a user-interface component that presents data in a two-dimensional
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
  * table format.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
  * Applications can determine if an object supports the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
  * AccessibleExtendedTable interface by first obtaining its
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
  * AccessibleContext and then calling the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
  * {@link AccessibleContext#getAccessibleTable} method.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
  * If the return value is not null and the type of the return value is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
  * AccessibleExtendedTable, the object supports this interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
  *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
  * @author      Lynn Monsanto
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
  * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
  */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
public interface AccessibleExtendedTable extends AccessibleTable {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
     /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
      * Returns the row number of an index in the table.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
      *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
      * @param index the zero-based index in the table.  The index is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
      * the table cell offset from row == 0 and column == 0.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
      * @return the zero-based row of the table if one exists;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
      * otherwise -1.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
      */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
     public int getAccessibleRow(int index);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
     /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
      * Returns the column number of an index in the table.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
      *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
      * @param index the zero-based index in the table.  The index is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
      * the table cell offset from row == 0 and column == 0.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
      * @return the zero-based column of the table if one exists;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
      * otherwise -1.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
      */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
     public int getAccessibleColumn(int index);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
19215
42891cf030cb 8022453: Fix doclint issues in javax.accessibility
darcy
parents: 5506
diff changeset
    63
    /**
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
      * Returns the index at a row and column in the table.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
      *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
      * @param r zero-based row of the table
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
      * @param c zero-based column of the table
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
      * @return the zero-based index in the table if one exists;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
      * otherwise -1.  The index is  the table cell offset from
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
      * row == 0 and column == 0.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
      */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     public int getAccessibleIndex(int r, int c);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
}