|
Control Surface API
3.0.3
|
|
Control Surface API
3.0.3
|
Public Member Functions | |
| int | getSizeOfBank () |
| int | getCapacityOfBank () |
| void | setSizeOfBank (int size) |
| 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 | scrollIntoView (int position) |
| void | scrollBy (int amount) |
| default void | scrollForwards () |
| default void | scrollBackwards () |
| void | scrollByPages (int amount) |
| BooleanValue | canScrollBackwards () |
| BooleanValue | canScrollForwards () |
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.
| 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.
| int getCapacityOfBank | ( | ) |
The maximum number of items in the bank which is defined when the bank is initially created.
| ItemType getItemAt | ( | int | index | ) |
Gets the item in the bank at the supplied index. The index must be >= 0 and < getSizeOfBank().
| int getSizeOfBank | ( | ) |
The fixed size of this bank. This will be initially equal to the capacity of the Bank.
| IntegerValue itemCount | ( | ) |
Value that reports the underlying total item count (not the number of items available in the bank window).
| default void scrollPageBackwards | ( | ) |
| default void scrollPageForwards | ( | ) |
| void setSizeOfBank | ( | int | size | ) |
Sets the size of this bank
| size | number of items in the bank that has to be greater than 0 and less or equal to the capacity of the bank. |
