Scrollable (Jexer - Java Text User Interface

All Known Implementing Classes:

TDirectoryList, TEditorWindow, TImageWindow, TList, TScrollableWidget, TScrollableWindow, TTableWindow, TTerminalWidget, TTerminalWindow, TText, TTreeViewWidget, TTreeViewWindow
```
public interface Scrollable
```
Scrollable 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 and Description
`void`	`bigHorizontalDecrement()` Perform a big step change left.
`void`	`bigHorizontalIncrement()` Perform a big step change right.
`void`	`bigVerticalDecrement()` Perform a big step change up.
`void`	`bigVerticalIncrement()` Perform a big step change down.
`int`	`getBottomValue()` Get the value that corresponds to being on the bottom edge of the vertical scroll bar.
`int`	`getHorizontalBigChange()` Get the increment for clicking in the bar between the box and an arrow on the horizontal scrollbar.
`THScroller`	`getHorizontalScroller()` Get the horizontal scrollbar, or null if this Viewport does not support horizontal scrolling.
`int`	`getHorizontalSmallChange()` Get the increment for clicking on an arrow on the horizontal scrollbar.
`int`	`getHorizontalValue()` Get current value of the horizontal scroll.
`int`	`getLeftValue()` Get the value that corresponds to being on the left edge of the horizontal scroll bar.
`int`	`getRightValue()` Get the value that corresponds to being on the right edge of the horizontal scroll bar.
`int`	`getTopValue()` Get the value that corresponds to being on the top edge of the vertical scroll bar.
`int`	`getVerticalBigChange()` Get the increment for clicking in the bar between the box and an arrow on the vertical scrollbar.
`TVScroller`	`getVerticalScroller()` Get the vertical scrollbar, or null if this Viewport does not support vertical scrolling.
`int`	`getVerticalSmallChange()` Get the increment for clicking on an arrow on the vertical scrollbar.
`int`	`getVerticalValue()` Get current value of the vertical scroll.
`void`	`horizontalDecrement()` Perform a small step change left.
`void`	`horizontalIncrement()` Perform a small step change right.
`void`	`setBottomValue(int bottomValue)` Set the value that corresponds to being on the bottom edge of the vertical scroll bar.
`void`	`setHorizontalBigChange(int bigChange)` Set the increment for clicking in the bar between the box and an arrow on the horizontal scrollbar.
`void`	`setHorizontalSmallChange(int smallChange)` Set the increment for clicking on an arrow on the horizontal scrollbar.
`void`	`setHorizontalValue(int value)` Set current value of the horizontal scroll.
`void`	`setLeftValue(int leftValue)` Set the value that corresponds to being on the left edge of the horizontal scroll bar.
`void`	`setRightValue(int rightValue)` Set the value that corresponds to being on the right edge of the horizontal scroll bar.
`void`	`setTopValue(int topValue)` Set the value that corresponds to being on the top edge of the vertical scroll bar.
`void`	`setVerticalBigChange(int bigChange)` Set the increment for clicking in the bar between the box and an arrow on the vertical scrollbar.
`void`	`setVerticalSmallChange(int smallChange)` Set the increment for clicking on an arrow on the vertical scrollbar.
`void`	`setVerticalValue(int value)` Set current value of the vertical scroll.
`void`	`toBottom()` Go to the bottom edge of the vertical scroller.
`void`	`toEnd()` Go to the bottom-right edge of the horizontal and vertical scrollers.
`void`	`toHome()` Go to the top-left edge of the horizontal and vertical scrollers.
`void`	`toLeft()` Go to the left edge of the horizontal scroller.
`void`	`toRight()` Go to the right edge of the horizontal scroller.
`void`	`toTop()` Go to the top edge of the vertical scroller.
`void`	`verticalDecrement()` Perform a small step change up.
`void`	`verticalIncrement()` 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.

Interface Scrollable

Method Summary

Method Detail

getHorizontalScroller

getVerticalScroller

getTopValue

setTopValue

getBottomValue

setBottomValue

getVerticalValue

setVerticalValue

getVerticalSmallChange

setVerticalSmallChange

getVerticalBigChange

setVerticalBigChange

verticalDecrement

verticalIncrement

bigVerticalDecrement

bigVerticalIncrement

toTop

toBottom

getLeftValue

setLeftValue

getRightValue

setRightValue

getHorizontalValue

setHorizontalValue

getHorizontalSmallChange

setHorizontalSmallChange

getHorizontalBigChange

setHorizontalBigChange

horizontalDecrement

horizontalIncrement

bigHorizontalDecrement

bigHorizontalIncrement

toLeft

toRight

toHome

toEnd