Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.eclipse.swt.accessibility
Class Accessible  view Accessible download Accessible.java

java.lang.Object
  extended byorg.eclipse.swt.accessibility.Accessible

public class Accessible
extends java.lang.Object

Instances of this class provide a bridge between application code and assistive technology clients. Many platforms provide default accessible behavior for most widgets, and this class allows that default behavior to be overridden. Applications can get the default Accessible object for a control by sending it getAccessible, and then add an accessible listener to override simple items like the name and help string, or they can add an accessible control listener to override complex items. As a rule of thumb, an application would only want to use the accessible control listener to implement accessibility for a custom control.

Since:
2.0

Field Summary
(package private)  java.util.Vector accessibleListeners
           
(package private)  AccessibleObject accessibleObject
           
(package private)  org.eclipse.swt.widgets.Control control
           
(package private)  java.util.Vector controlListeners
           
(package private)  java.util.Vector textListeners
           
 
Constructor Summary
(package private) Accessible(org.eclipse.swt.widgets.Control control)
           
 
Method Summary
 void addAccessibleControlListener(AccessibleControlListener listener)
          Adds the listener to the collection of listeners who will be notifed when an accessible client asks for custom control specific information.
 void addAccessibleListener(AccessibleListener listener)
          Adds the listener to the collection of listeners who will be notifed when an accessible client asks for certain strings, such as name, description, help, or keyboard shortcut.
 void addAccessibleTextListener(AccessibleTextListener listener)
          Adds the listener to the collection of listeners who will be notifed when an accessible client asks for custom text control specific information.
(package private)  void checkWidget()
           
(package private)  AccessibleListener[] getAccessibleListeners()
           
 org.eclipse.swt.widgets.Control getControl()
          Returns the control for this Accessible object.
(package private)  long getControlHandle()
           
(package private)  AccessibleControlListener[] getControlListeners()
           
(package private)  AccessibleTextListener[] getTextListeners()
           
static Accessible internal_new_Accessible(org.eclipse.swt.widgets.Control control)
          Invokes platform specific functionality to allocate a new accessible object.
(package private)  boolean isValidThread()
           
(package private)  void release()
           
 void removeAccessibleControlListener(AccessibleControlListener listener)
          Removes the listener from the collection of listeners who will be notifed when an accessible client asks for custom control specific information.
 void removeAccessibleListener(AccessibleListener listener)
          Removes the listener from the collection of listeners who will be notifed when an accessible client asks for certain strings, such as name, description, help, or keyboard shortcut.
 void removeAccessibleTextListener(AccessibleTextListener listener)
          Removes the listener from the collection of listeners who will be notifed when an accessible client asks for custom text control specific information.
 void selectionChanged()
          Sends a message to accessible clients that the child selection within a custom container control has changed.
 void setFocus(int childID)
          Sends a message to accessible clients indicating that the focus has changed within a custom control.
 void textCaretMoved(int index)
          Sends a message to accessible clients that the text caret has moved within a custom control.
 void textChanged(int type, int startIndex, int length)
          Sends a message to accessible clients that the text within a custom control has changed.
 void textSelectionChanged()
          Sends a message to accessible clients that the text selection has changed within a custom control.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

accessibleListeners

java.util.Vector accessibleListeners

controlListeners

java.util.Vector controlListeners

textListeners

java.util.Vector textListeners

accessibleObject

AccessibleObject accessibleObject

control

org.eclipse.swt.widgets.Control control
Constructor Detail

Accessible

Accessible(org.eclipse.swt.widgets.Control control)
Method Detail

addAccessibleListener

public void addAccessibleListener(AccessibleListener listener)
Adds the listener to the collection of listeners who will be notifed when an accessible client asks for certain strings, such as name, description, help, or keyboard shortcut. The listener is notified by sending it one of the messages defined in the AccessibleListener interface.


addAccessibleControlListener

public void addAccessibleControlListener(AccessibleControlListener listener)
Adds the listener to the collection of listeners who will be notifed when an accessible client asks for custom control specific information. The listener is notified by sending it one of the messages defined in the AccessibleControlListener interface.


addAccessibleTextListener

public void addAccessibleTextListener(AccessibleTextListener listener)
Adds the listener to the collection of listeners who will be notifed when an accessible client asks for custom text control specific information. The listener is notified by sending it one of the messages defined in the AccessibleTextListener interface.

Since:
3.0

getControl

public org.eclipse.swt.widgets.Control getControl()
Returns the control for this Accessible object.

Since:
3.0

checkWidget

void checkWidget()

getAccessibleListeners

AccessibleListener[] getAccessibleListeners()

getControlHandle

long getControlHandle()

getControlListeners

AccessibleControlListener[] getControlListeners()

getTextListeners

AccessibleTextListener[] getTextListeners()

internal_new_Accessible

public static Accessible internal_new_Accessible(org.eclipse.swt.widgets.Control control)
Invokes platform specific functionality to allocate a new accessible object.

IMPORTANT: This method is not part of the public API for Accessible. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms, and should never be called from application code.


isValidThread

boolean isValidThread()

release

void release()

removeAccessibleControlListener

public void removeAccessibleControlListener(AccessibleControlListener listener)
Removes the listener from the collection of listeners who will be notifed when an accessible client asks for custom control specific information.


removeAccessibleListener

public void removeAccessibleListener(AccessibleListener listener)
Removes the listener from the collection of listeners who will be notifed when an accessible client asks for certain strings, such as name, description, help, or keyboard shortcut.


removeAccessibleTextListener

public void removeAccessibleTextListener(AccessibleTextListener listener)
Removes the listener from the collection of listeners who will be notifed when an accessible client asks for custom text control specific information.

Since:
3.0

selectionChanged

public void selectionChanged()
Sends a message to accessible clients that the child selection within a custom container control has changed.

Since:
3.0

setFocus

public void setFocus(int childID)
Sends a message to accessible clients indicating that the focus has changed within a custom control.


textCaretMoved

public void textCaretMoved(int index)
Sends a message to accessible clients that the text caret has moved within a custom control.

Since:
3.0

textChanged

public void textChanged(int type,
                        int startIndex,
                        int length)
Sends a message to accessible clients that the text within a custom control has changed.

Since:
3.0

textSelectionChanged

public void textSelectionChanged()
Sends a message to accessible clients that the text selection has changed within a custom control.

Since:
3.0