JTerminalScreen (FreeHost3270 modules suite 0.2-CURRENT API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - net.sf.freehost3270.gui.JTerminalScreen

All Implemented Interfaces:

KeyListener, ImageObserver, MenuContainer, Printable, Serializable, EventListener, Accessible, RWTnAction
```
public class JTerminalScreen
extends JPanel
implements RWTnAction, KeyListener, Printable
```
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. In case if a default font size is changed, the JTerminalScreen adjusts it size in order to feed the grown terminal screen size.

Since:

0.1 RHPanel

See Also:
paintComponent(Graphics), setFont(Font), 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 Color`	`DEFAULT_BG_COLOR` Default terminal background color.
`static Color`	`DEFAULT_BOLD_COLOR` Default font color used to render bold text.
`static Color`	`DEFAULT_CURSOR_COLOR` Default color used to render cursor pointer on the terminal screen.
`static Color`	`DEFAULT_FG_COLOR` Default terminal foreground color.
`static Color`	`DEFAULT_FIELD_BG_COLOR` Default input field background color.
`static Font`	`DEFAULT_FONT` Default font used to draw terminal.
`static int`	`DEFAULT_FONT_SIZE` Default size of the screen font.
`static int`	`DEFAULT_HEIGHT` The default height of the panel.
`static int`	`DEFAULT_WIDTH` The default width of the panel.
`static int`	`MARGIN_LEFT`
`static int`	`MARGIN_TOP`

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 net.sf.freehost3270.client.RWTnAction
CONNECTION_ERROR, DISCONNECTED_BY_REMOTE_HOST, READY, X_WAIT

Fields inherited from interface java.awt.print.Printable
NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description
`JTerminalScreen()` Construct a new GUI session with a terminalModel of 2, and a terminalType of 3279-E.
`JTerminalScreen(int terminalModel)` Construct a new GUI session with a 3279-E terminalType and the specified model where 2 <= terminalModel <= 5.
`JTerminalScreen(int terminalModel, String terminalType)` Construct a new GUI session with the specified terminalModel and terminalType.
`JTerminalScreen(String terminalType)` Construct a new GUI session with a model 2 (24x80) screen using either a 3278, 3279, or 3279-E terminalType.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`beep()` This method is called when the host application sends the beep command.
`void`	`broadcastMessage(String msg)` This method is called when the SessionServer admin sends a broadcast message to all currently connected clients.
`void`	`clear()`
`void`	`connect(String host, int port)`
`void`	`connect(String host, int port, boolean encryption)`
`void`	`connect(String host, int port, String host3270, int port3270, boolean encryption)` Opens a connection to the destination terminal server host.
`void`	`cursorMove(int oldPos, int newPos)` This method is called when the cursor position (current buffer position) of the 3270 engine is changed by host commands or by user input.
`void`	`disconnect()`
`void`	`enter()`
`RW3270`	`getRW3270()`
`void`	`incomingData()` Is called by the 3270 telnet engine when it has received new data.
`void`	`keyPressed(KeyEvent evt)` Processess non-character keyboard events.
`void`	`keyReleased(KeyEvent evt)` To satisfy interface declarations.
`void`	`keyTyped(KeyEvent evt)`
`void`	`mouseClicked(MouseEvent e)` Dispatches mouse event.
`void`	`mouseDragged(MouseEvent e)`
`void`	`mousePressed(MouseEvent e)`
`void`	`mouseReleased(MouseEvent e)`
`void`	`PA(int paKey)`
`protected void`	`paintChar(RW3270Char c)` Paints a char on the terminal panel.
`protected void`	`paintComponent(Graphics g)` Paints backgoround buffered image on the given graphics context.
`void`	`paintCursor(int pos)`
`void`	`paintStatus()`
`void`	`paintWindowMessage()` Paints a message on the screen.
`int`	`print(Graphics graphics, PageFormat pageFormat, int pageIndex)`
`void`	`renderScreen()` Renders a terminal screen on the buffered image graphics context.
`void`	`run()`
`void`	`setBackgroundColor(Color c)`
`void`	`setBoldColor(Color c)`
`void`	`setCurrentPosition(int newPos)`
`void`	`setFont(Font newFont)` Sets the font used to draw the screen.
`void`	`setForegroundColor(Color c)`
`void`	`setStatus(String statusMessage)` Sets current status message and calls components `repaint` method to make the new status message visible.
`void`	`setWindowMessage(int msg)`
`void`	`setWindowMessage(String msg)`
`void`	`status(int status)` This method is called by the 3270 engine to communicate status changes to the client.

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, doLayout, 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
  - DEFAULT_WIDTH
```
public static final int DEFAULT_WIDTH
```
    The default width of the panel. Should be overriden upon panel initialization or font size change.
    
    See Also:
    Constant Field Values
  - DEFAULT_HEIGHT
```
public static final int DEFAULT_HEIGHT
```
    The default height of the panel.
    
    See Also:
    DEFAULT_WIDTH, Constant Field Values
  - DEFAULT_FONT_SIZE
```
public static final int DEFAULT_FONT_SIZE
```
    Default size of the screen font.
    
    See Also:
    Constant Field Values
  - DEFAULT_FONT
```
public static final Font DEFAULT_FONT
```
    Default font used to draw terminal.
  - DEFAULT_FG_COLOR
```
public static final Color DEFAULT_FG_COLOR
```
    Default terminal foreground color.
  - DEFAULT_BG_COLOR
```
public static final Color DEFAULT_BG_COLOR
```
    Default terminal background color.
  - DEFAULT_BOLD_COLOR
```
public static final Color DEFAULT_BOLD_COLOR
```
    Default font color used to render bold text.
  - DEFAULT_CURSOR_COLOR
```
public static final Color DEFAULT_CURSOR_COLOR
```
    Default color used to render cursor pointer on the terminal screen.
  - DEFAULT_FIELD_BG_COLOR
```
public static final Color DEFAULT_FIELD_BG_COLOR
```
    Default input field background color.
  - MARGIN_LEFT
```
public static final int MARGIN_LEFT
```
    See Also:
    Constant Field Values
  - MARGIN_TOP
```
public static final int MARGIN_TOP
```
    See Also:
    Constant Field Values
- Constructor Detail
  - JTerminalScreen
```
public JTerminalScreen()
```
    Construct a new GUI session with a terminalModel of 2, and a terminalType of 3279-E.
  - JTerminalScreen
```
public JTerminalScreen(int terminalModel,
               String terminalType)
```
    Construct a new GUI session with the specified terminalModel and terminalType.
    
    Parameters:
    terminalModel -
    terminalType -
  - JTerminalScreen
```
public JTerminalScreen(int terminalModel)
```
    Construct a new GUI session with a 3279-E terminalType and the specified model where 2 <= terminalModel <= 5.
    
    Parameters:
    terminalModel -
  - JTerminalScreen
```
public JTerminalScreen(String terminalType)
```
    Construct a new GUI session with a model 2 (24x80) screen using either a 3278, 3279, or 3279-E terminalType.
    
    Parameters:
    terminalType -
- Method Detail
  - beep
```
public void beep()
```
    Description copied from interface: RWTnAction
    This method is called when the host application sends the beep command. It should fire some sort of audible alarm on the client's system. For example:
```
 public void beep() {
    Toolkit.getDefaultToolkit().beep();
 }
 
```
    Specified by:
    
    beep in interface RWTnAction
  - broadcastMessage
```
public void broadcastMessage(String msg)
```
    Description copied from interface: RWTnAction
    
    This method is called when the SessionServer admin sends a broadcast message to all currently connected clients.
    If you're implementing Broadcast Messaging in your client, this method should paint String msg to the client's screen.
    
    Specified by:
    
    broadcastMessage in interface RWTnAction
    
    Parameters:
    msg - The broadcast message from the system administrator.
  - connect
```
public void connect(String host,
           int port,
           String host3270,
           int port3270,
           boolean encryption)
```
    Opens a connection to the destination terminal server host.
    
    Parameters:
    host - the host name or IP address of the SessionServer
    port - the SessionServer's port
    host3270 - the host name or IP address of the 3270 host. (If using SessionServer)
    port3270 - the port of the 3270 host
    encryption - true if encryption should be used, false otherwise.
  - connect
```
public void connect(String host,
           int port)
             throws IOException,
                    UnknownHostException
```
    Throws:
    
    IOException
    
    UnknownHostException
  - connect
```
public void connect(String host,
           int port,
           boolean encryption)
             throws IOException,
                    UnknownHostException
```
    Throws:
    
    IOException
    
    UnknownHostException
  - cursorMove
```
public void cursorMove(int oldPos,
              int newPos)
```
    Description copied from interface: RWTnAction
    
    This method is called when the cursor position (current buffer position) of the 3270 engine is changed by host commands or by user input. When drawing the cursor to the client's display, use this method to fire cursor draw logic.
    This is useful for 'undrawing' the cursor before drawing it in its new position. The position is returned as an integer value between 0 (first character position) and len(dataBuffer) - 1 (last character position). For example using 3270 Model 2. The value would be between 0 and 1919.
    
    Specified by:
    
    cursorMove in interface RWTnAction
    
    Parameters:
    oldPos - The previous cursor position.
    newPos - The new (current) cursor position.
  - disconnect
```
public void disconnect()
```
  - getRW3270
```
public RW3270 getRW3270()
```
  - incomingData
```
public void incomingData()
```
    Description copied from interface: RWTnAction
    
    Is called by the 3270 telnet engine when it has received new data.
    This method would usually call a paint() method or other display update. Note: this method is useful when the client implementation is stateful. If the 3270 engine does not have direct access to the user's display, the RW3270.waitForNewData() method will suspend the calling thread until new data arrives.
    
    Specified by:
    
    incomingData in interface RWTnAction
  - PA
```
public void PA(int paKey)
```
  - enter
```
public void enter()
```
  - clear
```
public void clear()
```
  - keyPressed
```
public void keyPressed(KeyEvent evt)
```
    Processess non-character keyboard events. All control, meta, escape arrow key typed events are processed here.
    
    Specified by:
    
    keyPressed in interface KeyListener
    
    Parameters:
    evt - DOCUMENT ME!
  - keyReleased
```
public void keyReleased(KeyEvent evt)
```
    To satisfy interface declarations.
    
    Specified by:
    
    keyReleased in interface KeyListener
    
    Parameters:
    evt - DOCUMENT ME!
  - keyTyped
```
public void keyTyped(KeyEvent evt)
```
    Specified by:
    
    keyTyped in interface KeyListener
  - mouseClicked
```
public void mouseClicked(MouseEvent e)
```
    Dispatches mouse event. In case if BUTTON1 is clicked, moves terminal cursor to the character, on which the mouse event occured.
    
    Parameters:
    e - DOCUMENT ME!
  - mousePressed
```
public void mousePressed(MouseEvent e)
```
  - mouseReleased
```
public void mouseReleased(MouseEvent e)
```
  - mouseDragged
```
public void mouseDragged(MouseEvent e)
```
  - paintCursor
```
public void paintCursor(int pos)
```
  - paintStatus
```
public void paintStatus()
```
  - paintWindowMessage
```
public void paintWindowMessage()
```
    Paints a message on the screen.
  - renderScreen
```
public void renderScreen()
```
    Renders a terminal screen on the buffered image graphics context.
  - run
```
public void run()
```
  - setBackgroundColor
```
public void setBackgroundColor(Color c)
```
  - setBoldColor
```
public void setBoldColor(Color c)
```
  - setFont
```
public void setFont(Font newFont)
```
    Sets the font used to draw the screen. Based on the given font metrics, changes screen size in case if the background rendering buffer is not null.
    
    Overrides:
    
    setFont in class JComponent
    
    Parameters:
    newFont - the new font to use for rendering terminal screen.
  - setForegroundColor
```
public void setForegroundColor(Color c)
```
  - setStatus
```
public void setStatus(String statusMessage)
```
    Sets current status message and calls components repaint method to make the new status message visible.
    
    Parameters:
    statusMessage - DOCUMENT ME!
  - setCurrentPosition
```
public void setCurrentPosition(int newPos)
```
  - setWindowMessage
```
public void setWindowMessage(int msg)
```
  - setWindowMessage
```
public void setWindowMessage(String msg)
```
  - status
```
public void status(int status)
```
    Description copied from interface: RWTnAction
    This method is called by the 3270 engine to communicate status changes to the client. The possible values for int are outlined in the constants for this field.
    - RWtnAction.DISCONNECTED_BY_REMOTE_HOST: This status message indicates that the connection to the host was lost.
    - RWTnAction.CONNECTION_ERROR: This status message that there was a problem connecting to the SessionServer or that the SessionServer had trouble connecting to the 3270 host.
    - RWTnAction.X_WAIT: This status message means the 3270 engine is waiting for a response from the 3270 host.
    - RWTnAction.READY: This status message means the 3270 engine is ready for input from the client implementation.
    Specified by:
    
    status in interface RWTnAction
    
    Parameters:
    status - The status message
  - paintChar
```
protected void paintChar(RW3270Char c)
```
    Paints a char on the terminal panel.
    
    Parameters:
    c - DOCUMENT ME!
  - paintComponent
```
protected void paintComponent(Graphics g)
```
    Paints backgoround buffered image on the given graphics context.
    
    Overrides:
    
    paintComponent in class JComponent
    
    Parameters:
    g - DOCUMENT ME!
  - print
```
public int print(Graphics graphics,
        PageFormat pageFormat,
        int pageIndex)
          throws PrinterException
```
    Specified by:
    
    print in interface Printable
    
    Throws:
    
    PrinterException

Class JTerminalScreen

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface net.sf.freehost3270.client.RWTnAction

Fields inherited from interface java.awt.print.Printable

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_WIDTH

DEFAULT_HEIGHT

DEFAULT_FONT_SIZE

DEFAULT_FONT

DEFAULT_FG_COLOR

DEFAULT_BG_COLOR

DEFAULT_BOLD_COLOR

DEFAULT_CURSOR_COLOR

DEFAULT_FIELD_BG_COLOR

MARGIN_LEFT

MARGIN_TOP

Constructor Detail

JTerminalScreen

JTerminalScreen

JTerminalScreen

JTerminalScreen

Method Detail

beep

broadcastMessage

connect

connect

connect

cursorMove

disconnect

getRW3270

incomingData

PA

enter

clear

keyPressed

keyReleased

keyTyped

mouseClicked

mousePressed

mouseReleased

mouseDragged

paintCursor

paintStatus

paintWindowMessage

renderScreen

run

setBackgroundColor

setBoldColor

setFont

setForegroundColor

setStatus

setCurrentPosition

setWindowMessage

setWindowMessage

status

paintChar

paintComponent

print