com.hp.lft.sdk.sap.gui

Class WindowDescription

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

    public class WindowDescription
extends ElementDescription
    Description of a window in a SAP GUI for Windows application.

    • Constructor Detail

      • WindowDescription

        public WindowDescription()
        Initializes a new instance of the WindowDescription class.

      • WindowDescription

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

    • Method Detail

      • setText

        public void setText(StringProperty text)
        Sets the text associated with the window.
        Parameters:
        text - the text.

      • setText

        public void setText(java.lang.String text)
        Sets the text associated with the window.
        Parameters:
        text - the text.

      • getText

        public StringProperty getText()
        Returns the text associated with the window.
        Returns:
        the text.

      • setWorkingPaneSize

        public void setWorkingPaneSize(SizeProperty size)
        Sets the window's working pane size in character metric. The working pane is the area between the toolbar and the status bar.
        Parameters:
        size - the size.

      • setWorkingPaneSize

        public void setWorkingPaneSize(java.awt.Dimension size)
        Sets the window's working pane size in character metric. The working pane is the area between the toolbar and the status bar.
        Parameters:
        size - the size.

      • setWorkingPaneSize

        public void setWorkingPaneSize(java.lang.Integer width,
                               java.lang.Integer height)
        Sets the window's working pane size in character metric. The working pane is the area between the toolbar and the status bar.
        Parameters:
        width - in character metric.
        height - in character metric.

      • getWorkingPaneSize

        public SizeProperty getWorkingPaneSize()
        Returns the window's working pane size in character metric. The working pane is the area between the toolbar and the status bar.
        Returns:
        the pane size.

      • setMinimized

        public void setMinimized(java.lang.Boolean minimized)
        Sets whether the window is minimized.
        Parameters:
        minimized - true if minimized.

      • IsMinimized

        public java.lang.Boolean IsMinimized()
        Indicates whether the window is minimized.
        Returns:
        true if minimized.

      • setTransaction

        public void setTransaction(StringProperty transaction)
        Sets the transaction the user is currently executing.
        Parameters:
        transaction - the transaction name.

      • setTransaction

        public void setTransaction(java.lang.String transaction)
        Sets the transaction the user is currently executing.
        Parameters:
        transaction - the transaction name.

      • getTransaction

        public StringProperty getTransaction()
        Returns the transaction the user is currently executing.
        Returns:
        the transaction name.

      • setScreenNumber

        public void setScreenNumber(java.lang.Long screenNumber)
        Sets the number of the currently displayed screen.
        Parameters:
        screenNumber - the screen number.

      • getScreenNumber

        public java.lang.Long getScreenNumber()
        Returns the number of the currently displayed screen.
        Returns:
        the screen number.

      • setProgram

        public void setProgram(StringProperty program)
        Sets the name of the SAP source program that is currently executing.
        Parameters:
        program - the program name.

      • setProgram

        public void setProgram(java.lang.String program)
        Sets the name of the SAP source program that is currently executing.
        Parameters:
        program - the program name.

      • getProgram

        public StringProperty getProgram()
        Returns the name of the SAP source program that is currently executing.
        Returns:
        the program name.