com.hp.lft.sdk.te

Class 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.

    • Field Summary

      • Fields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

        properties

    • Method Summary

      Modifier and TypeMethod and Description
      PositionPropertygetCursorPosition()
      Returns the position of the cursor in the emulator screen.
      java.lang.IntegergetId()
      Returns the value id of the screen.
      java.lang.IntegergetInputFieldCount()
      Returns the number of input fields on the emulator screen.
      StringPropertygetLabel()
      Returns the label of the Terminal Emulator screen.
      java.lang.IntegergetProtectedFieldCount()
      Returns the number of protected fields on the emulator screen.
      SizePropertygetSize()
      Returns the total number of rows and columns in the emulator screen.
      voidsetCursorPosition(java.lang.Integer row, java.lang.Integer column)
      Sets the position of the cursor in the emulator screen.
      voidsetCursorPosition(Position position)
      Sets the position of the cursor in the emulator screen.
      voidsetCursorPosition(PositionProperty position)
      Sets the position of the cursor in the emulator screen.
      voidsetId(java.lang.Integer id)
      Sets the value id of the screen.
      voidsetInputFieldCount(java.lang.Integer handle)
      Sets the number of input fields on the emulator screen.
      voidsetLabel(java.lang.String label)
      Sets the label of the Terminal Emulator screen.
      voidsetLabel(StringProperty label)
      Sets the label of the Terminal Emulator screen.
      voidsetProtectedFieldCount(java.lang.Integer protectedFieldCount)
      Sets the number of protected fields on the emulator screen.
      voidsetSize(java.lang.Integer row, java.lang.Integer column)
      Sets the total number of rows and columns in the emulator screen.
      voidsetSize(Size size)
      Sets the total number of rows and columns in the emulator screen.
      voidsetSize(SizeProperty size)
      Sets the total number of rows and columns in the emulator screen.

      • 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

    • 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.