Attachment 181567 Details for Bug 328521 – Patch

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Patch

accessible_listener.patch (text/plain), 15.52 KB, created by Elias Volanakis

on 2010-10-22 21:35:00 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Elias Volanakis

Created: 2010-10-22 21:35:00 EDT

Size: 15.52 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.rap.rwt
>Index: META-INF/MANIFEST.MF
>===================================================================
>RCS file: /cvsroot/rt/org.eclipse.rap/runtime.rwt/org.eclipse.rap.rwt/META-INF/MANIFEST.MF,v
>retrieving revision 1.60
>diff -u -r1.60 MANIFEST.MF
>--- META-INF/MANIFEST.MF	11 Aug 2010 13:42:34 -0000	1.60
>+++ META-INF/MANIFEST.MF	23 Oct 2010 01:34:20 -0000
>@@ -36,6 +36,7 @@
> org.eclipse.rwt.theme,
> org.eclipse.rwt.widgets,
> org.eclipse.swt,
>+ org.eclipse.swt.accessibility,
> org.eclipse.swt.browser,
> org.eclipse.swt.custom,
> org.eclipse.swt.dnd,
>Index: src/org/eclipse/swt/accessibility/AccessibleAdapter.java
>===================================================================
>RCS file: src/org/eclipse/swt/accessibility/AccessibleAdapter.java
>diff -N src/org/eclipse/swt/accessibility/AccessibleAdapter.java
>--- /dev/null	1 Jan 1970 00:00:00 -0000
>+++ src/org/eclipse/swt/accessibility/AccessibleAdapter.java	1 Jan 1970 00:00:00 -0000
>@@ -0,0 +1,135 @@
>+/*******************************************************************************
>+ * Copyright (c) 2000, 2008 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;
>+
>+/**
>+ * This adapter class provides default implementations for the methods described
>+ * by the <code>AccessibleListener</code> interface.
>+ * 
>+ * Classes that wish to deal with <code>AccessibleEvent</code>s can extend this
>+ * class and override only the methods that they are interested in.
>+ * 
>+ * 
>+ * 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.
>+ * 
>+ * 
>+ * @see AccessibleListener
>+ * @see AccessibleEvent
>+ * @see <a href="http://www.eclipse.org/swt/">Sample code and further
>+ * information</a>
>+ * @since 1.4
>+ */
>+public abstract class AccessibleAdapter implements AccessibleListener {
>+
>+ /**
>+ * Sent when an accessibility client requests the name of the control, or the
>+ * name of a child of the control. The default behavior is to do nothing.
>+ * 
>+ * Return the name of the control or specified child in the
>+ * <code>result</code> field of the event object. Returning an empty string
>+ * tells the client that the control or child does not have a name, and
>+ * returning null tells the client to use the platform name.
>+ * 
>+ * 
>+ * @param e an event object containing the following fields:
>+ * <ul>
>+ * <li>childID [IN] - an identifier specifying the control or one of
>+ * its children</li>
>+ * <li>result [OUT] - the requested name string, or null</li>
>+ * </ul>
>+ */
>+ public void getName( AccessibleEvent e ) {
>+ }
>+
>+ /**
>+ * Sent when an accessibility client requests the help string of the control,
>+ * or the help string of a child of the control. The default behavior is to do
>+ * nothing.
>+ * 
>+ * The information in this property should be similar to the help provided by
>+ * toolTipText. It describes what the control or child does or how to use it,
>+ * as opposed to getDescription, which describes appearance.
>+ * 
>+ * 
>+ * Return the help string of the control or specified child in the
>+ * <code>result</code> field of the event object. Returning an empty string
>+ * tells the client that the control or child does not have a help string, and
>+ * returning null tells the client to use the platform help string.
>+ * 
>+ * 
>+ * @param e an event object containing the following fields:
>+ * <ul>
>+ * <li>childID [IN] - an identifier specifying the control or one of
>+ * its children</li>
>+ * <li>result [OUT] - the requested help string, or null</li>
>+ * </ul>
>+ */
>+ public void getHelp( AccessibleEvent e ) {
>+ }
>+
>+ /**
>+ * Sent when an accessibility client requests the keyboard shortcut of the
>+ * control, or the keyboard shortcut of a child of the control. The default
>+ * behavior is to do nothing.
>+ * 
>+ * A keyboard shortcut can either be a mnemonic, or an accelerator. As a
>+ * general rule, if the control or child can receive keyboard focus, then you
>+ * should expose its mnemonic, and if it cannot receive keyboard focus, then
>+ * you should expose its accelerator.
>+ * 
>+ * 
>+ * Return the keyboard shortcut string of the control or specified child in
>+ * the <code>result</code> field of the event object. Returning an empty
>+ * string tells the client that the control or child does not have a keyboard
>+ * shortcut string, and returning null tells the client to use the platform
>+ * keyboard shortcut string.
>+ * 
>+ * 
>+ * @param e an event object containing the following fields:
>+ * <ul>
>+ * <li>childID [IN] - an identifier specifying the control or one of
>+ * its children</li>
>+ * <li>result [OUT] - the requested keyboard shortcut string
>+ * (example: "ALT+N"), or null</li>
>+ * </ul>
>+ */
>+ public void getKeyboardShortcut( AccessibleEvent e ) {
>+ }
>+
>+ /**
>+ * Sent when an accessibility client requests a description of the control, or
>+ * a description of a child of the control. The default behavior is to do
>+ * nothing.
>+ * 
>+ * This is a textual description of the control or child's visual appearance,
>+ * which is typically only necessary if it cannot be determined from other
>+ * properties such as role.
>+ * 
>+ * 
>+ * Return the description of the control or specified child in the
>+ * <code>result</code> field of the event object. Returning an empty string
>+ * tells the client that the control or child does not have a description, and
>+ * returning null tells the client to use the platform description.
>+ * 
>+ * 
>+ * @param e an event object containing the following fields:
>+ * <ul>
>+ * <li>childID [IN] - an identifier specifying the control or one of
>+ * its children</li>
>+ * <li>result [OUT] - the requested description string, or null</li>
>+ * </ul>
>+ */
>+ public void getDescription( AccessibleEvent e ) {
>+ }
>+}
>Index: src/org/eclipse/swt/accessibility/AccessibleEvent.java
>===================================================================
>RCS file: src/org/eclipse/swt/accessibility/AccessibleEvent.java
>diff -N src/org/eclipse/swt/accessibility/AccessibleEvent.java
>--- /dev/null	1 Jan 1970 00:00:00 -0000
>+++ src/org/eclipse/swt/accessibility/AccessibleEvent.java	1 Jan 1970 00:00:00 -0000
>@@ -0,0 +1,63 @@
>+/*******************************************************************************
>+ * Copyright (c) 2000, 2008 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 org.eclipse.swt.internal.SWTEventObject;
>+
>+/**
>+ * Instances of this class are sent as a result of accessibility clients sending
>+ * messages to controls asking for information about the control instance.
>+ * 
>+ * Note: The meaning of the result field depends on the message that was sent.
>+ * 
>+ * 
>+ * @see AccessibleListener
>+ * @see AccessibleAdapter
>+ * @see <a href="http://www.eclipse.org/swt/">Sample code and further
>+ * information</a>
>+ * @since 1.4
>+ */
>+public class AccessibleEvent extends SWTEventObject {
>+
>+ /**
>+ * The value of this field is set by an accessibility client before the
>+ * accessible listener method is called. ChildID can be CHILDID_SELF,
>+ * representing the control itself, or a 0-based integer representing a
>+ * specific child of the control.
>+ */
>+ public int childID;
>+ /**
>+ * The value of this field must be set in the accessible listener method
>+ * before returning. What to set it to depends on the listener method called,
>+ * and the childID specified by the client.
>+ */
>+ public String result;
>+ static final long serialVersionUID = 3257567304224026934L;
>+
>+ /**
>+ * Constructs a new instance of this class.
>+ * 
>+ * @param source the object that fired the event
>+ */
>+ public AccessibleEvent( Object source ) {
>+ super( source );
>+ }
>+
>+ /**
>+ * Returns a string containing a concise, human-readable description of the
>+ * receiver.
>+ * 
>+ * @return a string representation of the event
>+ */
>+ public String toString() {
>+ return "AccessibleEvent {childID=" + childID + " result=" + result + "}"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
>+ }
>+}
>Index: src/org/eclipse/swt/accessibility/AccessibleListener.java
>===================================================================
>RCS file: src/org/eclipse/swt/accessibility/AccessibleListener.java
>diff -N src/org/eclipse/swt/accessibility/AccessibleListener.java
>--- /dev/null	1 Jan 1970 00:00:00 -0000
>+++ src/org/eclipse/swt/accessibility/AccessibleListener.java	1 Jan 1970 00:00:00 -0000
>@@ -0,0 +1,131 @@
>+/*******************************************************************************
>+ * Copyright (c) 2000, 2005 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 org.eclipse.swt.internal.SWTEventListener;
>+
>+/**
>+ * 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>addAccessibleListener</code> method and
>+ * removed using the <code>removeAccessibleListener</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.
>+ * 
>+ * 
>+ * @see AccessibleAdapter
>+ * @see AccessibleEvent
>+ * @since 1.4
>+ */
>+public interface AccessibleListener extends SWTEventListener {
>+
>+ /**
>+ * Sent when an accessibility client requests the name of the control, or the
>+ * name of a child of the control.
>+ * 
>+ * Return the name of the control or specified child in the
>+ * <code>result</code> field of the event object. Returning an empty string
>+ * tells the client that the control or child does not have a name, and
>+ * returning null tells the client to use the platform name.
>+ * 
>+ * 
>+ * @param e an event object containing the following fields:
>+ * <ul>
>+ * <li>childID [IN] - an identifier specifying the control or one of
>+ * its children</li>
>+ * <li>result [OUT] - the requested name string, or null</li>
>+ * </ul>
>+ */
>+ public void getName( AccessibleEvent e );
>+
>+ /**
>+ * Sent when an accessibility client requests the help string of the control,
>+ * or the help string of a child of the control.
>+ * 
>+ * The information in this property should be similar to the help provided by
>+ * toolTipText. It describes what the control or child does or how to use it,
>+ * as opposed to getDescription, which describes appearance.
>+ * 
>+ * 
>+ * Return the help string of the control or specified child in the
>+ * <code>result</code> field of the event object. Returning an empty string
>+ * tells the client that the control or child does not have a help string, and
>+ * returning null tells the client to use the platform help string.
>+ * 
>+ * 
>+ * @param e an event object containing the following fields:
>+ * <ul>
>+ * <li>childID [IN] - an identifier specifying the control or one of
>+ * its children</li>
>+ * <li>result [OUT] - the requested help string, or null</li>
>+ * </ul>
>+ */
>+ public void getHelp( AccessibleEvent e );
>+
>+ /**
>+ * Sent when an accessibility client requests the keyboard shortcut of the
>+ * control, or the keyboard shortcut of a child of the control.
>+ * 
>+ * A keyboard shortcut can either be a mnemonic, or an accelerator. As a
>+ * general rule, if the control or child can receive keyboard focus, then you
>+ * should expose its mnemonic, and if it cannot receive keyboard focus, then
>+ * you should expose its accelerator.
>+ * 
>+ * 
>+ * Return the keyboard shortcut string of the control or specified child in
>+ * the <code>result</code> field of the event object. Returning an empty
>+ * string tells the client that the control or child does not have a keyboard
>+ * shortcut string, and returning null tells the client to use the platform
>+ * keyboard shortcut string.
>+ * 
>+ * 
>+ * @param e an event object containing the following fields:
>+ * <ul>
>+ * <li>childID [IN] - an identifier specifying the control or one of
>+ * its children</li>
>+ * <li>result [OUT] - the requested keyboard shortcut string
>+ * (example: "ALT+N"), or null</li>
>+ * </ul>
>+ */
>+ public void getKeyboardShortcut( AccessibleEvent e );
>+
>+ /**
>+ * Sent when an accessibility client requests a description of the control, or
>+ * a description of a child of the control.
>+ * 
>+ * This is a textual description of the control or child's visual appearance,
>+ * which is typically only necessary if it cannot be determined from other
>+ * properties such as role.
>+ * 
>+ * 
>+ * Return the description of the control or specified child in the
>+ * <code>result</code> field of the event object. Returning an empty string
>+ * tells the client that the control or child does not have a description, and
>+ * returning null tells the client to use the platform description.
>+ * 
>+ * 
>+ * @param e an event object containing the following fields:
>+ * <ul>
>+ * <li>childID [IN] - an identifier specifying the control or one of
>+ * its children</li>
>+ * <li>result [OUT] - the requested description string, or null</li>
>+ * </ul>
>+ */
>+ public void getDescription( AccessibleEvent e );
>+}

Actions: View

Attachments on bug 328521: 181567