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

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2010 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 import org.eclipse.swt.internal.SWTEventListener;
  17
  18 /**
  19  * Classes which implement this interface provide methods
  20  * that handle AccessibleTableCell events.
  21  * <p>
  22  * After creating an instance of a class that implements
  23  * this interface it can be added to an accessible using the
  24  * <code>addAccessibleTableCellListener</code> method and removed using
  25  * the <code>removeAccessibleTableCellListener</code> method.
  26  * </p>
  27  *
  28  * @see AccessibleTableCellAdapter
  29  * @see AccessibleTableCellEvent
  30  *
  31  * @since 3.6
  32  */
  33 public interface AccessibleTableCellListener extends SWTEventListener {
  34         /**
  35          * Returns the number of columns occupied by this cell accessible.
  36          * <p>
  37          * This is 1 if the specified cell is only in one column, or
  38          * more than 1 if the specified cell spans multiple columns.
  39          * </p>
  40          *
  41          * @param e an event object containing the following fields:<ul>
  42          * <li>[out] count - the 1 based number of columns spanned by the specified cell
  43          * </ul>
  44          */
  45         public void getColumnSpan(AccessibleTableCellEvent e);
  46
  47         /**
  48          * Returns the column headers as an array of cell accessibles.
  49          * TODO: doc that this is a more efficient way to get headers of a cell than TableListener.getRow/ColHeaders
  50          *
  51          * @param e an event object containing the following fields:<ul>
  52          * <li>[out] accessibles - an array of cell accessibles, or null if there are no column headers
  53          * </ul>
  54          */
  55         public void getColumnHeaders(AccessibleTableCellEvent e);
  56
  57         /**
  58          * Translates this cell accessible into the corresponding column index.
  59          *
  60          * @param e an event object containing the following fields:<ul>
  61          * <li>[out] index - the 0 based column index of the specified cell,
  62          *              or the index of the first column if the cell spans multiple columns
  63          * </ul>
  64          */
  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         public void getRowSpan(AccessibleTableCellEvent e);
  79
  80         /**
  81          * Returns the row headers as an array of cell accessibles.
  82          * TODO: doc that this is a more efficient way to get headers of a cell than TableListener.getRow/ColHeaders
  83          *
  84          * @param e an event object containing the following fields:<ul>
  85          * <li>[out] accessibles - an array of cell accessibles, or null if there are no row headers
  86          * </ul>
  87          */
  88         public void getRowHeaders(AccessibleTableCellEvent e);
  89
  90         /**
  91          * Translates this cell accessible into the corresponding row index.
  92          *
  93          * @param e an event object containing the following fields:<ul>
  94          * <li>[out] index - the 0 based row index of the specified cell,
  95          *              or the index of the first row if the cell spans multiple rows
  96          * </ul>
  97          */
  98         public void getRowIndex(AccessibleTableCellEvent e);
  99
 100         /**
 101          * Returns the accessible for the table containing this cell.
 102          *
 103          * @param e an event object containing the following fields:<ul>
 104          * <li>[out] accessible - the accessible for the containing table
 105          * </ul>
 106          */
 107         public void getTable(AccessibleTableCellEvent e);
 108
 109         /**
 110          * Returns a boolean value indicating whether this cell is selected.
 111          *
 112          * @param e an event object containing the following fields:<ul>
 113          * <li>[out] isSelected - true if the specified cell is selected and false otherwise
 114          * </ul>
 115          */
 116         public void isSelected(AccessibleTableCellEvent e);
 117 }