/
Bank.js
70 lines (60 loc) · 1.93 KB
/
Bank.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/* API Version - 3.1.2 */
/**
* 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
*/
function Bank() {}
Bank.prototype = new ObjectProxy();
Bank.prototype.constructor = Bank;
/**
* The fixed size of this bank.
* This will be initially equal to the capacity of the Bank.
*
* @return {int}
* @since API version 2
*/
Bank.prototype.getSizeOfBank = function() {};
/**
* The maximum number of items in the bank which is defined when the bank is initially created.
*
* @return {int}
* @since API version 7
*/
Bank.prototype.getCapacityOfBank = function() {};
/**
* Sets the size of this bank
*
* @param {int} 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
*/
Bank.prototype.setSizeOfBank = function(size) {};
Bank.prototype.scrollPageForwards = function() {};
Bank.prototype.scrollPageBackwards = function() {};
/**
* Gets the item in the bank at the supplied index. The index must be >= 0 and < {@link #getSizeOfBank()}.
*
* @param {int} index
* @return {ItemType}
* @since API version 2
*/
Bank.prototype.getItemAt = function(index) {};
/**
* Value that reports the underlying total item count (not the number of items available in the bank
* window).
*
* @return {IntegerValue}
* @since API version 2
*/
Bank.prototype.itemCount = function() {};
/**
* 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.
*
* @return {SettableIntegerValue}
* @since API version 2
*/
Bank.prototype.cursorIndex = function() {};