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

Public Member Functions

int getSize ()
 
BrowserFilterColumn getItem (int index)
 
void scrollUp ()
 
void scrollDown ()
 
void scrollPageUp ()
 
void scrollPageDown ()
 
void addScrollPositionObserver (IntegerValueChangedCallback callback)
 
void addCanScrollUpObserver (BooleanValueChangedCallback callback)
 
void addCanScrollDownObserver (BooleanValueChangedCallback callback)
 
void addEntryCountObserver (IntegerValueChangedCallback callback)
 
- Public Member Functions inherited from Bank< BrowserFilterColumn >
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 the columns of a Bitwig Studio browser session.

Since
API version 1
Deprecated:
Use PopupBrowser instead.

Member Function Documentation

◆ addCanScrollDownObserver()

void addCanScrollDownObserver ( BooleanValueChangedCallback  callback)

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

Parameters
callbacka callback function that receives a single boolean parameter
Since
API version 1

◆ addCanScrollUpObserver()

void addCanScrollUpObserver ( BooleanValueChangedCallback  callback)

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

Parameters
callbacka callback function that receives a single boolean parameter
Since
API version 1

◆ addEntryCountObserver()

void addEntryCountObserver ( IntegerValueChangedCallback  callback)

Registers an observer that reports the underlying total count of columns (not the size of the window).

Parameters
callbacka callback function that receives a single integer parameter
Since
API version 1

◆ 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 columns, that is shown as the first column 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

◆ getItem()

BrowserFilterColumn getItem ( int  index)

Returns the filter column for the given index.

Parameters
indexthe item index, must be in the range [0..getSize-1]
Returns
the requested filter column object

◆ getSize()

int getSize ( )

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

Returns
the size of the filter column.

◆ scrollDown()

void scrollDown ( )

Scrolls the filter columns one item down.

Since
API version 1

◆ scrollPageDown()

void scrollPageDown ( )

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

Since
API version 1

◆ scrollPageUp()

void scrollPageUp ( )

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

Since
API version 1

◆ scrollUp()

void scrollUp ( )

Scrolls the filter columns one item up.

Since
API version 1

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