Open topic with navigation

com.hp.lft.sdk.sap.ui5

## Interface Paginator

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

      public interface Paginator
      extends WebElement

  An SAPUI5 paginator object.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `void` | `firstPage()` Scrolls to the first page.
    `int` | `getCurrentPage()` Returns the index of the currently selected page.
    `int` | `getTotalPagesCount()` Returns the total number of pages.
    `int` | `getVisiblePagesCount()` Returns the number of pages currently visible in the paginator.
    `void` | `lastPage()` Scrolls to the last page.
    `void` | `navigateTo(int pageNum)` Navigates to the specified page.
    `void` | `nextPage()` Scrolls to the next page.
    `void` | `previousPage()` Scrolls to the previous page.

    - ### 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

    - #### getCurrentPage

          int getCurrentPage()
                      throws GeneralLeanFtException

      Returns the index of the currently selected page.
      Returns:
        The index of the currently selected page.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getTotalPagesCount

          int getTotalPagesCount()
                          throws GeneralLeanFtException

      Returns the total number of pages.
      Returns:
        the total number of pages.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getVisiblePagesCount

          int getVisiblePagesCount()
                            throws GeneralLeanFtException

      Returns the number of pages currently visible in the paginator.
      Returns:
        The number of pages currently visible in the paginator.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### navigateTo

          void navigateTo(int pageNum)
                   throws GeneralLeanFtException,
                          GeneralReplayException

      Navigates to the specified page.
      Parameters:
        `pageNum` - the page number to navigate to.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.
        `GeneralReplayException` - if error occurs during replay execution

    - #### firstPage

          void firstPage()
                  throws GeneralLeanFtException,
                         GeneralReplayException

      Scrolls to the first page.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.
        `GeneralReplayException` - if error occurs during replay execution

    - #### lastPage

          void lastPage()
                 throws GeneralLeanFtException,
                        GeneralReplayException

      Scrolls to the last page.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.
        `GeneralReplayException` - if error occurs during replay execution

    - #### previousPage

          void previousPage()
                     throws GeneralLeanFtException,
                            GeneralReplayException

      Scrolls to the previous page.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.
        `GeneralReplayException` - if error occurs during replay execution

    - #### nextPage

          void nextPage()
                 throws GeneralLeanFtException,
                        GeneralReplayException

      Scrolls to the next page.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.
        `GeneralReplayException` - if error occurs during replay execution