com.sshtools.terminal.awt
Class AWTVirtualTerminal

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Panel
              com.sshtools.terminal.awt.AWTVirtualTerminal

All Implemented Interfaces:

VirtualTerminal, VirtualSession, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class AWTVirtualTerminal
extends java.awt.Panel
implements VirtualTerminal

AWT implementation of a VirtualSession.

Author:

$Author: james $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Panel

java.awt.Panel.AccessibleAWTPanel

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.sshtools.terminal.VirtualTerminal

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

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

AWTVirtualTerminal()
Construct a new AWTVirtualTerminal

Method Summary

void	addVirtualSessionListener(VirtualSessionListener listener) Add a VirtualSessionListener to the list that should receive events such as connection made, disconnected, resizes, data sent and received etc.
void	addVirtualTerminalComponent(VirtualTerminalComponent component, java.lang.String position, int ring) Add a component to this terminal.
void	connect(ProfileTransport transport) Connect the session to the streams provided by the transport.
void	disconnect(boolean doDisconnect) Disconnect this session from the host it is connected to.
VDUDisplay	getDisplay() Return the VDUDisplay implementation this terminal is using.
TerminalEmulation	getEmulation() Return the emulation.
ResourceProfile	getProfile() Get the profile this virtual terminal is to use
java.lang.String	getTitle() Return the title of this virtual session.
ProfileTransport	getTransport() Get the transport currently in use.
VirtualSessionManager	getVirtualSessionManager() Get the virtual session manager.
void	init(VirtualSessionManager vsManager) Initialise the virtual session.
boolean	isConnected() Get if this virtual session is currently connected
void	removeVirtualSessionListener(VirtualSessionListener listener) Remove a VirtualSessionListener to the list receiving events such as connection made, disconnected, resizes, data sent and received etc.
void	reset() Reset the session back to its initial state (e.g.
void	screenResized(int w, int h, boolean remote) Invoked by the VDUDisplay implementation when it received a request to to resize the terminal window.
void	setProfile(ResourceProfile profile) Set the profile this virtual terminal is to use
void	setVirtualSessionProperties(ResourceProfile profile) Prior to connection, and when the user applies connection profiles, this method will be called.

Methods inherited from class java.awt.Panel

addNotify, getAccessibleContext

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AWTVirtualTerminal

public AWTVirtualTerminal()
                   throws java.io.IOException

Construct a new AWTVirtualTerminal

Throws:

java.io.IOException

Method Detail

init

public void init(VirtualSessionManager vsManager)

Description copied from interface: VirtualSession

Initialise the virtual session. Called after it has been added to the virtual session manager.

Specified by:

init in interface VirtualSession

Parameters:

vsManager - the virtual session manager session has been added to

addVirtualTerminalComponent

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

Description copied from interface: VirtualTerminal

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()

Specified by:

addVirtualTerminalComponent in interface VirtualTerminal

Parameters:

component - component to add

position - border position

ring - ring number

getEmulation

public TerminalEmulation getEmulation()

Description copied from interface: VirtualTerminal

Return the emulation.

Specified by:

getEmulation in interface VirtualTerminal

Returns:

emulation

getDisplay

public VDUDisplay getDisplay()

Description copied from interface: VirtualTerminal

Return the VDUDisplay implementation this terminal is using.

Specified by:

getDisplay in interface VirtualTerminal

Returns:

terminal panel

reset

public void reset()

Description copied from interface: VirtualSession

Reset the session back to its initial state (e.g. clear the scree, clear the buffer, reset the cursor etc)

Specified by:

reset in interface VirtualSession

connect

public void connect(ProfileTransport transport)

Description copied from interface: VirtualSession

Connect the session to the streams provided by the transport.

Specified by:

connect in interface VirtualSession

Parameters:

transport - transport

getTransport

public ProfileTransport getTransport()

Description copied from interface: VirtualSession

Get the transport currently in use. This will be set after connect() has been called and will be null if not connected.

Specified by:

getTransport in interface VirtualSession

Returns:

transport

disconnect

public void disconnect(boolean doDisconnect)

Description copied from interface: VirtualSession

Disconnect this session from the host it is connected to. If true is passed for the doDisconnect value, the the transport will also be disconnected.

Specified by:

disconnect in interface VirtualSession

Parameters:

doDisconnect - disconnect the transport

addVirtualSessionListener

public void addVirtualSessionListener(VirtualSessionListener listener)

Description copied from interface: VirtualSession

Add a VirtualSessionListener to the list that should receive events such as connection made, disconnected, resizes, data sent and received etc.

Specified by:

addVirtualSessionListener in interface VirtualSession

Parameters:

listener - listener to add

removeVirtualSessionListener

public void removeVirtualSessionListener(VirtualSessionListener listener)

Description copied from interface: VirtualSession

Remove a VirtualSessionListener to the list receiving events such as connection made, disconnected, resizes, data sent and received etc.

Specified by:

removeVirtualSessionListener in interface VirtualSession

Parameters:

listener - listener to remove

screenResized

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

Description copied from interface: VirtualTerminal

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.

Specified by:

screenResized in interface VirtualTerminal

Parameters:

w - new width

h - new height

remote - remote host requested resize

getTitle

public java.lang.String getTitle()

Description copied from interface: VirtualSession

Return the title of this virtual session. There may be more than one session with the same title.

Specified by:

getTitle in interface VirtualSession

Returns:

virtual session title

isConnected

public boolean isConnected()

Description copied from interface: VirtualSession

Get if this virtual session is currently connected

Specified by:

isConnected in interface VirtualSession

Returns:

connected

setProfile

public void setProfile(ResourceProfile profile)

Set the profile this virtual terminal is to use

Parameters:

profile - profile

getProfile

public ResourceProfile getProfile()

Get the profile this virtual terminal is to use

Returns:

profile

getVirtualSessionManager

public VirtualSessionManager getVirtualSessionManager()

Description copied from interface: VirtualSession

Get the virtual session manager. Will return null until init has been called.

Specified by:

getVirtualSessionManager in interface VirtualSession

Returns:

the virtual session manager session has been added to

setVirtualSessionProperties

public void setVirtualSessionProperties(ResourceProfile profile)

Description copied from interface: VirtualSession

Prior to connection, and when the user applies connection profiles, this method will be called. The virtual session implementation should configure itself using any properties the profile provides. For example, a terminal like implementation would set the background, foreground, cursor style etc.

Specified by:

setVirtualSessionProperties in interface VirtualSession

Parameters:

profile - profile to configure virtual session from