Open topic with navigation

com.hp.lft.sdk.te

## Class WindowDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.te.WindowDescription

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

      public class WindowDescription
      extends DescriptionBase

  The description of a terminal emulator window that fully supports HLLAPI.

- - ### Nested Class Summary

    Modifier and Type | Class and Description
    --- | ---
    `static class` | `WindowDescription.Builder` This class can be used to construct an instance of the WindowDescription class using the builder pattern.
    `protected static class` | `WindowDescription.Init<T extends WindowDescription.Init<T>>` Helper class for WindowDescription.Builder.

  - ### Field Summary

    - ### Fields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `properties`

  - ### Constructor Summary

    Modifier | Constructor and Description
    --- | ---
    `` | `WindowDescription()` Constructs a new WindowDescription.
    `protected` | `WindowDescription(WindowDescription.Init<?> init)` Initializes a new instance of the WindowDescription class using the Builder pattern.

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `EmulatorStatus` | `getEmulatorStatus()` Returns the current emulator status.
    `java.lang.Integer` | `getHandle()` Sets the handle to a window.
    `Protocol` | `getProtocol()` Returns the current protocol.
    `StringProperty` | `getShortName()` Sets the short name of the window.
    `void` | `setEmulatorStatus(EmulatorStatus emulatorStatus)` Sets the current emulator status.
    `void` | `setHandle(java.lang.Integer handle)` Sets the handle to a window.
    `void` | `setProtocol(Protocol protocol)` Sets the current protocol.
    `void` | `setShortName(java.lang.String shortName)` Sets the short name of the window.
    `void` | `setShortName(StringProperty shortName)` Sets the short name of the window.

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

      `cloneTo, getIndex, getIndexType, getVRI, setIndex, setIndexType, setVRI, setVRI`

    - ### Methods inherited from class com.hp.lft.sdk.PropertiesDescription

      `clone`

    - ### Methods inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `getValueAs, getValueAsStringProperty, insertValue`

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

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

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

      `clone`

- - ### Constructor Detail

    - #### WindowDescription

          public WindowDescription()

      Constructs a new WindowDescription.

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

    - #### setShortName

          public void setShortName(StringProperty shortName)

      Sets the short name of the window.
      Parameters:
        `shortName` - a StringProperty(or RegExpProperty) representing the short name of the window.

    - #### setShortName

          public void setShortName(java.lang.String shortName)

      Sets the short name of the window.
      Parameters:
        `shortName` - the short name of the window.

    - #### getShortName

          public StringProperty getShortName()

      Sets the short name of the window.
      Returns:
        the short name of the window.

    - #### setHandle

          public void setHandle(java.lang.Integer handle)

      Sets the handle to a window.
      Parameters:
        `handle` - the handle to a window.

    - #### getHandle

          public java.lang.Integer getHandle()

      Sets the handle to a window.
      Returns:
        the handle to a window.

    - #### setProtocol

          public void setProtocol(Protocol protocol)

      Sets the current protocol.
      Parameters:
        `protocol` - the current protocol.

    - #### getProtocol

          public Protocol getProtocol()

      Returns the current protocol.
      Returns:
        the current protocol.

    - #### setEmulatorStatus

          public void setEmulatorStatus(EmulatorStatus emulatorStatus)

      Sets the current emulator status.
      Parameters:
        `emulatorStatus` - the current emulator status.

    - #### getEmulatorStatus

          public EmulatorStatus getEmulatorStatus()

      Returns the current emulator status.
      Returns:
        the current emulator status.