com.jscape.inet.terminal.commands

## Class CUPCommand

- java.lang.Object
- - com.jscape.inet.terminal.commands.CUPCommand

- All Implemented Interfaces:
    ControlCommand

      public class CUPCommand
      extends java.lang.Object
      implements ControlCommand

  CUP -- Cursor Position. The CUP sequence moves the active position to the position specified by the parameters. This sequence has two parameter values, the first specifying the line position and the second specifying the column position. A parameter value of zero or one for the first or second parameter moves the active position to the first line or column in the display, respectively. The default condition with no parameters present is equivalent to a cursor to home action. In the VT100, this control behaves identically with its format effector counterpart, HVP.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static java.lang.String` | `CANONICAL_FORM`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `execute(int[] params, Terminal terminal)` Executes command giving parameters and `Terminal` object.
    `static CUPCommand` | `getInstance()` Returns one and only one instance of this type.
    `void` | `send(int[] params, Terminal terminal)` Sends command to remote host.

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

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

- - ### Field Detail

    - #### CANONICAL_FORM

          public static final java.lang.String CANONICAL_FORM

      See Also:
        Constant Field Values

  - ### Method Detail

    - #### getInstance

          public static final CUPCommand getInstance()

      Returns one and only one instance of this type.
      Returns:
        one and only one instance of this type.

    - #### execute

          public void execute(int[] params,
                              Terminal terminal)

      Executes command giving parameters and `Terminal` object.
      Specified by:
        `execute` in interface `ControlCommand`
      Parameters:
        `params` - array of `int` command parametrs.
        `terminal` - target `Terminal` object.

    - #### send

          public void send(int[] params,
                           Terminal terminal)

      Sends command to remote host.
      Specified by:
        `send` in interface `ControlCommand`
      Parameters:
        `params` - command parameters.
        `terminal` - target `Terminal` object to send command.

Copyright © JSCAPE LLC. 1999-2021. All Rights Reserved