Package com.bitwig.extension.controller.api

Interface BrowserItemBank<ItemType extends BrowserItem>

All Superinterfaces:
Bank<ItemType>, HardwareBindable, ObjectProxy, RelativeHardwarControlBindable, Scrollable, Subscribable
All Known Subinterfaces:
BrowserFilterItemBank, BrowserResultsItemBank
public interface BrowserItemBank<ItemType extends BrowserItem> extends Bank<ItemType>
Instances of this interface are used to navigate a column in the Bitwig Studio browser.
Since:
API version 1

  • Method Details

    • getSize

      @Deprecated int getSize()
      Deprecated.
      Use Bank.getSizeOfBank() instead.
      Returns the window size that was used to configure the filter column during creation.
      Returns:
      the size of the filter column.
      Since:
      API version 1

    • getItem

      @Deprecated BrowserItem getItem(int index)
      Deprecated.
      Use Bank.getItemAt(int) instead.
      Returns the item for the given index.
      Parameters:
      index - the item index, must be in the range `[0..getSize-1]`
      Returns:
      the requested item object
      Since:
      API version 1

    • scrollUp

      @Deprecated void scrollUp()
      Deprecated.
      Use Scrollable.scrollBackwards() instead.
      Scrolls the filter column entries one item up.
      Since:
      API version 1

    • scrollDown

      @Deprecated void scrollDown()
      Deprecated.
      Use Scrollable.scrollForwards() instead.
      Scrolls the filter column entries one item down.
      Since:
      API version 1

    • scrollPageUp

      @Deprecated void scrollPageUp()
      Deprecated.
      Use Scrollable.scrollPageBackwards() instead.
      Scrolls the filter column entries one page up. For example if the column is configured with a window size of 8 entries and is currently showing items [1..8], calling this method would scroll the column to show items [9..16].
      Since:
      API version 1

    • scrollPageDown

      @Deprecated void scrollPageDown()
      Deprecated.
      Use Scrollable.scrollPageForwards() instead.
      Scrolls the filter column entries one page up. For example if the column is configured with a window size of 8 entries and is currently showing items [9..16], calling this method would scroll the column to show items [1..8].
      Since:
      API version 1

    • addScrollPositionObserver

      @Deprecated void addScrollPositionObserver(IntegerValueChangedCallback callback)
      Deprecated.
      Use Scrollable.scrollPosition() instead.
      Registers an observer that reports the current scroll position, more specifically the position of the first item within the underlying list of entries, that is shown as the first entry 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 void addCanScrollUpObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use Scrollable.canScrollBackwards() instead.
      Registers an observer that reports if the column entries can be scrolled further up.
      Parameters:
      callback - a callback function that receives a single boolean parameter
      Since:
      API version 1

    • addCanScrollDownObserver

      @Deprecated void addCanScrollDownObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use Scrollable.canScrollForwards() instead.
      Registers an observer that reports if the column entries can be scrolled further down.
      Parameters:
      callback - a callback function that receives a single boolean parameter
      Since:
      API version 1