1. /*

  2.  * @(#)AccessibleValue.java	1.14 03/01/23

  3.  *

  4.  * Copyright 2003 Sun Microsystems, Inc. All rights reserved.

  5.  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

  6.  */

  7. 

  8. package javax.accessibility;

  9. 

  10. /**

  11.  * The AccessibleValue interface should be supported by any object 

  12.  * that supports a numerical value (e.g., a scroll bar).  This interface 

  13.  * provides the standard mechanism for an assistive technology to determine 

  14.  * and set the numerical value as well as get the minimum and maximum values.

  15.  * Applications can determine

  16.  * if an object supports the AccessibleValue interface by first

  17.  * obtaining its AccessibleContext (see

  18.  * {@link Accessible}) and then calling the

  19.  * {@link AccessibleContext#getAccessibleValue} method.

  20.  * If the return value is not null, the object supports this interface.

  21.  *

  22.  * @see Accessible

  23.  * @see Accessible#getAccessibleContext

  24.  * @see AccessibleContext

  25.  * @see AccessibleContext#getAccessibleValue

  26.  *

  27.  * @version     1.9 10/12/99 15:41:54

  28.  * @author	Peter Korn

  29.  * @author      Hans Muller

  30.  * @author      Willie Walker

  31.  */

  32. public interface AccessibleValue {

  33. 

  34.     /**

  35.      * Get the value of this object as a Number.  If the value has not been

  36.      * set, the return value will be null.

  37.      *

  38.      * @return value of the object

  39.      * @see #setCurrentAccessibleValue

  40.      */

  41.     public Number getCurrentAccessibleValue();

  42. 

  43.     /**

  44.      * Set the value of this object as a Number.

  45.      *

  46.      * @return True if the value was set; else False

  47.      * @see #getCurrentAccessibleValue

  48.      */

  49.     public boolean setCurrentAccessibleValue(Number n);

  50. 

  51. //    /**

  52. //     * Get the description of the value of this object.

  53. //     *

  54. //     * @return description of the value of the object

  55. //     */

  56. //    public String getAccessibleValueDescription();

  57. 

  58.     /**

  59.      * Get the minimum value of this object as a Number.

  60.      *

  61.      * @return Minimum value of the object; null if this object does not 

  62.      * have a minimum value

  63.      * @see #getMaximumAccessibleValue

  64.      */

  65.     public Number getMinimumAccessibleValue();

  66. 

  67.     /**

  68.      * Get the maximum value of this object as a Number.

  69.      *

  70.      * @return Maximum value of the object; null if this object does not 

  71.      * have a maximum value

  72.      * @see #getMinimumAccessibleValue

  73.      */

  74.     public Number getMaximumAccessibleValue();

  75. }