net.sf.freehost3270.gui

Class JTerminal

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

net.sf.freehost3270.gui.JTerminal

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, TerminalEventListener

public class JTerminal
extends JPanel
implements TerminalEventListener

A SWING component that interactively renders terminal screen contents and handles user to terminal interaction.

The terminal is first rendered to a buffered image and then, whan a component repaint is requested this buffered image is painted on the given component's graphics context. The font face may be set via setFont(), with the font scaling policy set via setFontScalePolicy(). If font scaling is enabled, the font will scale to the available size of the component, rather than the component scaling to the size of the font.

This class concerns itself with rendering the data provided by a DefaultTerminalModel or appropriate subclass. The model communicates with the component through normal event-dispatching mechanisms.

Author:

Bryan.Varner

See Also:

paintComponent(Graphics), setFont(Font), doLayout(), Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	SCALE_FONT_OFF
static int	SCALE_FONT_SIZE
static int	STRETCH_FONT_VERTICALLY

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
JTerminal() Creates a new JTerminal with a DefaultTerminalModel (type 2), DefaultKeyMap, and DefaultColorMap.
JTerminal(DefaultTerminalModel model) Creates a new JTerminal with a DefaultKeyMap and DefaultColorMap.
JTerminal(DefaultTerminalModel model, KeyMap km) Creates a new JTerminal with a DefaultColorMap.
JTerminal(DefaultTerminalModel model, KeyMap km, ColorMap cm) Creates a new JTerminal

Method Summary

Methods

Modifier and Type	Method and Description
void	doLayout() Invoked by our parent objects layout manager.
ColorMap	getColorMap() Gets the current ColorMap
int	getFontScalePolicy() Gets the font scaling policy in use.
KeyMap	getKeyMap() Retrieves the current KeyMap
DefaultTerminalModel	getTerminalModel() Gets the active TerminalModel for this JTerminal
protected void	paintComponent(Graphics g) Overrides the painting of our component's interior bounds.
protected void	renderScreen() Handles the drawing of the screen.
void	setColorMap(ColorMap cm) Sets the ColorMap.
void	setFont(Font font) Overrides setFont.
void	setFontScalePolicy(int policy) Sets the font scaling policy.
void	setKeyMap(KeyMap km) Sets the KeyMap
void	setTextAntialiasing(boolean b) Sets the font text antialiasing policy.
void	terminalEventReceived(TerminalEvent te) Handles incomming terminalEvents from the DefaultTerminalModel.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

SCALE_FONT_OFF

public static final int SCALE_FONT_OFF

See Also:

Constant Field Values

SCALE_FONT_SIZE

public static final int SCALE_FONT_SIZE

See Also:

Constant Field Values

STRETCH_FONT_VERTICALLY

public static final int STRETCH_FONT_VERTICALLY

See Also:

Constant Field Values

Constructor Detail

JTerminal

public JTerminal()

Creates a new JTerminal with a DefaultTerminalModel (type 2), DefaultKeyMap, and DefaultColorMap.

JTerminal

public JTerminal(DefaultTerminalModel model)

Creates a new JTerminal with a DefaultKeyMap and DefaultColorMap.

Parameters:

model - The TerminalModel to use for interaction.

JTerminal

public JTerminal(DefaultTerminalModel model,
         KeyMap km)

Creates a new JTerminal with a DefaultColorMap.

Parameters:

model - The TerminalModel to use for interaction.

km - The KeyMap to use when translating keyboard events.

JTerminal

public JTerminal(DefaultTerminalModel model,
         KeyMap km,
         ColorMap cm)

Creates a new JTerminal

Parameters:

model - The TerminalModel to use for interaction.

km - The KeyMap to use when translating keyboard events.

cm - The ColorMap to use for selecting colors while rendering.

Method Detail

getTerminalModel

public DefaultTerminalModel getTerminalModel()

Gets the active TerminalModel for this JTerminal

doLayout

public void doLayout()

Invoked by our parent objects layout manager. Because JPanel is a container class, this is invoked after our own size has been correctly set. We flush any existing backbuffer, and create a new backbuffer using hardware acceleration where possible.

Overrides:

doLayout in class Container

setFont

public void setFont(Font font)

Overrides setFont. Sets the font to be used for all text rendering for this component. Depending on the font scale policy that is currently set, the font may be scaled to fit the bounds of the component, or stretched to fill it vertically.

Overrides:

setFont in class JComponent

Parameters:

font - The new Font face to use.

setKeyMap

public void setKeyMap(KeyMap km)

Sets the KeyMap

getKeyMap

public KeyMap getKeyMap()

Retrieves the current KeyMap

setColorMap

public void setColorMap(ColorMap cm)

Sets the ColorMap.

getColorMap

public ColorMap getColorMap()

Gets the current ColorMap

getFontScalePolicy

public int getFontScalePolicy()

Gets the font scaling policy in use.

setFontScalePolicy

public void setFontScalePolicy(int policy)

Sets the font scaling policy.

setTextAntialiasing

public void setTextAntialiasing(boolean b)

Sets the font text antialiasing policy.

paintComponent

protected void paintComponent(Graphics g)

Overrides the painting of our component's interior bounds. We'll simply blit the backbuffer.

Overrides:

paintComponent in class JComponent

Parameters:

g - Graphics object pre-inset.

renderScreen

protected void renderScreen()

Handles the drawing of the screen.

terminalEventReceived

public void terminalEventReceived(TerminalEvent te)

Handles incomming terminalEvents from the DefaultTerminalModel.

Specified by:

terminalEventReceived in interface TerminalEventListener

Parameters:

te - The TerminalEvent to handle