public class Accessible extends Object
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.Modifier | Constructor and Description |
---|---|
protected |
Accessible()
Deprecated.
|
|
Accessible(Accessible parent)
Constructs a new instance of this class given its parent.
|
Modifier and Type | Method and Description |
---|---|
void |
addAccessibleActionListener(AccessibleActionListener listener)
Adds the listener to the collection of listeners that will be
notified when an accessible client asks for any of the properties
defined in the
AccessibleActionListener interface. |
void |
addAccessibleAttributeListener(AccessibleAttributeListener listener)
Adds the listener to the collection of listeners that will be
notified when an accessible client asks for any of the properties
defined in the
AccessibleAttributeListener interface. |
void |
addAccessibleControlListener(AccessibleControlListener listener)
Adds the listener to the collection of listeners who will
be notified when an accessible client asks for custom control
specific information.
|
void |
addAccessibleEditableTextListener(AccessibleEditableTextListener listener)
Adds the listener to the collection of listeners that will be
notified when an accessible client asks for any of the properties
defined in the
AccessibleEditableTextListener interface. |
void |
addAccessibleHyperlinkListener(AccessibleHyperlinkListener listener)
Adds the listener to the collection of listeners that will be
notified when an accessible client asks for any of the properties
defined in the
AccessibleHyperlinkListener interface. |
void |
addAccessibleListener(AccessibleListener listener)
Adds the listener to the collection of listeners who will
be notified when an accessible client asks for certain strings,
such as name, description, help, or keyboard shortcut.
|
void |
addAccessibleTableCellListener(AccessibleTableCellListener listener)
Adds the listener to the collection of listeners that will be
notified when an accessible client asks for any of the properties
defined in the
AccessibleTableCellListener interface. |
void |
addAccessibleTableListener(AccessibleTableListener listener)
Adds the listener to the collection of listeners that will be
notified when an accessible client asks for any of the properties
defined in the
AccessibleTableListener interface. |
void |
addAccessibleTextListener(AccessibleTextListener listener)
Adds the listener to the collection of listeners who will
be notified when an accessible client asks for custom text control
specific information.
|
void |
addAccessibleValueListener(AccessibleValueListener listener)
Adds the listener to the collection of listeners that will be
notified when an accessible client asks for any of the properties
defined in the
AccessibleValueListener interface. |
void |
addRelation(int type,
Accessible target)
Adds a relation with the specified type and target
to the receiver's set of relations.
|
void |
dispose()
Disposes of the operating system resources associated with
the receiver, and removes the receiver from its parent's
list of children.
|
Control |
getControl()
Returns the control for this Accessible object.
|
void |
internal_dispose_Accessible()
Invokes platform specific functionality to dispose an accessible object.
|
static Accessible |
internal_new_Accessible(Control control)
Invokes platform specific functionality to allocate a new accessible object.
|
long |
internal_WM_GETOBJECT(long wParam,
long lParam)
Invokes platform specific functionality to handle a window message.
|
void |
removeAccessibleActionListener(AccessibleActionListener listener)
Removes the listener from the collection of listeners that will be
notified when an accessible client asks for any of the properties
defined in the
AccessibleActionListener interface. |
void |
removeAccessibleAttributeListener(AccessibleAttributeListener listener)
Removes the listener from the collection of listeners that will be
notified when an accessible client asks for any of the properties
defined in the
AccessibleAttributeListener interface. |
void |
removeAccessibleControlListener(AccessibleControlListener listener)
Removes the listener from the collection of listeners who will
be notified when an accessible client asks for custom control
specific information.
|
void |
removeAccessibleEditableTextListener(AccessibleEditableTextListener listener)
Removes the listener from the collection of listeners that will be
notified when an accessible client asks for any of the properties
defined in the
AccessibleEditableTextListener interface. |
void |
removeAccessibleHyperlinkListener(AccessibleHyperlinkListener listener)
Removes the listener from the collection of listeners that will be
notified when an accessible client asks for any of the properties
defined in the
AccessibleHyperlinkListener interface. |
void |
removeAccessibleListener(AccessibleListener listener)
Removes the listener from the collection of listeners who will
be notified when an accessible client asks for certain strings,
such as name, description, help, or keyboard shortcut.
|
void |
removeAccessibleTableCellListener(AccessibleTableCellListener listener)
Removes the listener from the collection of listeners that will be
notified when an accessible client asks for any of the properties
defined in the
AccessibleTableCellListener interface. |
void |
removeAccessibleTableListener(AccessibleTableListener listener)
Removes the listener from the collection of listeners that will be
notified when an accessible client asks for any of the properties
defined in the
AccessibleTableListener interface. |
void |
removeAccessibleTextListener(AccessibleTextListener listener)
Removes the listener from the collection of listeners who will
be notified when an accessible client asks for custom text control
specific information.
|
void |
removeAccessibleValueListener(AccessibleValueListener listener)
Removes the listener from the collection of listeners that will be
notified when an accessible client asks for any of the properties
defined in the
AccessibleValueListener interface. |
void |
removeRelation(int type,
Accessible target)
Removes the relation with the specified type and target
from the receiver's set of relations.
|
void |
selectionChanged()
Sends a message to accessible clients that the child selection
within a custom container control has changed.
|
void |
sendEvent(int event,
Object eventData)
Sends a message with event-specific data to accessible clients
indicating that something has changed within a custom control.
|
void |
sendEvent(int event,
Object eventData,
int childID)
Sends a message with event-specific data and a childID
to accessible clients, indicating that something has changed
within a custom control.
|
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.
|
String |
toString() |
public Accessible(Accessible parent)
parent
- the Accessible parent, which must not be nullIllegalArgumentException
- dispose()
,
Control.getAccessible()
protected Accessible()
public static Accessible internal_new_Accessible(Control control)
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.
control
- the control to get the accessible object forpublic void addAccessibleListener(AccessibleListener listener)
AccessibleListener
interface.listener
- the listener that should be notified when the receiver
is asked for a name, description, help, or keyboard shortcut stringIllegalArgumentException
- SWTException
- AccessibleListener
,
removeAccessibleListener(org.eclipse.swt.accessibility.AccessibleListener)
public void addAccessibleControlListener(AccessibleControlListener listener)
AccessibleControlListener
interface.listener
- the listener that should be notified when the receiver
is asked for custom control specific informationIllegalArgumentException
- SWTException
- AccessibleControlListener
,
removeAccessibleControlListener(org.eclipse.swt.accessibility.AccessibleControlListener)
public void addAccessibleTextListener(AccessibleTextListener listener)
AccessibleTextListener
and AccessibleTextExtendedListener
interfaces.listener
- the listener that should be notified when the receiver
is asked for custom text control specific informationIllegalArgumentException
- SWTException
- AccessibleTextListener
,
AccessibleTextExtendedListener
,
removeAccessibleTextListener(org.eclipse.swt.accessibility.AccessibleTextListener)
public void addAccessibleActionListener(AccessibleActionListener listener)
AccessibleActionListener
interface.listener
- the listener that should be notified when the receiver
is asked for AccessibleActionListener
interface propertiesIllegalArgumentException
- SWTException
- AccessibleActionListener
,
removeAccessibleActionListener(org.eclipse.swt.accessibility.AccessibleActionListener)
public void addAccessibleEditableTextListener(AccessibleEditableTextListener listener)
AccessibleEditableTextListener
interface.listener
- the listener that should be notified when the receiver
is asked for AccessibleEditableTextListener
interface propertiesIllegalArgumentException
- SWTException
- AccessibleEditableTextListener
,
removeAccessibleEditableTextListener(org.eclipse.swt.accessibility.AccessibleEditableTextListener)
public void addAccessibleHyperlinkListener(AccessibleHyperlinkListener listener)
AccessibleHyperlinkListener
interface.listener
- the listener that should be notified when the receiver
is asked for AccessibleHyperlinkListener
interface propertiesIllegalArgumentException
- SWTException
- AccessibleHyperlinkListener
,
removeAccessibleHyperlinkListener(org.eclipse.swt.accessibility.AccessibleHyperlinkListener)
public void addAccessibleTableListener(AccessibleTableListener listener)
AccessibleTableListener
interface.listener
- the listener that should be notified when the receiver
is asked for AccessibleTableListener
interface propertiesIllegalArgumentException
- SWTException
- AccessibleTableListener
,
removeAccessibleTableListener(org.eclipse.swt.accessibility.AccessibleTableListener)
public void addAccessibleTableCellListener(AccessibleTableCellListener listener)
AccessibleTableCellListener
interface.listener
- the listener that should be notified when the receiver
is asked for AccessibleTableCellListener
interface propertiesIllegalArgumentException
- SWTException
- AccessibleTableCellListener
,
removeAccessibleTableCellListener(org.eclipse.swt.accessibility.AccessibleTableCellListener)
public void addAccessibleValueListener(AccessibleValueListener listener)
AccessibleValueListener
interface.listener
- the listener that should be notified when the receiver
is asked for AccessibleValueListener
interface propertiesIllegalArgumentException
- SWTException
- AccessibleValueListener
,
removeAccessibleValueListener(org.eclipse.swt.accessibility.AccessibleValueListener)
public void addAccessibleAttributeListener(AccessibleAttributeListener listener)
AccessibleAttributeListener
interface.listener
- the listener that should be notified when the receiver
is asked for AccessibleAttributeListener
interface propertiesIllegalArgumentException
- SWTException
- AccessibleAttributeListener
,
removeAccessibleAttributeListener(org.eclipse.swt.accessibility.AccessibleAttributeListener)
public void addRelation(int type, Accessible target)
type
- an ACC
constant beginning with RELATION_* indicating the type of relationtarget
- the accessible that is the target for this relationpublic void dispose()
This method should be called when an accessible that was created
with the public constructor Accessible(Accessible parent)
is no longer needed. You do not need to call this when the receiver's
control is disposed, because all Accessible
instances
associated with a control are released when the control is disposed.
It is also not necessary to call this for instances of Accessible
that were retrieved with Control.getAccessible()
.
public Control getControl()
public void internal_dispose_Accessible()
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.
public long internal_WM_GETOBJECT(long wParam, long lParam)
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.
public void removeAccessibleListener(AccessibleListener listener)
listener
- the listener that should no longer be notified when the receiver
is asked for a name, description, help, or keyboard shortcut stringIllegalArgumentException
- SWTException
- AccessibleListener
,
addAccessibleListener(org.eclipse.swt.accessibility.AccessibleListener)
public void removeAccessibleControlListener(AccessibleControlListener listener)
listener
- the listener that should no longer be notified when the receiver
is asked for custom control specific informationIllegalArgumentException
- SWTException
- AccessibleControlListener
,
addAccessibleControlListener(org.eclipse.swt.accessibility.AccessibleControlListener)
public void removeAccessibleTextListener(AccessibleTextListener listener)
listener
- the listener that should no longer be notified when the receiver
is asked for custom text control specific informationIllegalArgumentException
- SWTException
- AccessibleTextListener
,
AccessibleTextExtendedListener
,
addAccessibleTextListener(org.eclipse.swt.accessibility.AccessibleTextListener)
public void removeAccessibleActionListener(AccessibleActionListener listener)
AccessibleActionListener
interface.listener
- the listener that should no longer be notified when the receiver
is asked for AccessibleActionListener
interface propertiesIllegalArgumentException
- SWTException
- AccessibleActionListener
,
addAccessibleActionListener(org.eclipse.swt.accessibility.AccessibleActionListener)
public void removeAccessibleEditableTextListener(AccessibleEditableTextListener listener)
AccessibleEditableTextListener
interface.listener
- the listener that should no longer be notified when the receiver
is asked for AccessibleEditableTextListener
interface propertiesIllegalArgumentException
- SWTException
- AccessibleEditableTextListener
,
addAccessibleEditableTextListener(org.eclipse.swt.accessibility.AccessibleEditableTextListener)
public void removeAccessibleHyperlinkListener(AccessibleHyperlinkListener listener)
AccessibleHyperlinkListener
interface.listener
- the listener that should no longer be notified when the receiver
is asked for AccessibleHyperlinkListener
interface propertiesIllegalArgumentException
- SWTException
- AccessibleHyperlinkListener
,
addAccessibleHyperlinkListener(org.eclipse.swt.accessibility.AccessibleHyperlinkListener)
public void removeAccessibleTableListener(AccessibleTableListener listener)
AccessibleTableListener
interface.listener
- the listener that should no longer be notified when the receiver
is asked for AccessibleTableListener
interface propertiesIllegalArgumentException
- SWTException
- AccessibleTableListener
,
addAccessibleTableListener(org.eclipse.swt.accessibility.AccessibleTableListener)
public void removeAccessibleTableCellListener(AccessibleTableCellListener listener)
AccessibleTableCellListener
interface.listener
- the listener that should no longer be notified when the receiver
is asked for AccessibleTableCellListener
interface propertiesIllegalArgumentException
- SWTException
- AccessibleTableCellListener
,
addAccessibleTableCellListener(org.eclipse.swt.accessibility.AccessibleTableCellListener)
public void removeAccessibleValueListener(AccessibleValueListener listener)
AccessibleValueListener
interface.listener
- the listener that should no longer be notified when the receiver
is asked for AccessibleValueListener
interface propertiesIllegalArgumentException
- SWTException
- AccessibleValueListener
,
addAccessibleValueListener(org.eclipse.swt.accessibility.AccessibleValueListener)
public void removeAccessibleAttributeListener(AccessibleAttributeListener listener)
AccessibleAttributeListener
interface.listener
- the listener that should no longer be notified when the receiver
is asked for AccessibleAttributeListener
interface propertiesIllegalArgumentException
- SWTException
- AccessibleAttributeListener
,
addAccessibleAttributeListener(org.eclipse.swt.accessibility.AccessibleAttributeListener)
public void removeRelation(int type, Accessible target)
type
- an ACC
constant beginning with RELATION_* indicating the type of relationtarget
- the accessible that is the target for this relationpublic void sendEvent(int event, Object eventData)
event
- an ACC
constant beginning with EVENT_* indicating the message to sendeventData
- an object containing event-specific data, or null if there is no event-specific data
(eventData is specified in the documentation for individual ACC.EVENT_* constants)SWTException
- ACC.EVENT_ACTION_CHANGED
,
ACC.EVENT_ATTRIBUTE_CHANGED
,
ACC.EVENT_DESCRIPTION_CHANGED
,
ACC.EVENT_DOCUMENT_LOAD_COMPLETE
,
ACC.EVENT_DOCUMENT_LOAD_STOPPED
,
ACC.EVENT_DOCUMENT_RELOAD
,
ACC.EVENT_HYPERLINK_ACTIVATED
,
ACC.EVENT_HYPERLINK_ANCHOR_COUNT_CHANGED
,
ACC.EVENT_HYPERLINK_END_INDEX_CHANGED
,
ACC.EVENT_HYPERLINK_SELECTED_LINK_CHANGED
,
ACC.EVENT_HYPERLINK_START_INDEX_CHANGED
,
ACC.EVENT_HYPERTEXT_LINK_COUNT_CHANGED
,
ACC.EVENT_HYPERTEXT_LINK_SELECTED
,
ACC.EVENT_LOCATION_CHANGED
,
ACC.EVENT_NAME_CHANGED
,
ACC.EVENT_PAGE_CHANGED
,
ACC.EVENT_SECTION_CHANGED
,
ACC.EVENT_SELECTION_CHANGED
,
ACC.EVENT_STATE_CHANGED
,
ACC.EVENT_TABLE_CAPTION_CHANGED
,
ACC.EVENT_TABLE_CHANGED
,
ACC.EVENT_TABLE_COLUMN_DESCRIPTION_CHANGED
,
ACC.EVENT_TABLE_COLUMN_HEADER_CHANGED
,
ACC.EVENT_TABLE_ROW_DESCRIPTION_CHANGED
,
ACC.EVENT_TABLE_ROW_HEADER_CHANGED
,
ACC.EVENT_TABLE_SUMMARY_CHANGED
,
ACC.EVENT_TEXT_ATTRIBUTE_CHANGED
,
ACC.EVENT_TEXT_CARET_MOVED
,
ACC.EVENT_TEXT_CHANGED
,
ACC.EVENT_TEXT_COLUMN_CHANGED
,
ACC.EVENT_TEXT_SELECTION_CHANGED
,
ACC.EVENT_VALUE_CHANGED
public void sendEvent(int event, Object eventData, int childID)
event
- an ACC
constant beginning with EVENT_* indicating the message to sendeventData
- an object containing event-specific data, or null if there is no event-specific data
(eventData is specified in the documentation for individual ACC.EVENT_* constants)childID
- an identifier specifying a child of the controlSWTException
- ACC.EVENT_DESCRIPTION_CHANGED
,
ACC.EVENT_LOCATION_CHANGED
,
ACC.EVENT_NAME_CHANGED
,
ACC.EVENT_SELECTION_CHANGED
,
ACC.EVENT_STATE_CHANGED
,
ACC.EVENT_TEXT_SELECTION_CHANGED
,
ACC.EVENT_VALUE_CHANGED
public void selectionChanged()
SWTException
- public void setFocus(int childID)
childID
- an identifier specifying a child of the controlSWTException
- public void textCaretMoved(int index)
index
- the new caret index within the controlSWTException
- public void textChanged(int type, int startIndex, int length)
type
- the type of change, one of ACC.TEXT_INSERT
or ACC.TEXT_DELETE
startIndex
- the text index within the control where the insertion or deletion beginslength
- the non-negative length in characters of the insertion or deletionSWTException
- ACC.TEXT_INSERT
,
ACC.TEXT_DELETE
public void textSelectionChanged()
SWTException
-
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.