Open topic with navigation

com.hp.lft.sdk.stdwin

## Interface ScrollBar

- All Superinterfaces:
    Clickable, DoubleClickable, LocationInfoProvider, SupportDragAndDrop, SupportSendKeys, TestObject, TestObjectDescriber, UiObjectBase, VisibleProvider, WaitUntilVisibleProvider, WaitUntilEnabledProvider, EnabledProvider

      public interface ScrollBar
      extends UiObjectBase, TestObject

  A standard Windows scroll bar.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `int` | `getMaxPosition()` Returns the maximum scrolling position.
    `int` | `getMinPosition()` Returns the minimum scrolling position.
    `int` | `getPosition()` Returns the scroll bar position.
    `void` | `nextLine()` Moves the scroll bar downward, or to the right, by one line.
    `void` | `nextLine(int numberOfLines)` Moves the scroll bar downward, or to the right, the specified number of lines.
    `void` | `nextPage()` Moves the scroll bar downward, or to the right, by one page.
    `void` | `nextPage(int numberOfPages)` Moves the scroll bar downward, or to the right, the specified number of pages.
    `void` | `previousLine()` Moves the scroll bar upward, or to the left, by one line.
    `void` | `previousLine(int numberOfLines)` Moves the scroll bar upward, or to the left, the specified number of lines.
    `void` | `previousPage()` Moves the scroll bar upward, or to the left, by one page.
    `void` | `previousPage(int numberOfPages)` Moves the scroll bar upward, or to the left, the specified number of pages.
    `void` | `setPosition(int position)` Sets the scroll bar position.

    - ### Methods inherited from interface com.hp.lft.sdk.stdwin.UiObjectBase

      `getAccessibleName, getAttachedText, getText, getWindowClassRegExp, getWindowExtendedStyle, getWindowExtendedStyleAsLong, getWindowId, getWindowStyle, getWindowStyleAsLong`

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

      `getHandle, getNativeClass, getWindowTitleRegExp, isEnabled, isFocused, isVisible, mouseMove`

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

      `click, click, click`

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

      `doubleClick, doubleClick, doubleClick`

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

      `getAbsoluteLocation, getLocation, getSize`

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

      `sendKeys, sendKeys`

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

      `dragAndDropOn, dragAndDropOn`

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

      `describe`

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

      `waitUntilEnabled, waitUntilEnabled`

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

      `isEnabled`

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

      `waitUntilVisible, waitUntilVisible`

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

      `isVisible`

- - ### Method Detail

    - #### getMaxPosition

          int getMaxPosition()
                      throws GeneralLeanFtException

      Returns the maximum scrolling position.
      Returns:
        the maximum scrolling position.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getMinPosition

          int getMinPosition()
                      throws GeneralLeanFtException

      Returns the minimum scrolling position.
      Returns:
        the minimum scrolling position.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getPosition

          int getPosition()
                   throws GeneralLeanFtException

      Returns the scroll bar position.
      Returns:
        the scroll bar position.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setPosition

          void setPosition(int position)
                    throws GeneralLeanFtException

      Sets the scroll bar position.
      Parameters:
        `position` - the scroll bar position to be set.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### nextLine

          void nextLine(int numberOfLines)
                 throws GeneralLeanFtException

      Moves the scroll bar downward, or to the right, the specified number of lines.
      Parameters:
        `numberOfLines` - the number of lines to move the scroll bar.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### nextLine

          void nextLine()
                 throws GeneralLeanFtException

      Moves the scroll bar downward, or to the right, by one line.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### nextPage

          void nextPage(int numberOfPages)
                 throws GeneralLeanFtException

      Moves the scroll bar downward, or to the right, the specified number of pages.
      Parameters:
        `numberOfPages` - the number of pages to move the scroll bar.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### nextPage

          void nextPage()
                 throws GeneralLeanFtException

      Moves the scroll bar downward, or to the right, by one page.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### previousLine

          void previousLine(int numberOfLines)
                     throws GeneralLeanFtException

      Moves the scroll bar upward, or to the left, the specified number of lines.
      Parameters:
        `numberOfLines` - the number of lines to move the scroll bar.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### previousLine

          void previousLine()
                     throws GeneralLeanFtException

      Moves the scroll bar upward, or to the left, by one line.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### previousPage

          void previousPage(int numberOfPages)
                     throws GeneralLeanFtException

      Moves the scroll bar upward, or to the left, the specified number of pages.
      Parameters:
        `numberOfPages` - the number of pages to move the scroll bar.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### previousPage

          void previousPage()
                     throws GeneralLeanFtException

      Moves the scroll bar upward, or to the left, by one page.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.