Bitwig Studio Control Surface API  5.0.11
Scrollable Interface Reference
+ Inheritance diagram for Scrollable:

Public Member Functions

SettableIntegerValue scrollPosition ()
 
void scrollIntoView (int position)
 
void scrollBy (int amount)
 
default void scrollForwards ()
 
HardwareActionBindable scrollForwardsAction ()
 
default void scrollBackwards ()
 
HardwareActionBindable scrollBackwardsAction ()
 
void scrollByPages (int amount)
 
default void scrollPageForwards ()
 
HardwareActionBindable scrollPageForwardsAction ()
 
default void scrollPageBackwards ()
 
HardwareActionBindable scrollPageBackwardsAction ()
 
BooleanValue canScrollBackwards ()
 
BooleanValue canScrollForwards ()
 
- Public Member Functions inherited from RelativeHardwarControlBindable
default RelativeHardwareControlBinding addBinding (RelativeHardwareControl hardwareControl)
 
RelativeHardwareControlBinding addBindingWithSensitivity (RelativeHardwareControl hardwareControl, double sensitivity)
 

Detailed Description

Interface for something that can be scrolled.

Since
API version 2

Member Function Documentation

◆ canScrollBackwards()

BooleanValue canScrollBackwards ( )

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

Since
API version 2

◆ canScrollForwards()

BooleanValue canScrollForwards ( )

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

Since
API version 2

◆ scrollBackwards()

default void scrollBackwards ( )

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

Since
API version 2

◆ scrollBy()

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).

◆ scrollByPages()

void scrollByPages ( int  amount)

Scrolls by a number of pages.

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

◆ scrollForwards()

default void scrollForwards ( )

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

Since
API version 2

◆ scrollIntoView()

void scrollIntoView ( int  position)

Scrolls the supplied position into view if it isn't already.

Since
API version 7

◆ scrollPageBackwards()

default void scrollPageBackwards ( )

Scrolls backwards by one page.

Since
API version 2

Implemented in Bank< ItemType extends ObjectProxy >.

◆ scrollPageForwards()

default void scrollPageForwards ( )

Scrolls forwards by one page.

Since
API version 2

Implemented in Bank< ItemType extends ObjectProxy >.

◆ scrollPosition()

SettableIntegerValue scrollPosition ( )

Value that reports the current scroll position.

Since
API version 2

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