terminal

java.lang.Object
- pw3270.terminal

public class terminal
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description
`terminal()` Creates a tn3270 terminal without associating it with any pw3270 window.
`terminal(java.lang.String id)` Creates a tn3270 terminal associated with a pw3270 window.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`action(java.lang.String name)` Launch a lib3270 action by name.
`int`	`cmp_string_at(int row, int col, java.lang.String text)` Compare terminal contents.
`int`	`connect(java.lang.String host, int seconds)` Connect to 3270 host.
`int`	`disconnect()` Disconnect from host.
`int`	`enter()` Send an "ENTER" action.
`int`	`erase_eof()` Erase from cursor position until the end of the field.
`int`	`erase_eol()`
`int`	`erase_input()`
`int`	`erase()`
`java.lang.String`	`file_chooser_dialog(int action, java.lang.String title, java.lang.String extension, java.lang.String filename)` File selection dialog.
`protected void`	`finalize()`
`java.lang.String`	`get_clipboard()`
`java.lang.String`	`get_copy()`
`int`	`get_cursor_addr()` Get cursor offset
`java.lang.String`	`get_encoding()` Get the current lib3270 encoding.
`int`	`get_field_len()` Get the current field length.
`int`	`get_field_len(int baddr)` Get the field length.
`int`	`get_field_start()` Get the current field start address.
`int`	`get_field_start(int baddr)` Get the field start address.
`int`	`get_is_protected_at(int row, int col)` Check if the address is protected.
`int`	`get_is_protected(int baddr)` Check if the address is protected.
`int`	`get_next_unprotected()` Get next field address.
`int`	`get_next_unprotected(int baddr)` Get next field address.
`java.lang.String`	`get_revision()` Get the current lib3270 revision.
`int`	`get_secure()` Get connection SSL state
`java.lang.String`	`get_string_at(int row, int col, int sz)` Get terminal contents starting at row, col.
`java.lang.String`	`get_string(int baddr, int len)` Get terminal contents starting at desired address.
`java.lang.String`	`get_version()` Get the current lib3270 version.
`int`	`input_string(java.lang.String str)`
`boolean`	`is_connected()`
`boolean`	`is_ready()`
`void`	`log(java.lang.String msg)`
`int`	`pakey(int key)` Send a pakey to host.
`int`	`pfkey(int key)` Send a pfkey to host.
`int`	`popup_dialog(int id, java.lang.String title, java.lang.String message, java.lang.String secondary)` Open popup dialog.
`int`	`print()` Open print dialog.
`int`	`quit()` quit remote pw3270 window.
`int`	`set_clipboard(java.lang.String text)`
`int`	`set_copy(java.lang.String text)`
`int`	`set_cursor_addr(int addr)` Set cursor offset in the terminal buffer.
`int`	`set_cursor_position(int row, int col)` Move cursor to selected position.
`int`	`set_string_at(int row, int col, java.lang.String str)` Set terminal contents at position.
`java.lang.String`	`toString()` Get Screen contents.
`int`	`wait_for_ready(int seconds)` Wait for terminal negociation.
`int`	`wait_for_string_at(int row, int col, java.lang.String text, int seconds)` Wait for text at defined position
`int`	`wait(int seconds)` Wait for an specified amount of time.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - terminal
```
public terminal()
```
    Creates a tn3270 terminal without associating it with any pw3270 window.
  - terminal
```
public terminal(java.lang.String id)
```
    Creates a tn3270 terminal associated with a pw3270 window.
    
    Parameters:
    id - String identifying the target window ("pw3270:a") or "" to run without window.
- Method Detail
  - wait
```
public int wait(int seconds)
```
    Wait for an specified amount of time.
    Wait for the specified time keeping the main loop active.
    
    Parameters:
    seconds - Number of seconds to wait.
  - wait_for_ready
```
public int wait_for_ready(int seconds)
```
    Wait for terminal negociation.
    Wait on a loop until the terminal contents are ready for reading.
    
    Parameters:
    seconds - Maximum time (in seconds) to wait for.
    
    Returns:
    0 for success, error code if not.
  - wait_for_string_at
```
public int wait_for_string_at(int row,
                     int col,
                     java.lang.String text,
                     int seconds)
```
    Wait for text at defined position
    
    Parameters:
    row - Row for text to compare.
    col - Column for text to compare.
    text - String to compare.
    seconds - Maximum time (in seconds) to wait for.
    
    Returns:
    0 for success, error code if not.
  - get_version
```
public java.lang.String get_version()
```
    Get the current lib3270 version.
    
    Returns:
    String with the current lib3270 version.
  - get_revision
```
public java.lang.String get_revision()
```
    Get the current lib3270 revision.
    
    Returns:
    String with the current lib3270 revision.
  - get_encoding
```
public java.lang.String get_encoding()
```
    Get the current lib3270 encoding.
    
    Returns:
    String with the current lib3270 encoding (ISO-8859-1).
  - get_string
```
public java.lang.String get_string(int baddr,
                          int len)
```
    Get terminal contents starting at desired address.
    
    Parameters:
    baddr - Address of the beginning of the string.
    len - Length of the string.
    
    Returns:
    Terminal contents with "len" bytes starting at "baddr" position.
  - get_string_at
```
public java.lang.String get_string_at(int row,
                             int col,
                             int sz)
```
    Get terminal contents starting at row, col.
    
    Parameters:
    row - Row of the text.
    col - Column of the text.
    sz - Size to read.
    
    Returns:
    Contents of terminal at row, col with sz bytes.
  - set_string_at
```
public int set_string_at(int row,
                int col,
                java.lang.String str)
```
    Set terminal contents at position.
    
    Parameters:
    row - Row for starting of change.
    col - Column for starting of change.
    str - Text to set.
    
    Returns:
    0 if ok, error code if not.
  - cmp_string_at
```
public int cmp_string_at(int row,
                int col,
                java.lang.String text)
```
    Compare terminal contents.
    
    Parameters:
    row - Row for text to compare.
    col - Column for text to compare.
    text - String to compare.
    
    Returns:
    result of strcmp() from text and terminal contents.
  - input_string
```
public int input_string(java.lang.String str)
```
  - set_cursor_position
```
public int set_cursor_position(int row,
                      int col)
```
    Move cursor to selected position.
    
    Parameters:
    row - Row of the new cursor position.
    col - Column of the new cursor position.
    
    Returns:
    Address of current cursor position.
  - set_cursor_addr
```
public int set_cursor_addr(int addr)
```
    Set cursor offset in the terminal buffer.
    
    Parameters:
    addr - New cursor offset.
    
    Returns:
    Original cursor offset.
  - get_cursor_addr
```
public int get_cursor_addr()
```
    Get cursor offset
    
    Returns:
    Current cursor offset.
  - enter
```
public int enter()
```
    Send an "ENTER" action.
    
    Returns:
    reserved.
  - pfkey
```
public int pfkey(int key)
```
    Send a pfkey to host.
    
    Parameters:
    key - PFkey number.
    
    Returns:
    reserved.
  - pakey
```
public int pakey(int key)
```
    Send a pakey to host.
    
    Parameters:
    key - PFkey number.
    
    Returns:
    reserved.
  - quit
```
public int quit()
```
    quit remote pw3270 window.
    Only valid if connected to a remote window
    
    Returns:
    reserved.
  - erase
```
public int erase()
```
  - erase_eol
```
public int erase_eol()
```
  - erase_input
```
public int erase_input()
```
  - erase_eof
```
public int erase_eof()
```
    Erase from cursor position until the end of the field.
    
    Returns:
    reserved.
  - print
```
public int print()
```
    Open print dialog.
    Only valid if connected to a remote window
    
    Returns:
    reserved
  - connect
```
public int connect(java.lang.String host,
          int seconds)
```
    Connect to 3270 host.
    Connect to the 3270 host
    URI formats:
    - tn3270://[HOSTNAME]:[HOSTPORT] for non SSL connections.
    - tn3270s://[HOSTNAME]:[HOSTPORT] for ssl connection.
    Parameters:
    host - Host URI.
    seconds - How many seconds to wait for a connection.
    
    Returns:
    0 if ok, error code if not.
  - disconnect
```
public int disconnect()
```
    Disconnect from host.
    
    Returns:
    0 if ok, error code if not.
  - get_field_start
```
public int get_field_start(int baddr)
```
    Get the field start address.
    
    Parameters:
    baddr - address of the field.
    
    Returns:
    Address of current field start.
  - get_field_start
```
public int get_field_start()
```
    Get the current field start address.
    
    Returns:
    Current field start address.
  - get_field_len
```
public int get_field_len(int baddr)
```
    Get the field length.
    
    Parameters:
    baddr - Address of the field.
    
    Returns:
    Field length.
  - get_field_len
```
public int get_field_len()
```
    Get the current field length.
    
    Returns:
    Current field length.
  - get_next_unprotected
```
public int get_next_unprotected(int baddr)
```
    Get next field address.
    
    Parameters:
    baddr - Field address.
    
    Returns:
    Address of the next field.
  - get_is_protected
```
public int get_is_protected(int baddr)
```
    Check if the address is protected.
    
    Parameters:
    baddr - Field address.
    
    Returns:
    Protect state.
  - get_is_protected_at
```
public int get_is_protected_at(int row,
                      int col)
```
    Check if the address is protected.
    
    Parameters:
    row - Screen row.
    col - Screen col.
    
    Returns:
    Protect state.
  - get_next_unprotected
```
public int get_next_unprotected()
```
    Get next field address.
    
    Returns:
    Address of the next field.
  - popup_dialog
```
public int popup_dialog(int id,
               java.lang.String title,
               java.lang.String message,
               java.lang.String secondary)
```
    Open popup dialog.
    
    Parameters:
    id - Dialog type.
    title - Window title.
    message - Dialog message.
    secondary - Dialog secondary text.
    
    Returns:
    reserved.
  - action
```
public int action(java.lang.String name)
```
    Launch a lib3270 action by name.
    
    Parameters:
    name - Name of the action to fire.
    
    Returns:
    Return code of the action call.
  - file_chooser_dialog
```
public java.lang.String file_chooser_dialog(int action,
                                   java.lang.String title,
                                   java.lang.String extension,
                                   java.lang.String filename)
```
    File selection dialog.
    
    Parameters:
    action - Dialog action.
    title - Window title.
    extension - File extension.
    filename - Default file name;
    
    Returns:
    Selected file name.
  - set_copy
```
public int set_copy(java.lang.String text)
```
  - get_copy
```
public java.lang.String get_copy()
```
  - get_clipboard
```
public java.lang.String get_clipboard()
```
  - set_clipboard
```
public int set_clipboard(java.lang.String text)
```
  - is_connected
```
public boolean is_connected()
```
  - is_ready
```
public boolean is_ready()
```
  - log
```
public void log(java.lang.String msg)
```
  - toString
```
public java.lang.String toString()
```
    Get Screen contents.
    
    Overrides:
    
    toString in class java.lang.Object
  - get_secure
```
public int get_secure()
```
    Get connection SSL state
    
    Returns:
    State of SSL connection (0 = Unsafe, 1 = Valid CA, 2 = Invalid CA or self-signed, 3 = Negotiating, 4 = Undefined)
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable

Class terminal

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

terminal

terminal

Method Detail

wait

wait_for_ready

wait_for_string_at

get_version

get_revision

get_encoding

get_string

get_string_at

set_string_at

cmp_string_at

input_string

set_cursor_position

set_cursor_addr

get_cursor_addr

enter

pfkey

pakey

quit

erase

erase_eol

erase_input

erase_eof

print

connect

disconnect

get_field_start

get_field_start

get_field_len

get_field_len

get_next_unprotected

get_is_protected

get_is_protected_at

get_next_unprotected

popup_dialog

action

file_chooser_dialog

set_copy

get_copy

get_clipboard

set_clipboard

is_connected

is_ready

log

toString

get_secure

finalize