Top Description Constructors Methods
org.eclipse.swt.accessibility

public Class AccessibleActionAdapter

extends Object
implements AccessibleActionListener
Class Inheritance
All Implemented Interfaces
org.eclipse.swt.accessibility.AccessibleActionListener, org.eclipse.swt.internal.SWTEventListener, java.util.EventListener
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.

Since
3.6
See Also
AccessibleActionListener, AccessibleActionEvent

Constructor Summary

AccessConstructor and Description
public
AccessibleActionAdapter()

Method Summary

Modifier and TypeMethod and Description
public void
doAction(AccessibleActionEvent
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 ACC#OK if the action was performed.
e)

Implements org.eclipse.swt.accessibility.AccessibleActionListener.doAction.

Performs the specified action on the object.
public void
getActionCount(AccessibleActionEvent
an event object containing the following fields:
  • [out] count - the number of actions, or zero if there are no actions
e)

Implements org.eclipse.swt.accessibility.AccessibleActionListener.getActionCount.

Returns the number of accessible actions available in this object.
public void
getDescription(AccessibleActionEvent
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
e)

Implements org.eclipse.swt.accessibility.AccessibleActionListener.getDescription.

Returns a description of the specified action.
public void
getKeyBinding(AccessibleActionEvent
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
e)

Implements org.eclipse.swt.accessibility.AccessibleActionListener.getKeyBinding.

Returns a string representing one or more key bindings, if there are any, associated with the specified action.
public void
getName(AccessibleActionEvent
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
e)

Implements org.eclipse.swt.accessibility.AccessibleActionListener.getName.

Returns the name of the specified action.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

AccessibleActionAdapterback to summary
public AccessibleActionAdapter()

Method Detail

doActionback to summary
public void doAction(AccessibleActionEvent e)

Implements org.eclipse.swt.accessibility.AccessibleActionListener.doAction.

Performs the specified action on the object.

Parameters
e:AccessibleActionEvent

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 ACC#OK if the action was performed.
Annotations
@Override
getActionCountback to summary
public void getActionCount(AccessibleActionEvent e)

Implements org.eclipse.swt.accessibility.AccessibleActionListener.getActionCount.

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.

Parameters
e:AccessibleActionEvent

an event object containing the following fields:

  • [out] count - the number of actions, or zero if there are no actions
Annotations
@Override
getDescriptionback to summary
public void getDescription(AccessibleActionEvent e)

Implements org.eclipse.swt.accessibility.AccessibleActionListener.getDescription.

Returns a description of the specified action.

Parameters
e:AccessibleActionEvent

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
Annotations
@Override
getKeyBindingback to summary
public void getKeyBinding(AccessibleActionEvent e)

Implements org.eclipse.swt.accessibility.AccessibleActionListener.getKeyBinding.

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.

Parameters
e:AccessibleActionEvent

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
Annotations
@Override
getNameback to summary
public void getName(AccessibleActionEvent e)

Implements org.eclipse.swt.accessibility.AccessibleActionListener.getName.

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.

Parameters
e:AccessibleActionEvent

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
Annotations
@Override