mikera.gui

Class JConsole

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

mikera.gui.JConsole

All Implemented Interfaces:

HierarchyListener, ImageObserver, MenuContainer, Serializable, EventListener

public class JConsole
extends JComponent
implements HierarchyListener

Class implementing a Swing-based text console Principles: - provides a fixed number of rows and columns, but can be resized - each cell can have its own foreground and background colour - The main font determines the grid size

Author:

Mike Anderson

See Also:

Serialized Form

Nested Class Summary

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 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
JConsole(int columns, int rows)

Method Summary

Methods

Modifier and Type	Method and Description
void	addNotify()
void	captureStdOut() Redirects System.out to this console by calling System.setOut
void	clear()
void	clearScreen()
void	fillArea(char c, Color fg, Color bg, int column, int row, int width, int height)
Color	getBackground()
Color	getBackgroundAt(int column, int row)
char	getCharAt(int column, int row)
int	getColumns()
int	getCursorX()
int	getCursorY()
Font	getFontAt(int column, int row)
int	getFontHeight()
int	getFontWidth()
Color	getForeground()
Color	getForegroundAt(int column, int row)
int	getRows()
void	hierarchyChanged(HierarchyEvent e)
protected void	init(int columns, int rows) Initialises the console to a specified size
void	paintComponent(Graphics graphics)
void	removeNotify()
void	repaintArea(int column, int row, int width, int height) Fires a repaint event on a specified rectangle of characters in the console
void	resetCursor()
void	resize(int columns, int rows)
void	setBackground(Color c)
void	setBlinkDelay(int millis)
void	setColumns(int columns)
void	setCursorBlink(boolean blink)
void	setCursorPos(int column, int row)
void	setCursorVisible(boolean visible)
void	setFont(Font f)
void	setForeground(Color c)
void	setMainFont(Font font) Sets the main font of the console, which is used to determine the size of characters
void	setRows(int rows)
void	write(char c)
void	write(String string)
void	write(String string, Color foreGround, Color backGround)
void	writeln(String line)

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, 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, 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, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, 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, 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

Constructor Detail

JConsole

public JConsole(int columns,
        int rows)

Method Detail

setMainFont

public void setMainFont(Font font)

Sets the main font of the console, which is used to determine the size of characters

Parameters:

font -

setCursorBlink

public void setCursorBlink(boolean blink)

setBlinkDelay

public void setBlinkDelay(int millis)

addNotify

public void addNotify()

Overrides:

addNotify in class JComponent

removeNotify

public void removeNotify()

Overrides:

removeNotify in class JComponent

setRows

public void setRows(int rows)

setFont

public void setFont(Font f)

Overrides:

setFont in class JComponent

setCursorVisible

public void setCursorVisible(boolean visible)

getRows

public int getRows()

setColumns

public void setColumns(int columns)

getColumns

public int getColumns()

getFontWidth

public int getFontWidth()

getFontHeight

public int getFontHeight()

repaintArea

public void repaintArea(int column,
               int row,
               int width,
               int height)

Fires a repaint event on a specified rectangle of characters in the console

init

protected void init(int columns,
        int rows)

Initialises the console to a specified size

resize

public void resize(int columns,
          int rows)

Overrides:

resize in class Component

clear

public void clear()

resetCursor

public void resetCursor()

clearScreen

public void clearScreen()

paintComponent

public void paintComponent(Graphics graphics)

Overrides:

paintComponent in class JComponent

setCursorPos

public void setCursorPos(int column,
                int row)

getCursorX

public int getCursorX()

getCursorY

public int getCursorY()

setForeground

public void setForeground(Color c)

Overrides:

setForeground in class JComponent

setBackground

public void setBackground(Color c)

Overrides:

setBackground in class JComponent

getForeground

public Color getForeground()

Overrides:

getForeground in class Component

getBackground

public Color getBackground()

Overrides:

getBackground in class Component

getCharAt

public char getCharAt(int column,
             int row)

getForegroundAt

public Color getForegroundAt(int column,
                    int row)

getBackgroundAt

public Color getBackgroundAt(int column,
                    int row)

getFontAt

public Font getFontAt(int column,
             int row)

captureStdOut

public void captureStdOut()

Redirects System.out to this console by calling System.setOut

write

public void write(char c)

writeln

public void writeln(String line)

write

public void write(String string,
         Color foreGround,
         Color backGround)

write

public void write(String string)

fillArea

public void fillArea(char c,
            Color fg,
            Color bg,
            int column,
            int row,
            int width,
            int height)

hierarchyChanged

public void hierarchyChanged(HierarchyEvent e)

Specified by:

hierarchyChanged in interface HierarchyListener