AccessibleControlListener

Classes that implement this interface provide methods that deal with the events that are generated when an accessibility client sends a message to a control. After creating an instance of a class that implements this interface it can be added to a control using the <code>addAccessibleControlListener</code> method and removed using the <code>removeAccessibleControlListener</code> method. When a client requests information the appropriate method will be invoked. 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. Note: This interface is typically used by implementors of a custom control to provide very detailed information about the control instance to accessibility clients.

@see AccessibleControlAdapter @see AccessibleControlEvent

@since 2.0

interface AccessibleControlListener : SWTEventListener {

void getChildAtPoint(AccessibleControlEvent e);

void getLocation(AccessibleControlEvent e);

void getChild(AccessibleControlEvent e);

void getChildCount(AccessibleControlEvent e);

void getDefaultAction(AccessibleControlEvent e);

void getFocus(AccessibleControlEvent e);

void getRole(AccessibleControlEvent e);

void getSelection(AccessibleControlEvent e);

void getState(AccessibleControlEvent e);

void getValue(AccessibleControlEvent e);

void getChildren(AccessibleControlEvent e);

}

Members

Functions

getChild void getChild(AccessibleControlEvent e): Sent when an accessibility client requests the accessible object for a child of the control. Return an <code>Accessible</code> for the specified control or child in the <code>accessible</code> field of the event object. Return null if the specified child does not have its own <code>Accessible</code>.
getChildAtPoint void getChildAtPoint(AccessibleControlEvent e): Sent when an accessibility client requests the identifier of the control child at the specified display coordinates. Return the identifier of the child at display point (x, y) in the <code>childID</code> field of the event object. Return CHILDID_SELF if point (x, y) is in the control itself and not in any child. Return CHILDID_NONE if point (x, y) is not contained in either the control or any of its children.
getChildCount void getChildCount(AccessibleControlEvent e): Sent when an accessibility client requests the number of children in the control. Return the number of child items in the <code>detail</code> field of the event object.
getChildren void getChildren(AccessibleControlEvent e): Sent when an accessibility client requests the children of the control. Return the children as an array of childIDs in the <code>children</code> field of the event object.
getDefaultAction void getDefaultAction(AccessibleControlEvent e): Sent when an accessibility client requests the default action of the control, or the default action of a child of the control. This string is typically a verb describing what the user does to it. For example, a Push Button's default action is "Press", a Check Button's is "Check" or "UnCheck", and List items have the default action "Double Click". Return a string describing the default action of the specified control or child in the <code>result</code> field of the event object. Returning null tells the client to use the platform default action string.
getFocus void getFocus(AccessibleControlEvent e): Sent when an accessibility client requests the identity of the child or control that has keyboard focus. Return the identifier of the child that has focus in the <code>childID</code> field of the event object. Return CHILDID_SELF if the control itself has keyboard focus. Return CHILDID_NONE if neither the control nor any of its children has focus.
getLocation void getLocation(AccessibleControlEvent e): Sent when an accessibility client requests the location of the control, or the location of a child of the control. Return a rectangle describing the location of the specified control or child in the <code>x, y, width, and height</code> fields of the event object.
getRole void getRole(AccessibleControlEvent e): Sent when an accessibility client requests the role of the control, or the role of a child of the control. Return a role constant (constant defined in ACC beginning with ROLE_) that describes the role of the specified control or child in the <code>detail</code> field of the event object.
getSelection void getSelection(AccessibleControlEvent e): Sent when an accessibility client requests the identity of the child or control that is currently selected. Return the identifier of the selected child in the <code>childID</code> field of the event object. Return CHILDID_SELF if the control itself is selected. Return CHILDID_MULTIPLE if multiple children are selected, and return an array of childIDs in the <code>children</code> field. Return CHILDID_NONE if neither the control nor any of its children are selected.
getState void getState(AccessibleControlEvent e): Sent when an accessibility client requests the state of the control, or the state of a child of the control. Return a state mask (mask bit constants defined in ACC beginning with STATE_) that describes the current state of the specified control or child in the <code>detail</code> field of the event object.
getValue void getValue(AccessibleControlEvent e): Sent when an accessibility client requests the value of the control, or the value of a child of the control. Many controls do not return a value. Examples of controls that do are: Combo returns the text string, Text returns its contents, ProgressBar returns a string representing a percentage, and Tree items return a string representing their level in the tree. Return a string describing the value of the specified control or child in the <code>result</code> field of the event object. Returning null tells the client to use the platform value string.

AccessibleControlListener

Members

Functions

Meta

Source