summaryrefslogtreecommitdiff
path: root/java/awt/Adjustable.java
blob: eb773a07c69bdbf155c95e19d6c9713bf4e1c7a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/* Adjustable.java -- Objects with a numeric adjustment scale.
   Copyright (C) 1999 Free Software Foundation, Inc.

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. */


package java.awt;

import java.awt.event.AdjustmentListener;

/**
  * 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
 */

/**
  * 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