Bitwig Studio Control Surface API  5.0.11
BrowserItemBank< ItemType extends BrowserItem > Interface Template Reference
+ Inheritance diagram for BrowserItemBank< ItemType extends BrowserItem >:

Public Member Functions

int getSize ()
 
BrowserItem getItem (int index)
 
void scrollUp ()
 
void scrollDown ()
 
void scrollPageUp ()
 
void scrollPageDown ()
 
void addScrollPositionObserver (IntegerValueChangedCallback callback)
 
void addCanScrollUpObserver (BooleanValueChangedCallback callback)
 
void addCanScrollDownObserver (BooleanValueChangedCallback callback)
 
- Public Member Functions inherited from Bank< ItemType >
int getSizeOfBank ()
 
int getCapacityOfBank ()
 
void setSizeOfBank (int size)
 
default void scrollPageForwards ()
 
default void scrollPageBackwards ()
 
ItemType getItemAt (int index)
 
IntegerValue itemCount ()
 
SettableIntegerValue cursorIndex ()
 
void setSkipDisabledItems (boolean shouldSkip)
 

Detailed Description

Instances of this interface are used to navigate a column in the Bitwig Studio browser.

Since
API version 1

Member Function Documentation

◆ addCanScrollDownObserver()

void addCanScrollDownObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the column entries can be scrolled further down.

Parameters
callbacka callback function that receives a single boolean parameter
Since
API version 1
Deprecated:
Use canScrollForwards() instead.

◆ addCanScrollUpObserver()

void addCanScrollUpObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the column entries can be scrolled further up.

Parameters
callbacka callback function that receives a single boolean parameter
Since
API version 1
Deprecated:
Use canScrollBackwards() instead.

◆ addScrollPositionObserver()

void addScrollPositionObserver ( IntegerValueChangedCallback  callback)

Registers an observer that reports the current scroll position, more specifically the position of the first item within the underlying list of entries, that is shown as the first entry within the window.

Parameters
callbacka callback function that receives a single integer number parameter. The parameter reflects the scroll position, or -1 in case the column has no content.
Since
API version 1
Deprecated:
Use scrollPosition() instead.

◆ getItem()

BrowserItem getItem ( int  index)

Returns the item for the given index.

Parameters
indexthe item index, must be in the range [0..getSize-1]
Returns
the requested item object
Since
API version 1
Deprecated:
Use getItemAt(int) instead.

◆ getSize()

int getSize ( )

Returns the window size that was used to configure the filter column during creation.

Returns
the size of the filter column.
Since
API version 1
Deprecated:
Use getSizeOfBank() instead.

◆ scrollDown()

void scrollDown ( )

Scrolls the filter column entries one item down.

Since
API version 1
Deprecated:
Use scrollForwards() instead.

◆ scrollPageDown()

void scrollPageDown ( )

Scrolls the filter column entries one page up. For example if the column is configured with a window size of 8 entries and is currently showing items [9..16], calling this method would scroll the column to show items [1..8].

Since
API version 1
Deprecated:
Use scrollPageForwards() instead.

◆ scrollPageUp()

void scrollPageUp ( )

Scrolls the filter column entries one page up. For example if the column is configured with a window size of 8 entries and is currently showing items [1..8], calling this method would scroll the column to show items [9..16].

Since
API version 1
Deprecated:
Use scrollPageBackwards() instead.

◆ scrollUp()

void scrollUp ( )

Scrolls the filter column entries one item up.

Since
API version 1
Deprecated:
Use scrollBackwards() instead.

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