bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/accessibility/AccessibleEvent.java

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