org.eclipse.actf.accservice.core.win32.ia2
Class IA2AccessibleAction

java.lang.Object
  extended by org.eclipse.actf.accservice.core.win32.ia2.IA2AccessibleElement
      extended by org.eclipse.actf.accservice.core.win32.ia2.IA2AccessibleAction
Direct Known Subclasses:
IA2AccessibleHyperlink

public class IA2AccessibleAction
extends IA2AccessibleElement

implementation of IA2AccessibleValue /** The IA2AccessibleAction interface gives access to actions that can be executed for accessible objects. Every accessible object that can be manipulated beyond its methods exported over the accessibility API should support this interface to expose all actions that it can perform. Each action can be performed or queried for a name, description or associated key bindings. Actions are needed more for ATs that assist the mobility impaired. By providing actions directly, the AT can present them to the user without the user having to perform the extra steps to navigate a context menu.

Author:
Kavitha Teegala
See Also:
IA2Accessible

Field Summary
 
Fields inherited from class org.eclipse.actf.accservice.core.win32.ia2.IA2AccessibleElement
errorCodeReturnMap, errString
 
Constructor Summary
IA2AccessibleAction(int val, IA2Accessible parent)
          Constructor used to create an accessible action object
 
Method Summary
 boolean doAccessibleAction(int actionIndex)
          Performs the specified Action on the object.
 int getActionCount()
          Returns the number of accessible actions available in this object.If there are more than one, the first one is considered the "default" action of the object.
 String[] getActionDescription()
          Returns a description of the specified action of the object
 String[] getActionKeyBinding(int actionIndex, int nMaxBinding)
          Returns an array of strings describing one or more key bindings, if there are any, associated with the specified action.
 String[] getActionName()
          Returns the non-localized name of specified action.
 String[] getLocalizedAccessibleActionName()
          Returns the localized name of specified action
protected  boolean internalDoAccessibleAction(int actionIndex)
           
protected  int internalGetActionCount()
           
protected  String internalGetActionDescription(int actionIndex)
           
protected  String[] internalGetActionKeyBinding(int actionIndex, int nMaxBinding)
           
protected  String internalGetActionName(int actionIndex)
           
protected  String internalGetLocalizedAccessibleActionName(int actionIndex)
           
 int internalRef()
          used by native code only.
 
Methods inherited from class org.eclipse.actf.accservice.core.win32.ia2.IA2AccessibleElement
errorCodeMap, putErrorCode
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IA2AccessibleAction

public IA2AccessibleAction(int val,
                           IA2Accessible parent)
Constructor used to create an accessible action object

Parameters:
val -
parent - IA2Accessible parent of this object
Method Detail

internalRef

public int internalRef()
used by native code only. Clients should not call directly.

Returns:
ptr address for native object

getActionCount

public int getActionCount()
Returns the number of accessible actions available in this object.If there are more than one, the first one is considered the "default" action of the object.

Returns:
int -number of actions or zero if there are no actions.

internalGetActionCount

protected int internalGetActionCount()

doAccessibleAction

public boolean doAccessibleAction(int actionIndex)
Performs the specified Action on the object.

Parameters:
actionIndex - - This index specifies the action to perform. If it lies outside the valid range no action is performed.
Returns:
boolean

internalDoAccessibleAction

protected boolean internalDoAccessibleAction(int actionIndex)

getActionDescription

public String[] getActionDescription()
Returns a description of the specified action of the object

Returns:
- The returned value is a localized string of the specified action.

internalGetActionDescription

protected String internalGetActionDescription(int actionIndex)

getActionKeyBinding

public String[] getActionKeyBinding(int actionIndex,
                                    int nMaxBinding)
Returns an array of strings describing one or more key bindings, if there are any, associated with the specified action.

Parameters:
actionIndex -
nMaxBinding -
Returns:
String[]

internalGetActionKeyBinding

protected String[] internalGetActionKeyBinding(int actionIndex,
                                               int nMaxBinding)

getActionName

public String[] getActionName()
Returns the non-localized name of specified action.

Returns:
Stringp[]

internalGetActionName

protected String internalGetActionName(int actionIndex)

getLocalizedAccessibleActionName

public String[] getLocalizedAccessibleActionName()
Returns the localized name of specified action

Returns:
String[]

internalGetLocalizedAccessibleActionName

protected String internalGetLocalizedAccessibleActionName(int actionIndex)