Control Surface API  2.2.2
Scrollable Interface Reference
Inheritance diagram for Scrollable:

Public Member Functions

SettableIntegerValue scrollPosition ()
 
void scrollBy (int amount)
 
default void scrollForwards ()
 
default void scrollBackwards ()
 
void scrollByPages (int pages)
 
default void scrollPageForwards ()
 
default void scrollPageBackwards ()
 
BooleanValue canScrollBackwards ()
 
BooleanValue canScrollForwards ()
 

Detailed Description

Interface for something that can be scrolled.

Since
API version 2

Definition at line 8 of file Scrollable.java.

Member Function Documentation

BooleanValue canScrollBackwards ( )

Value that reports if it is possible to scroll the bank backwards or not.

Since
API version 2
BooleanValue canScrollForwards ( )

Value that reports if it is possible to scroll the bank forwards or not.

Since
API version 2
default void scrollBackwards ( )

Scrolls forwards by one step. This is the same as calling scrollBy(int) with -1

Since
API version 2

Definition at line 40 of file Scrollable.java.

void scrollBy ( int  amount)

Scrolls by a number of steps.

Parameters
amountThe number of steps to scroll by (positive is forwards and negative is backwards).
void scrollByPages ( int  pages)

Scrolls by a number of pages.

Parameters
amountThe number of pages to scroll by (positive is forwards and negative is backwards).
default void scrollForwards ( )

Scrolls forwards by one step. This is the same as calling scrollBy(int) with 1

Since
API version 2

Definition at line 30 of file Scrollable.java.

default void scrollPageBackwards ( )

Scrolls backwards by one page.

Since
API version 2

Implemented in Bank< ItemType extends ObjectProxy >.

Definition at line 68 of file Scrollable.java.

default void scrollPageForwards ( )

Scrolls forwards by one page.

Since
API version 2

Implemented in Bank< ItemType extends ObjectProxy >.

Definition at line 58 of file Scrollable.java.

SettableIntegerValue scrollPosition ( )

Value that reports the current scene scroll position.

Since
API version 2

The documentation for this interface was generated from the following file: