Open topic with navigation

com.hp.lft.sdk.winforms

## Class StatusBarDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.winforms.UiObjectDescriptionBase
        - - com.hp.lft.sdk.winforms.StatusBarDescription

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

      public class StatusBarDescription
      extends UiObjectDescriptionBase

  The description of a .NET Windows Forms StatusBar test object.

- - ### Nested Class Summary

    Modifier and Type | Class and Description
    --- | ---
    `static class` | `StatusBarDescription.Builder` This class can be used to construct an instance of the StatusBarDescription class using the builder pattern.
    `protected static class` | `StatusBarDescription.Init<T extends StatusBarDescription.Init<T>>`

  - ### Field Summary

    - ### Fields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `properties`

  - ### Constructor Summary

    Modifier | Constructor and Description
    --- | ---
    `` | `StatusBarDescription()` Constructs a new StatusBarDescription.
    `protected` | `StatusBarDescription(StatusBarDescription.Init<?> init)`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `getAttachedText()` Returns the static text that is attached to this object.
    `java.lang.String[]` | `getItems()` Returns the items in the status bar.
    `java.lang.Integer` | `getItemsCount()` Returns the number of items in the status bar.
    `java.util.EnumSet<WindowExtendedStyles>` | `getWindowExtendedStyle()` Returns the extended window style of the object.
    `java.lang.Long` | `getWindowExtendedStyleAsLong()` Returns the extended window style of the object as long.
    `java.util.EnumSet<WindowStyles>` | `getWindowStyle()` Returns the window style of the object.
    `java.lang.Long` | `getWindowStyleAsLong()` Returns the window style of the object as long.
    `java.lang.Boolean` | `isRightAligned()` Indicates whether the object has generic right-aligned properties.
    `java.lang.Boolean` | `isRightToLeftLayout()` Indicates whether the object's horizontal origin is on the right edge.
    `java.lang.Boolean` | `isRightToLeftReading()` Indicates whether the object's text is displayed using right-to-left reading-order properties.
    `void` | `setAttachedText(java.lang.String attachedText)` Sets the static text that is attached to the object.
    `void` | `setAttachedText(StringProperty attachedText)` Sets the static text that is attached to the object.
    `void` | `setItems(java.lang.String[] items)` Sets the items in the status bar.
    `void` | `setItemsCount(java.lang.Integer count)` Sets the number of items in the status bar.
    `void` | `setRightAligned(java.lang.Boolean rightAligned)` Sets whether the generic right-aligned properties state of test object.
    `void` | `setRightToLeftLayout(java.lang.Boolean rightToLeftLayout)` Sets whether the object's horizontal origin is on the right edge state of test object.
    `void` | `setRightToLeftReading(java.lang.Boolean rightToLeftReading)` Sets whether the object's text is displayed using right-to-left reading-order properties state of test object.
    `void` | `setWindowExtendedStyle(java.util.EnumSet<WindowExtendedStyles> windowExtendedStyle)` Sets the extended window style of the object.
    `void` | `setWindowExtendedStyle(java.lang.Long windowExtendedStyle)` Sets the extended window style of the object as long.
    `void` | `setWindowStyle(java.util.EnumSet<WindowStyles> windowStyle)` Sets window style of the object.
    `void` | `setWindowStyle(java.lang.Long windowStyle)` Sets window style of the object as long.

    - ### Methods inherited from class com.hp.lft.sdk.winforms.UiObjectDescriptionBase

      `getAbsoluteLocation, getFullNamePath, getFullType, getLocation, getNativeClass, getObjectName, getObjectProperties, getSize, getText, getWindowClassRegExp, getWindowId, getWindowTitleRegExp, isChildWindow, isEnabled, isFocused, isOwnedWindow, isVisible, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setChildWindow, setEnabled, setFocused, setFullNamePath, setFullNamePath, setFullType, setFullType, setLocation, setLocation, setLocation, setNativeClass, setNativeClass, setObjectName, setObjectName, setObjectProperties, setOwnedWindow, setSize, setSize, setSize, setText, setText, setVisible, setWindowClassRegExp, setWindowClassRegExp, setWindowId, setWindowTitleRegExp, setWindowTitleRegExp`

    - ### Methods inherited from class com.hp.lft.sdk.DescriptionBase

      `cloneTo, getIndex, getIndexType, getVRI, setIndex, setIndexType, setVRI, setVRI`

    - ### Methods inherited from class com.hp.lft.sdk.PropertiesDescription

      `clone`

    - ### Methods inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `getValueAs, getValueAsStringProperty, insertValue`

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

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

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

      `clone`

- - ### Constructor Detail

    - #### StatusBarDescription

          public StatusBarDescription()

      Constructs a new StatusBarDescription.

    - #### StatusBarDescription

          protected StatusBarDescription(StatusBarDescription.Init<?> init)

  - ### Method Detail

    - #### setItems

          public void setItems(java.lang.String[] items)

      Sets the items in the status bar.
      Parameters:
        `items` - the items

    - #### getItems

          public java.lang.String[] getItems()

      Returns the items in the status bar.
      Returns:
        the items

    - #### setItemsCount

          public void setItemsCount(java.lang.Integer count)

      Sets the number of items in the status bar.
      Parameters:
        `count` - the item count

    - #### getItemsCount

          public java.lang.Integer getItemsCount()

      Returns the number of items in the status bar.
      Returns:
        the item count

    - #### setRightAligned

          public void setRightAligned(java.lang.Boolean rightAligned)

      Sets whether the generic right-aligned properties state of test object.
      Parameters:
        `rightAligned` - the generic right-aligned properties state of test object.

    - #### isRightAligned

          public java.lang.Boolean isRightAligned()

      Indicates whether the object has generic right-aligned properties.
      Returns:
        true, if the current object has generic right-aligned properties.

    - #### setRightToLeftLayout

          public void setRightToLeftLayout(java.lang.Boolean rightToLeftLayout)

      Sets whether the object's horizontal origin is on the right edge state of test object.
      Parameters:
        `rightToLeftLayout` - the object's horizontal origin is on the right edge.

    - #### isRightToLeftLayout

          public java.lang.Boolean isRightToLeftLayout()

      Indicates whether the object's horizontal origin is on the right edge.
      Returns:
        true, if the object's horizontal origin is on the right edge.

    - #### setRightToLeftReading

          public void setRightToLeftReading(java.lang.Boolean rightToLeftReading)

      Sets whether the object's text is displayed using right-to-left reading-order properties state of test object.
      Parameters:
        `rightToLeftReading` - the object's text is displayed using right-to-left reading-order properties state of test object.

    - #### isRightToLeftReading

          public java.lang.Boolean isRightToLeftReading()

      Indicates whether the object's text is displayed using right-to-left reading-order properties.
      Returns:
        true, if the object's text is displayed using right-to-left reading-order properties.

    - #### setAttachedText

          public void setAttachedText(java.lang.String attachedText)

      Sets the static text that is attached to the object.
      Parameters:
        `attachedText` - the the static text that is attached to this object.

    - #### setAttachedText

          public void setAttachedText(StringProperty attachedText)

      Sets the static text that is attached to the object.
      Parameters:
        `attachedText` - a `StringProperty` or `RegExpProperty`

    - #### getAttachedText

          public StringProperty getAttachedText()

      Returns the static text that is attached to this object.
      Returns:
        the static text that is attached to this object.

    - #### getWindowExtendedStyle

          public java.util.EnumSet<WindowExtendedStyles> getWindowExtendedStyle()

      Returns the extended window style of the object.
      Returns:
        the extended window style of the object.

    - #### setWindowExtendedStyle

          public void setWindowExtendedStyle(java.util.EnumSet<WindowExtendedStyles> windowExtendedStyle)

      Sets the extended window style of the object.
      Parameters:
        `windowExtendedStyle` - the extended window style of the object.

    - #### getWindowExtendedStyleAsLong

          public java.lang.Long getWindowExtendedStyleAsLong()

      Returns the extended window style of the object as long.
      Returns:
        the extended window style of the object as long.

    - #### setWindowExtendedStyle

          public void setWindowExtendedStyle(java.lang.Long windowExtendedStyle)

      Sets the extended window style of the object as long.
      Parameters:
        `windowExtendedStyle` - the extended window style of the object as long.

    - #### getWindowStyle

          public java.util.EnumSet<WindowStyles> getWindowStyle()

      Returns the window style of the object.
      Returns:
        the window style of the object.

    - #### setWindowStyle

          public void setWindowStyle(java.util.EnumSet<WindowStyles> windowStyle)

      Sets window style of the object.
      Parameters:
        `windowStyle` - window style of the object.

    - #### getWindowStyleAsLong

          public java.lang.Long getWindowStyleAsLong()

      Returns the window style of the object as long.
      Returns:
        the window style of the object as long.

    - #### setWindowStyle

          public void setWindowStyle(java.lang.Long windowStyle)

      Sets window style of the object as long.
      Parameters:
        `windowStyle` - window style of the object as long.