Open topic with navigation

com.hp.lft.sdk.sap.ui5

## Interface RoadMap

- All Superinterfaces:
    Clickable, LocationInfoProvider, SupportDragAndDrop, SupportsNativeObject, TestObject, TestObjectDescriber, VisibleProvider, WaitUntilVisibleProvider, WebElement, WebTestObject, WebTestObjectDescriber

      public interface RoadMap
      extends WebElement

  An SAPUI5 roadmap object.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `RoadMapItem` | `getItem(java.lang.String path)` Returns the path to the item as a semicolon-delimited string.
    `java.util.List<RoadMapItem>` | `getItems()` Returns a list of the names of all `RoadMapItem` steps and sub-steps, separated by semicolons (;).
    `RoadMapItem` | `getSelectedItem()` Returns the currently selected step or sub-step in the road map.
    `java.util.List<RoadMapItem>` | `getSteps()` Returns a list of all of the top-level steps in the road map (including hidden steps).
    `void` | `next()` Scrolls to the next step in the road map object.
    `void` | `previous()` Scrolls to the previous step in the road map object.
    `void` | `select(RoadMapItem item)` Selects the step or sub-step in the road map object.
    `void` | `select(java.lang.String path)` Selects the step or sub-step (by path) in the road map object.

    - ### Methods inherited from interface com.hp.lft.sdk.web.WebElement

      `doubleClick, doubleClick, fireEvent, getAccessibilityName, getCSSSelector, getRole, getXPath, hoverTap, hoverTap, longPress, longPress, pan, pan, pinch, pinch, swipe, swipe`

    - ### Methods inherited from interface com.hp.lft.sdk.TestObject

      `exists, exists, findChildren, getDescription, getDisplayName, getParent, getSnapshot, getTextLocations, getTextLocations, getVisibleText, getVisibleText, highlight, highlightMatches, setDescription, setDisplayName, verifyImageExists, verifyImageExists, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, waitUntilExists, waitUntilExists`

    - ### Methods inherited from interface com.hp.lft.sdk.Clickable

      `click, click, click`

    - ### Methods inherited from interface com.hp.lft.sdk.web.WebTestObject

      `getAttribute, getAttributes, getClassName, getComputedStyle, getComputedStyles, getId, getInnerHTML, getInnerText, getName, getOuterHTML, getOuterText, getTagName, getTitle, isVisible`

    - ### Methods inherited from interface com.hp.lft.sdk.LocationInfoProvider

      `getAbsoluteLocation, getLocation, getSize`

    - ### Methods inherited from interface com.hp.lft.sdk.web.WebTestObjectDescriber

      `describe, describe`

    - ### Methods inherited from interface com.hp.lft.sdk.TestObjectDescriber

      `describe`

    - ### Methods inherited from interface com.hp.lft.sdk.SupportsNativeObject

      `getNativeObject`

    - ### Methods inherited from interface com.hp.lft.sdk.SupportDragAndDrop

      `dragAndDropOn, dragAndDropOn`

    - ### Methods inherited from interface com.hp.lft.sdk.WaitUntilVisibleProvider

      `waitUntilVisible, waitUntilVisible`

    - ### Methods inherited from interface com.hp.lft.sdk.VisibleProvider

      `isVisible`

- - ### Method Detail

    - #### getItems

          java.util.List<RoadMapItem> getItems()
                                        throws GeneralLeanFtException

      Returns a list of the names of all `RoadMapItem` steps and sub-steps, separated by semicolons (;).
      Returns:
        A semicolon-delimited list of the names of all `RoadMapItem` steps and sub-steps.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getSteps

          java.util.List<RoadMapItem> getSteps()
                                        throws GeneralLeanFtException

      Returns a list of all of the top-level steps in the road map (including hidden steps).
      Returns:
        A list of all of the top-level steps in the road map (including hidden steps).
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getSelectedItem

                                                      RoadMapItem getSelectedItem()
                               throws GeneralLeanFtException

      Returns the currently selected step or sub-step in the road map.
      Returns:
        The currently selected step or sub-step in the road map.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getItem

                                                      RoadMapItem getItem(java.lang.String path)
                       throws GeneralLeanFtException

      Returns the path to the item as a semicolon-delimited string.
      Parameters:
        `path` - the path to the item
      Returns:
        the path to the item as a semicolon-delimited string.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### next

          void next()
             throws GeneralLeanFtException,
                    GeneralReplayException

      Scrolls to the next step in the road map object.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.
        `GeneralReplayException` - if error occurs during replay execution

    - #### previous

          void previous()
                 throws GeneralLeanFtException,
                        GeneralReplayException

      Scrolls to the previous step in the road map object.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.
        `GeneralReplayException` - if error occurs during replay execution

    - #### select

          void select(java.lang.String path)
               throws GeneralLeanFtException

      Selects the step or sub-step (by path) in the road map object.
      Parameters:
        `path` - the path to the step or sub-step.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### select

          void select(RoadMapItem item)
               throws GeneralLeanFtException

      Selects the step or sub-step in the road map object.
      Parameters:
        `item` - the `RoadMapItem` step or sub-step to select.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.