Share this page

com.hp.lft.sdk.sap.gui

## 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.sap.gui.ElementDescription
        - - com.hp.lft.sdk.sap.gui.StatusBarDescription

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

      public class StatusBarDescription
      extends ElementDescription

  Description of a SAP GUI for Windows status bar.

- - ### 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>>` Helper class for StatusBarDescription.Builder.

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

    Modifier | Constructor and Description
    --- | ---
    `` | `StatusBarDescription()` Initializes a new instance of the StatusBarDescription class.
    `protected` | `StatusBarDescription(StatusBarDescription.Init<?> init)` Initializes a new instance of the StatusBarDescription class using the Builder pattern.

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String[]` | `getItems()` Returns the list of non-empty items in the status bar.
    `java.lang.Integer` | `getItemsCount()` Returns the number of non-empty items contained in the status bar.
    `StringProperty` | `getMessageId()` Returns the ID of the message in text format.
    `StringProperty` | `getMessageNumber()` Returns the internal number of the message on the status bar.
    `StatusBarMessageType` | `getMessageType()` Returns the type of message.
    `StringProperty` | `getText()` Returns the text associated with the status bar.
    `java.lang.Boolean` | `isMessageAsPopup()` Indicates whether the message is a pop-up.
    `void` | `setItems(java.lang.String[] items)` Sets the list of non-empty items in the status bar.
    `void` | `setItemsCount(java.lang.Integer number)` Sets the number of non-empty items contained in the status bar.
    `void` | `setMessageAsPopup(java.lang.Boolean popup)` Sets whether the message is a pop-up.
    `void` | `setMessageId(java.lang.String messageId)` Sets the ID of the message in text format.
    `void` | `setMessageId(StringProperty messageId)` Sets the ID of the message in text format.
    `void` | `setMessageNumber(java.lang.String messageNumber)` Sets the internal number of the message on the status bar.
    `void` | `setMessageNumber(StringProperty messageNumber)` Sets the internal number of the message on the status bar.
    `void` | `setMessageType(StatusBarMessageType type)` Sets the type of message.
    `void` | `setText(java.lang.String text)` Sets the text associated with the status bar.
    `void` | `setText(StringProperty text)` Sets the text associated with the status bar.

    - ### Methods inherited from class com.hp.lft.sdk.sap.gui.ElementDescription

      `getAbsoluteLocation, getId, getLocation, getName, getSize, getType, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setId, setId, setLocation, setLocation, setLocation, setName, setName, setSize, setSize, setSize, setType`

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

      Initializes a new instance of the StatusBarDescription class.

    - #### StatusBarDescription

          protected StatusBarDescription(StatusBarDescription.Init<?> init)

      Initializes a new instance of the StatusBarDescription class using the Builder pattern.
      Parameters:
        `init` - the Builder pattern.

  - ### Method Detail

    - #### setText

          public void setText(StringProperty text)

      Sets the text associated with the status bar.
      Parameters:
        `text` - a `StringProperty` or `RegExpProperty`.

    - #### setText

          public void setText(java.lang.String text)

      Sets the text associated with the status bar.
      Parameters:
        `text` - the text.

    - #### getText

          public StringProperty getText()

      Returns the text associated with the status bar.
      Returns:
        the text.

    - #### setItemsCount

          public void setItemsCount(java.lang.Integer number)

      Sets the number of non-empty items contained in the status bar.
      Parameters:
        `number` - the number of non-empty items.

    - #### getItemsCount

          public java.lang.Integer getItemsCount()

      Returns the number of non-empty items contained in the status bar.
      Returns:
        the number of non-empty items.

    - #### setItems

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

      Sets the list of non-empty items in the status bar.
      Parameters:
        `items` - the list of non-empty items.

    - #### getItems

          public java.lang.String[] getItems()

      Returns the list of non-empty items in the status bar.
      Returns:
        the list of non-empty items.

    - #### setMessageAsPopup

          public void setMessageAsPopup(java.lang.Boolean popup)

      Sets whether the message is a pop-up.
      Parameters:
        `popup` - true to set as pop-up.

    - #### isMessageAsPopup

          public java.lang.Boolean isMessageAsPopup()

      Indicates whether the message is a pop-up.
      Returns:
        true if pop-up.

    - #### setMessageId

          public void setMessageId(StringProperty messageId)

      Sets the ID of the message in text format.
      Parameters:
        `messageId` - a `StringProperty` or `RegExpProperty`.

    - #### setMessageId

          public void setMessageId(java.lang.String messageId)

      Sets the ID of the message in text format.
      Parameters:
        `messageId` - the ID of the message.

    - #### getMessageId

          public StringProperty getMessageId()

      Returns the ID of the message in text format.
      Returns:
        the ID of the message.

    - #### setMessageNumber

          public void setMessageNumber(StringProperty messageNumber)

      Sets the internal number of the message on the status bar.
      Parameters:
        `messageNumber` - a `StringProperty` or `RegExpProperty`.

    - #### setMessageNumber

          public void setMessageNumber(java.lang.String messageNumber)

      Sets the internal number of the message on the status bar.
      Parameters:
        `messageNumber` - the internal number.

    - #### getMessageNumber

          public StringProperty getMessageNumber()

      Returns the internal number of the message on the status bar.
      Returns:
        the internal number.

    - #### setMessageType

          public void setMessageType(StatusBarMessageType type)

      Sets the type of message.
      Parameters:
        `type` - the type.

    - #### getMessageType

          public StatusBarMessageType getMessageType()

      Returns the type of message.
      Returns:
        the type.

Tips to improve your search results... UFT Developer Java SDK Reference Version 15.0-15.0.2 UFT Developer SDK Reference All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic Version: