Package 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, Cloneable
public class StatusBarDescription extends ElementDescription
Description of a SAP GUI for Windows status bar.

  • Constructor Details

    • 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 Details

    • setText

      public void setText(StringProperty text)
      Sets the text associated with the status bar.
      Parameters:
      text - a StringProperty or RegExpProperty.

    • setText

      public void setText(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(Integer number)
      Sets the number of non-empty items contained in the status bar.
      Parameters:
      number - the number of non-empty items.

    • getItemsCount

      public 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(String[] items)
      Sets the list of non-empty items in the status bar.
      Parameters:
      items - the list of non-empty items.

    • getItems

      public String[] getItems()
      Returns the list of non-empty items in the status bar.
      Returns:
      the list of non-empty items.

    • setMessageAsPopup

      public void setMessageAsPopup(Boolean popup)
      Sets whether the message is a pop-up.
      Parameters:
      popup - true to set as pop-up.

    • isMessageAsPopup

      public 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(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(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.