Control Surface API  2.2.2
Bank< ItemType extends ObjectProxy > Interface Template Reference
Inheritance diagram for Bank< ItemType extends ObjectProxy >:

Public Member Functions

int getSizeOfBank ()
 
default void scrollPageForwards ()
 
default void scrollPageBackwards ()
 
ItemType getItemAt (int index)
 
IntegerValue itemCount ()
 
SettableIntegerValue cursorIndex ()
 
- Public Member Functions inherited from ObjectProxy
BooleanValue exists ()
 
BooleanValue createEqualsValue (ObjectProxy other)
 
- Public Member Functions inherited from Subscribable
boolean isSubscribed ()
 
void setIsSubscribed (boolean value)
 
void subscribe ()
 
void unsubscribe ()
 
- Public Member Functions inherited from Scrollable
SettableIntegerValue scrollPosition ()
 
void scrollBy (int amount)
 
default void scrollForwards ()
 
default void scrollBackwards ()
 
void scrollByPages (int pages)
 
BooleanValue canScrollBackwards ()
 
BooleanValue canScrollForwards ()
 

Detailed Description

A bank provides access to a range of items in Bitwig Studio. Instances of a bank are configured with a fixed number of items and represent an excerpt of a larger list of items. Various methods are provided for scrolling to different sections of the item list. It basically acts like a window moving over the list of underlying items.

Since
API version 2

Definition at line 11 of file Bank.java.

Member Function Documentation

SettableIntegerValue cursorIndex ( )

An integer value that defines the location of the cursor that this bank is following. If there is no cursor or the cursor is not within the bank then the value is -1.

Since
API version 2
ItemType getItemAt ( int  index)

Gets the item in the bank at the supplied index. The index must be >= 0 and < getSizeOfBank().

Since
API version 2
int getSizeOfBank ( )

The fixed size of this bank.

Since
API version 2
IntegerValue itemCount ( )

Value that reports the underlying total item count (not the number of items available in the bank window).

Since
API version 2
default void scrollPageBackwards ( )

Scrolls backwards by one page.

Since
API version 2

Implements Scrollable.

Definition at line 27 of file Bank.java.

default void scrollPageForwards ( )

Scrolls forwards by one page.

Since
API version 2

Implements Scrollable.

Definition at line 21 of file Bank.java.


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