java.awt
Interface Adjustable

All Known Implementing Classes:
JScrollBar sample code for javax.swing.JScrollBar definition code for javax.swing.JScrollBar , JScrollPane.ScrollBar sample code for javax.swing.JScrollPane.ScrollBar definition code for javax.swing.JScrollPane.ScrollBar , Scrollbar sample code for java.awt.Scrollbar definition code for java.awt.Scrollbar , ScrollPaneAdjustable sample code for java.awt.ScrollPaneAdjustable definition code for java.awt.ScrollPaneAdjustable

public interface Adjustable

The interface for objects which have an adjustable numeric value contained within a bounded range of values.


Field Summary
static int HORIZONTAL sample code for java.awt.Adjustable.HORIZONTAL definition code for java.awt.Adjustable.HORIZONTAL
          Indicates that the Adjustable has horizontal orientation.
static int NO_ORIENTATION sample code for java.awt.Adjustable.NO_ORIENTATION definition code for java.awt.Adjustable.NO_ORIENTATION
          Indicates that the Adjustable has no orientation.
static int VERTICAL sample code for java.awt.Adjustable.VERTICAL definition code for java.awt.Adjustable.VERTICAL
          Indicates that the Adjustable has vertical orientation.
 
Method Summary
 void addAdjustmentListener sample code for java.awt.Adjustable.addAdjustmentListener(java.awt.event.AdjustmentListener) definition code for java.awt.Adjustable.addAdjustmentListener(java.awt.event.AdjustmentListener) (AdjustmentListener sample code for java.awt.event.AdjustmentListener definition code for java.awt.event.AdjustmentListener  l)
          Adds a listener to receive adjustment events when the value of the adjustable object changes.
 int getBlockIncrement sample code for java.awt.Adjustable.getBlockIncrement() definition code for java.awt.Adjustable.getBlockIncrement() ()
          Gets the block value increment for the adjustable object.
 int getMaximum sample code for java.awt.Adjustable.getMaximum() definition code for java.awt.Adjustable.getMaximum() ()
          Gets the maximum value of the adjustable object.
 int getMinimum sample code for java.awt.Adjustable.getMinimum() definition code for java.awt.Adjustable.getMinimum() ()
          Gets the minimum value of the adjustable object.
 int getOrientation sample code for java.awt.Adjustable.getOrientation() definition code for java.awt.Adjustable.getOrientation() ()
          Gets the orientation of the adjustable object.
 int getUnitIncrement sample code for java.awt.Adjustable.getUnitIncrement() definition code for java.awt.Adjustable.getUnitIncrement() ()
          Gets the unit value increment for the adjustable object.
 int getValue sample code for java.awt.Adjustable.getValue() definition code for java.awt.Adjustable.getValue() ()
          Gets the current value of the adjustable object.
 int getVisibleAmount sample code for java.awt.Adjustable.getVisibleAmount() definition code for java.awt.Adjustable.getVisibleAmount() ()
          Gets the length of the proportional indicator.
 void removeAdjustmentListener sample code for java.awt.Adjustable.removeAdjustmentListener(java.awt.event.AdjustmentListener) definition code for java.awt.Adjustable.removeAdjustmentListener(java.awt.event.AdjustmentListener) (AdjustmentListener sample code for java.awt.event.AdjustmentListener definition code for java.awt.event.AdjustmentListener  l)
          Removes an adjustment listener.
 void setBlockIncrement sample code for java.awt.Adjustable.setBlockIncrement(int) definition code for java.awt.Adjustable.setBlockIncrement(int) (int b)
          Sets the block value increment for the adjustable object.
 void setMaximum sample code for java.awt.Adjustable.setMaximum(int) definition code for java.awt.Adjustable.setMaximum(int) (int max)
          Sets the maximum value of the adjustable object.
 void setMinimum sample code for java.awt.Adjustable.setMinimum(int) definition code for java.awt.Adjustable.setMinimum(int) (int min)
          Sets the minimum value of the adjustable object.
 void setUnitIncrement sample code for java.awt.Adjustable.setUnitIncrement(int) definition code for java.awt.Adjustable.setUnitIncrement(int) (int u)
          Sets the unit value increment for the adjustable object.
 void setValue sample code for java.awt.Adjustable.setValue(int) definition code for java.awt.Adjustable.setValue(int) (int v)
          Sets the current value of the adjustable object.
 void setVisibleAmount sample code for java.awt.Adjustable.setVisibleAmount(int) definition code for java.awt.Adjustable.setVisibleAmount(int) (int v)
          Sets the length of the proportional indicator of the adjustable object.
 

Field Detail

HORIZONTAL sample code for java.awt.Adjustable.HORIZONTAL

static final int HORIZONTAL
Indicates that the Adjustable has horizontal orientation.

See Also:
Constant Field Values

VERTICAL sample code for java.awt.Adjustable.VERTICAL

static final int VERTICAL
Indicates that the Adjustable has vertical orientation.

See Also:
Constant Field Values

NO_ORIENTATION sample code for java.awt.Adjustable.NO_ORIENTATION

static final int NO_ORIENTATION
Indicates that the Adjustable has no orientation.

See Also:
Constant Field Values
Method Detail

getOrientation sample code for java.awt.Adjustable.getOrientation() definition code for java.awt.Adjustable.getOrientation()

int getOrientation()
Gets the orientation of the adjustable object.

Returns:
the orientation of the adjustable object; either HORIZONTAL, VERTICAL, or NO_ORIENTATION

setMinimum sample code for java.awt.Adjustable.setMinimum(int) definition code for java.awt.Adjustable.setMinimum(int)

void setMinimum(int min)
Sets the minimum value of the adjustable object.

Parameters:
min - the minimum value

getMinimum sample code for java.awt.Adjustable.getMinimum() definition code for java.awt.Adjustable.getMinimum()

int getMinimum()
Gets the minimum value of the adjustable object.

Returns:
the minimum value of the adjustable object

setMaximum sample code for java.awt.Adjustable.setMaximum(int) definition code for java.awt.Adjustable.setMaximum(int)

void setMaximum(int max)
Sets the maximum value of the adjustable object.

Parameters:
max - the maximum value

getMaximum sample code for java.awt.Adjustable.getMaximum() definition code for java.awt.Adjustable.getMaximum()

int getMaximum()
Gets the maximum value of the adjustable object.

Returns:
the maximum value of the adjustable object

setUnitIncrement sample code for java.awt.Adjustable.setUnitIncrement(int) definition code for java.awt.Adjustable.setUnitIncrement(int)

void setUnitIncrement(int u)
Sets the unit value increment for the adjustable object.

Parameters:
u - the unit increment

getUnitIncrement sample code for java.awt.Adjustable.getUnitIncrement() definition code for java.awt.Adjustable.getUnitIncrement()

int getUnitIncrement()
Gets the unit value increment for the adjustable object.

Returns:
the unit value increment for the adjustable object

setBlockIncrement sample code for java.awt.Adjustable.setBlockIncrement(int) definition code for java.awt.Adjustable.setBlockIncrement(int)

void setBlockIncrement(int b)
Sets the block value increment for the adjustable object.

Parameters:
b - the block increment

getBlockIncrement sample code for java.awt.Adjustable.getBlockIncrement() definition code for java.awt.Adjustable.getBlockIncrement()

int getBlockIncrement()
Gets the block value increment for the adjustable object.

Returns:
the block value increment for the adjustable object

setVisibleAmount sample code for java.awt.Adjustable.setVisibleAmount(int) definition code for java.awt.Adjustable.setVisibleAmount(int)

void setVisibleAmount(int v)
Sets the length of the proportional indicator of the adjustable object.

Parameters:
v - the length of the indicator

getVisibleAmount sample code for java.awt.Adjustable.getVisibleAmount() definition code for java.awt.Adjustable.getVisibleAmount()

int getVisibleAmount()
Gets the length of the proportional indicator.

Returns:
the length of the proportional indicator

setValue sample code for java.awt.Adjustable.setValue(int) definition code for java.awt.Adjustable.setValue(int)

void setValue(int v)
Sets the current value of the adjustable object. If the value supplied is less than minimum or greater than maximum - visibleAmount, then one of those values is substituted, as appropriate.

Calling this method does not fire an AdjustmentEvent.

Parameters:
v - the current value, between minimum and maximum - visibleAmount

getValue sample code for java.awt.Adjustable.getValue() definition code for java.awt.Adjustable.getValue()

int getValue()
Gets the current value of the adjustable object.

Returns:
the current value of the adjustable object

addAdjustmentListener sample code for java.awt.Adjustable.addAdjustmentListener(java.awt.event.AdjustmentListener) definition code for java.awt.Adjustable.addAdjustmentListener(java.awt.event.AdjustmentListener)

void addAdjustmentListener(AdjustmentListener sample code for java.awt.event.AdjustmentListener definition code for java.awt.event.AdjustmentListener  l)
Adds a listener to receive adjustment events when the value of the adjustable object changes.

Parameters:
l - the listener to receive events
See Also:
AdjustmentEvent sample code for java.awt.event.AdjustmentEvent definition code for java.awt.event.AdjustmentEvent

removeAdjustmentListener sample code for java.awt.Adjustable.removeAdjustmentListener(java.awt.event.AdjustmentListener) definition code for java.awt.Adjustable.removeAdjustmentListener(java.awt.event.AdjustmentListener)

void removeAdjustmentListener(AdjustmentListener sample code for java.awt.event.AdjustmentListener definition code for java.awt.event.AdjustmentListener  l)
Removes an adjustment listener.

Parameters:
l - the listener being removed
See Also:
AdjustmentEvent sample code for java.awt.event.AdjustmentEvent definition code for java.awt.event.AdjustmentEvent