Open topic with navigation

com.hp.lft.sdk

## Class ScrollProperty

- java.lang.Object
- - com.hp.lft.sdk.ScrollProperty

- All Implemented Interfaces:
    CloneableObject, com.hp.lft.sdk.internal.GroupedProperty, java.lang.Cloneable

      public class ScrollProperty
      extends java.lang.Object
      implements com.hp.lft.sdk.internal.GroupedProperty, CloneableObject

  The class used for scrollbar properties.

- - ### Constructor Summary

    Constructor and Description
    `ScrollProperty()` Initializes a new instance of the ScrollProperty class.
    `ScrollProperty(ScrollInfo scrollInfo)` Initializes a new instance of the ScrollProperty class with the provided scrollInfo.
    `ScrollProperty(ScrollProperty scrollPropertyToCopy)` Initializes a new instance of the ScrollProperty class provided copy of a ScrollProperty object.

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.Object` | `clone()` Returns a clone of this instance.
    `java.lang.Integer` | `getMaximum()` Returns the maximum position (in lines) of the scroll bar.
    `java.lang.Integer` | `getMinimum()` Returns the minimum position (in lines) of the scroll bar.
    `java.lang.Integer` | `getPageSize()` Returns the size (in lines) of a single page of the scroll bar.
    `java.lang.Integer` | `getPosition()` Returns the current position (in lines) of the scroll bar.
    `java.util.Map<java.lang.String,java.lang.Object>` | `getProperties()`
    `java.lang.Boolean` | `isExists()` Indicates whether the scroll bar exists.
    `ScrollProperty` | `setExists(java.lang.Boolean exists)` Sets whether the scroll bar exists.
    `ScrollProperty` | `setMaximum(java.lang.Integer maximum)` Sets the maximum position (in lines) of the scroll bar.
    `ScrollProperty` | `setMinimum(java.lang.Integer minimum)` Sets the minimum position (in lines) of the scroll bar.
    `ScrollProperty` | `setPageSize(java.lang.Integer pageSize)` Sets the size (in lines) of a single page of the scroll bar.
    `ScrollProperty` | `setPosition(java.lang.Integer position)` Sets the current position (in lines) of the scroll bar.

    - ### Methods inherited from class java.lang.Object

      `equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### ScrollProperty

          public ScrollProperty()

      Initializes a new instance of the ScrollProperty class.

    - #### ScrollProperty

          public ScrollProperty(ScrollInfo scrollInfo)

      Initializes a new instance of the ScrollProperty class with the provided scrollInfo.
      Parameters:
        `scrollInfo` - the properties of the scroll bar instance.

    - #### ScrollProperty

          public ScrollProperty(ScrollProperty scrollPropertyToCopy)

      Initializes a new instance of the ScrollProperty class provided copy of a ScrollProperty object.
      Parameters:
        `scrollPropertyToCopy` - the ScrollProperty object to use for the initialization of the new instance.

  - ### Method Detail

    - #### clone

          public java.lang.Object clone()
                                 throws java.lang.CloneNotSupportedException

      Description copied from interface: `CloneableObject`
      Returns a clone of this instance.
      Specified by:
        `clone` in interface `CloneableObject`
      Overrides:
        `clone` in class `java.lang.Object`
      Returns:
        a clone of this instance.
      Throws:
        `java.lang.CloneNotSupportedException` - if the instance cannot be cloned.

    - #### isExists

          public java.lang.Boolean isExists()

      Indicates whether the scroll bar exists.
      Returns:
        true, if the scroll bar exists.

    - #### setExists

          public ScrollProperty setExists(java.lang.Boolean exists)

      Sets whether the scroll bar exists.
      Parameters:
        `exists` - indicates whether the scroll bar exists.
      Returns:
        the ScrollProperty instance with the updated state (builder pattern).

    - #### getPageSize

          public java.lang.Integer getPageSize()

      Returns the size (in lines) of a single page of the scroll bar.
      Returns:
        the pageSize

    - #### setPageSize

          public ScrollProperty setPageSize(java.lang.Integer pageSize)

      Sets the size (in lines) of a single page of the scroll bar.
      Parameters:
        `pageSize` - the size (in lines) of a single page of the scroll bar.
      Returns:
        the ScrollProperty instance with the updated state (builder pattern).

    - #### getPosition

          public java.lang.Integer getPosition()

      Returns the current position (in lines) of the scroll bar.
      Returns:
        position the current position (in lines) of the scroll bar.

    - #### setPosition

          public ScrollProperty setPosition(java.lang.Integer position)

      Sets the current position (in lines) of the scroll bar.
      Parameters:
        `position` - the position (in lines) to set.
      Returns:
        the ScrollProperty instance with the updated state (builder pattern).

    - #### getMaximum

          public java.lang.Integer getMaximum()

      Returns the maximum position (in lines) of the scroll bar.
      Returns:
        the maximum position (in lines) of the scroll bar.

    - #### setMaximum

          public ScrollProperty setMaximum(java.lang.Integer maximum)

      Sets the maximum position (in lines) of the scroll bar.
      Parameters:
        `maximum` - position (in lines) of the scroll bar.
      Returns:
        the ScrollProperty instance with the updated state (builder pattern).

    - #### getMinimum

          public java.lang.Integer getMinimum()

      Returns the minimum position (in lines) of the scroll bar.
      Returns:
        minimum position (in lines) of the scroll bar.

    - #### setMinimum

          public ScrollProperty setMinimum(java.lang.Integer minimum)

      Sets the minimum position (in lines) of the scroll bar.
      Parameters:
        `minimum` - the minimum position (in lines) of the scroll bar.
      Returns:
        the ScrollProperty instance with the updated state (builder pattern).

    - #### getProperties

          public java.util.Map<java.lang.String,java.lang.Object> getProperties()

      Specified by:
        `getProperties` in interface `com.hp.lft.sdk.internal.GroupedProperty`