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

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2016 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  * This adapter class provides default implementations for the
  18  * methods in the <code>AccessibleValueListener</code> interface.
  19  * <p>
  20  * Classes that wish to deal with <code>AccessibleValue</code> events can
  21  * extend this class and override only the methods that they are
  22  * interested in.
  23  * </p>
  24  *
  25  * @see AccessibleValueListener
  26  * @see AccessibleValueEvent
  27  *
  28  * @since 3.6
  29  */
  30 public class AccessibleValueAdapter implements AccessibleValueListener {
  31         /**
  32          * Returns the value of this object as a number.
  33          *
  34          * @param e an event object containing the following fields:<ul>
  35          * <li>[out] value - the number that is the current value of this object</li>
  36          * </ul>
  37          */
  38         @Override
  39         public void getCurrentValue(AccessibleValueEvent e) {}
  40
  41         /**
  42          * Sets the value of this object to the given number.
  43          *
  44          * The argument is clipped to the valid interval whose upper and lower
  45          * bounds are returned by getMaximumValue and getMinimumValue,
  46          * i.e. if it is lower than the minimum value the new value will be the minimum,
  47          * and if it is greater than the maximum then the new value will be the maximum.
  48          *
  49          * @param e an event object containing the following fields:<ul>
  50          * <li>[in/out] value - on input, the number that will be the new value of this object
  51          *              <br>- on output, set to null if the value cannot be set</li>
  52          * </ul>
  53          */
  54         @Override
  55         public void setCurrentValue(AccessibleValueEvent e) {}
  56
  57         /**
  58          * Returns the maximum value that can be represented by this object.
  59          *
  60          * @param e an event object containing the following fields:<ul>
  61          * <li>[out] value - the number that is the maximum value that this object can represent.
  62          *              If this object has no upper bound then null is returned.</li>
  63          * </ul>
  64          */
  65         @Override
  66         public void getMaximumValue(AccessibleValueEvent e) {}
  67
  68         /**
  69          * Returns the minimum value that can be represented by this object.
  70          *
  71          * @param e an event object containing the following fields:<ul>
  72          * <li>[out] value - the number that is the minimum value that this object can represent.
  73          *              If this object has no lower bound then null is returned.</li>
  74          * </ul>
  75          */
  76         @Override
  77         public void getMinimumValue(AccessibleValueEvent e) {}
  78 }