KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > swt > accessibility > AccessibleEvent


1 /*******************************************************************************
2  * Copyright (c) 2000, 2004 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.swt.accessibility;
12
13
14 import org.eclipse.swt.internal.SWTEventObject;
15
16 /**
17  * Instances of this class are sent as a result of
18  * accessibility clients sending messages to controls
19  * asking for information about the control instance.
20  * <p>
21  * Note: The meaning of the result field depends
22  * on the message that was sent.
23  * </p>
24  *
25  * @see AccessibleListener
26  * @see AccessibleAdapter
27  *
28  * @since 2.0
29  */
30 public class AccessibleEvent extends SWTEventObject {
31     /**
32      * The value of this field is set by an accessibility client
33      * before the accessible listener method is called.
34      * ChildID can be CHILDID_SELF, representing the control itself,
35      * or a 0-based integer representing a specific child of the control.
36      */
37     public int childID;
38     
39     /**
40      * The value of this field must be set in the accessible listener
41      * method before returning.
42      * What to set it to depends on the listener method called, and
43      * the childID specified by the client.
44      */
45     public String JavaDoc result;
46     
47     static final long serialVersionUID = 3257567304224026934L;
48     
49 /**
50  * Constructs a new instance of this class.
51  *
52  * @param source the object that fired the event
53  */
54 public AccessibleEvent(Object JavaDoc source) {
55     super(source);
56 }
57
58 /**
59  * Returns a string containing a concise, human-readable
60  * description of the receiver.
61  *
62  * @return a string representation of the event
63  */
64 public String JavaDoc toString () {
65     return "AccessibleEvent {childID=" + childID + " result=" + result + "}"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
66 }
67 }
68
Popular Tags