TerminalWindow (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - se.entra.phantom.common.TerminalWindow

All Implemented Interfaces:

ActionListener, ComponentListener, KeyListener, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener
```
public class TerminalWindow
extends JComponent
implements ActionListener, PropertyChangeListener, ComponentListener, KeyListener
```
This class creates and displays the terminal window inside a JComponent, typically a JFrame or JInternalFrame. It will create a status bar at the bottom, place the terminal window display on top and possibly with scroll bars around.
This class is used by the Clients, but also by the terminal window on the Server when running in GUI mode.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TerminalWindow.SetUp
- 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`TerminalWindow.SetUp`

Field Summary

Fields
Modifier and Type Field and Description

static int ATTR_UNDERLINE
Underline attribute.

Color[] cgaColors
The 16 CGA colors.

static boolean useBoldFonts
Use bold fonts.
- Fields inherited from class javax.swing.JComponent
  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
  accessibleContext, 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

Fields
Modifier and Type	Field and Description
`static int`	`ATTR_UNDERLINE` Underline attribute.
`Color[]`	`cgaColors` The 16 CGA colors.
`static boolean`	`useBoldFonts` Use bold fonts.

Constructor Summary

Constructors
Constructor and Description
`TerminalWindow(Container terminalParent, Container container, Color[] cgaColors, String ii, String im, String mw, String caps, String num, int cx, int cy, int x, int y, char[] cd, int[] ad, TerminalWindowListener listener)` The constructor creates the child components (terminal display with possible scroll bars and the status bar.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent e)` The action performed is actually a timer message and causes the cursor to flash.
`void`	`componentHidden(ComponentEvent e)` Invoked when the component has been made invisible.
`void`	`componentMoved(ComponentEvent e)` Invoked when the component's position changes.
`void`	`componentResized(ComponentEvent e)` Invoked when the component's size changes.
`void`	`componentShown(ComponentEvent e)` Invoked when the component has been made visible.
`void`	`dispose()` Disposes of this window.
`void`	`doLayout()` The component is resized.
`void`	`fillCharBackground(Graphics g, int xPos, int yPos, int x, int y, int cx, int cy)` Fills the background of a character position with the current color.
`Color`	`getBackground(Color background, int x, int y)` Gets the background color when drawing a character.
`Point`	`getCursorPoint()` Gets the current point of the cursor.
`int`	`getcxFont()` Gets the vertical font size.
`int`	`getcyFont()` Gets the horizontal font size.
`FieldPaintInterface.Fields`	`getFields(boolean inputOnly)` Gets all host fields defined in the current screen.
`Container`	`getFrame()`
`int`	`getLeftMargin()` Gets the left margin.
`Rectangle`	`getMark()` Get the current selected mark.
`Dimension`	`getMinimumSize()` Gets the minimum size of this component.
`MouseInterface`	`getMouseHandler()` Get the mouse handler.
`Dimension`	`getPreferredSize()` Gets the minimum size of this component.
`int`	`getScreenWidth()` Gets the screenWidth.
`String`	`getTerminalContent(int pos, int length)` Get the terminal character content in the indicated position.
`int`	`getTopMargin()` Gets the top margin.
`boolean`	`inInsertMode()` The insert mode can be read using this method, but it only checks the enabled state of the control in the status bar.
`void`	`initialize()` Perform any necessary initialization.
`static void`	`initializeFonts()` Initializes the fonts for the terminal window.
`boolean`	`isFocusTraversable()` The emulator window can receive input focus, and therefore returning true here.
`boolean`	`isLocked()` Checks if the lock state is present.
`boolean`	`isManagingFocus()` This method returns true because the emulator needs the Tab keys.
`void`	`keyPressed(KeyEvent e)` Special key pressed (CapsLock, NumLock).
`void`	`keyReleased(KeyEvent e)` Special key pressed (CapsLock, NumLock).
`void`	`keyTyped(KeyEvent e)` Special key pressed (CapsLock, NumLock).
`void`	`paint(Graphics g)` Paints the emulator window.
`void`	`postPaint(Graphics g, int xPos, int yPos, int x, int y, int cx, int cy)` Post-paints a character position as required.
`FieldPaintInterface.Field`	`probeHostField(int position)` Probe for host field.
`protected void`	`processFocusEvent(FocusEvent e)` The focus event.
`protected void`	`processKeyEvent(KeyEvent e)` Key events comes here.
`void`	`processKeyEvent0(KeyEvent e)` Key events comes here.
`protected void`	`processMouseEvent(MouseEvent e)` Processes mouse events.
`protected void`	`processMouseMotionEvent(MouseEvent e)` Processes mouse events.
`void`	`propertyChange(PropertyChangeEvent e)` Property change event processing to check for selection change (i.e.
`void`	`removeExcludedPopup()` Perform remove excluded pop-up window action in the editor.
`void`	`removeMark()` Removes the mouse marking area that currently exists.
`void`	`repaintComponent(JComponent jc)` Repaints a component and all its dirty regions using the Swing Repaint Manager.
`void`	`repaintStatusLine()` Repaints the status line.
`void`	`repaintText(int beginPos, int endPos)` Change of character/color data between two positions.
`void`	`selectAll()` Selects all text on the screen.
`void`	`sendHostKey(int key)` Sends a key to the terminal.
`void`	`setCursor(int x, int y)` Changes cursor position.
`void`	`setInsertMode(boolean on)` Sets the insert mode indicator.
`void`	`setLocked(boolean isLocked)` Sets the lock state.
`static void`	`setMouseExit(MouseInterface theMouseExit)` Sets a mouse exit.
`void`	`setNormalPainting(boolean on)` Sets normal painting or not (non-normal is when doing block-mode for the client part).
`static void`	`setPaintExit(PaintInterface paintExit)` Sets a paint exit.
`void`	`setScreenSize(int cx, int cy, char[] cd, int[] ad)` Sets the current screen size.
`void`	`setup(List<HotSpot>[] lineHotSpots)` Sets up the hot spots definition.
`void`	`setup(String p, String fn, int cursorHeight)` Sets up the terminal window with user settings.
`void`	`setup(TerminalWindow.SetUp setup)` Sets up the terminal window with user settings.
`void`	`setUsePrivateInsertMode(boolean on)` Sets the usage of private insert mode flag.

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, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, 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, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

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, getAccessibleContext, 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, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, 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, 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
  - useBoldFonts
```
public static boolean useBoldFonts
```
    Use bold fonts.
  - ATTR_UNDERLINE
```
public static final int ATTR_UNDERLINE
```
    Underline attribute.
    
    See Also:
    
    Constant Field Values
  - cgaColors
```
public Color[] cgaColors
```
    The 16 CGA colors.
- Constructor Detail
  - TerminalWindow
```
public TerminalWindow(Container terminalParent,
                      Container container,
                      Color[] cgaColors,
                      String ii,
                      String im,
                      String mw,
                      String caps,
                      String num,
                      int cx,
                      int cy,
                      int x,
                      int y,
                      char[] cd,
                      int[] ad,
                      TerminalWindowListener listener)
```
    The constructor creates the child components (terminal display with possible scroll bars and the status bar. It also starts to listen to keystrokes and focus changes.
- Method Detail
  - initializeFonts
```
public static void initializeFonts()
```
    Initializes the fonts for the terminal window.
  - dispose
```
public void dispose()
```
    Disposes of this window.
  - setup
```
public void setup(String p,
                  String fn,
                  int cursorHeight)
```
    Sets up the terminal window with user settings.
  - setup
```
public void setup(TerminalWindow.SetUp setup)
```
    Sets up the terminal window with user settings.
  - isFocusTraversable
```
public boolean isFocusTraversable()
```
    The emulator window can receive input focus, and therefore returning true here.
    
    Overrides:
    
    isFocusTraversable in class Component
  - isManagingFocus
```
public boolean isManagingFocus()
```
    This method returns true because the emulator needs the Tab keys.
    
    Overrides:
    
    isManagingFocus in class JComponent
  - getMinimumSize
```
public Dimension getMinimumSize()
```
    Gets the minimum size of this component.
    
    Overrides:
    
    getMinimumSize in class JComponent
  - getMouseHandler
```
public MouseInterface getMouseHandler()
```
    Get the mouse handler.
  - getTerminalContent
```
public String getTerminalContent(int pos,
                                 int length)
```
    Get the terminal character content in the indicated position.
  - getScreenWidth
```
public int getScreenWidth()
```
    Gets the screenWidth.
    
    Returns:
    
    int
  - getTopMargin
```
public int getTopMargin()
```
    Gets the top margin.
    
    Returns:
    
    int
  - getLeftMargin
```
public int getLeftMargin()
```
    Gets the left margin.
    
    Returns:
    
    int
  - getcxFont
```
public int getcxFont()
```
    Gets the vertical font size.
    
    Returns:
    
    int
  - getcyFont
```
public int getcyFont()
```
    Gets the horizontal font size.
    
    Returns:
    
    int
  - getPreferredSize
```
public Dimension getPreferredSize()
```
    Gets the minimum size of this component.
    
    Overrides:
    
    getPreferredSize in class JComponent
  - doLayout
```
public void doLayout()
```
    The component is resized. This method finds the best matching font size that can display the "entire" window.
    
    Overrides:
    
    doLayout in class Container
  - processFocusEvent
```
protected void processFocusEvent(FocusEvent e)
```
    The focus event.
    
    Overrides:
    
    processFocusEvent in class Component
  - propertyChange
```
public void propertyChange(PropertyChangeEvent e)
```
    Property change event processing to check for selection change (i.e. if another internal frame gets selected).
    
    Specified by:
    
    propertyChange in interface PropertyChangeListener
  - processKeyEvent
```
protected void processKeyEvent(KeyEvent e)
```
    Key events comes here.
    
    Overrides:
    
    processKeyEvent in class JComponent
  - processKeyEvent0
```
public void processKeyEvent0(KeyEvent e)
```
    Key events comes here.
  - getFrame
```
public Container getFrame()
```
  - getCursorPoint
```
public Point getCursorPoint()
```
    Gets the current point of the cursor.
  - processMouseEvent
```
protected void processMouseEvent(MouseEvent e)
```
    Processes mouse events.
    
    Overrides:
    
    processMouseEvent in class JComponent
  - processMouseMotionEvent
```
protected void processMouseMotionEvent(MouseEvent e)
```
    Processes mouse events.
    
    Overrides:
    
    processMouseMotionEvent in class JComponent
  - removeMark
```
public void removeMark()
```
    Removes the mouse marking area that currently exists.
  - probeHostField
```
public FieldPaintInterface.Field probeHostField(int position)
```
    Probe for host field.
    
    Parameters:
    
    position - Field position.
    
    Returns:
    
    Field
  - selectAll
```
public void selectAll()
```
    Selects all text on the screen.
  - setPaintExit
```
public static void setPaintExit(PaintInterface paintExit)
```
    Sets a paint exit.
  - setMouseExit
```
public static void setMouseExit(MouseInterface theMouseExit)
```
    Sets a mouse exit.
  - paint
```
public void paint(Graphics g)
```
    Paints the emulator window.
    
    Overrides:
    
    paint in class JComponent
  - getBackground
```
public Color getBackground(Color background,
                           int x,
                           int y)
```
    Gets the background color when drawing a character.
    
    Returns:
    
    The color to use or null for default background color.
  - getFields
```
public FieldPaintInterface.Fields getFields(boolean inputOnly)
```
    Gets all host fields defined in the current screen.
    
    Returns:
    
    Fields - null if not defined.
  - fillCharBackground
```
public void fillCharBackground(Graphics g,
                               int xPos,
                               int yPos,
                               int x,
                               int y,
                               int cx,
                               int cy)
```
    Fills the background of a character position with the current color.
  - postPaint
```
public void postPaint(Graphics g,
                      int xPos,
                      int yPos,
                      int x,
                      int y,
                      int cx,
                      int cy)
```
    Post-paints a character position as required.
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    The action performed is actually a timer message and causes the cursor to flash.
    
    Specified by:
    
    actionPerformed in interface ActionListener
  - setNormalPainting
```
public void setNormalPainting(boolean on)
```
    Sets normal painting or not (non-normal is when doing block-mode for the client part).
  - repaintComponent
```
public void repaintComponent(JComponent jc)
```
    Repaints a component and all its dirty regions using the Swing Repaint Manager. This method doesn't perform anything unless called directly from the AWT thread.
  - setCursor
```
public void setCursor(int x,
                      int y)
```
    Changes cursor position.
  - repaintText
```
public void repaintText(int beginPos,
                        int endPos)
```
    Change of character/color data between two positions.
  - repaintStatusLine
```
public void repaintStatusLine()
```
    Repaints the status line.
  - setLocked
```
public void setLocked(boolean isLocked)
```
    Sets the lock state.
  - isLocked
```
public boolean isLocked()
```
    Checks if the lock state is present.
  - setUsePrivateInsertMode
```
public void setUsePrivateInsertMode(boolean on)
```
    Sets the usage of private insert mode flag.
  - setInsertMode
```
public void setInsertMode(boolean on)
```
    Sets the insert mode indicator.
  - inInsertMode
```
public boolean inInsertMode()
```
    The insert mode can be read using this method, but it only checks the enabled state of the control in the status bar.
  - initialize
```
public void initialize()
```
    Perform any necessary initialization.
  - removeExcludedPopup
```
public void removeExcludedPopup()
```
    Perform remove excluded pop-up window action in the editor.
  - sendHostKey
```
public void sendHostKey(int key)
```
    Sends a key to the terminal.
    
    Parameters:
    
    key - The key to send.
  - getMark
```
public Rectangle getMark()
```
    Get the current selected mark.
    
    Returns:
    
    Rectangle
  - setScreenSize
```
public void setScreenSize(int cx,
                          int cy,
                          char[] cd,
                          int[] ad)
```
    Sets the current screen size.
  - componentHidden
```
public void componentHidden(ComponentEvent e)
```
    Invoked when the component has been made invisible.
    
    Specified by:
    
    componentHidden in interface ComponentListener
  - componentMoved
```
public void componentMoved(ComponentEvent e)
```
    Invoked when the component's position changes.
    
    Specified by:
    
    componentMoved in interface ComponentListener
  - componentResized
```
public void componentResized(ComponentEvent e)
```
    Invoked when the component's size changes.
    
    Specified by:
    
    componentResized in interface ComponentListener
  - componentShown
```
public void componentShown(ComponentEvent e)
```
    Invoked when the component has been made visible.
    
    Specified by:
    
    componentShown in interface ComponentListener
  - keyPressed
```
public void keyPressed(KeyEvent e)
```
    Special key pressed (CapsLock, NumLock).
    
    Specified by:
    
    keyPressed in interface KeyListener
  - keyReleased
```
public void keyReleased(KeyEvent e)
```
    Special key pressed (CapsLock, NumLock).
    
    Specified by:
    
    keyReleased in interface KeyListener
  - keyTyped
```
public void keyTyped(KeyEvent e)
```
    Special key pressed (CapsLock, NumLock).
    
    Specified by:
    
    keyTyped in interface KeyListener
  - setup
```
public void setup(List<HotSpot>[] lineHotSpots)
```
    Sets up the hot spots definition.

Class TerminalWindow

Nested Class Summary

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 java.awt.image.ImageObserver

Constructor Summary

Method Summary

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

useBoldFonts

ATTR_UNDERLINE

cgaColors

Constructor Detail

TerminalWindow

Method Detail

initializeFonts

dispose

setup

setup

isFocusTraversable

isManagingFocus

getMinimumSize

getMouseHandler

getTerminalContent

getScreenWidth

getTopMargin

getLeftMargin

getcxFont

getcyFont

getPreferredSize

doLayout

processFocusEvent

propertyChange

processKeyEvent

processKeyEvent0

getFrame

getCursorPoint

processMouseEvent

processMouseMotionEvent

removeMark

probeHostField

selectAll

setPaintExit

setMouseExit

paint

getBackground

getFields

fillCharBackground

postPaint

actionPerformed

setNormalPainting

repaintComponent

setCursor

repaintText

repaintStatusLine

setLocked

isLocked

setUsePrivateInsertMode

setInsertMode

inInsertMode

initialize

removeExcludedPopup

sendHostKey

getMark

setScreenSize

componentHidden

componentMoved

componentResized

componentShown

keyPressed

keyReleased

keyTyped

setup