com.sshtools.terminal
Interface TerminalComponent

All Known Subinterfaces:

StatusBar

All Known Implementing Classes:

AWTComponentTerminalComponentAdapter, AWTStatusBar, SwingComponentTerminalComponentAdapter, SwingStatusBar, SwingToolBar

public interface TerminalComponent

All components that are to be added to the TerminalDisplay implementation must implement this interface.

A terminal component need not actually be visual, i.e. provide an AWT or Swing component for display, but if it is it must return a Component from the getComponent() method.

Each component can be added to any position (north, south, east or west) in any ring.

Version:

$Revision: 1.1 $

Author:

$Author: richard $

Method Summary

java.awt.Component	getComponent() Return the AWT / Swing component this terminal component provides.
Terminal	getTerminalDisplay() Return the TerminalDisplay this componet has been added to.
void	init(Terminal display) Invoked when the terminal adds the component to its UI.

Method Detail

init

public void init(Terminal display)

Invoked when the terminal adds the component to its UI.

Parameters:

display - display implementation

getTerminalDisplay

public Terminal getTerminalDisplay()

Return the TerminalDisplay this componet has been added to. Before init(TerminalDisplay) is called this method should return null.

Returns:

terminal display

getComponent

public java.awt.Component getComponent()

Return the AWT / Swing component this terminal component provides. If the terminal component is not visual it will just return null

Returns:

component