Interface Scrollable

All Superinterfaces:
HardwareBindable, RelativeHardwarControlBindable
All Known Subinterfaces:
Bank<ItemType>, BrowserFilterColumnBank, BrowserFilterItemBank, BrowserItemBank<ItemType>, BrowserResultsItemBank, BrowsingSessionBank, ChannelBank<ChannelType>, ClipLauncherSlotBank, ClipLauncherSlotOrSceneBank<ItemType>, CueMarkerBank, DeviceBank, DeviceLayerBank, DrumPadBank, SceneBank, SendBank, TrackBank

public interface Scrollable extends RelativeHardwarControlBindable
Interface for something that can be scrolled.
Since:
API version 2
  • Method Details

    • scrollPosition

      SettableIntegerValue scrollPosition()
      Value that reports the current scroll position.
      Since:
      API version 2
    • scrollIntoView

      void scrollIntoView(int position)
      Scrolls the supplied position into view if it isn't already.
      Since:
      API version 7
    • scrollBy

      void scrollBy(int amount)
      Scrolls by a number of steps.
      Parameters:
      amount - The number of steps to scroll by (positive is forwards and negative is backwards).
    • scrollForwards

      default void scrollForwards()
      Scrolls forwards by one step. This is the same as calling scrollBy(int) with 1
      Since:
      API version 2
    • scrollForwardsAction

      HardwareActionBindable scrollForwardsAction()
    • scrollBackwards

      default void scrollBackwards()
      Scrolls forwards by one step. This is the same as calling scrollBy(int) with -1
      Since:
      API version 2
    • scrollBackwardsAction

      HardwareActionBindable scrollBackwardsAction()
    • scrollByPages

      void scrollByPages(int amount)
      Scrolls by a number of pages.
      Parameters:
      amount - The number of pages to scroll by (positive is forwards and negative is backwards).
    • scrollPageForwards

      default void scrollPageForwards()
      Scrolls forwards by one page.
      Since:
      API version 2
    • scrollPageForwardsAction

      HardwareActionBindable scrollPageForwardsAction()
    • scrollPageBackwards

      default void scrollPageBackwards()
      Scrolls backwards by one page.
      Since:
      API version 2
    • scrollPageBackwardsAction

      HardwareActionBindable scrollPageBackwardsAction()
    • canScrollBackwards

      BooleanValue canScrollBackwards()
      Value that reports if it is possible to scroll the bank backwards or not.
      Since:
      API version 2
    • canScrollForwards

      BooleanValue canScrollForwards()
      Value that reports if it is possible to scroll the bank forwards or not.
      Since:
      API version 2