Interface CursorRemoteControlsPage

All Superinterfaces:
Cursor, DeleteableObject, HardwareBindable, ParameterBank, RelativeHardwarControlBindable, RemoteControlsPage

public interface CursorRemoteControlsPage extends Cursor, RemoteControlsPage
Represents a cursor that looks at a RemoteControlsPage.
Since:
API version 2
  • Method Details

    • pageNames

      StringArrayValue pageNames()
      Value that reports the names of the devices parameter pages.
    • selectNextPage

      void selectNextPage(boolean shouldCycle)
      Selects the next page.
      Parameters:
      shouldCycle - If true then when the end is reached and there is no next page it selects the first page
      Since:
      API version 2
    • selectPreviousPage

      void selectPreviousPage(boolean shouldCycle)
      Selects the previous page.
      Parameters:
      shouldCycle - If true then when the end is reached and there is no next page it selects the first page
      Since:
      API version 2
    • selectNextPageMatching

      void selectNextPageMatching(String expression, boolean shouldCycle)
      Selects the next page that matches the given expression.
      Parameters:
      expression - An expression that can match a page based on how it has been tagged. For now this can only be the name of a single tag that you would like to match.
      shouldCycle - If true then when the end is reached and there is no next page it selects the first page
      Since:
      API version 2
    • selectPreviousPageMatching

      void selectPreviousPageMatching(String expression, boolean shouldCycle)
      Selects the previous page that matches the given expression.
      Parameters:
      expression - An expression that can match a page based on how it has been tagged. For now this can only be the name of a single tag that you would like to match.
      shouldCycle - If true then when the end is reached and there is no next page it selects the first page
      Since:
      API version 2
    • selectedPageIndex

      SettableIntegerValue selectedPageIndex()
      Value that reports the currently selected parameter page index.
      Since:
      API version 2
    • pageCount

      IntegerValue pageCount()
      Value that represents the number of pages.
      Since:
      API version 7
    • createPresetPage

      void createPresetPage()
      Creates a new preset page.
      Since:
      API version 16
    • createPresetPageAction

      HardwareActionBindable createPresetPageAction()
      See Also: