bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/accessibility/AccessibleTableCellAdapter.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>AccessibleTableCellListener</code> interface.
  19  * <p>
  20  * Classes that wish to deal with <code>AccessibleTableCell</code> events can
  21  * extend this class and override only the methods that they are
  22  * interested in.
  23  * </p>
  24  *
  25  * @see AccessibleTableCellListener
  26  * @see AccessibleTableCellEvent
  27  *
  28  * @since 3.6
  29  */
  30 public class AccessibleTableCellAdapter implements AccessibleTableCellListener {
  31         /**
  32          * Returns the number of columns occupied by this cell accessible.
  33          * <p>
  34          * This is 1 if the specified cell is only in one column, or
  35          * more than 1 if the specified cell spans multiple columns.
  36          * </p>
  37          *
  38          * @param e an event object containing the following fields:<ul>
  39          * <li>[out] count - the 1 based number of columns spanned by the specified cell
  40          * </ul>
  41          */
  42         @Override
  43         public void getColumnSpan(AccessibleTableCellEvent e) {}
  44
  45         /**
  46          * Returns the column headers as an array of cell accessibles.
  47          * TODO: doc that this is a more efficient way to get headers of a cell than TableListener.getRow/ColHeaders
  48          *
  49          * @param e an event object containing the following fields:<ul>
  50          * <li>[out] accessibles - an array of cell accessibles, or null if there are no column headers
  51          * </ul>
  52          */
  53         @Override
  54         public void getColumnHeaders(AccessibleTableCellEvent e) {}
  55
  56         /**
  57          * Translates this cell accessible into the corresponding column index.
  58          *
  59          * @param e an event object containing the following fields:<ul>
  60          * <li>[out] index - the 0 based column index of the specified cell,
  61          *              or the index of the first column if the cell spans multiple columns
  62          * </ul>
  63          */
  64         @Override
  65         public void getColumnIndex(AccessibleTableCellEvent e) {}
  66
  67         /**
  68          * Returns the number of rows occupied by this cell accessible.
  69          * <p>
  70          * This is 1 if the specified cell is only in one row, or
  71          * more than 1 if the specified cell spans multiple rows.
  72          * </p>
  73          *
  74          * @param e an event object containing the following fields:<ul>
  75          * <li>[out] count - the 1 based number of rows spanned by the specified cell
  76          * </ul>
  77          */
  78         @Override
  79         public void getRowSpan(AccessibleTableCellEvent e) {}
  80
  81         /**
  82          * Returns the row headers as an array of cell accessibles.
  83          * TODO: doc that this is a more efficient way to get headers of a cell than TableListener.getRow/ColHeaders
  84          *
  85          * @param e an event object containing the following fields:<ul>
  86          * <li>[out] accessibles - an array of cell accessibles, or null if there are no row headers
  87          * </ul>
  88          */
  89         @Override
  90         public void getRowHeaders(AccessibleTableCellEvent e) {}
  91
  92         /**
  93          * Translates this cell accessible into the corresponding row index.
  94          *
  95          * @param e an event object containing the following fields:<ul>
  96          * <li>[out] index - the 0 based row index of the specified cell,
  97          *              or the index of the first row if the cell spans multiple rows
  98          * </ul>
  99          */
 100         @Override
 101         public void getRowIndex(AccessibleTableCellEvent e) {}
 102
 103         /**
 104          * Returns the accessible for the table containing this cell.
 105          *
 106          * @param e an event object containing the following fields:<ul>
 107          * <li>[out] accessible - the accessible for the containing table
 108          * </ul>
 109          */
 110         @Override
 111         public void getTable(AccessibleTableCellEvent e) {}
 112
 113         /**
 114          * Returns a boolean value indicating whether this cell is selected.
 115          *
 116          * @param e an event object containing the following fields:<ul>
 117          * <li>[out] isSelected - true if the specified cell is selected and false otherwise
 118          * </ul>
 119          */
 120         @Override
 121         public void isSelected(AccessibleTableCellEvent e) {}
 122 }