001 /*
002 * Copyright 1996-2003 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package java.awt;
027
028 import java.awt.event.*;
029
030 /**
031 * The interface for objects which have an adjustable numeric value
032 * contained within a bounded range of values.
033 *
034 * @version 1.25 05/05/07
035 * @author Amy Fowler
036 * @author Tim Prinzing
037 */
038
039 public interface Adjustable {
040
041 /**
042 * Indicates that the <code>Adjustable</code> has horizontal orientation.
043 */
044 public static final int HORIZONTAL = 0;
045
046 /**
047 * Indicates that the <code>Adjustable</code> has vertical orientation.
048 */
049 public static final int VERTICAL = 1;
050
051 /**
052 * Indicates that the <code>Adjustable</code> has no orientation.
053 */
054 public static final int NO_ORIENTATION = 2;
055
056 /**
057 * Gets the orientation of the adjustable object.
058 * @return the orientation of the adjustable object;
059 * either <code>HORIZONTAL</code>, <code>VERTICAL</code>,
060 * or <code>NO_ORIENTATION</code>
061 */
062 int getOrientation();
063
064 /**
065 * Sets the minimum value of the adjustable object.
066 * @param min the minimum value
067 */
068 void setMinimum(int min);
069
070 /**
071 * Gets the minimum value of the adjustable object.
072 * @return the minimum value of the adjustable object
073 */
074 int getMinimum();
075
076 /**
077 * Sets the maximum value of the adjustable object.
078 * @param max the maximum value
079 */
080 void setMaximum(int max);
081
082 /**
083 * Gets the maximum value of the adjustable object.
084 * @return the maximum value of the adjustable object
085 */
086 int getMaximum();
087
088 /**
089 * Sets the unit value increment for the adjustable object.
090 * @param u the unit increment
091 */
092 void setUnitIncrement(int u);
093
094 /**
095 * Gets the unit value increment for the adjustable object.
096 * @return the unit value increment for the adjustable object
097 */
098 int getUnitIncrement();
099
100 /**
101 * Sets the block value increment for the adjustable object.
102 * @param b the block increment
103 */
104 void setBlockIncrement(int b);
105
106 /**
107 * Gets the block value increment for the adjustable object.
108 * @return the block value increment for the adjustable object
109 */
110 int getBlockIncrement();
111
112 /**
113 * Sets the length of the proportional indicator of the
114 * adjustable object.
115 * @param v the length of the indicator
116 */
117 void setVisibleAmount(int v);
118
119 /**
120 * Gets the length of the proportional indicator.
121 * @return the length of the proportional indicator
122 */
123 int getVisibleAmount();
124
125 /**
126 * Sets the current value of the adjustable object. If
127 * the value supplied is less than <code>minimum</code>
128 * or greater than <code>maximum</code> - <code>visibleAmount</code>,
129 * then one of those values is substituted, as appropriate.
130 * <p>
131 * Calling this method does not fire an
132 * <code>AdjustmentEvent</code>.
133 *
134 * @param v the current value, between <code>minimum</code>
135 * and <code>maximum</code> - <code>visibleAmount</code>
136 */
137 void setValue(int v);
138
139 /**
140 * Gets the current value of the adjustable object.
141 * @return the current value of the adjustable object
142 */
143 int getValue();
144
145 /**
146 * Adds a listener to receive adjustment events when the value of
147 * the adjustable object changes.
148 * @param l the listener to receive events
149 * @see AdjustmentEvent
150 */
151 void addAdjustmentListener(AdjustmentListener l);
152
153 /**
154 * Removes an adjustment listener.
155 * @param l the listener being removed
156 * @see AdjustmentEvent
157 */
158 void removeAdjustmentListener(AdjustmentListener l);
159
160 }
|