Package com.bitwig.extension.controller.api

Interface Bank<ItemType extends ObjectProxy>

All Superinterfaces:

HardwareBindable, ObjectProxy, RelativeHardwarControlBindable, Scrollable, Subscribable

All Known Subinterfaces:

BrowserFilterColumnBank, BrowserFilterItemBank, BrowserItemBank<ItemType>, BrowserResultsItemBank, BrowsingSessionBank, ChannelBank<ChannelType>, ClipLauncherSlotBank, ClipLauncherSlotOrSceneBank<ItemType>, CueMarkerBank, DeviceBank, DeviceLayerBank, DrumPadBank, SceneBank, SendBank, TrackBank

public interface Bank<ItemType extends ObjectProxy>
extends ObjectProxy, Scrollable

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

Method Summary

Modifier and Type	Method	Description
SettableIntegerValue	cursorIndex()	An integer value that defines the location of the cursor that this bank is following.
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.
int	getSizeOfBank()	The fixed size of this bank.
IntegerValue	itemCount()	Value that reports the underlying total item count (not the number of items available in the bank window).
void	setSizeOfBank(int size)	Sets the size of this bank
void	setSkipDisabledItems(boolean shouldSkip)	Disabled items will not be accessible via the bank if set to true.

Methods inherited from interface com.bitwig.extension.controller.api.ObjectProxy

createEqualsValue, exists

Methods inherited from interface com.bitwig.extension.controller.api.RelativeHardwarControlBindable

addBinding, addBindingWithSensitivity

Methods inherited from interface com.bitwig.extension.controller.api.Scrollable

canScrollBackwards, canScrollForwards, scrollBackwards, scrollBackwardsAction, scrollBy, scrollByPages, scrollForwards, scrollForwardsAction, scrollIntoView, scrollPageBackwards, scrollPageBackwardsAction, scrollPageForwards, scrollPageForwardsAction, scrollPosition

Methods inherited from interface com.bitwig.extension.controller.api.Subscribable

isSubscribed, setIsSubscribed, subscribe, unsubscribe

Method Details

getSizeOfBank

int getSizeOfBank()

The fixed size of this bank. This will be initially equal to the capacity of the Bank.

Since:

API version 2

getCapacityOfBank

int getCapacityOfBank()

The maximum number of items in the bank which is defined when the bank is initially created.

Since:

API version 7

setSizeOfBank

void setSizeOfBank(int size)

Sets the size of this bank

Parameters:

size - number of items in the bank that has to be greater than 0 and less or equal to the capacity of the bank.

Since:

API version 7

getItemAt

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

itemCount

IntegerValue itemCount()

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

Since:

API version 2

cursorIndex

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

setSkipDisabledItems

void setSkipDisabledItems(boolean shouldSkip)

Disabled items will not be accessible via the bank if set to true.

Since:

API version 11