com.sshtools.terminal
Interface Terminal

All Superinterfaces:

VirtualSessionManager

All Known Implementing Classes:

AWTTerminal, SwingTerminal

public interface Terminal

extends VirtualSessionManager

Top level interface for a terminal component. Implementations do hold a single terminal emulator, more they are a container for many VirtualSession implementations.

Each VirtualSession will be connected a different host (and / or session) and it may be also be the Terminals responsibility to give the user a way of switching between these VirtualTerminals and displaying the selected one.

Terminals can also 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 will contain the currently selected VirtualSession. To deny this feature getRingCount() should return zero and addTerminalComponent(Terminal) should throw an exception.

Version:

$Revision: 1.1 $

Author:

$Author: richard $

Method Summary

void	addTerminalComponent(TerminalComponent component, java.lang.String position, int ring) Add a component to this terminal.
int	getRingCount() This terminal implementation allows 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.

Methods inherited from interface com.sshtools.virtualsession.VirtualSessionManager

addVirtualSession, addVirtualSessionManagerListener, getSelectedVirtualSession, getSelectedVirtualSessionIndex, getVirtualSession, getVirtualSessionCount, removeVirtualSession, removeVirtualSessionManagerListener, setSelectedVirtualSession, virtualSessions

Method Detail

getRingCount

public int getRingCount()

This terminal implementation allows 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.

This method returns the number of rings that are available for use

Returns:

number of available rings

addTerminalComponent

public void addTerminalComponent(TerminalComponent 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()

The Terminal will also invoke TerminalComponent.init(Terminal) to initialise the component (adding of listeners etc should be done here)

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