1. /*

  2.  * @(#)AccessibleValue.java	1.12 00/02/02

  3.  *

  4.  * Copyright 1997-2000 Sun Microsystems, Inc. All Rights Reserved.

  5.  * 

  6.  * This software is the proprietary information of Sun Microsystems, Inc.  

  7.  * Use is subject to license terms.

  8.  * 

  9.  */

  10. 

  11. package javax.accessibility;

  12. 

  13. /**

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

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

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

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

  18.  * Applications can determine

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

  20.  * obtaining its AccessibleContext (see

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

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

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

  24.  *

  25.  * @see Accessible

  26.  * @see Accessible#getAccessibleContext

  27.  * @see AccessibleContext

  28.  * @see AccessibleContext#getAccessibleValue

  29.  *

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

  31.  * @author	Peter Korn

  32.  * @author      Hans Muller

  33.  * @author      Willie Walker

  34.  */

  35. public interface AccessibleValue {

  36. 

  37.     /**

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

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

  40.      *

  41.      * @return value of the object

  42.      * @see #setCurrentAccessibleValue

  43.      */

  44.     public Number getCurrentAccessibleValue();

  45. 

  46.     /**

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

  48.      *

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

  50.      * @see #getCurrentAccessibleValue

  51.      */

  52.     public boolean setCurrentAccessibleValue(Number n);

  53. 

  54. //    /**

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

  56. //     *

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

  58. //     */

  59. //    public String getAccessibleValueDescription();

  60. 

  61.     /**

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

  63.      *

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

  65.      * have a minimum value

  66.      * @see #getMaximumAccessibleValue

  67.      */

  68.     public Number getMinimumAccessibleValue();

  69. 

  70.     /**

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

  72.      *

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

  74.      * have a maximum value

  75.      * @see #getMinimumAccessibleValue

  76.      */

  77.     public Number getMaximumAccessibleValue();

  78. }