no.gar.glink.api
Class GlinkKey

java.lang.Object
  extended by no.gar.glink.api.GlinkKey

public class GlinkKey
extends java.lang.Object

Glink command keys constants. This class contains the list of the available Glink command keys that can be supplied as a parameter to the SendCommandKey method. For other characters, use the sendKeys method.

See Also:
GlinkApi.sendCommandKey(int), GlinkApi.sendKeys(java.lang.String)

Field Summary
static int ALPHA_OVERIDE
          3270 specific: Enable alphanumeric characters for the current unprotected field
static int BACK_TAB
          Tab to previous variable field
static int BACKSPACE
          Delete the character at the previous position if the cursor is placed in an unprotected field
static int BREAK
          Break/Attention
static int CLEAR
          Clear the screen and remove the fields defined
static int CURSOR_SELECT
          3270 specific: Cursor select
static int DELETE
          Delete the character at the cursor position if the cursor is placed in an unprotected field
static int DISCONNECT
          Disconnect
static int DOWN
          Cursor down
static int DUP
          3270 specific: Set duplicate operation for the rest of the field and do a TAB key operation
static int END
          Move the cursor to the position following the last none space character in the variable field
static int ENTER
          Transmit to host if the keyboard option "Enter sends Transmit" is configured, otherwise a new line is performed
static int EOL
          Erase to end of field or end of line
static int EOP
          Erase all unproteced fields
static int F1
          Program function key 1
static int F10
          Program function key 10
static int F11
          Program function key 11
static int F12
          Program function key 12
static int F2
          Program function key 2
static int F3
          Program function key 3
static int F4
          Program function key 4
static int F5
          Program function key 5
static int F6
          Program function key 6
static int F7
          Program function key 7
static int F8
          Program function key 8
static int F9
          Program function key 9
static int FIELD_MARK
          3270 specific: Set a field mark character to inform the application of the end of the field for an unformatted screen
static int HOME
          Go to first variable field.
static int HOST_HELP
          5250 specific: Request host help
static int INSERT
          Set the emulator into insert mode
static int LEFT
          Cursor left
static int NEW_LINE
          New line
static int PA1
          3270 specific: Program access key 1
static int PA2
          3270 specific: Program access key 2
static int PA3
          3270 specific: Program access key 3
static int PA4
          3270 specific: Program access key 4
static int PGDN
          Page down, 5250 Roll up
static int PGUP
          Page up, 5250 Roll down
static int PRINT_SCREEN
          Print screen
static int RESET_EMULATION
          Reset emulation
static int RESET_KEYBOARD
          3270 and 5250 specific: Reset keyboard
static int RIGHT
          Cursor right
static int SF1
          Program function key shift/F1 or program function key 13 for 3270
static int SF10
          Program function key shift/F10 or program function key 22 for 3270
static int SF11
          Program function key shift/F11 or program function key 23 for 3270
static int SF12
          Program function key shift/F12 or program function key 24 for 3270
static int SF2
          Program function key shift/F2 or program function key 14 for 3270
static int SF3
          Program function key shift/F3 or program function key 15 for 3270
static int SF4
          Program function key shift/F4 or program function key 16 for 3270
static int SF5
          Program function key shift/F5 or program function key 17 for 3270
static int SF6
          Program function key shift/F6 or program function key 18 for 3270
static int SF7
          Program function key shift/F7 or program function key 19 for 3270
static int SF8
          Program function key shift/F8 or program function key 20 for 3270
static int SF9
          Program function key shift/F9 or program function key 21 for 3270
static int SYSREQ
          3270 and 5250 specific: System request key
static int TAB
          Tab to next variable field
static int TESTREQ
          5250 specific: Test request
static int TRANSMIT
          Transmit to host
static int UP
          Cursor up
 
Constructor Summary
GlinkKey()
           
 
Method Summary
static int toKey(java.lang.String keyName)
          Returns the key value for the string representation of the key, for example for the keyName "TAB", the value for the TAB key is returned.
static java.lang.String toString(int key)
          Returns the string representation of the key value, for example "TAB" for the TAB key
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALPHA_OVERIDE

public static final int ALPHA_OVERIDE
3270 specific: Enable alphanumeric characters for the current unprotected field

See Also:
Constant Field Values

BACK_TAB

public static final int BACK_TAB
Tab to previous variable field

See Also:
Constant Field Values

BACKSPACE

public static final int BACKSPACE
Delete the character at the previous position if the cursor is placed in an unprotected field

See Also:
Constant Field Values

BREAK

public static final int BREAK
Break/Attention

See Also:
Constant Field Values

CLEAR

public static final int CLEAR
Clear the screen and remove the fields defined

See Also:
Constant Field Values

CURSOR_SELECT

public static final int CURSOR_SELECT
3270 specific: Cursor select

See Also:
Constant Field Values

DELETE

public static final int DELETE
Delete the character at the cursor position if the cursor is placed in an unprotected field

See Also:
Constant Field Values

DISCONNECT

public static final int DISCONNECT
Disconnect

See Also:
Constant Field Values

DOWN

public static final int DOWN
Cursor down

See Also:
Constant Field Values

DUP

public static final int DUP
3270 specific: Set duplicate operation for the rest of the field and do a TAB key operation

See Also:
Constant Field Values

END

public static final int END
Move the cursor to the position following the last none space character in the variable field

See Also:
Constant Field Values

ENTER

public static final int ENTER
Transmit to host if the keyboard option "Enter sends Transmit" is configured, otherwise a new line is performed

See Also:
Constant Field Values

EOL

public static final int EOL
Erase to end of field or end of line

See Also:
Constant Field Values

EOP

public static final int EOP
Erase all unproteced fields

See Also:
Constant Field Values

F1

public static final int F1
Program function key 1

See Also:
Constant Field Values

F10

public static final int F10
Program function key 10

See Also:
Constant Field Values

F11

public static final int F11
Program function key 11

See Also:
Constant Field Values

F12

public static final int F12
Program function key 12

See Also:
Constant Field Values

F2

public static final int F2
Program function key 2

See Also:
Constant Field Values

F3

public static final int F3
Program function key 3

See Also:
Constant Field Values

F4

public static final int F4
Program function key 4

See Also:
Constant Field Values

F5

public static final int F5
Program function key 5

See Also:
Constant Field Values

F6

public static final int F6
Program function key 6

See Also:
Constant Field Values

F7

public static final int F7
Program function key 7

See Also:
Constant Field Values

F8

public static final int F8
Program function key 8

See Also:
Constant Field Values

F9

public static final int F9
Program function key 9

See Also:
Constant Field Values

FIELD_MARK

public static final int FIELD_MARK
3270 specific: Set a field mark character to inform the application of the end of the field for an unformatted screen

See Also:
Constant Field Values

HOME

public static final int HOME
Go to first variable field.

See Also:
Constant Field Values

HOST_HELP

public static final int HOST_HELP
5250 specific: Request host help

See Also:
Constant Field Values

INSERT

public static final int INSERT
Set the emulator into insert mode

See Also:
Constant Field Values

LEFT

public static final int LEFT
Cursor left

See Also:
Constant Field Values

NEW_LINE

public static final int NEW_LINE
New line

See Also:
Constant Field Values

PA1

public static final int PA1
3270 specific: Program access key 1

See Also:
Constant Field Values

PA2

public static final int PA2
3270 specific: Program access key 2

See Also:
Constant Field Values

PA3

public static final int PA3
3270 specific: Program access key 3

See Also:
Constant Field Values

PA4

public static final int PA4
3270 specific: Program access key 4

See Also:
Constant Field Values

PGDN

public static final int PGDN
Page down, 5250 Roll up

See Also:
Constant Field Values

PGUP

public static final int PGUP
Page up, 5250 Roll down

See Also:
Constant Field Values

PRINT_SCREEN

public static final int PRINT_SCREEN
Print screen

See Also:
Constant Field Values

RESET_EMULATION

public static final int RESET_EMULATION
Reset emulation

See Also:
Constant Field Values

RESET_KEYBOARD

public static final int RESET_KEYBOARD
3270 and 5250 specific: Reset keyboard

See Also:
Constant Field Values

RIGHT

public static final int RIGHT
Cursor right

See Also:
Constant Field Values

SF1

public static final int SF1
Program function key shift/F1 or program function key 13 for 3270

See Also:
Constant Field Values

SF10

public static final int SF10
Program function key shift/F10 or program function key 22 for 3270

See Also:
Constant Field Values

SF11

public static final int SF11
Program function key shift/F11 or program function key 23 for 3270

See Also:
Constant Field Values

SF12

public static final int SF12
Program function key shift/F12 or program function key 24 for 3270

See Also:
Constant Field Values

SF2

public static final int SF2
Program function key shift/F2 or program function key 14 for 3270

See Also:
Constant Field Values

SF3

public static final int SF3
Program function key shift/F3 or program function key 15 for 3270

See Also:
Constant Field Values

SF4

public static final int SF4
Program function key shift/F4 or program function key 16 for 3270

See Also:
Constant Field Values

SF5

public static final int SF5
Program function key shift/F5 or program function key 17 for 3270

See Also:
Constant Field Values

SF6

public static final int SF6
Program function key shift/F6 or program function key 18 for 3270

See Also:
Constant Field Values

SF7

public static final int SF7
Program function key shift/F7 or program function key 19 for 3270

See Also:
Constant Field Values

SF8

public static final int SF8
Program function key shift/F8 or program function key 20 for 3270

See Also:
Constant Field Values

SF9

public static final int SF9
Program function key shift/F9 or program function key 21 for 3270

See Also:
Constant Field Values

SYSREQ

public static final int SYSREQ
3270 and 5250 specific: System request key

See Also:
Constant Field Values

TAB

public static final int TAB
Tab to next variable field

See Also:
Constant Field Values

TESTREQ

public static final int TESTREQ
5250 specific: Test request

See Also:
Constant Field Values

TRANSMIT

public static final int TRANSMIT
Transmit to host

See Also:
Constant Field Values

UP

public static final int UP
Cursor up

See Also:
Constant Field Values
Constructor Detail

GlinkKey

public GlinkKey()
Method Detail

toKey

public static int toKey(java.lang.String keyName)
Returns the key value for the string representation of the key, for example for the keyName "TAB", the value for the TAB key is returned.

Returns:
returns the key value or -1 if the keyName is not recognized

toString

public static java.lang.String toString(int key)
Returns the string representation of the key value, for example "TAB" for the TAB key