home *** CD-ROM | disk | FTP | other *** search
/ Java 1.2 How-To / JavaHowTo.iso / 3rdParty / jbuilder / unsupported / JDK1.2beta3 / SOURCE / SRC.ZIP / java / awt / accessibility / AccessibleValue.java < prev   
Encoding:
Java Source  |  1998-03-20  |  3.1 KB  |  91 lines
  1. /*
  2.  * @(#)AccessibleValue.java    1.5 98/02/04
  3.  * 
  4.  * Copyright (c) 1997 Sun Microsystems, Inc. All Rights Reserved.
  5.  * 
  6.  * This software is the confidential and proprietary information of Sun
  7.  * Microsystems, Inc. ("Confidential Information").  You shall not
  8.  * disclose such Confidential Information and shall use it only in
  9.  * accordance with the terms of the license agreement you entered into
  10.  * with Sun.
  11.  * 
  12.  * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
  13.  * SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  14.  * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  15.  * PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR ANY DAMAGES
  16.  * SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
  17.  * THIS SOFTWARE OR ITS DERIVATIVES.
  18.  * 
  19.  */
  20.  
  21. package java.awt.accessibility;
  22.  
  23. /**
  24.  * The AccessibleValue interface should be supported by any object 
  25.  * that supports a numerical value (e.g., a scroll bar).  This interface 
  26.  * provides the standard mechanism for an assistive technology to determine 
  27.  * and set the numerical value as well as get the minimum and maximum values.
  28.  * Applications can determine
  29.  * if an object supports the AccessibleValue interface by first
  30.  * obtaining its AccessibleContext (see
  31.  * <a href="java.awt.accessibility.Accessible.html">Accessible</a>) and
  32.  * then calling the
  33.  * <a href="java.awt.accessibility.AccessibleContext.html#getAccessibleValue">
  34.  * getAccessibleValue</a> method of AccessibleContext.  If the return 
  35.  * value is not null, the object supports this interface.
  36.  *
  37.  * @see Accessible
  38.  * @see Accessible#getAccessibleContext
  39.  * @see AccessibleContext
  40.  * @see AccessibleContext#getAccessibleValue
  41.  *
  42.  * @version     1.5 02/04/98 11:49:35
  43.  * @author    Peter Korn
  44.  * @author      Hans Muller
  45.  * @author      Willie Walker
  46.  */
  47. public interface AccessibleValue {
  48.  
  49.     /**
  50.      * Get the value of this object as a Number.  If the value has not been
  51.      * set, the return value will be null.
  52.      *
  53.      * @return value of the object
  54.      * @see #setCurrentAccessibleValue
  55.      */
  56.     public Number getCurrentAccessibleValue();
  57.  
  58.     /**
  59.      * Set the value of this object as a Number.
  60.      *
  61.      * @return True if the value was set; else False
  62.      * @see #getCurrentAccessibleValue
  63.      */
  64.     public boolean setCurrentAccessibleValue(Number n);
  65.  
  66. //    /**
  67. //     * Get the description of the value of this object.
  68. //     *
  69. //     * @return description of the value of the object
  70. //     */
  71. //    public String getAccessibleValueDescription();
  72.  
  73.     /**
  74.      * Get the minimum value of this object as a Number.
  75.      *
  76.      * @return Minimum value of the object; null if this object does not 
  77.      * have a minimum value
  78.      * @see #getMaximumAccessibleValue
  79.      */
  80.     public Number getMinimumAccessibleValue();
  81.  
  82.     /**
  83.      * Get the maximum value of this object as a Number.
  84.      *
  85.      * @return Maximum value of the object; null if this object does not 
  86.      * have a maximum value
  87.      * @see #getMinimumAccessibleValue
  88.      */
  89.     public Number getMaximumAccessibleValue();
  90. }
  91.