aboutsummaryrefslogtreecommitdiff
path: root/libjava/java/awt/Adjustable.java
diff options
context:
space:
mode:
Diffstat (limited to 'libjava/java/awt/Adjustable.java')
-rw-r--r--libjava/java/awt/Adjustable.java233
1 files changed, 203 insertions, 30 deletions
diff --git a/libjava/java/awt/Adjustable.java b/libjava/java/awt/Adjustable.java
index bfdbb39..eb773a0 100644
--- a/libjava/java/awt/Adjustable.java
+++ b/libjava/java/awt/Adjustable.java
@@ -1,39 +1,212 @@
-/* Copyright (C) 1999, 2000 Free Software Foundation
+/* Adjustable.java -- Objects with a numeric adjustment scale.
+ Copyright (C) 1999 Free Software Foundation, Inc.
- This file is part of libjava.
+This file is part of GNU Classpath.
+
+GNU Classpath is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+GNU Classpath is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GNU Classpath; see the file COPYING. If not, write to the
+Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+02111-1307 USA.
+
+As a special exception, if you link this library with other files to
+produce an executable, this library does not by itself cause the
+resulting executable to be covered by the GNU General Public License.
+This exception does not however invalidate any other reasons why the
+executable file might be covered by the GNU General Public License. */
-This software is copyrighted work licensed under the terms of the
-Libjava License. Please consult the file "LIBJAVA_LICENSE" for
-details. */
package java.awt;
-import java.awt.event.*;
+
+import java.awt.event.AdjustmentListener;
/**
- * @author Tom Tromey <tromey@cygnus.com>
- * @date April 8, 2000
+ * This interface is for objects that take a numeric value that
+ * can be adjusted within a bounded range. For example, a scroll bar.
+ *
+ * @author Aaron M. Renn (arenn@urbanophile.com)
+ */
+public interface Adjustable
+{
+
+/*
+ * Static Variables
*/
-/* Status: Believed complete and correct to JDK 1.2. */
+/**
+ * Constant for a horizontal orientation
+ */
+public static final int HORIZONTAL = 0;
+
+/**
+ * Constant for a vertical orientation
+ */
+public static final int VERTICAL = 1;
+
+/*************************************************************************/
+
+/*
+ * Instance Methods
+ */
+
+/**
+ * Returns the current value of the object.
+ *
+ * @return The current value of the object.
+ */
+public abstract int
+getValue();
+
+/*************************************************************************/
+
+/**
+ * Sets the current value of the object.
+ *
+ * @param value The current value of the object.
+ */
+public abstract void
+setValue(int value);
+
+/*************************************************************************/
+
+/**
+ * Returns the orientation of the object, either <code>HORIZONTAL</code>
+ * or <code>VERTICAL</code>.
+ *
+ * @return The orientation of this object.
+ */
+public abstract int
+getOrientation();
+
+/*************************************************************************/
+
+/**
+ * Returns the minimum value this object can take.
+ *
+ * @return The minimum value this object can take.
+ */
+public abstract int
+getMinimum();
+
+/*************************************************************************/
+
+/**
+ * Sets the minimum value this object can take to the specified value.
+ *
+ * @param minimum The new minimum value for this object.
+ */
+public abstract void
+setMinimum(int minimum);
+
+/*************************************************************************/
+
+/**
+ * Returns the maximum value this object can take.
+ *
+ * @return The maximum value this object can take.
+ */
+public abstract int
+getMaximum();
+
+/*************************************************************************/
+
+/**
+ * Sets the maximum value this object can take to the specified value.
+ *
+ * @param maximum The new maximum value for this object.
+ */
+public abstract void
+setMaximum(int maximum);
+
+/*************************************************************************/
+
+/**
+ * Returns the increment value for incrementing by units.
+ *
+ * @return The unit increment value.
+ */
+public abstract int
+getUnitIncrement();
+
+/*************************************************************************/
+
+/**
+ * Sets the increment value for incrementing by units to the specified value.
+ *
+ * @param increment The unit increment value.
+ */
+public abstract void
+setUnitIncrement(int increment);
+
+/*************************************************************************/
+
+/**
+ * Returns the increment value for incrementing by blocks.
+ *
+ * @return The block increment value.
+ */
+public abstract int
+getBlockIncrement();
+
+/*************************************************************************/
+
+/**
+ * Sets the increment value for incrementing by blocks to the specified value.
+ *
+ * @param increment The block increment value.
+ */
+public abstract void
+setBlockIncrement(int increment);
+
+/*************************************************************************/
+
+/**
+ * Returns the length of the indicator for this object.
+ *
+ * @return The indicator length.
+ */
+public abstract int
+getVisibleAmount();
+
+/*************************************************************************/
+
+/**
+ * Sets the length of the indicator for this object to the specified value.
+ *
+ * @param length The indicator length
+ */
+public abstract void
+setVisibleAmount(int length);
+
+/*************************************************************************/
+
+/**
+ * Adds a listener that will receive adjustment events for this object.
+ *
+ * @param listener The adjustment listener to add.
+ */
+public abstract void
+addAdjustmentListener(AdjustmentListener listener);
+
+/*************************************************************************/
+
+/**
+ * Removes an adjustment listener from this object. It will no longer
+ * receive adjustment events.
+ *
+ * @param listener The adjustment listener to remove.
+ */
+public abstract void
+removeAdjustmentListener(AdjustmentListener listener);
+
+} // interface Adjustable
-public interface Adjustable
-{
- public static final int HORIZONTAL = 0;
- public static final int VERTICAL = 1;
-
- public void addAdjustmentListener (AdjustmentListener l);
- public int getBlockIncrement ();
- public int getMaximum ();
- public int getMinimum ();
- public int getOrientation ();
- public int getUnitIncrement ();
- public int getValue ();
- public int getVisibleAmount ();
- public void removeAdjustmentListener (AdjustmentListener l);
- public void setBlockIncrement (int b);
- public void setMaximum (int max);
- public void setMinimum (int min);
- public void setUnitIncrement (int u);
- public void setValue (int v);
- public void setVisibleAmount (int v);
-}