java.awt

Interface Adjustable

Known Implementing Classes:
JScrollBar, JScrollPane.ScrollBar, Scrollbar, ScrollPaneAdjustable

public interface Adjustable

This interface is for objects that take a numeric value that can be adjusted within a bounded range. For example, a scroll bar.
Since:
1.0

Field Summary

static int
HORIZONTAL
Constant for an adjustable object with horizontal orientation.
static int
NO_ORIENTATION
Constant for an adjustable object with no orientation.
static int
VERTICAL
Constant for an adjustable object with vertical orientation.

Method Summary

void
addAdjustmentListener(AdjustmentListener listener)
Adds a listener that will receive adjustment events for this object.
int
getBlockIncrement()
Returns the increment value for incrementing the value by blocks.
int
getMaximum()
Returns the maximum value this object can have.
int
getMinimum()
Returns the minimum value this object can have.
int
getOrientation()
Returns a constant representing the orientation of the object.
int
getUnitIncrement()
Returns the increment value for incrementing the value by units.
int
getValue()
Returns the current value of the object.
int
getVisibleAmount()
Returns the length of the indicator for this object.
void
removeAdjustmentListener(AdjustmentListener listener)
Removes an adjustment listener from this object.
void
setBlockIncrement(int increment)
Sets the increment value for incrementing the value by blocks.
void
setMaximum(int maximum)
Sets the maximum value this object can have.
void
setMinimum(int minimum)
Sets the minimum value this object can have.
void
setUnitIncrement(int increment)
Sets the increment value for incrementing the value by units.
void
setValue(int value)
Sets the current value of the object.
void
setVisibleAmount(int length)
Sets the length of the indicator for this object to the specified value.

Field Details

HORIZONTAL

public static final int HORIZONTAL
Constant for an adjustable object with horizontal orientation.
Field Value:
0

NO_ORIENTATION

public static final int NO_ORIENTATION
Constant for an adjustable object with no orientation.
Field Value:
2

VERTICAL

public static final int VERTICAL
Constant for an adjustable object with vertical orientation.
Field Value:
1

Method Details

addAdjustmentListener

public void addAdjustmentListener(AdjustmentListener listener)
Adds a listener that will receive adjustment events for this object.
Parameters:
listener - the adjustment listener to add

getBlockIncrement

public int getBlockIncrement()
Returns the increment value for incrementing the value by blocks.
Returns:
the block increment value

getMaximum

public int getMaximum()
Returns the maximum value this object can have.
Returns:
the maximum value

getMinimum

public int getMinimum()
Returns the minimum value this object can have.
Returns:
the minimum value

getOrientation

public int getOrientation()
Returns a constant representing the orientation of the object.
Returns:
the orientation of this object

getUnitIncrement

public int getUnitIncrement()
Returns the increment value for incrementing the value by units.
Returns:
the unit increment value

getValue

public int getValue()
Returns the current value of the object.
Returns:
the current value

getVisibleAmount

public int getVisibleAmount()
Returns the length of the indicator for this object.
Returns:
the indicator length

removeAdjustmentListener

public void removeAdjustmentListener(AdjustmentListener listener)
Removes an adjustment listener from this object.
Parameters:
listener - the adjustment listener to remove

setBlockIncrement

public void setBlockIncrement(int increment)
Sets the increment value for incrementing the value by blocks.
Parameters:
increment - the block increment value

setMaximum

public void setMaximum(int maximum)
Sets the maximum value this object can have.
Parameters:
maximum - the new maximum value

setMinimum

public void setMinimum(int minimum)
Sets the minimum value this object can have.
Parameters:
minimum - the new minimum value

setUnitIncrement

public void setUnitIncrement(int increment)
Sets the increment value for incrementing the value by units.
Parameters:
increment - the unit increment value

setValue

public void setValue(int value)
Sets the current value of the object.
Parameters:
value - the new value

setVisibleAmount

public void setVisibleAmount(int length)
Sets the length of the indicator for this object to the specified value.
Parameters:
length - the indicator length

Adjustable.java -- Objects with a numeric adjustment scale Copyright (C) 1999, 2002, 2005 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.