Package jexer
Interface Scrollable
-
- All Known Implementing Classes:
TDirectoryList,TEditorWindow,THelpText,TImageWindow,TList,TScrollableWidget,TScrollableWindow,TTableWindow,TTerminalWidget,TTerminalWindow,TText,TTextPicture,TTextPictureWindow,TTreeViewWidget,TTreeViewWindow
public interface ScrollableScrollable provides a public API for horizontal and vertical scrollbars. Note that not all Scrollables support both horizontal and vertical scrolling; for those that only support a subset, it is expected that the methods corresponding to the missing scrollbar quietly succeed without throwing any exceptions.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidbigHorizontalDecrement()Perform a big step change left.voidbigHorizontalIncrement()Perform a big step change right.voidbigVerticalDecrement()Perform a big step change up.voidbigVerticalIncrement()Perform a big step change down.intgetBottomValue()Get the value that corresponds to being on the bottom edge of the vertical scroll bar.intgetHorizontalBigChange()Get the increment for clicking in the bar between the box and an arrow on the horizontal scrollbar.THScrollergetHorizontalScroller()Get the horizontal scrollbar, or null if this Viewport does not support horizontal scrolling.intgetHorizontalSmallChange()Get the increment for clicking on an arrow on the horizontal scrollbar.intgetHorizontalValue()Get current value of the horizontal scroll.intgetLeftValue()Get the value that corresponds to being on the left edge of the horizontal scroll bar.intgetRightValue()Get the value that corresponds to being on the right edge of the horizontal scroll bar.intgetTopValue()Get the value that corresponds to being on the top edge of the vertical scroll bar.intgetVerticalBigChange()Get the increment for clicking in the bar between the box and an arrow on the vertical scrollbar.TVScrollergetVerticalScroller()Get the vertical scrollbar, or null if this Viewport does not support vertical scrolling.intgetVerticalSmallChange()Get the increment for clicking on an arrow on the vertical scrollbar.intgetVerticalValue()Get current value of the vertical scroll.voidhorizontalDecrement()Perform a small step change left.voidhorizontalIncrement()Perform a small step change right.voidsetBottomValue(int bottomValue)Set the value that corresponds to being on the bottom edge of the vertical scroll bar.voidsetHorizontalBigChange(int bigChange)Set the increment for clicking in the bar between the box and an arrow on the horizontal scrollbar.voidsetHorizontalSmallChange(int smallChange)Set the increment for clicking on an arrow on the horizontal scrollbar.voidsetHorizontalValue(int value)Set current value of the horizontal scroll.voidsetLeftValue(int leftValue)Set the value that corresponds to being on the left edge of the horizontal scroll bar.voidsetRightValue(int rightValue)Set the value that corresponds to being on the right edge of the horizontal scroll bar.voidsetTopValue(int topValue)Set the value that corresponds to being on the top edge of the vertical scroll bar.voidsetVerticalBigChange(int bigChange)Set the increment for clicking in the bar between the box and an arrow on the vertical scrollbar.voidsetVerticalSmallChange(int smallChange)Set the increment for clicking on an arrow on the vertical scrollbar.voidsetVerticalValue(int value)Set current value of the vertical scroll.voidtoBottom()Go to the bottom edge of the vertical scroller.voidtoEnd()Go to the bottom-right edge of the horizontal and vertical scrollers.voidtoHome()Go to the top-left edge of the horizontal and vertical scrollers.voidtoLeft()Go to the left edge of the horizontal scroller.voidtoRight()Go to the right edge of the horizontal scroller.voidtoTop()Go to the top edge of the vertical scroller.voidverticalDecrement()Perform a small step change up.voidverticalIncrement()Perform a small step change down.
-
-
-
Method Detail
-
getHorizontalScroller
THScroller getHorizontalScroller()
Get the horizontal scrollbar, or null if this Viewport does not support horizontal scrolling.- Returns:
- the horizontal scrollbar
-
getVerticalScroller
TVScroller getVerticalScroller()
Get the vertical scrollbar, or null if this Viewport does not support vertical scrolling.- Returns:
- the vertical scrollbar
-
getTopValue
int getTopValue()
Get the value that corresponds to being on the top edge of the vertical scroll bar.- Returns:
- the scroll value
-
setTopValue
void setTopValue(int topValue)
Set the value that corresponds to being on the top edge of the vertical scroll bar.- Parameters:
topValue- the new scroll value
-
getBottomValue
int getBottomValue()
Get the value that corresponds to being on the bottom edge of the vertical scroll bar.- Returns:
- the scroll value
-
setBottomValue
void setBottomValue(int bottomValue)
Set the value that corresponds to being on the bottom edge of the vertical scroll bar.- Parameters:
bottomValue- the new scroll value
-
getVerticalValue
int getVerticalValue()
Get current value of the vertical scroll.- Returns:
- the scroll value
-
setVerticalValue
void setVerticalValue(int value)
Set current value of the vertical scroll.- Parameters:
value- the new scroll value
-
getVerticalSmallChange
int getVerticalSmallChange()
Get the increment for clicking on an arrow on the vertical scrollbar.- Returns:
- the increment value
-
setVerticalSmallChange
void setVerticalSmallChange(int smallChange)
Set the increment for clicking on an arrow on the vertical scrollbar.- Parameters:
smallChange- the new increment value
-
getVerticalBigChange
int getVerticalBigChange()
Get the increment for clicking in the bar between the box and an arrow on the vertical scrollbar.- Returns:
- the increment value
-
setVerticalBigChange
void setVerticalBigChange(int bigChange)
Set the increment for clicking in the bar between the box and an arrow on the vertical scrollbar.- Parameters:
bigChange- the new increment value
-
verticalDecrement
void verticalDecrement()
Perform a small step change up.
-
verticalIncrement
void verticalIncrement()
Perform a small step change down.
-
bigVerticalDecrement
void bigVerticalDecrement()
Perform a big step change up.
-
bigVerticalIncrement
void bigVerticalIncrement()
Perform a big step change down.
-
toTop
void toTop()
Go to the top edge of the vertical scroller.
-
toBottom
void toBottom()
Go to the bottom edge of the vertical scroller.
-
getLeftValue
int getLeftValue()
Get the value that corresponds to being on the left edge of the horizontal scroll bar.- Returns:
- the scroll value
-
setLeftValue
void setLeftValue(int leftValue)
Set the value that corresponds to being on the left edge of the horizontal scroll bar.- Parameters:
leftValue- the new scroll value
-
getRightValue
int getRightValue()
Get the value that corresponds to being on the right edge of the horizontal scroll bar.- Returns:
- the scroll value
-
setRightValue
void setRightValue(int rightValue)
Set the value that corresponds to being on the right edge of the horizontal scroll bar.- Parameters:
rightValue- the new scroll value
-
getHorizontalValue
int getHorizontalValue()
Get current value of the horizontal scroll.- Returns:
- the scroll value
-
setHorizontalValue
void setHorizontalValue(int value)
Set current value of the horizontal scroll.- Parameters:
value- the new scroll value
-
getHorizontalSmallChange
int getHorizontalSmallChange()
Get the increment for clicking on an arrow on the horizontal scrollbar.- Returns:
- the increment value
-
setHorizontalSmallChange
void setHorizontalSmallChange(int smallChange)
Set the increment for clicking on an arrow on the horizontal scrollbar.- Parameters:
smallChange- the new increment value
-
getHorizontalBigChange
int getHorizontalBigChange()
Get the increment for clicking in the bar between the box and an arrow on the horizontal scrollbar.- Returns:
- the increment value
-
setHorizontalBigChange
void setHorizontalBigChange(int bigChange)
Set the increment for clicking in the bar between the box and an arrow on the horizontal scrollbar.- Parameters:
bigChange- the new increment value
-
horizontalDecrement
void horizontalDecrement()
Perform a small step change left.
-
horizontalIncrement
void horizontalIncrement()
Perform a small step change right.
-
bigHorizontalDecrement
void bigHorizontalDecrement()
Perform a big step change left.
-
bigHorizontalIncrement
void bigHorizontalIncrement()
Perform a big step change right.
-
toLeft
void toLeft()
Go to the left edge of the horizontal scroller.
-
toRight
void toRight()
Go to the right edge of the horizontal scroller.
-
toHome
void toHome()
Go to the top-left edge of the horizontal and vertical scrollers.
-
toEnd
void toEnd()
Go to the bottom-right edge of the horizontal and vertical scrollers.
-
-