|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjava.awt.Component
java.awt.Scrollbar
public class Scrollbar
This class implements a scrollbar widget.
| Nested Class Summary | |
|---|---|
protected class |
Scrollbar.AccessibleAWTScrollBar
This class provides accessibility support for the scrollbar. |
| Nested classes/interfaces inherited from class java.awt.Component |
|---|
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy |
| Field Summary | |
|---|---|
static int |
HORIZONTAL
Constant indicating that a scrollbar is horizontal. |
static int |
VERTICAL
Constant indicating that a scrollbar is vertical. |
| Fields inherited from class java.awt.Component |
|---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
| Fields inherited from interface java.awt.Adjustable |
|---|
NO_ORIENTATION |
| Fields inherited from interface java.awt.image.ImageObserver |
|---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
| Constructor Summary | |
|---|---|
Scrollbar()
Initializes a new instance of Scrollbar with a
vertical orientation and default values for all other parameters. |
|
Scrollbar(int orientation)
Initializes a new instance of Scrollbar with the
specified orientation and default values for all other parameters. |
|
Scrollbar(int orientation,
int value,
int visibleAmount,
int minimum,
int maximum)
Initializes a new instance of Scrollbar with the
specified parameters. |
|
| Method Summary | ||
|---|---|---|
void |
addAdjustmentListener(AdjustmentListener listener)
Adds a new adjustment listener to the list of registered listeners for this object. |
|
void |
addNotify()
Notifies this object to create its native peer. |
|
AccessibleContext |
getAccessibleContext()
Gets the AccessibleContext associated with this Scrollbar. |
|
AdjustmentListener[] |
getAdjustmentListeners()
Returns an array of all registered adjustment listeners. |
|
int |
getBlockIncrement()
Returns the value added or subtracted when the user activates the scrollbar scroll by a "block" amount. |
|
int |
getLineIncrement()
Deprecated. This method is deprecated in favor of getUnitIncrement(). |
|
|
getListeners(Class<T> listenerType)
Returns an array of all the objects currently registered as FooListeners upon this Scrollbar. |
|
int |
getMaximum()
Returns the maximum value for this scrollbar. |
|
int |
getMinimum()
Returns the minimum value for this scrollbar. |
|
int |
getOrientation()
Returns the orientation constant for this object. |
|
int |
getPageIncrement()
Deprecated. This method is deprecated in favor of getBlockIncrement(). |
|
int |
getUnitIncrement()
Returns the value added or subtracted when the user activates the scrollbar scroll by a "unit" amount. |
|
int |
getValue()
Returns the current value for this scrollbar. |
|
boolean |
getValueIsAdjusting()
Returns true if the value is in the process of changing. |
|
int |
getVisible()
Deprecated. This method is deprecated in favor of getVisibleAmount(). |
|
int |
getVisibleAmount()
Returns the width of the scrollbar's thumb, in units relative to the maximum and minimum value of the scrollbar. |
|
protected String |
paramString()
Returns a debugging string for this object. |
|
protected void |
processAdjustmentEvent(AdjustmentEvent event)
Processes adjustment events for this object by dispatching them to any registered listeners. |
|
protected void |
processEvent(AWTEvent event)
Processes events for this scrollbar. |
|
void |
removeAdjustmentListener(AdjustmentListener listener)
Removes the specified listener from the list of registered listeners for this object. |
|
void |
setBlockIncrement(int blockIncrement)
Sets the value added or subtracted to the scrollbar value when the user selects the scroll by a "block" amount control. |
|
void |
setLineIncrement(int lineIncrement)
Deprecated. This method is deprecated in favor of setUnitIncrement(). |
|
void |
setMaximum(int maximum)
Sets the maximum value for this scrollbar to the specified value. |
|
void |
setMinimum(int minimum)
Sets the minimum value for this scrollbar to the specified value. |
|
void |
setOrientation(int orientation)
Sets the orientation of this scrollbar to the specified value. |
|
void |
setPageIncrement(int pageIncrement)
Deprecated. This method is deprecated in favor of setBlockIncrement(). |
|
void |
setUnitIncrement(int unitIncrement)
Sets the value added or subtracted to the scrollbar value when the user selects the scroll by a "unit" amount control. |
|
void |
setValue(int value)
Sets the current value for this scrollbar to the specified value. |
|
void |
setValueIsAdjusting(boolean valueIsAdjusting)
Sets the value of valueIsAdjusting. |
|
void |
setValues(int value,
int visibleAmount,
int minimum,
int maximum)
Sets the current value, visible amount, minimum, and maximum for this scrollbar. |
|
void |
setVisibleAmount(int visibleAmount)
Sets the width of the scrollbar's thumb, in units relative to the maximum and minimum value of the scrollbar. |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final int HORIZONTAL
public static final int VERTICAL
| Constructor Detail |
|---|
public Scrollbar()
Scrollbar with a
vertical orientation and default values for all other parameters.
HeadlessException - If GraphicsEnvironment.isHeadless() is true,
public Scrollbar(int orientation)
throws IllegalArgumentException
Scrollbar with the
specified orientation and default values for all other parameters.
The orientation must be either the constant HORIZONTAL or
VERTICAL from this class. An incorrect value will throw
an exception.
orientation - The orientation of this scrollbar.
HeadlessException - If GraphicsEnvironment.isHeadless() is true,
IllegalArgumentException - If the orientation value is not valid.
public Scrollbar(int orientation,
int value,
int visibleAmount,
int minimum,
int maximum)
throws IllegalArgumentException
Scrollbar with the
specified parameters. The orientation must be either the constant
HORIZONTAL or VERTICAL. An incorrect value
will throw an exception. Inconsistent values for other parameters
are silently corrected to valid values.
orientation - The orientation of this scrollbar.value - The initial value of the scrollbar.visibleAmount - The width of the scrollbar thumb.minimum - The minimum value of the scrollbar.maximum - The maximum value of the scrollbar.
HeadlessException - If GraphicsEnvironment.isHeadless() is true,
IllegalArgumentException - If the orientation value is not valid.| Method Detail |
|---|
public int getOrientation()
getOrientation in interface AdjustableAdjustable.HORIZONTAL,
Adjustable.VERTICAL,
Adjustable.NO_ORIENTATIONpublic void setOrientation(int orientation)
HORIZONTAL or
VERTICAL from this class or an exception will be thrown.
orientation - The new orientation value.
IllegalArgumentException - If the orientation value is not valid.public int getValue()
getValue in interface Adjustablepublic void setValue(int value)
setValue in interface Adjustablevalue - The new value for this scrollbar.public int getMaximum()
getMaximum in interface Adjustablepublic void setMaximum(int maximum)
setMaximum in interface Adjustablemaximum - The new maximum value for this scrollbar.public int getMinimum()
getMinimum in interface Adjustablepublic void setMinimum(int minimum)
setMinimum in interface Adjustableminimum - The new minimum value for this scrollbar.public int getVisibleAmount()
getVisibleAmount in interface Adjustablepublic int getVisible()
getVisibleAmount().
public void setVisibleAmount(int visibleAmount)
setVisibleAmount in interface AdjustablevisibleAmount - The new visible amount value of the scrollbar.
public void setValues(int value,
int visibleAmount,
int minimum,
int maximum)
value - The new value for this scrollbar.visibleAmount - The new visible amount for this scrollbar.minimum - The new minimum value for this scrollbar.maximum - The new maximum value for this scrollbar.public int getUnitIncrement()
getUnitIncrement in interface Adjustablepublic int getLineIncrement()
getUnitIncrement().
public void setUnitIncrement(int unitIncrement)
setUnitIncrement in interface AdjustableunitIncrement - The new unit increment amount.public void setLineIncrement(int lineIncrement)
setUnitIncrement().
lineIncrement - The new unit increment amount.public int getBlockIncrement()
getBlockIncrement in interface Adjustablepublic int getPageIncrement()
getBlockIncrement().
public void setBlockIncrement(int blockIncrement)
setBlockIncrement in interface AdjustableblockIncrement - The new block increment amount.public void setPageIncrement(int pageIncrement)
setBlockIncrement().
pageIncrement - The new block increment amount.public void addNotify()
addNotify in class ComponentComponent.isDisplayable(),
Component.removeNotify()public void addAdjustmentListener(AdjustmentListener listener)
addAdjustmentListener in interface Adjustablelistener - The listener to add.AdjustmentEventpublic void removeAdjustmentListener(AdjustmentListener listener)
removeAdjustmentListener in interface Adjustablelistener - The listener to remove.AdjustmentEventprotected void processEvent(AWTEvent event)
processAdjustmentEvent() if the event is an instance of
AdjustmentEvent, otherwise it calls the superclass to
process the event.
processEvent in class Componentevent - The event to process.Component.processComponentEvent(ComponentEvent),
Component.processFocusEvent(FocusEvent),
Component.processKeyEvent(KeyEvent),
Component.processMouseEvent(MouseEvent),
Component.processMouseMotionEvent(MouseEvent),
Component.processInputMethodEvent(InputMethodEvent),
Component.processHierarchyEvent(HierarchyEvent),
Component.processMouseWheelEvent(MouseWheelEvent)protected void processAdjustmentEvent(AdjustmentEvent event)
enableEvents().
event - The event to process.protected String paramString()
paramString in class Componentpublic <T extends EventListener> T[] getListeners(Class<T> listenerType)
Scrollbar. FooListeners are registered using the
addFooListener method.
getListeners in class ComponentlistenerType - the class of listeners to filter (null
not permitted).
ClassCastException - If listenerType doesn't specify a class or
interface that implements java.util.EventListener.Component.getComponentListeners(),
Component.getFocusListeners(),
Component.getHierarchyListeners(),
Component.getHierarchyBoundsListeners(),
Component.getKeyListeners(),
Component.getMouseListeners(),
Component.getMouseMotionListeners(),
Component.getMouseWheelListeners(),
Component.getInputMethodListeners(),
Component.getPropertyChangeListeners()public AdjustmentListener[] getAdjustmentListeners()
public boolean getValueIsAdjusting()
public void setValueIsAdjusting(boolean valueIsAdjusting)
public AccessibleContext getAccessibleContext()
Scrollbar.
The context is created, if necessary.
getAccessibleContext in interface AccessiblegetAccessibleContext in class Component
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||