Open topic with navigation

com.hp.lft.sdk.sap.gui

## Interface StatusBar

- All Superinterfaces:
    Element, LocationInfoProvider, SupportsNativeObject, TestObject, TestObjectDescriber

      public interface StatusBar
      extends Element

  A status bar in a SAP GUI for Windows application.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<java.lang.String>` | `getItems()` Returns the list of non-empty items in the status bar.
    `java.lang.String` | `getMessageId()` Returns the ID of the message in text format.
    `java.lang.String` | `getMessageNumber()` Returns the internal number of the message on the status bar.
    `StatusBarMessageType` | `getMessageType()` Returns the type of message.
    `java.lang.String` | `getText()` Returns the text associated with the status bar.
    `boolean` | `isMessageAsPopup()` Indicates whether the message is a pop-up.

    - ### Methods inherited from interface com.hp.lft.sdk.sap.gui.Element

      `getId, getName, getType`

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

      `getAbsoluteLocation, getLocation, getSize`

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

      `getNativeObject`

- - ### Method Detail

    - #### getItems

          java.util.List<java.lang.String> getItems()
                                             throws GeneralLeanFtException

      Returns the list of non-empty items in the status bar.
      Returns:
        the list of non-empty items.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isMessageAsPopup

          boolean isMessageAsPopup()
                            throws GeneralLeanFtException

      Indicates whether the message is a pop-up.
      Returns:
        true if a pop-up.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getMessageId

          java.lang.String getMessageId()
                                 throws GeneralLeanFtException

      Returns the ID of the message in text format.
      Returns:
        the ID.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getMessageNumber

          java.lang.String getMessageNumber()
                                     throws GeneralLeanFtException

      Returns the internal number of the message on the status bar.
      Returns:
        the internal number of the message.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getMessageType

                                                      StatusBarMessageType getMessageType()
                                       throws GeneralLeanFtException

      Returns the type of message.
      Returns:
        the type of message.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getText

          java.lang.String getText()
                            throws GeneralLeanFtException

      Returns the text associated with the status bar.
      Returns:
        the text.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.