bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/accessibility/AccessibleTableAdapter.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2016 IBM Corporation and others.
   3  *
   4  * This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License 2.0
   6  * which accompanies this distribution, and is available at
   7  * https://www.eclipse.org/legal/epl-2.0/
   8  *
   9  * SPDX-License-Identifier: EPL-2.0
  10  *
  11  * Contributors:
  12  *     IBM Corporation - initial API and implementation
  13  *******************************************************************************/
  14 package org.eclipse.swt.accessibility;
  15
  16 /**
  17  * This adapter class provides default implementations for the
  18  * methods in the <code>AccessibleTableListener</code> interface.
  19  * <p>
  20  * Classes that wish to deal with <code>AccessibleTable</code> events can
  21  * extend this class and override only the methods that they are
  22  * interested in.
  23  * </p><p>
  24  * Many methods in this adapter return cell accessible objects,
  25  * which should implement <code>AccessibleTableCellListener</code>.
  26  * </p>
  27  *
  28  * @see AccessibleTableAdapter
  29  * @see AccessibleTableEvent
  30  * @see AccessibleTableCellListener
  31  * @see AccessibleTableCellEvent
  32  *
  33  * @since 3.6
  34  */
  35 public class AccessibleTableAdapter implements AccessibleTableListener {
  36         /**
  37          * Deselects one column, leaving other selected columns selected (if any).
  38          *
  39          * @param e an event object containing the following fields:<ul>
  40          * <li>[in] column - 0 based index of the column to be unselected.</li>
  41          * <li>[out] result - set to {@link ACC#OK} if the column was deselected.</li>
  42          * </ul>
  43          */
  44         @Override
  45         public void deselectColumn(AccessibleTableEvent e) {}
  46
  47         /**
  48          * Deselects one row, leaving other selected rows selected (if any).
  49          *
  50          * @param e an event object containing the following fields:<ul>
  51          * <li>[in] row - 0 based index of the row to be unselected</li>
  52          * <li>[out] result - set to {@link ACC#OK} if the row was deselected.</li>
  53          * </ul>
  54          */
  55         @Override
  56         public void deselectRow(AccessibleTableEvent e) {}
  57
  58         /**
  59          * Returns the caption for the table.
  60          *
  61          * @param e an event object containing the following fields:<ul>
  62          * <li>[out] accessible - the caption for the table, or null if the table does not have a caption</li>
  63          * </ul>
  64          *
  65          * @deprecated IAccessibleTable2::caption is deprecated, instead use the
  66          * IA2_RELATION_LABELED_BY relation to create a relation between the table and its caption.
  67          */
  68         @Deprecated
  69         @Override
  70         public void getCaption(AccessibleTableEvent e) {}
  71
  72         /**
  73          * Returns the accessible object at the specified row and column in the table.
  74          *
  75          * @param e an event object containing the following fields:<ul>
  76          * <li>[in] row - the 0 based row index for which to retrieve the accessible cell</li>
  77          * <li>[in] column - the 0 based column index for which to retrieve the accessible cell</li>
  78          * <li>[out] accessible - the table cell at the specified row and column index,
  79          *              or null if the row or column index are not valid</li>
  80          * </ul>
  81          */
  82         @Override
  83         public void getCell(AccessibleTableEvent e) {}
  84
  85         /**
  86          * Returns the accessible object for the specified column in the table.
  87          *
  88          * @param e an event object containing the following fields:<ul>
  89          * <li>[in] column - the 0 based column index for which to retrieve the accessible column</li>
  90          * <li>[out] accessible - the table column at the specified column index,
  91          *              or null if the column index is not valid</li>
  92          * </ul>
  93          */
  94         @Override
  95         public void getColumn(AccessibleTableEvent e) {}
  96
  97         /**
  98          * Returns the total number of columns in the table.
  99          *
 100          * @param e an event object containing the following fields:<ul>
 101          * <li>[out] count - the number of columns in the table</li>
 102          * </ul>
 103          */
 104         @Override
 105         public void getColumnCount(AccessibleTableEvent e) {}
 106
 107         /**
 108          * Returns the description text of the specified column in the table.
 109          *
 110          * @param e an event object containing the following fields:<ul>
 111          * <li>[in] column - the 0 based index of the column for which to retrieve the description</li>
 112          * <li>[out] result - the description text of the specified column in the table,
 113          *              or null if the column does not have a description</li>
 114          * </ul>
 115          */
 116         @Override
 117         public void getColumnDescription(AccessibleTableEvent e) {}
 118
 119         /**
 120          * Returns the accessible object for the column header.
 121          *
 122          * @param e an event object containing the following fields:<ul>
 123          * <li>[out] accessible - an accessible object representing the column header,
 124          *              or null if there is no column header</li>
 125          * </ul>
 126          */
 127         @Override
 128         public void getColumnHeader(AccessibleTableEvent e) {}
 129
 130         /**
 131          * Returns the column header cells as an array of accessible objects.
 132          *
 133          * @param e an event object containing the following fields:<ul>
 134          * <li>[out] accessibles - an array of accessible objects representing column header cells,
 135          *              or null if there are no column header cells</li>
 136          * </ul>
 137          */
 138         @Override
 139         public void getColumnHeaderCells(AccessibleTableEvent e) {}
 140
 141         /**
 142          * Returns the columns as an array of accessible objects.
 143          *
 144          * @param e an event object containing the following fields:<ul>
 145          * <li>[out] accessibles - an array of accessible objects representing columns,
 146          *              or null if there are no columns</li>
 147          * </ul>
 148          */
 149         @Override
 150         public void getColumns(AccessibleTableEvent e) {}
 151
 152         /**
 153          * Returns the accessible object for the specified row in the table.
 154          *
 155          * @param e an event object containing the following fields:<ul>
 156          * <li>[in] row - the 0 based row index for which to retrieve the accessible row</li>
 157          * <li>[out] accessible - the table row at the specified row index,
 158          *              or null if the row index is not valid</li>
 159          * </ul>
 160          */
 161         @Override
 162         public void getRow(AccessibleTableEvent e) {}
 163
 164         /**
 165          * Returns the total number of rows in the table.
 166          *
 167          * @param e an event object containing the following fields:<ul>
 168          * <li>[out] count - the number of rows in the table</li>
 169          * </ul>
 170          */
 171         @Override
 172         public void getRowCount(AccessibleTableEvent e) {}
 173
 174         /**
 175          * Returns the description text of the specified row in the table.
 176          *
 177          * @param e an event object containing the following fields:<ul>
 178          * <li>[in] row - the 0 based index of the row for which to retrieve the description</li>
 179          * <li>[out] result - the description text of the specified row in the table,
 180          *              or null if the row does not have a description</li>
 181          * </ul>
 182          */
 183         @Override
 184         public void getRowDescription(AccessibleTableEvent e) {}
 185
 186         /**
 187          * Returns the accessible object for the row header.
 188          *
 189          * @param e an event object containing the following fields:<ul>
 190          * <li>[out] accessible - an accessible object representing the row header,
 191          *              or null if there is no row header</li>
 192          * </ul>
 193          */
 194         @Override
 195         public void getRowHeader(AccessibleTableEvent e) {}
 196
 197         /**
 198          * Returns the row header cells as an array of accessible objects.
 199          *
 200          * @param e an event object containing the following fields:<ul>
 201          * <li>[out] accessibles - an array of accessible objects representing row header cells,
 202          *              or null if there are no row header cells</li>
 203          * </ul>
 204          */
 205         @Override
 206         public void getRowHeaderCells(AccessibleTableEvent e) {}
 207
 208         /**
 209          * Returns the rows as an array of accessible objects.
 210          *
 211          * @param e an event object containing the following fields:<ul>
 212          * <li>[out] accessibles - an array of accessible objects representing rows,
 213          *              or null if there are no rows</li>
 214          * </ul>
 215          */
 216         @Override
 217         public void getRows(AccessibleTableEvent e) {}
 218
 219         /**
 220          * Returns the number of selected cells.
 221          *
 222          * @param e an event object containing the following fields:<ul>
 223          * <li>[out] count -  the number of cells currently selected</li>
 224          * </ul>
 225          */
 226         @Override
 227         public void getSelectedCellCount(AccessibleTableEvent e) {}
 228
 229         /**
 230          * Returns the currently selected cells.
 231          *
 232          * @param e an event object containing the following fields:<ul>
 233          * <li>[out] accessibles - array containing the selected accessible cells</li>
 234          * </ul>
 235          */
 236         @Override
 237         public void getSelectedCells(AccessibleTableEvent e) {}
 238
 239         /**
 240          * Returns the number of selected columns.
 241          *
 242          * @param e an event object containing the following fields:<ul>
 243          * <li>[out] count - the number of columns currently selected</li>
 244          * </ul>
 245          */
 246         @Override
 247         public void getSelectedColumnCount(AccessibleTableEvent e) {}
 248
 249         /**
 250          * Returns the column indexes that are currently selected.
 251          *
 252          * @param e an event object containing the following fields:<ul>
 253          * <li>[out] selected - an array of 0 based column indexes of selected columns</li>
 254          * </ul>
 255          */
 256         @Override
 257         public void getSelectedColumns(AccessibleTableEvent e) {}
 258
 259         /**
 260          * Returns the number of selected rows.
 261          *
 262          * @param e an event object containing the following fields:<ul>
 263          * <li>[out] count - the number of rows currently selected</li>
 264          * </ul>
 265          */
 266         @Override
 267         public void getSelectedRowCount(AccessibleTableEvent e) {}
 268
 269         /**
 270          * Returns the row indexes that are currently selected.
 271          *
 272          * @param e an event object containing the following fields:<ul>
 273          * <li>[out] selected - an array of 0 based row indexes of selected rows</li>
 274          * </ul>
 275          */
 276         @Override
 277         public void getSelectedRows(AccessibleTableEvent e) {}
 278
 279         /**
 280          * Returns the summary description of the table.
 281          *
 282          * @param e an event object containing the following fields:<ul>
 283          * <li>[out] accessible - the summary for the table,
 284          *              or null if the table does not have a summary</li>
 285          * </ul>
 286          *
 287          * @deprecated IAccessibleTable2::summary is deprecated, instead use the
 288          * IA2_RELATION_DESCRIBED_BY relation to create a relation between the table and its summary.
 289          */
 290         @Deprecated
 291         @Override
 292         public void getSummary(AccessibleTableEvent e) {}
 293
 294         /**
 295          * Returns the visible columns as an array of accessible objects.
 296          *
 297          * @param e an event object containing the following fields:<ul>
 298          * <li>[out] accessibles - an array of accessible objects representing visible columns,
 299          *              or null if there are no visible columns</li>
 300          * </ul>
 301          */
 302         @Override
 303         public void getVisibleColumns(AccessibleTableEvent e) {}
 304
 305         /**
 306          * Returns the visible rows as an array of accessible objects.
 307          *
 308          * @param e an event object containing the following fields:<ul>
 309          * <li>[out] accessibles - an array of accessible objects representing visible rows,
 310          *              or null if there are no visible rows</li>
 311          * </ul>
 312          */
 313         @Override
 314         public void getVisibleRows(AccessibleTableEvent e) {}
 315
 316         /**
 317          * Returns a boolean value indicating whether the specified column is
 318          * completely selected.
 319          *
 320          * @param e an event object containing the following fields:<ul>
 321          * <li>[in] column - 0 based index of the column for which to determine whether it is selected</li>
 322          * <li>[out] isSelected - true if the specified column is selected completely, and false otherwise</li>
 323          * </ul>
 324          */
 325         @Override
 326         public void isColumnSelected(AccessibleTableEvent e) {}
 327
 328         /**
 329          * Returns a boolean value indicating whether the specified row is
 330          * completely selected.
 331          *
 332          * @param e an event object containing the following fields:<ul>
 333          * <li>[in] row - 0 based index of the row for which to determine whether it is selected</li>
 334          * <li>[out] isSelected - true if the specified row is selected completely, and false otherwise</li>
 335          * </ul>
 336          */
 337         @Override
 338         public void isRowSelected(AccessibleTableEvent e) {}
 339
 340         /**
 341          * Selects a column.
 342          *
 343          * @param e an event object containing the following fields:<ul>
 344          * <li>[in] column - 0 based index of the column to be selected</li>
 345          * <li>[out] result - set to {@link ACC#OK} if the column was selected.</li>
 346          * </ul>
 347          */
 348         @Override
 349         public void selectColumn(AccessibleTableEvent e) {}
 350
 351         /**
 352          * Selects a row.
 353          *
 354          * @param e an event object containing the following fields:<ul>
 355          * <li>[in] row - 0 based index of the row to be selected</li>
 356          * <li>[out] result - set to {@link ACC#OK} if the row was selected.</li>
 357          * </ul>
 358          */
 359         @Override
 360         public void selectRow(AccessibleTableEvent e) {}
 361
 362         /**
 363          * Selects a column and deselects all previously selected columns.
 364          *
 365          * @param e an event object containing the following fields:<ul>
 366          * <li>[in] column - 0 based index of the column to be selected</li>
 367          * <li>[out] result - set to {@link ACC#OK} if the column was selected.</li>
 368          * </ul>
 369          */
 370         @Override
 371         public void setSelectedColumn(AccessibleTableEvent e) {}
 372
 373         /**
 374          * Selects a row and deselects all previously selected rows.
 375          *
 376          * @param e an event object containing the following fields:<ul>
 377          * <li>[in] row - 0 based index of the row to be selected</li>
 378          * <li>[out] result - set to {@link ACC#OK} if the row was selected.</li>
 379          * </ul>
 380          */
 381         @Override
 382         public void setSelectedRow(AccessibleTableEvent e) {}
 383 }