Interface BrowserFilterColumnBank
- All Superinterfaces:
Bank<BrowserFilterColumn>,HardwareBindable,ObjectProxy,RelativeHardwarControlBindable,Scrollable,Subscribable
Deprecated.
Instances of this interface are used to navigate the columns of a Bitwig Studio browser session.
- Since:
- API version 1
-
Method Summary
Modifier and TypeMethodDescriptionvoidDeprecated.Registers an observer that reports if the columns can be scrolled further down.voidDeprecated.Registers an observer that reports if the columns can be scrolled further up.voidDeprecated.Registers an observer that reports the underlying total count of columns (not the size of the window).voidDeprecated.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.getItem(int index) Deprecated.Returns the filter column for the given index.intgetSize()Deprecated.Returns the window size that was used to configure the filter column during creation.voidDeprecated.Scrolls the filter columns one item down.voidDeprecated.Scrolls the filter columns one page up.voidDeprecated.Scrolls the filter columns one page up.voidscrollUp()Deprecated.Scrolls the filter columns one item up.Methods inherited from interface com.bitwig.extension.controller.api.Bank
cursorIndex, getCapacityOfBank, getItemAt, getSizeOfBank, itemCount, setSizeOfBank, setSkipDisabledItemsMethods inherited from interface com.bitwig.extension.controller.api.ObjectProxy
createEqualsValue, existsMethods inherited from interface com.bitwig.extension.controller.api.RelativeHardwarControlBindable
addBinding, addBindingWithSensitivityMethods inherited from interface com.bitwig.extension.controller.api.Scrollable
canScrollBackwards, canScrollForwards, scrollBackwards, scrollBackwardsAction, scrollBy, scrollByPages, scrollForwards, scrollForwardsAction, scrollIntoView, scrollPageBackwards, scrollPageBackwardsAction, scrollPageForwards, scrollPageForwardsAction, scrollPositionMethods inherited from interface com.bitwig.extension.controller.api.Subscribable
isSubscribed, setIsSubscribed, subscribe, unsubscribe
-
Method Details
-
getSize
int getSize()Deprecated.Returns the window size that was used to configure the filter column during creation.- Returns:
- the size of the filter column.
-
getItem
Deprecated.Returns the filter column for the given index.- Parameters:
index- the item index, must be in the range `[0..getSize-1]`- Returns:
- the requested filter column object
-
scrollUp
void scrollUp()Deprecated.Scrolls the filter columns one item up.- Since:
- API version 1
-
scrollDown
void scrollDown()Deprecated.Scrolls the filter columns one item down.- Since:
- API version 1
-
scrollPageUp
void scrollPageUp()Deprecated.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
-
scrollPageDown
void scrollPageDown()Deprecated.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
-
addScrollPositionObserver
Deprecated.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:
callback- a 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
-
addCanScrollUpObserver
Deprecated.Registers an observer that reports if the columns can be scrolled further up.- Parameters:
callback- a callback function that receives a single boolean parameter- Since:
- API version 1
-
addCanScrollDownObserver
Deprecated.Registers an observer that reports if the columns can be scrolled further down.- Parameters:
callback- a callback function that receives a single boolean parameter- Since:
- API version 1
-
addEntryCountObserver
Deprecated.Registers an observer that reports the underlying total count of columns (not the size of the window).- Parameters:
callback- a callback function that receives a single integer parameter- Since:
- API version 1
-
PopupBrowserinstead.