All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.eclipse.swt.accessibility.Accessible Maven / Gradle / Ivy

    Go to download

    SWT is an open source widget toolkit for Java designed to provide efficient, portable access to the user-interface facilities of the operating systems on which it is implemented.

    The newest version!
    /*******************************************************************************
 * Copyright (c) 2000, 2013 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.swt.accessibility;


import java.util.*;
import org.eclipse.swt.*;
import org.eclipse.swt.widgets.*;
import org.eclipse.swt.internal.gtk.*;

/**
 * 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.
 * 
 * @see Control#getAccessible
 * @see AccessibleListener
 * @see AccessibleEvent
 * @see AccessibleControlListener
 * @see AccessibleControlEvent
 * @see Accessibility snippets
 * @see Sample code and further information
 * 
 * @since 2.0
 */
public class Accessible {
	Vector accessibleListeners, accessibleControlListeners, accessibleTextListeners, accessibleActionListeners,
		accessibleEditableTextListeners, accessibleHyperlinkListeners, accessibleTableListeners, accessibleTableCellListeners,
		accessibleTextExtendedListeners, accessibleValueListeners, accessibleAttributeListeners;
	Accessible parent;
	AccessibleObject accessibleObject;
	Control control;
	Vector relations;
	Vector children;
	
	static class Relation {
		int type;
		Accessible target;
		
		public Relation(int type, Accessible target) {
			this.type = type;
			this.target = target;
		}

		public boolean equals(Object object) {
			if (object == this) return true;
			if (!(object instanceof Relation)) return false;
			Relation relation = (Relation)object;
			return (relation.type == this.type) && (relation.target == this.target);
		}
	}
	
	/**
	 * Constructs a new instance of this class given its parent.
	 * 
	 * @param parent the Accessible parent, which must not be null
	 * 
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the parent is null
      • 
	 * 
    
	 * 
	 * @see #dispose
	 * @see Control#getAccessible
	 * 
	 * @since 3.6
	 */
	public Accessible(Accessible parent) {
		this.parent = checkNull(parent);
		this.control = parent.control;
		if (parent.children == null) parent.children = new Vector();
		parent.children.addElement(this);
	}

	/**
	 * @since 3.5
	 * @deprecated
	 */
	protected Accessible() {
	}

	static Accessible checkNull (Accessible parent) {
		if (parent == null) SWT.error (SWT.ERROR_NULL_ARGUMENT);
		return parent;
	}

	Accessible (Control control) {
		super ();
		this.control = control;
		AccessibleFactory.registerAccessible (this);
	}	
	
	/**
	 * 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. The
	 * listener is notified by sending it one of the messages defined
	 * in the AccessibleListener interface.
	 *
	 * @param listener the listener that should be notified when the receiver
	 * is asked for a name, description, help, or keyboard shortcut string
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleListener
	 * @see #removeAccessibleListener
	 */
	public void addAccessibleListener (AccessibleListener listener) {
		checkWidget ();
		if (listener == null) SWT.error (SWT.ERROR_NULL_ARGUMENT);
		if (accessibleListeners == null) accessibleListeners = new Vector();
		accessibleListeners.addElement (listener);	
	}

	/**
	 * Adds the listener to the collection of listeners who will
	 * be notified 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.
	 *
	 * @param listener the listener that should be notified when the receiver
	 * is asked for custom control specific information
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleControlListener
	 * @see #removeAccessibleControlListener
	 */
	public void addAccessibleControlListener (AccessibleControlListener listener) {
		checkWidget ();
		if (listener == null) SWT.error (SWT.ERROR_NULL_ARGUMENT);
		if (accessibleControlListeners == null) accessibleControlListeners = new Vector();
		accessibleControlListeners.addElement (listener);		
	}

	/**
	 * Adds the listener to the collection of listeners who will
	 * be notified 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
	 * and AccessibleTextExtendedListener interfaces.
	 *
	 * @param listener the listener that should be notified when the receiver
	 * is asked for custom text control specific information
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleTextListener
	 * @see AccessibleTextExtendedListener
	 * @see #removeAccessibleTextListener
	 * 
	 * @since 3.0
	 */
	public void addAccessibleTextListener (AccessibleTextListener listener) {
		checkWidget ();
		if (listener == null) SWT.error (SWT.ERROR_NULL_ARGUMENT);
		if (listener instanceof AccessibleTextExtendedListener) {
			if (accessibleTextExtendedListeners == null) accessibleTextExtendedListeners = new Vector();
			accessibleTextExtendedListeners.addElement (listener);		
		} else {
			if (accessibleTextListeners == null) accessibleTextListeners = new Vector();
			accessibleTextListeners.addElement (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.
	 *
	 * @param listener the listener that should be notified when the receiver
	 * is asked for AccessibleActionListener interface properties
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleActionListener
	 * @see #removeAccessibleActionListener
	 * 
	 * @since 3.6
	 */
	public void addAccessibleActionListener(AccessibleActionListener listener) {
		checkWidget();
		if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
		if (accessibleActionListeners == null) accessibleActionListeners = new Vector();
		accessibleActionListeners.addElement(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.
	 *
	 * @param listener the listener that should be notified when the receiver
	 * is asked for AccessibleEditableTextListener interface properties
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleEditableTextListener
	 * @see #removeAccessibleEditableTextListener
	 * 
	 * @since 3.7
	 */
	public void addAccessibleEditableTextListener(AccessibleEditableTextListener listener) {
	    checkWidget();
	    if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
		if (accessibleEditableTextListeners == null) accessibleEditableTextListeners = new Vector();
	    accessibleEditableTextListeners.addElement(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.
	 *
	 * @param listener the listener that should be notified when the receiver
	 * is asked for AccessibleHyperlinkListener interface properties
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleHyperlinkListener
	 * @see #removeAccessibleHyperlinkListener
	 * 
	 * @since 3.6
	 */
	public void addAccessibleHyperlinkListener(AccessibleHyperlinkListener listener) {
		checkWidget();
		if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
		if (accessibleHyperlinkListeners == null) accessibleHyperlinkListeners = new Vector();
		accessibleHyperlinkListeners.addElement(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.
	 *
	 * @param listener the listener that should be notified when the receiver
	 * is asked for AccessibleTableListener interface properties
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleTableListener
	 * @see #removeAccessibleTableListener
	 * 
	 * @since 3.6
	 */
	public void addAccessibleTableListener(AccessibleTableListener listener) {
		checkWidget();
		if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
		if (accessibleTableListeners == null) accessibleTableListeners = new Vector();
		accessibleTableListeners.addElement(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.
	 *
	 * @param listener the listener that should be notified when the receiver
	 * is asked for AccessibleTableCellListener interface properties
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleTableCellListener
	 * @see #removeAccessibleTableCellListener
	 * 
	 * @since 3.6
	 */
	public void addAccessibleTableCellListener(AccessibleTableCellListener listener) {
		checkWidget();
		if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
		if (accessibleTableCellListeners == null) accessibleTableCellListeners = new Vector();
		accessibleTableCellListeners.addElement(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.
	 *
	 * @param listener the listener that should be notified when the receiver
	 * is asked for AccessibleValueListener interface properties
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleValueListener
	 * @see #removeAccessibleValueListener
	 * 
	 * @since 3.6
	 */
	public void addAccessibleValueListener(AccessibleValueListener listener) {
		checkWidget();
		if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
		if (accessibleValueListeners == null) accessibleValueListeners = new Vector();
		accessibleValueListeners.addElement(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.
	 *
	 * @param listener the listener that should be notified when the receiver
	 * is asked for AccessibleAttributeListener interface properties
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleAttributeListener
	 * @see #removeAccessibleAttributeListener
	 * 
	 * @since 3.6
	 */
	public void addAccessibleAttributeListener(AccessibleAttributeListener listener) {
		checkWidget();
		if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
		if (accessibleAttributeListeners == null) accessibleAttributeListeners = new Vector();
		accessibleAttributeListeners.addElement(listener);
	}

	/**
	 * Adds a relation with the specified type and target
	 * to the receiver's set of relations.
	 * 
	 * @param type an ACC constant beginning with RELATION_* indicating the type of relation
	 * @param target the accessible that is the target for this relation
	 * 
	 * @since 3.6
	 */
	public void addRelation(int type, Accessible target) {
		checkWidget();
		if (relations == null) relations = new Vector();
		Relation relation = new Relation(type, target);
		if (relations.indexOf(relation) != -1) return;
		relations.add(relation);
		if (accessibleObject != null) accessibleObject.addRelation(type, target);
	}
	
	void addRelations () {
		if (relations == null) return;
		if (accessibleObject == null) return;
		for (int i = 0; i < relations.size(); i++) {
			Relation relation = (Relation)relations.elementAt(i);
			accessibleObject.addRelation(relation.type, relation.target);
		}
	}
	
	/**
	 * Disposes of the operating system resources associated with
	 * the receiver, and removes the receiver from its parent's
	 * list of children.
	 * 
    
	 * 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().
	 * 
    
	 * 
	 * @since 3.6
	 */
	public void dispose () {
		if (parent == null) return;
		release();
		parent.children.removeElement(this);
		parent = null;
	}

	/**
	 * Returns the control for this Accessible object. 
	 *
	 * @return the receiver's control
	 * @since 3.0
	 */
	public Control getControl() {
		return control;
	}

	/* checkWidget was copied from Widget, and rewritten to work in this package */
	void checkWidget () {
		if (!isValidThread ()) SWT.error (SWT.ERROR_THREAD_INVALID_ACCESS);
		if (control.isDisposed ()) SWT.error (SWT.ERROR_WIDGET_DISPOSED);
	}
	
	AccessibleObject getAccessibleObject () {
		if (accessibleObject == null) {
			if (parent == null) {
				AccessibleFactory.createAccessible(this);
			} else {
				accessibleObject = AccessibleFactory.createChildAccessible(this, ACC.CHILDID_SELF);
				accessibleObject.parent = parent.getAccessibleObject();
			}
		}
		return accessibleObject;
	}

	long /*int*/ getControlHandle () {
		long /*int*/ result = control.handle;
		if (control instanceof Label) {
			long /*int*/ list = OS.gtk_container_get_children (result);
			if (list != 0) {
				long /*int*/ temp = list;
				while (temp != 0) {
					long /*int*/ widget = OS.g_list_data( temp);
					if (OS.GTK_VERSION >= OS.VERSION (2, 18, 0) ? OS.gtk_widget_get_visible (widget) : OS.GTK_WIDGET_VISIBLE (widget)) {
						result = widget;
						break;
					}
					temp = OS.g_list_next (temp);
				}
				OS.g_list_free (list);
			}
		}
		return result;
	}

	/**
	 * Invokes platform specific functionality to dispose an 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.
	 * 
    
	 * 
	 * @noreference This method is not intended to be referenced by clients.
	 */
	public void internal_dispose_Accessible() {
		AccessibleFactory.unregisterAccessible (Accessible.this);
		release ();
	}
	
	/**
	 * 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.
	 * 
    
	 *
	 * @param control the control to get the accessible object for
	 * @return the platform specific accessible object
	 * 
	 * @noreference This method is not intended to be referenced by clients.
	 */
	public static Accessible internal_new_Accessible (Control control) {
		return new Accessible (control);
	}

	/* isValidThread was copied from Widget, and rewritten to work in this package */
	boolean isValidThread () {
		return control.getDisplay ().getThread () == Thread.currentThread ();
	}
	
	void release () {
		if (children != null) {
			for (int i = 0; i < children.size(); i++) {
				Accessible child = (Accessible) children.elementAt(i);
				child.dispose();
			}
		}
		if (accessibleObject != null) {
			accessibleObject.release ();
			accessibleObject = null;
		}
	}
	
	/**
	 * Removes the listener from the collection of listeners who will
	 * be notified when an accessible client asks for custom control
	 * specific information.
	 *
	 * @param listener the listener that should no longer be notified when the receiver
	 * is asked for custom control specific information
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleControlListener
	 * @see #addAccessibleControlListener
	 */
	public void removeAccessibleControlListener (AccessibleControlListener listener) {
		checkWidget ();
		if (listener == null) SWT.error (SWT.ERROR_NULL_ARGUMENT);
		if (accessibleControlListeners != null) {
			accessibleControlListeners.removeElement(listener);
			if (accessibleControlListeners.isEmpty()) accessibleControlListeners = null;
		}
	}

	/**
	 * 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.
	 *
	 * @param listener the listener that should no longer be notified when the receiver
	 * is asked for a name, description, help, or keyboard shortcut string
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleListener
	 * @see #addAccessibleListener
	 */
	public void removeAccessibleListener (AccessibleListener listener) {
		checkWidget ();
		if (listener == null) SWT.error (SWT.ERROR_NULL_ARGUMENT);
		if (accessibleListeners != null) {
			accessibleListeners.removeElement(listener);
			if (accessibleListeners.isEmpty()) accessibleListeners = null;
		}
	}

	/**
	 * Removes the listener from the collection of listeners who will
	 * be notified when an accessible client asks for custom text control
	 * specific information.
	 *
	 * @param listener the listener that should no longer be notified when the receiver
	 * is asked for custom text control specific information
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleTextListener
	 * @see AccessibleTextExtendedListener
	 * @see #addAccessibleTextListener
	 * 
	 * @since 3.0
	 */
	public void removeAccessibleTextListener (AccessibleTextListener listener) {
		checkWidget ();
		if (listener == null) SWT.error (SWT.ERROR_NULL_ARGUMENT);
		if (listener instanceof AccessibleTextExtendedListener) {
			if (accessibleTextExtendedListeners != null) {
				accessibleTextExtendedListeners.removeElement (listener);
				if (accessibleTextExtendedListeners.isEmpty()) accessibleTextExtendedListeners = null;
			}
		} else {
			if (accessibleTextListeners != null) {
				accessibleTextListeners.removeElement (listener);
				if (accessibleTextListeners.isEmpty()) accessibleTextListeners = null;
			}
		}
	}
	
	/**
	 * 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.
	 *
	 * @param listener the listener that should no longer be notified when the receiver
	 * is asked for AccessibleActionListener interface properties
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleActionListener
	 * @see #addAccessibleActionListener
	 * 
	 * @since 3.6
	 */
	public void removeAccessibleActionListener(AccessibleActionListener listener) {
		checkWidget();
		if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
		if (accessibleActionListeners != null) {
			accessibleActionListeners.removeElement(listener);
			if (accessibleActionListeners.isEmpty()) accessibleActionListeners = null;
		}
	}

	/**
	 * 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.
	 *
	 * @param listener the listener that should no longer be notified when the receiver
	 * is asked for AccessibleEditableTextListener interface properties
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleEditableTextListener
	 * @see #addAccessibleEditableTextListener
	 * 
	 * @since 3.7
	 */
	public void removeAccessibleEditableTextListener(AccessibleEditableTextListener listener) {
	    checkWidget();
	    if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
	    if (accessibleEditableTextListeners != null) {
	    	accessibleEditableTextListeners.removeElement(listener);
			if (accessibleEditableTextListeners.isEmpty()) accessibleEditableTextListeners = null;
	    }
	}
	
	/**
	 * 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.
	 *
	 * @param listener the listener that should no longer be notified when the receiver
	 * is asked for AccessibleHyperlinkListener interface properties
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleHyperlinkListener
	 * @see #addAccessibleHyperlinkListener
	 * 
	 * @since 3.6
	 */
	public void removeAccessibleHyperlinkListener(AccessibleHyperlinkListener listener) {
		checkWidget();
		if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
		if (accessibleHyperlinkListeners != null) {
			accessibleHyperlinkListeners.removeElement(listener);
			if (accessibleHyperlinkListeners.isEmpty()) accessibleHyperlinkListeners = null;
		}
	}

	/**
	 * 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.
	 *
	 * @param listener the listener that should no longer be notified when the receiver
	 * is asked for AccessibleTableListener interface properties
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleTableListener
	 * @see #addAccessibleTableListener
	 * 
	 * @since 3.6
	 */
	public void removeAccessibleTableListener(AccessibleTableListener listener) {
		checkWidget();
		if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
		if (accessibleTableListeners != null) {
			accessibleTableListeners.removeElement(listener);
			if (accessibleTableListeners.isEmpty()) accessibleTableListeners = null;
		}
	}

	/**
	 * 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.
	 *
	 * @param listener the listener that should no longer be notified when the receiver
	 * is asked for AccessibleTableCellListener interface properties
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleTableCellListener
	 * @see #addAccessibleTableCellListener
	 * 
	 * @since 3.6
	 */
	public void removeAccessibleTableCellListener(AccessibleTableCellListener listener) {
		checkWidget();
		if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
		if (accessibleTableCellListeners != null) {
			accessibleTableCellListeners.removeElement(listener);
			if (accessibleTableCellListeners.isEmpty()) accessibleTableCellListeners = null;
		}
	}

	/**
	 * 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.
	 *
	 * @param listener the listener that should no longer be notified when the receiver
	 * is asked for AccessibleValueListener interface properties
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleValueListener
	 * @see #addAccessibleValueListener
	 * 
	 * @since 3.6
	 */
	public void removeAccessibleValueListener(AccessibleValueListener listener) {
		checkWidget();
		if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
		if (accessibleValueListeners != null) {
			accessibleValueListeners.removeElement(listener);
			if (accessibleValueListeners.isEmpty()) accessibleValueListeners = null;
		}
	}

	/**
	 * 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.
	 *
	 * @param listener the listener that should no longer be notified when the receiver
	 * is asked for AccessibleAttributeListener interface properties
	 *
	 * @exception IllegalArgumentException 
      
	 *    
    • ERROR_NULL_ARGUMENT - if the listener is null
      • 
	 * 
    
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @see AccessibleAttributeListener
	 * @see #addAccessibleAttributeListener
	 * 
	 * @since 3.6
	 */
	public void removeAccessibleAttributeListener(AccessibleAttributeListener listener) {
		checkWidget();
		if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
		if (accessibleAttributeListeners != null) {
			accessibleAttributeListeners.removeElement(listener);
			if (accessibleAttributeListeners.isEmpty()) accessibleAttributeListeners = null;
		}
	}

	/**
	 * Removes the relation with the specified type and target
	 * from the receiver's set of relations.
	 * 
	 * @param type an ACC constant beginning with RELATION_* indicating the type of relation
	 * @param target the accessible that is the target for this relation
	 * 
	 * @since 3.6
	 */
	public void removeRelation(int type, Accessible target) {
		checkWidget();
		if (relations == null) return;
		Relation relation = new Relation(type, target);
		int index = relations.indexOf(relation);
		if (index == -1) return;
		relations.remove(index);
		if (accessibleObject != null) accessibleObject.removeRelation(type, target);
	}

	/**
	 * Sends a message with event-specific data to accessible clients
	 * indicating that something has changed within a custom control.
	 *
	 * @param event an ACC constant beginning with EVENT_* indicating the message to send
	 * @param eventData 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)
	 * 
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 * 
	 * @see ACC#EVENT_ACTION_CHANGED
	 * @see ACC#EVENT_ATTRIBUTE_CHANGED
	 * @see ACC#EVENT_DESCRIPTION_CHANGED
	 * @see ACC#EVENT_DOCUMENT_LOAD_COMPLETE
	 * @see ACC#EVENT_DOCUMENT_LOAD_STOPPED
	 * @see ACC#EVENT_DOCUMENT_RELOAD
	 * @see ACC#EVENT_HYPERLINK_ACTIVATED
	 * @see ACC#EVENT_HYPERLINK_ANCHOR_COUNT_CHANGED
	 * @see ACC#EVENT_HYPERLINK_END_INDEX_CHANGED
	 * @see ACC#EVENT_HYPERLINK_SELECTED_LINK_CHANGED
	 * @see ACC#EVENT_HYPERLINK_START_INDEX_CHANGED
	 * @see ACC#EVENT_HYPERTEXT_LINK_COUNT_CHANGED
	 * @see ACC#EVENT_HYPERTEXT_LINK_SELECTED
	 * @see ACC#EVENT_LOCATION_CHANGED
	 * @see ACC#EVENT_NAME_CHANGED
	 * @see ACC#EVENT_PAGE_CHANGED
	 * @see ACC#EVENT_SECTION_CHANGED
	 * @see ACC#EVENT_SELECTION_CHANGED
	 * @see ACC#EVENT_STATE_CHANGED
	 * @see ACC#EVENT_TABLE_CAPTION_CHANGED
	 * @see ACC#EVENT_TABLE_CHANGED
	 * @see ACC#EVENT_TABLE_COLUMN_DESCRIPTION_CHANGED
	 * @see ACC#EVENT_TABLE_COLUMN_HEADER_CHANGED
	 * @see ACC#EVENT_TABLE_ROW_DESCRIPTION_CHANGED
	 * @see ACC#EVENT_TABLE_ROW_HEADER_CHANGED
	 * @see ACC#EVENT_TABLE_SUMMARY_CHANGED
	 * @see ACC#EVENT_TEXT_ATTRIBUTE_CHANGED
	 * @see ACC#EVENT_TEXT_CARET_MOVED
	 * @see ACC#EVENT_TEXT_CHANGED
	 * @see ACC#EVENT_TEXT_COLUMN_CHANGED
	 * @see ACC#EVENT_TEXT_SELECTION_CHANGED
	 * @see ACC#EVENT_VALUE_CHANGED
	 * 
	 * @since 3.6
	 */
	public void sendEvent(int event, Object eventData) {
		checkWidget();
		if (accessibleObject != null) {
			accessibleObject.sendEvent(event, eventData);
		}
	}
	
	/**
	 * Sends a message with event-specific data and a childID
	 * to accessible clients, indicating that something has changed
	 * within a custom control.
	 * 
	 * NOTE: This API is intended for applications that are still using childIDs.
	 * Moving forward, applications should use accessible objects instead of childIDs.
	 *
	 * @param event an ACC constant beginning with EVENT_* indicating the message to send
	 * @param eventData 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)
	 * @param childID an identifier specifying a child of the control
	 * 
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 * 
	 * @see ACC#EVENT_DESCRIPTION_CHANGED
	 * @see ACC#EVENT_LOCATION_CHANGED
	 * @see ACC#EVENT_NAME_CHANGED
	 * @see ACC#EVENT_SELECTION_CHANGED
	 * @see ACC#EVENT_STATE_CHANGED
	 * @see ACC#EVENT_TEXT_SELECTION_CHANGED
	 * @see ACC#EVENT_VALUE_CHANGED
	 * 
	 * @since 3.8
	 */
	public void sendEvent(int event, Object eventData, int childID) {
		checkWidget();
		if (accessibleObject != null) {
			switch (event) {
				case ACC.EVENT_STATE_CHANGED:
				case ACC.EVENT_NAME_CHANGED:
				case ACC.EVENT_VALUE_CHANGED:
				case ACC.EVENT_LOCATION_CHANGED:
				case ACC.EVENT_SELECTION_CHANGED:
				case ACC.EVENT_TEXT_SELECTION_CHANGED:
				case ACC.EVENT_DESCRIPTION_CHANGED:
					accessibleObject.sendEvent(event, eventData, childID);
			}
		}
	}
	
	/**
	 * Sends a message to accessible clients that the child selection
	 * within a custom container control has changed.
	 *
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 * 
	 * @since 3.0
	 */
	public void selectionChanged () {
		checkWidget ();
		if (accessibleObject != null) {
			accessibleObject.selectionChanged ();
		}
	}

	/**
	 * Sends a message to accessible clients indicating that the focus
	 * has changed within a custom control.
	 *
	 * @param childID an identifier specifying a child of the control
	 * 
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 */
	public void setFocus (int childID) {
		checkWidget ();
		if (accessibleObject != null) {
			accessibleObject.setFocus (childID);
		}
	}
	
	/**
	 * Sends a message to accessible clients that the text
	 * caret has moved within a custom control.
	 *
	 * @param index the new caret index within the control
	 * 
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @since 3.0
	 */
	public void textCaretMoved (int index) {
		checkWidget ();
		if (accessibleObject != null) {
			accessibleObject.textCaretMoved (index);
		}
	}

	/**
	 * Sends a message to accessible clients that the text
	 * within a custom control has changed.
	 *
	 * @param type the type of change, one of ACC.TEXT_INSERT
	 * or ACC.TEXT_DELETE
	 * @param startIndex the text index within the control where the insertion or deletion begins
	 * @param length the non-negative length in characters of the insertion or deletion
	 *
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 * 
	 * @see ACC#TEXT_INSERT
	 * @see ACC#TEXT_DELETE
	 * 
	 * @since 3.0
	 */
	public void textChanged (int type, int startIndex, int length) {
		checkWidget ();
		if (accessibleObject != null) {
			accessibleObject.textChanged (type, startIndex, length);
		}
	}

	/**
	 * Sends a message to accessible clients that the text
	 * selection has changed within a custom control.
	 *
	 * @exception SWTException 
      
	 *    
    • ERROR_WIDGET_DISPOSED - if the receiver's control has been disposed
      • 
	 *    
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control
      • 
	 * 
    
	 *
	 * @since 3.0
	 */
	public void textSelectionChanged () {
		checkWidget ();
		if (accessibleObject != null) {
			accessibleObject.textSelectionChanged ();
		}
	}
}




    © 2015 - 2025 Weber Informatics LLC | Privacy Policy