Adjustable (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.awt
interface Adjustable

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

Most common way to construct:

ScrollPane sp = …;

Adjustable adj = sp.getVAdjustable();

Based on 30 examples

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` Indicates that the `Adjustable` has horizontal orientation.
`static int`	`NO_ORIENTATION` Indicates that the `Adjustable` has no orientation.
`static int`	`VERTICAL` Indicates that the `Adjustable` has vertical orientation.

Method Summary
`void`	`addAdjustmentListener(AdjustmentListener l)` Adds a listener to receive adjustment events when the value of the adjustable object changes.
`int`	`getBlockIncrement()` Gets the block value increment for the adjustable object.
`int`	`getMaximum()` Gets the maximum value of the adjustable object.
`int`	`getMinimum()` Gets the minimum value of the adjustable object.
`int`	`getOrientation()` Gets the orientation of the adjustable object.
`int`	`getUnitIncrement()` Gets the unit value increment for the adjustable object.
`int`	`getValue()` Gets the current value of the adjustable object.
`int`	`getVisibleAmount()` Gets the length of the proportional indicator.
`void`	`removeAdjustmentListener(AdjustmentListener l)` Removes an adjustment listener.
`void`	`setBlockIncrement(int b)` Sets the block value increment for the adjustable object.
`void`	`setMaximum(int max)` Sets the maximum value of the adjustable object.
`void`	`setMinimum(int min)` Sets the minimum value of the adjustable object.
`void`	`setUnitIncrement(int u)` Sets the unit value increment for the adjustable object.
`void`	`setValue(int v)` Sets the current value of the adjustable object.
`void`	`setVisibleAmount(int v)` Sets the length of the proportional indicator of the adjustable object.

Field Detail

HORIZONTAL

public static final int HORIZONTAL

Indicates that the Adjustable has horizontal orientation.

NO_ORIENTATION

public static final int NO_ORIENTATION

Indicates that the Adjustable has no orientation.

VERTICAL

public static final int VERTICAL

Indicates that the Adjustable has vertical orientation.

Method Detail

addAdjustmentListener

public void addAdjustmentListener(AdjustmentListener l)

Adds a listener to receive adjustment events when the value of the adjustable object changes.

Parameters:: l - the listener to receive events

getBlockIncrement

public int getBlockIncrement()

Gets the block value increment for the adjustable object.

Returns:: the block value increment for the adjustable object

getMaximum

public int getMaximum()

Gets the maximum value of the adjustable object.

Returns:: the maximum value of the adjustable object

getMinimum

public int getMinimum()

Gets the minimum value of the adjustable object.

Returns:: the minimum value of the adjustable object

getOrientation

public int getOrientation()

Gets the orientation of the adjustable object.

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

getUnitIncrement

public int getUnitIncrement()

Gets the unit value increment for the adjustable object.

Returns:: the unit value increment for the adjustable object

getValue

public int getValue()

Gets the current value of the adjustable object.

Returns:: the current value of the adjustable object

getVisibleAmount

public int getVisibleAmount()

Gets the length of the proportional indicator.

Returns:: the length of the proportional indicator

removeAdjustmentListener

public void removeAdjustmentListener(AdjustmentListener l)

Removes an adjustment listener.

Parameters:: l - the listener being removed

setBlockIncrement

public void setBlockIncrement(int b)

Sets the block value increment for the adjustable object.

Parameters:: b - the block increment

setMaximum

public void setMaximum(int max)

Sets the maximum value of the adjustable object.

Parameters:: max - the maximum value

setMinimum

public void setMinimum(int min)

Sets the minimum value of the adjustable object.

Parameters:: min - the minimum value

setUnitIncrement

public void setUnitIncrement(int u)

Sets the unit value increment for the adjustable object.

Parameters:: u - the unit increment

setValue

public 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

setVisibleAmount

public void setVisibleAmount(int v)

Sets the length of the proportional indicator of the adjustable object.

Parameters:: v - the length of the indicator