/*******************************************************************************
* Copyright (c) 2000, 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 described by the AccessibleListener
interface.
*
* Classes that wish to deal with AccessibleEvent
s can
* extend this class and override only the methods that they are
* interested in.
*
* Note: Accessibility clients use child identifiers to specify * whether they want information about a control or one of its children. * Child identifiers are increasing integers beginning with 0. * The identifier CHILDID_SELF represents the control itself. *
* * @see AccessibleListener * @see AccessibleEvent * @see Sample code and further information * * @since 2.0 */ public abstract class AccessibleAdapter implements AccessibleListener { /** * Sent when an accessibility client requests the name * of the control, or the name of a child of the control. * The default behavior is to do nothing. *
* Return the name of the control or specified child in the
* result
field of the event object. Returning
* an empty string tells the client that the control or child
* does not have a name, and returning null tells the client
* to use the platform name.
*
* The information in this property should be similar to the help * provided by toolTipText. It describes what the control or child * does or how to use it, as opposed to getDescription, which * describes appearance. *
* Return the help string of the control or specified child in
* the result
field of the event object. Returning
* an empty string tells the client that the control or child
* does not have a help string, and returning null tells the
* client to use the platform help string.
*
* A keyboard shortcut can either be a mnemonic, or an accelerator. * As a general rule, if the control or child can receive keyboard focus, * then you should expose its mnemonic, and if it cannot receive keyboard * focus, then you should expose its accelerator. *
* Return the keyboard shortcut string of the control or specified child
* in the result
field of the event object. Returning an
* empty string tells the client that the control or child does not
* have a keyboard shortcut string, and returning null tells the client
* to use the platform keyboard shortcut string.
*
* This is a textual description of the control or child's visual * appearance, which is typically only necessary if it cannot be * determined from other properties such as role. *
* Return the description of the control or specified child in
* the result
field of the event object. Returning
* an empty string tells the client that the control or child
* does not have a description, and returning null tells the
* client to use the platform description.
*