Class ScrollPaneAdjustable
java.lang.Object
java.awt.ScrollPaneAdjustable
- All Implemented Interfaces:
Adjustable,Serializable
This class represents the state of a horizontal or vertical
scrollbar of a
ScrollPane. Objects of this class are
returned by ScrollPane methods.- Since:
- 1.4
- See Also:
-
Field Summary
Fields declared in interface java.awt.Adjustable
HORIZONTAL, NO_ORIENTATION, VERTICAL -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds the specified adjustment listener to receive adjustment events from thisScrollPaneAdjustable.Returns an array of all the adjustment listeners registered on thisScrollPaneAdjustable.intGets the block value increment for the adjustable object.intGets the maximum value of the adjustable object.intGets the minimum value of the adjustable object.intReturns the orientation of this scrollbar.intGets the unit value increment for the adjustable object.intgetValue()Gets the current value of the adjustable object.booleanReturns true if the value is in the process of changing as a result of actions being taken by the user.intGets the length of the proportional indicator.Returns a string representing the state of this scrollbar.voidRemoves the specified adjustment listener so that it no longer receives adjustment events from thisScrollPaneAdjustable.voidsetBlockIncrement(int b) Sets the block value increment for the adjustable object.voidsetMaximum(int max) This method should NOT be called by user code.voidsetMinimum(int min) This method should NOT be called by user code.voidsetUnitIncrement(int u) Sets the unit value increment for the adjustable object.voidsetValue(int v) Sets the value of this scrollbar to the specified value.voidsetValueIsAdjusting(boolean b) Sets thevalueIsAdjustingproperty.voidsetVisibleAmount(int v) This method should NOT be called by user code.toString()Returns a string representation of this scrollbar and its values.
-
Method Details
-
getOrientation
public int getOrientation()Returns the orientation of this scrollbar.- Specified by:
getOrientationin interfaceAdjustable- Returns:
- the orientation of this scrollbar, either
Adjustable.HORIZONTALorAdjustable.VERTICAL
-
setMinimum
public void setMinimum(int min) This method should NOT be called by user code. This method is public for this class to properly implementAdjustableinterface.- Specified by:
setMinimumin interfaceAdjustable- Parameters:
min- the minimum value- Throws:
AWTError- Always throws an error when called.
-
getMinimum
public int getMinimum()Description copied from interface:AdjustableGets the minimum value of the adjustable object.- Specified by:
getMinimumin interfaceAdjustable- Returns:
- the minimum value of the adjustable object
-
setMaximum
public void setMaximum(int max) This method should NOT be called by user code. This method is public for this class to properly implementAdjustableinterface.- Specified by:
setMaximumin interfaceAdjustable- Parameters:
max- the maximum value- Throws:
AWTError- Always throws an error when called.
-
getMaximum
public int getMaximum()Description copied from interface:AdjustableGets the maximum value of the adjustable object.- Specified by:
getMaximumin interfaceAdjustable- Returns:
- the maximum value of the adjustable object
-
setUnitIncrement
public void setUnitIncrement(int u) Description copied from interface:AdjustableSets the unit value increment for the adjustable object.- Specified by:
setUnitIncrementin interfaceAdjustable- Parameters:
u- the unit increment
-
getUnitIncrement
public int getUnitIncrement()Description copied from interface:AdjustableGets the unit value increment for the adjustable object.- Specified by:
getUnitIncrementin interfaceAdjustable- Returns:
- the unit value increment for the adjustable object
-
setBlockIncrement
public void setBlockIncrement(int b) Description copied from interface:AdjustableSets the block value increment for the adjustable object.- Specified by:
setBlockIncrementin interfaceAdjustable- Parameters:
b- the block increment
-
getBlockIncrement
public int getBlockIncrement()Description copied from interface:AdjustableGets the block value increment for the adjustable object.- Specified by:
getBlockIncrementin interfaceAdjustable- Returns:
- the block value increment for the adjustable object
-
setVisibleAmount
public void setVisibleAmount(int v) This method should NOT be called by user code. This method is public for this class to properly implementAdjustableinterface.- Specified by:
setVisibleAmountin interfaceAdjustable- Parameters:
v- the length of the indicator- Throws:
AWTError- Always throws an error when called.
-
getVisibleAmount
public int getVisibleAmount()Description copied from interface:AdjustableGets the length of the proportional indicator.- Specified by:
getVisibleAmountin interfaceAdjustable- Returns:
- the length of the proportional indicator
-
setValueIsAdjusting
public void setValueIsAdjusting(boolean b) Sets thevalueIsAdjustingproperty.- Parameters:
b- new adjustment-in-progress status- Since:
- 1.4
- See Also:
-
getValueIsAdjusting
public boolean getValueIsAdjusting()Returns true if the value is in the process of changing as a result of actions being taken by the user.- Returns:
- the value of the
valueIsAdjustingproperty - See Also:
-
setValue
public void setValue(int v) Sets the value of this scrollbar to the specified value.If the value supplied is less than the current minimum or greater than the current maximum, then one of those values is substituted, as appropriate.
- Specified by:
setValuein interfaceAdjustable- Parameters:
v- the new value of the scrollbar
-
getValue
public int getValue()Description copied from interface:AdjustableGets the current value of the adjustable object.- Specified by:
getValuein interfaceAdjustable- Returns:
- the current value of the adjustable object
-
addAdjustmentListener
Adds the specified adjustment listener to receive adjustment events from thisScrollPaneAdjustable. Iflisnull, no exception is thrown and no action is performed.Refer to AWT Threading Issues for details on AWT's threading model.
- Specified by:
addAdjustmentListenerin interfaceAdjustable- Parameters:
l- the adjustment listener.- See Also:
-
removeAdjustmentListener
Removes the specified adjustment listener so that it no longer receives adjustment events from thisScrollPaneAdjustable. Iflisnull, no exception is thrown and no action is performed.Refer to AWT Threading Issues for details on AWT's threading model.
- Specified by:
removeAdjustmentListenerin interfaceAdjustable- Parameters:
l- the adjustment listener.- Since:
- 1.1
- See Also:
-
getAdjustmentListeners
Returns an array of all the adjustment listeners registered on thisScrollPaneAdjustable.- Returns:
- all of this
ScrollPaneAdjustable'sAdjustmentListeners or an empty array if no adjustment listeners are currently registered - Since:
- 1.4
- See Also:
-
toString
-
paramString
Returns a string representing the state of this scrollbar. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not benull.- Returns:
- the parameter string of this scrollbar.
-