Open topic with navigation

com.hp.lft.sdk.te

## Class ScreenDescription

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

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

      public class ScreenDescription
      extends DescriptionBase

  A terminal emulator screen that fully supports HLLAPI.

- - ### Nested Class Summary

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `PositionProperty` | `getCursorPosition()` Returns the position of the cursor in the emulator screen.
    `java.lang.Integer` | `getId()` Returns the value id of the screen.
    `java.lang.Integer` | `getInputFieldCount()` Returns the number of input fields on the emulator screen.
    `StringProperty` | `getLabel()` Returns the label of the Terminal Emulator screen.
    `java.lang.Integer` | `getProtectedFieldCount()` Returns the number of protected fields on the emulator screen.
    `SizeProperty` | `getSize()` Returns the total number of rows and columns in the emulator screen.
    `void` | `setCursorPosition(java.lang.Integer row, java.lang.Integer column)` Sets the position of the cursor in the emulator screen.
    `void` | `setCursorPosition(Position position)` Sets the position of the cursor in the emulator screen.
    `void` | `setCursorPosition(PositionProperty position)` Sets the position of the cursor in the emulator screen.
    `void` | `setId(java.lang.Integer id)` Sets the value id of the screen.
    `void` | `setInputFieldCount(java.lang.Integer handle)` Sets the number of input fields on the emulator screen.
    `void` | `setLabel(java.lang.String label)` Sets the label of the Terminal Emulator screen.
    `void` | `setLabel(StringProperty label)` Sets the label of the Terminal Emulator screen.
    `void` | `setProtectedFieldCount(java.lang.Integer protectedFieldCount)` Sets the number of protected fields on the emulator screen.
    `void` | `setSize(java.lang.Integer row, java.lang.Integer column)` Sets the total number of rows and columns in the emulator screen.
    `void` | `setSize(Size size)` Sets the total number of rows and columns in the emulator screen.
    `void` | `setSize(SizeProperty size)` Sets the total number of rows and columns in the emulator screen.

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

    - #### ScreenDescription

          public ScreenDescription()

      Constructs a new ScreenDescription.

    - #### ScreenDescription

          protected ScreenDescription(ScreenDescription.Init<?> init)

      Initializes a new instance of the ScreenDescription class using the Builder pattern.
      Parameters:
        `init` - the Builder pattern.

  - ### Method Detail

    - #### setSize

          public void setSize(SizeProperty size)

      Sets the total number of rows and columns in the emulator screen.
      Parameters:
        `size` - the size

    - #### setSize

          public void setSize(Size size)

      Sets the total number of rows and columns in the emulator screen.
      Parameters:
        `size` - the size

    - #### setSize

          public void setSize(java.lang.Integer row,
                              java.lang.Integer column)

      Sets the total number of rows and columns in the emulator screen.
      Parameters:
        `row` - in pixels
        `column` - in pixels

    - #### getSize

          public SizeProperty getSize()

      Returns the total number of rows and columns in the emulator screen.
      Returns:
        the size

    - #### setCursorPosition

          public void setCursorPosition(PositionProperty position)

      Sets the position of the cursor in the emulator screen.
      Parameters:
        `position` - the position

    - #### setCursorPosition

          public void setCursorPosition(Position position)

      Sets the position of the cursor in the emulator screen.
      Parameters:
        `position` - the position

    - #### setCursorPosition

          public void setCursorPosition(java.lang.Integer row,
                                        java.lang.Integer column)

      Sets the position of the cursor in the emulator screen.
      Parameters:
        `row` - in pixels
        `column` - in pixels

    - #### getCursorPosition

          public PositionProperty getCursorPosition()

      Returns the position of the cursor in the emulator screen.
      Returns:
        the position

    - #### setLabel

          public void setLabel(StringProperty label)

      Sets the label of the Terminal Emulator screen.
      Parameters:
        `label` - a StringProperty(or RegExpProperty) representing the short name of the Terminal Emulator screen.

    - #### setLabel

          public void setLabel(java.lang.String label)

      Sets the label of the Terminal Emulator screen.
      Parameters:
        `label` - the label of the Terminal Emulator screen.

    - #### getLabel

          public StringProperty getLabel()

      Returns the label of the Terminal Emulator screen.
      Returns:
        the label of the Terminal Emulator screen.

    - #### setInputFieldCount

          public void setInputFieldCount(java.lang.Integer handle)

      Sets the number of input fields on the emulator screen.
      Parameters:
        `handle` - the number of input fields on the emulator screen.

    - #### getInputFieldCount

          public java.lang.Integer getInputFieldCount()

      Returns the number of input fields on the emulator screen.
      Returns:
        the number of input fields on the emulator screen.

    - #### setId

          public void setId(java.lang.Integer id)

      Sets the value id of the screen.
      Parameters:
        `id` - the value id of the screen.

    - #### getId

          public java.lang.Integer getId()

      Returns the value id of the screen.
      Returns:
        the value id of the screen.

    - #### setProtectedFieldCount

          public void setProtectedFieldCount(java.lang.Integer protectedFieldCount)

      Sets the number of protected fields on the emulator screen.
      Parameters:
        `protectedFieldCount` - the number of protected fields on the emulator screen.

    - #### getProtectedFieldCount

          public java.lang.Integer getProtectedFieldCount()

      Returns the number of protected fields on the emulator screen.
      Returns:
        the number of protected fields on the emulator screen.