Open topic with navigation

com.hp.lft.sdk.sap.gui

## Class WindowDescription.Init<T extends WindowDescription.Init<T>>

- java.lang.Object
- - com.hp.lft.sdk.DescriptionBase.Init<T>
  - - com.hp.lft.sdk.sap.gui.ElementDescription.Init<T>
    - - com.hp.lft.sdk.sap.gui.WindowDescription.Init<T>

- Direct Known Subclasses:
    WindowDescription.Builder
  Enclosing class:
    WindowDescription

      protected abstract static class WindowDescription.Init<T extends WindowDescription.Init<T>>
      extends ElementDescription.Init<T>

  Helper class for WindowDescription.Builder.

- - ### Constructor Summary

    Modifier | Constructor and Description
    --- | ---
    `protected` | `Init()`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `WindowDescription` | `build()` Returns the built description instance (builder pattern).
    `T` | `minimized(java.lang.Boolean minimized)` Initializes whether the window is minimized.
    `T` | `program(java.lang.String program)` Initializes the name of the SAP source program that is currently executing.
    `T` | `program(StringProperty program)` Initializes the name of the SAP source program that is currently executing.
    `T` | `screenNumber(java.lang.Long screenNumber)` Initializes the number of the currently displayed screen.
    `T` | `text(java.lang.String text)` Initializes the text associated with the window.
    `T` | `text(StringProperty text)` Initializes the text associated with the window.
    `T` | `transaction(java.lang.String transaction)` Initializes the transaction the user is currently executing.
    `T` | `transaction(StringProperty transaction)` Initializes the transaction the user is currently executing.
    `T` | `workingPaneSize(java.awt.Dimension workingPaneSize)` Initializes the window's working pane size in character metric.
    `T` | `workingPaneSize(java.lang.Integer width, java.lang.Integer height)` Initializes the window's working pane size in character metric.
    `T` | `workingPaneSize(SizeProperty workingPaneSize)` Initializes the window's working pane size in character metric.

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

      `absoluteLocation, absoluteLocation, absoluteLocation, id, id, location, location, location, name, name, size, size, size, type`

    - ### Methods inherited from class com.hp.lft.sdk.DescriptionBase.Init

      `index, self, vri, vri`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### Init

          protected Init()

  - ### Method Detail

    - #### build

          public WindowDescription build()

      Description copied from class: `DescriptionBase.Init`
      Returns the built description instance (builder pattern).
      Overrides:
        `build` in class `ElementDescription.Init<T extends WindowDescription.Init<T>>`
      Returns:
        The built description instance (builder pattern).

    - #### text

          public T text(StringProperty text)

      Initializes the text associated with the window.
      Parameters:
        `text` - the text.
      Returns:
        the description instance with the update state (builder pattern).

    - #### text

          public T text(java.lang.String text)

      Initializes the text associated with the window.
      Parameters:
        `text` - the text.
      Returns:
        the description instance with the update state (builder pattern).

    - #### workingPaneSize

          public T workingPaneSize(SizeProperty workingPaneSize)

      Initializes the window's working pane size in character metric. The working pane is the area between the toolbar and the status bar.
      Parameters:
        `workingPaneSize` - the working pane size.
      Returns:
        the description instance with the update state (builder pattern).

    - #### workingPaneSize

          public T workingPaneSize(java.lang.Integer width,
                                   java.lang.Integer height)

      Initializes 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.
      Returns:
        the description instance with the update state (builder pattern).

    - #### workingPaneSize

          public T workingPaneSize(java.awt.Dimension workingPaneSize)

      Initializes the window's working pane size in character metric. The working pane is the area between the toolbar and the status bar.
      Parameters:
        `workingPaneSize` - in character metric.
      Returns:
        the description instance with the update state (builder pattern).

    - #### minimized

          public T minimized(java.lang.Boolean minimized)

      Initializes whether the window is minimized.
      Parameters:
        `minimized` - true if minimized.
      Returns:
        the description instance with the update state (builder pattern).

    - #### transaction

          public T transaction(StringProperty transaction)

      Initializes the transaction the user is currently executing.
      Parameters:
        `transaction` - the transaction name.
      Returns:
        the description instance with the update state (builder pattern).

    - #### transaction

          public T transaction(java.lang.String transaction)

      Initializes the transaction the user is currently executing.
      Parameters:
        `transaction` - the transaction name.
      Returns:
        the description instance with the update state (builder pattern).

    - #### screenNumber

          public T screenNumber(java.lang.Long screenNumber)

      Initializes the number of the currently displayed screen.
      Parameters:
        `screenNumber` - the screen number.
      Returns:
        the description instance with the update state (builder pattern).

    - #### program

          public T program(StringProperty program)

      Initializes the name of the SAP source program that is currently executing.
      Parameters:
        `program` - the program name.
      Returns:
        the description instance with the update state (builder pattern).

    - #### program

          public T program(java.lang.String program)

      Initializes the name of the SAP source program that is currently executing.
      Parameters:
        `program` - the program name.
      Returns:
        the description instance with the update state (builder pattern).