001/* Adjustable.java -- Objects with a numeric adjustment scale
002   Copyright (C) 1999, 2002, 2005  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package java.awt;
040
041import java.awt.event.AdjustmentListener;
042
043/**
044 * This interface is for objects that take a numeric value that can be
045 * adjusted within a bounded range.  For example, a scroll bar.
046 *
047 * @author Aaron M. Renn (arenn@urbanophile.com)
048 * @since 1.0
049 * @status updated to 1.4
050 */
051public interface Adjustable
052{
053  /** Constant for an adjustable object with horizontal orientation. */
054  int HORIZONTAL = 0;
055
056  /** Constant for an adjustable object with vertical orientation. */
057  int VERTICAL = 1;
058
059  /** Constant for an adjustable object with no orientation. */
060  int NO_ORIENTATION = 2;
061
062  /**
063   * Returns a constant representing the orientation of the object.
064   *
065   * @return the orientation of this object
066   * @see #HORIZONTAL
067   * @see #VERTICAL
068   * @see #NO_ORIENTATION
069   */
070  int getOrientation();
071
072  /**
073   * Sets the minimum value this object can have.
074   *
075   * @param minimum the new minimum value
076   */
077  void setMinimum(int minimum);
078
079  /**
080   * Returns the minimum value this object can have.
081   *
082   * @return the minimum value
083   */
084  int getMinimum();
085
086  /**
087   * Sets the maximum value this object can have.
088   *
089   * @param maximum the new maximum value
090   */
091  void setMaximum(int maximum);
092
093  /**
094   * Returns the maximum value this object can have.
095   *
096   * @return the maximum value
097   */
098  int getMaximum();
099
100  /**
101   * Sets the increment value for incrementing the value by units.
102   *
103   * @param increment the unit increment value
104   */
105  void setUnitIncrement(int increment);
106
107  /**
108   * Returns the increment value for incrementing the value by units.
109   *
110   * @return the unit increment value
111   */
112  int getUnitIncrement();
113
114  /**
115   * Sets the increment value for incrementing the value by blocks.
116   *
117   * @param increment the block increment value
118   */
119  void setBlockIncrement(int increment);
120
121  /**
122   * Returns the increment value for incrementing the value by blocks.
123   *
124   * @return the block increment value
125   */
126  int getBlockIncrement();
127
128  /**
129   * Sets the length of the indicator for this object to the specified value.
130   *
131   * @param length the indicator length
132   */
133  void setVisibleAmount(int length);
134
135  /**
136   * Returns the length of the indicator for this object.
137   *
138   * @return the indicator length
139   */
140  int getVisibleAmount();
141
142  /**
143   * Sets the current value of the object.
144   *
145   * @param value the new value
146   */
147  void setValue(int value);
148
149  /**
150   * Returns the current value of the object.
151   *
152   * @return the current value
153   */
154  int getValue();
155
156  /**
157   * Adds a listener that will receive adjustment events for this object.
158   *
159   * @param listener the adjustment listener to add
160   * @see java.awt.event.AdjustmentEvent
161   */
162  void addAdjustmentListener(AdjustmentListener listener);
163
164  /**
165   * Removes an adjustment listener from this object.
166   *
167   * @param listener the adjustment listener to remove
168   * @see java.awt.event.AdjustmentEvent
169   */
170  void removeAdjustmentListener(AdjustmentListener listener);
171} // interface Adjustable