Package com.hp.lft.sdk.uiapro

Interface ScrollPattern

public interface ScrollPattern
The methods and properties used to interact with a container control that can be scrolled. The children of this element support ScrollItemPattern.

  • Method Details

    • canScrollHorizontally

      boolean canScrollHorizontally() throws GeneralLeanFtException
      Returns:
      Indicates whether the UIA Pro element can scroll horizontally.
      Throws:
      GeneralLeanFtException - if error occurs during execution.

    • canScrollVertically

      boolean canScrollVertically() throws GeneralLeanFtException
      Returns:
      Indicates whether the UIA Pro element can scroll vertically.
      Throws:
      GeneralLeanFtException - if error occurs during execution.

    • getVerticalViewSize

      double getVerticalViewSize() throws GeneralLeanFtException
      Returns:
      The current vertical view size.
      Throws:
      GeneralLeanFtException - if error occurs during execution.

    • getHorizontalViewSize

      double getHorizontalViewSize() throws GeneralLeanFtException
      Returns:
      The current horizontal view size.
      Throws:
      GeneralLeanFtException - if error occurs during execution.

    • setVerticalScrollPercent

      void setVerticalScrollPercent(double value) throws GeneralLeanFtException
      Set the current vertical scroll position.
      Parameters:
      value - the current vertical scroll position.
      Throws:
      GeneralLeanFtException - if error occurs during execution.

    • getVerticalScrollPercent

      double getVerticalScrollPercent() throws GeneralLeanFtException
      Returns:
      The current vertical scroll position.
      Throws:
      GeneralLeanFtException - if error occurs during execution.

    • setHorizontalScrollPercent

      void setHorizontalScrollPercent(double value) throws GeneralLeanFtException
      Set the current horizontal scroll position.
      Parameters:
      value - the current horizontal scroll position.
      Throws:
      GeneralLeanFtException - if error occurs during execution.

    • getHorizontalScrollPercent

      double getHorizontalScrollPercent() throws GeneralLeanFtException
      Returns:
      The current horizontal scroll position.
      Throws:
      GeneralLeanFtException - if error occurs during execution.

    • scroll

      void scroll(ScrollAmount horizontalAmount, ScrollAmount verticalAmount) throws GeneralLeanFtException
      Scrolls the visible region of the content area horizontally and vertically.
      Parameters:
      horizontalAmount - The horizontal increment specific to the control.
      verticalAmount - The vertical increment specific to the control.
      Throws:
      GeneralLeanFtException - if error occurs during execution.

    • scrollHorizontal

      void scrollHorizontal(ScrollAmount horizontalAmount) throws GeneralLeanFtException
      Scrolls the visible region of the content area horizontally.
      Parameters:
      horizontalAmount - The horizontal increment specific to the control.
      Throws:
      GeneralLeanFtException - if error occurs during execution.

    • scrollVertical

      void scrollVertical(ScrollAmount verticalAmount) throws GeneralLeanFtException
      Scrolls the visible region of the content area vertically.
      Parameters:
      verticalAmount - The vertical increment specific to the control.
      Throws:
      GeneralLeanFtException - if error occurs during execution.

    • setScrollPercent

      void setScrollPercent(double horizontalPercent, double verticalPercent) throws GeneralLeanFtException
      Sets the horizontal and/or vertical scroll position as a percentage of the total content area within the automation element.
      Parameters:
      horizontalPercent - The percentage of the total horizontal content area.
      verticalPercent - The percentage of the total vertical content area.
      Throws:
      GeneralLeanFtException - if error occurs during execution.