org.eclipse.swt.accessibility.AccessibleActionAdapter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.swt.gtk.linux.ppc64le Show documentation
Standard Widget Toolkit for GTK on ppc64le
The newest version!
/*******************************************************************************
 * Copyright (c) 2009, 2016 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.swt.accessibility;

/**
 * This adapter class provides default implementations for the
 * methods in the AccessibleActionListener interface.
 * 
 * Classes that wish to deal with AccessibleAction events can
 * extend this class and override only the methods that they are
 * interested in.
 * 
 *
 * @see AccessibleActionListener
 * @see AccessibleActionEvent
 *
 * @since 3.6
 */
public class AccessibleActionAdapter implements AccessibleActionListener {
	/**
	 * Returns the number of accessible actions available in this object.
	 * 
	 * If there are more than one, the first one (index 0) is considered the
	 * "default" action of the object.
	 * 
	 *
	 * @param e an event object containing the following fields:
	 * [out] count - the number of actions, or zero if there are no actions
	 * 
	 */
	@Override
	public void getActionCount(AccessibleActionEvent e) {}

	/**
	 * Performs the specified action on the object.
	 *
	 * @param e an event object containing the following fields:
	 * [in] index - a 0 based index specifying the action to perform.
	 * 		If the index lies outside the valid range no action is performed.
	 * [out] result - set to {@link ACC#OK} if the action was performed.
	 * 
	 */
	@Override
	public void doAction(AccessibleActionEvent e) {}

	/**
	 * Returns a description of the specified action.
	 *
	 * @param e an event object containing the following fields:
	 * [in] index - a 0 based index specifying which action's description to return
	 * [out] result - a localized string describing the specified action,
	 * 		or null if the index lies outside the valid range
	 * 
	 */
	@Override
	public void getDescription(AccessibleActionEvent e) {}

	/**
	 * Returns a string representing one or more key bindings, if there
	 * are any, associated with the specified action.
	 * 
	 * The returned string is of the following form: mnemonic;accelerator
	 * for example: "C;CTRL+C" for the Copy item in a typical Edit menu.
	 * 
	 *
	 * @param e an event object containing the following fields:
	 * [in] index - a 0 based index specifying which action's key bindings to return
	 * [out] result - a semicolon-delimited string of localized key bindings
	 * 		(example: "C;CTRL+C"), or null if the index lies outside the valid range
	 * 
	 */
	@Override
	public void getKeyBinding(AccessibleActionEvent e) {}

	/**
	 * Returns the name of the specified action.
	 * 
	 * There is no need to implement this method for single action controls
	 * since that would be redundant with AccessibleControlListener.getDefaultAction.
	 * 
	 *
	 * @param e an event object containing the following fields:
	 * [in] index - a 0 based index specifying which action's name to return
	 * [in] localized - a boolean indicating whether or not to return a localized name
	 * [out] result - the name of the specified action,
	 * 		or null if the index lies outside the valid range
	 * 
	 */
	@Override
	public void getName(AccessibleActionEvent e) {}
}