AccessibleTableCellListener.java

/*******************************************************************************
 * Copyright (c) 2009, 2010, 2012 IBM Corporation, Gerhardt Informatics Kft. and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Gerhardt Informatics Kft. - GEFGWT port
 *******************************************************************************/
package org.eclipse.swt.accessibility;

import org.eclipse.swt.events.SWTEventListener;

/**
 * Classes which implement this interface provide methods that handle
 * AccessibleTableCell events.
 * <p>
 * After creating an instance of a class that implements this interface it can
 * be added to an accessible using the
 * <code>addAccessibleTableCellListener</code> method and removed using the
 * <code>removeAccessibleTableCellListener</code> method.
 * </p>
 * 
 * @see AccessibleTableCellAdapter
 * @see AccessibleTableCellEvent
 * 
 * @since 3.6
 */
public interface AccessibleTableCellListener extends SWTEventListener {
	/**
	 * Returns the number of columns occupied by this cell accessible.
	 * <p>
	 * This is 1 if the specified cell is only in one column, or more than 1 if
	 * the specified cell spans multiple columns.
	 * </p>
	 * 
	 * @param e
	 *            an event object containing the following fields:
	 *            <ul>
	 *            <li>[out] count - the 1 based number of columns spanned by the
	 *            specified cell
	 *            </ul>
	 */
	public void getColumnSpan(AccessibleTableCellEvent e);

	/**
	 * Returns the column headers as an array of cell accessibles. TODO: doc
	 * that this is a more efficient way to get headers of a cell than
	 * TableListener.getRow/ColHeaders
	 * 
	 * @param e
	 *            an event object containing the following fields:
	 *            <ul>
	 *            <li>[out] accessibles - an array of cell accessibles, or null
	 *            if there are no column headers
	 *            </ul>
	 */
	public void getColumnHeaders(AccessibleTableCellEvent e);

	/**
	 * Translates this cell accessible into the corresponding column index.
	 * 
	 * @param e
	 *            an event object containing the following fields:
	 *            <ul>
	 *            <li>[out] index - the 0 based column index of the specified
	 *            cell, or the index of the first column if the cell spans
	 *            multiple columns
	 *            </ul>
	 */
	public void getColumnIndex(AccessibleTableCellEvent e);

	/**
	 * Returns the number of rows occupied by this cell accessible.
	 * <p>
	 * This is 1 if the specified cell is only in one row, or more than 1 if the
	 * specified cell spans multiple rows.
	 * </p>
	 * 
	 * @param e
	 *            an event object containing the following fields:
	 *            <ul>
	 *            <li>[out] count - the 1 based number of rows spanned by the
	 *            specified cell
	 *            </ul>
	 */
	public void getRowSpan(AccessibleTableCellEvent e);

	/**
	 * Returns the row headers as an array of cell accessibles. TODO: doc that
	 * this is a more efficient way to get headers of a cell than
	 * TableListener.getRow/ColHeaders
	 * 
	 * @param e
	 *            an event object containing the following fields:
	 *            <ul>
	 *            <li>[out] accessibles - an array of cell accessibles, or null
	 *            if there are no row headers
	 *            </ul>
	 */
	public void getRowHeaders(AccessibleTableCellEvent e);

	/**
	 * Translates this cell accessible into the corresponding row index.
	 * 
	 * @param e
	 *            an event object containing the following fields:
	 *            <ul>
	 *            <li>[out] index - the 0 based row index of the specified cell,
	 *            or the index of the first row if the cell spans multiple rows
	 *            </ul>
	 */
	public void getRowIndex(AccessibleTableCellEvent e);

	/**
	 * Returns the accessible for the table containing this cell.
	 * 
	 * @param e
	 *            an event object containing the following fields:
	 *            <ul>
	 *            <li>[out] accessible - the accessible for the containing table
	 *            </ul>
	 */
	public void getTable(AccessibleTableCellEvent e);

	/**
	 * Returns a boolean value indicating whether this cell is selected.
	 * 
	 * @param e
	 *            an event object containing the following fields:
	 *            <ul>
	 *            <li>[out] isSelected - true if the specified cell is selected
	 *            and false otherwise
	 *            </ul>
	 */
	public void isSelected(AccessibleTableCellEvent e);
}