1 |
/* Adjustable.java -- Objects with a numeric adjustment scale. |
/* Adjustable.java -- Objects with a numeric adjustment scale |
2 |
Copyright (C) 1999 Free Software Foundation, Inc. |
Copyright (C) 1999, 2002 Free Software Foundation, Inc. |
3 |
|
|
4 |
This file is part of GNU Classpath. |
This file is part of GNU Classpath. |
5 |
|
|
41 |
import java.awt.event.AdjustmentListener; |
import java.awt.event.AdjustmentListener; |
42 |
|
|
43 |
/** |
/** |
44 |
* This interface is for objects that take a numeric value that |
* This interface is for objects that take a numeric value that can be |
45 |
* can be adjusted within a bounded range. For example, a scroll bar. |
* adjusted within a bounded range. For example, a scroll bar. |
46 |
* |
* |
47 |
* @author Aaron M. Renn (arenn@urbanophile.com) |
* @author Aaron M. Renn <arenn@urbanophile.com> |
48 |
*/ |
* @since 1.0 |
49 |
|
* @status updated to 1.4 |
50 |
|
*/ |
51 |
public interface Adjustable |
public interface Adjustable |
52 |
{ |
{ |
53 |
|
/** Constant for an adjustable object with horizontal orientation. */ |
54 |
|
int HORIZONTAL = 0; |
55 |
|
|
56 |
/* |
/** Constant for an adjustable object with vertical orientation. */ |
57 |
* Static Variables |
int VERTICAL = 1; |
|
*/ |
|
|
|
|
|
/** |
|
|
* 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); |
|
58 |
|
|
59 |
/*************************************************************************/ |
/** Constant for an adjustable object with no orientation. */ |
60 |
|
int NO_ORIENTATION = 2; |
|
/** |
|
|
* 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); |
|
61 |
|
|
62 |
|
/** |
63 |
|
* Returns a constant representing the orientation of the object. |
64 |
|
* |
65 |
|
* @return the orientation of this object |
66 |
|
* @see #HORIZONTAL |
67 |
|
* @see #VERTICAL |
68 |
|
* @see #NO_ORIENTATION |
69 |
|
*/ |
70 |
|
int getOrientation(); |
71 |
|
|
72 |
|
/** |
73 |
|
* Sets the minimum value this object can have. |
74 |
|
* |
75 |
|
* @param minimum the new minimum value |
76 |
|
*/ |
77 |
|
void setMinimum(int minimum); |
78 |
|
|
79 |
|
/** |
80 |
|
* Returns the minimum value this object can have. |
81 |
|
* |
82 |
|
* @return the minimum value |
83 |
|
*/ |
84 |
|
int getMinimum(); |
85 |
|
|
86 |
|
/** |
87 |
|
* Sets the maximum value this object can have. |
88 |
|
* |
89 |
|
* @param maximum the new maximum value |
90 |
|
*/ |
91 |
|
void setMaximum(int maximum); |
92 |
|
|
93 |
|
/** |
94 |
|
* Returns the maximum value this object can have. |
95 |
|
* |
96 |
|
* @return the maximum value |
97 |
|
*/ |
98 |
|
int getMaximum(); |
99 |
|
|
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 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 AdjustmentEvent |
169 |
|
*/ |
170 |
|
void removeAdjustmentListener(AdjustmentListener listener); |
171 |
} // interface Adjustable |
} // interface Adjustable |
|
|
|