com.sshtools.terminal
Interface VirtualTerminal

All Superinterfaces:

VirtualSession

All Known Implementing Classes:

AWTVirtualTerminal, SwingVirtualTerminal

public interface VirtualTerminal
extends VirtualSession

A single virtual terminal provides a display'screen' for a single connection to a host and will usually be added to a VirtualSessionManagerUI implementation that manages all of the virtual terminals.

Author:

$Author: james $

Field Summary

static java.lang.String	PROFILE_PROPERTY_ANSWERBACK_STRING
static java.lang.String	PROFILE_PROPERTY_ANTIALIAS
static java.lang.String	PROFILE_PROPERTY_BACKGROUND_COLOR
static java.lang.String	PROFILE_PROPERTY_BACKGROUND_IMAGE
static java.lang.String	PROFILE_PROPERTY_BACKGROUND_IMAGE_TYPE
static java.lang.String	PROFILE_PROPERTY_BACKSPACE_IS_DEL
static java.lang.String	PROFILE_PROPERTY_CHARSET_NAME
static java.lang.String	PROFILE_PROPERTY_COLOR_PRINTING
static java.lang.String	PROFILE_PROPERTY_CURSOR_BACKGROUND
static java.lang.String	PROFILE_PROPERTY_CURSOR_BLINK
static java.lang.String	PROFILE_PROPERTY_CURSOR_FOREGROUND
static java.lang.String	PROFILE_PROPERTY_CURSOR_STYLE
static java.lang.String	PROFILE_PROPERTY_EOL
static java.lang.String	PROFILE_PROPERTY_FONT_NAME
static java.lang.String	PROFILE_PROPERTY_FONT_SIZE
static java.lang.String	PROFILE_PROPERTY_FONT_STYLE
static java.lang.String	PROFILE_PROPERTY_FOREGROUND_COLOR
static java.lang.String	PROFILE_PROPERTY_HOST_IS_VMS
static java.lang.String	PROFILE_PROPERTY_KEEP_CENTRAL
static java.lang.String	PROFILE_PROPERTY_KEYCODE_FILE
static java.lang.String	PROFILE_PROPERTY_RESIZE_STRATEGY
static java.lang.String	PROFILE_PROPERTY_REVERSE_VIDEO
static java.lang.String	PROFILE_PROPERTY_SCREEN_SIZE
static java.lang.String	PROFILE_PROPERTY_TERMINAL
static java.lang.String	PROFILE_PROPERTY_USE_IBM_CHARSET

Method Summary

void	addVirtualTerminalComponent(VirtualTerminalComponent component, java.lang.String position, int ring) Add a component to this terminal.
VDUDisplay	getDisplay() Return the VDUDisplay implementation this terminal is using.
TerminalEmulation	getEmulation() Return the emulation.
void	screenResized(int w, int h, boolean remote) Invoked by the VDUDisplay implementation when it received a request to to resize the terminal window.

Methods inherited from interface com.sshtools.virtualsession.VirtualSession

addVirtualSessionListener, connect, disconnect, getTitle, getTransport, getVirtualSessionManager, init, isConnected, removeVirtualSessionListener, reset, setVirtualSessionProperties

Field Detail

PROFILE_PROPERTY_TERMINAL

static final java.lang.String PROFILE_PROPERTY_TERMINAL

See Also:

Constant Field Values

PROFILE_PROPERTY_EOL

static final java.lang.String PROFILE_PROPERTY_EOL

See Also:

Constant Field Values

PROFILE_PROPERTY_SCREEN_SIZE

static final java.lang.String PROFILE_PROPERTY_SCREEN_SIZE

See Also:

Constant Field Values

PROFILE_PROPERTY_RESIZE_STRATEGY

static final java.lang.String PROFILE_PROPERTY_RESIZE_STRATEGY

See Also:

Constant Field Values

PROFILE_PROPERTY_ANTIALIAS

static final java.lang.String PROFILE_PROPERTY_ANTIALIAS

See Also:

Constant Field Values

PROFILE_PROPERTY_FONT_SIZE

static final java.lang.String PROFILE_PROPERTY_FONT_SIZE

See Also:

Constant Field Values

PROFILE_PROPERTY_BACKGROUND_COLOR

static final java.lang.String PROFILE_PROPERTY_BACKGROUND_COLOR

See Also:

Constant Field Values

PROFILE_PROPERTY_FOREGROUND_COLOR

static final java.lang.String PROFILE_PROPERTY_FOREGROUND_COLOR

See Also:

Constant Field Values

PROFILE_PROPERTY_COLOR_PRINTING

static final java.lang.String PROFILE_PROPERTY_COLOR_PRINTING

See Also:

Constant Field Values

PROFILE_PROPERTY_CURSOR_FOREGROUND

static final java.lang.String PROFILE_PROPERTY_CURSOR_FOREGROUND

See Also:

Constant Field Values

PROFILE_PROPERTY_CURSOR_BACKGROUND

static final java.lang.String PROFILE_PROPERTY_CURSOR_BACKGROUND

See Also:

Constant Field Values

PROFILE_PROPERTY_CURSOR_STYLE

static final java.lang.String PROFILE_PROPERTY_CURSOR_STYLE

See Also:

Constant Field Values

PROFILE_PROPERTY_CURSOR_BLINK

static final java.lang.String PROFILE_PROPERTY_CURSOR_BLINK

See Also:

Constant Field Values

PROFILE_PROPERTY_CHARSET_NAME

static final java.lang.String PROFILE_PROPERTY_CHARSET_NAME

See Also:

Constant Field Values

PROFILE_PROPERTY_ANSWERBACK_STRING

static final java.lang.String PROFILE_PROPERTY_ANSWERBACK_STRING

See Also:

Constant Field Values

PROFILE_PROPERTY_REVERSE_VIDEO

static final java.lang.String PROFILE_PROPERTY_REVERSE_VIDEO

See Also:

Constant Field Values

PROFILE_PROPERTY_KEYCODE_FILE

static final java.lang.String PROFILE_PROPERTY_KEYCODE_FILE

See Also:

Constant Field Values

PROFILE_PROPERTY_USE_IBM_CHARSET

static final java.lang.String PROFILE_PROPERTY_USE_IBM_CHARSET

See Also:

Constant Field Values

PROFILE_PROPERTY_HOST_IS_VMS

static final java.lang.String PROFILE_PROPERTY_HOST_IS_VMS

See Also:

Constant Field Values

PROFILE_PROPERTY_KEEP_CENTRAL

static final java.lang.String PROFILE_PROPERTY_KEEP_CENTRAL

See Also:

Constant Field Values

PROFILE_PROPERTY_BACKGROUND_IMAGE_TYPE

static final java.lang.String PROFILE_PROPERTY_BACKGROUND_IMAGE_TYPE

See Also:

Constant Field Values

PROFILE_PROPERTY_BACKGROUND_IMAGE

static final java.lang.String PROFILE_PROPERTY_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROFILE_PROPERTY_FONT_STYLE

static final java.lang.String PROFILE_PROPERTY_FONT_STYLE

See Also:

Constant Field Values

PROFILE_PROPERTY_FONT_NAME

static final java.lang.String PROFILE_PROPERTY_FONT_NAME

See Also:

Constant Field Values

PROFILE_PROPERTY_BACKSPACE_IS_DEL

static final java.lang.String PROFILE_PROPERTY_BACKSPACE_IS_DEL

See Also:

Constant Field Values

Method Detail

addVirtualTerminalComponent

void addVirtualTerminalComponent(VirtualTerminalComponent component,
                                 java.lang.String position,
                                 int ring)
                                 throws java.lang.IllegalArgumentException

Add a component to this terminal. The position field should be one of

• BorderLayout.NORTH
• BorderLayout.SOUTH
• BorderLayout.EAST
• BorderLayout.WEST

This terminal implementation should allow components to be added to one panel in a "ring" of nested panels each with a border layout and the child panel being in the center. The very innermost ring contains the actual terminal display.

The ring number should be the index of the ring from 0 up to getRingCount()

Parameters:

component - component to add

position - border position

ring - ring number

Throws:

java.lang.IllegalArgumentException - if the ring is invalid or the wrong type of component is being added

screenResized

void screenResized(int w,
                   int h,
                   boolean remote)

Invoked by the VDUDisplay implementation when it received a request to to resize the terminal window. This should then in turn notify all of the listeners.

remote will be true if it was the remote host that requested the screen resize. This can be used to resize the container window if required.

Parameters:

w - new width

h - new height

remote - remote host requested resize

getDisplay

VDUDisplay getDisplay()

Return the VDUDisplay implementation this terminal is using.

Returns:

terminal panel

getEmulation

TerminalEmulation getEmulation()

Return the emulation.

Returns:

emulation