com.hp.lft.sdk.sap.gui

Class LabelDescription

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


    public class LabelDescription
    extends ElementDescription
    Description of a SAP GUI for Windows label.
    • Constructor Detail

      • LabelDescription

        public LabelDescription()
        Initializes a new instance of the LabelDescription class.
      • LabelDescription

        protected LabelDescription(LabelDescription.Init<?> init)
        Initializes a new instance of the LabelDescription class using the Builder pattern.
        Parameters:
        init - the Builder pattern.
    • Method Detail

      • setText

        public void setText(java.lang.String text)
        Sets the the text of the label.
        Parameters:
        text - the text.
      • getText

        public StringProperty getText()
        Returns the text of the label.
        Returns:
        the text.
      • setHighlighted

        public void setHighlighted(java.lang.Boolean isHighlighted)
        Sets whether the label is highlighted.
        Parameters:
        isHighlighted - true to set highlighted.
      • isHighlighted

        public java.lang.Boolean isHighlighted()
        Indicates whether the label is highlighted.
        Returns:
        true if highlighted.
      • setIconName

        public void setIconName(java.lang.String iconName)
        Sets the name of the icon used in the label.
        Parameters:
        iconName - name of the icon.
      • getIconName

        public StringProperty getIconName()
        Returns the name of the icon used within the label.
        Returns:
        the name of the icon.
      • setMaxLength

        public void setMaxLength(java.lang.Integer maxLength)
        Sets the maximum number of characters that can be displayed in the label.
        Parameters:
        maxLength - the maximum number of characters.
      • getMaxLength

        public java.lang.Integer getMaxLength()
        Returns the maximum number of characters that can be displayed in the label.
        Returns:
        the maximum number of characters.
      • setNumerical

        public void setNumerical(java.lang.Boolean isNumerical)
        Sets whether the label is a numerical field.
        Parameters:
        isNumerical - true to set as numerical field.
      • isNumerical

        public java.lang.Boolean isNumerical()
        Indicates whether the label is a numerical field.
        Returns:
        true if numerical field.
      • setRelativeId

        public void setRelativeId(StringProperty relativeId)
        Sets the object's unique identifier relative to the parent window ID in text format.
        Parameters:
        relativeId - a StringProperty or RegExpProperty.
      • setRelativeId

        public void setRelativeId(java.lang.String relativeId)
        Sets the object's unique identifier relative to the parent window ID.
        Parameters:
        relativeId - the UID in text format.
      • getRelativeId

        public StringProperty getRelativeId()
        Returns the object's unique identifier relative to the parent window ID in text format.
        Returns:
        the UID in text format.