org.openbp.swing.components
Class JConsole

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JScrollPane
                  org.openbp.swing.components.JConsole

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.ScrollPaneConstants

public class JConsole
extends javax.swing.JScrollPane

This component can redirect output/input from various output/input streams to/from the document of the text pane. It can be used to redirect e. g. System.out/err/in to the text pane.

Author:

Heiko Erhardt

See Also:

Serialized Form

Nested Class Summary

protected class	JConsole.GUIMappedInputStream This output stream reads all input data from a component.
protected class	JConsole.GUIMappedOutputStream This output stream writes all output data to a text component.

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

javax.swing.JScrollPane.AccessibleJScrollPane, javax.swing.JScrollPane.ScrollBar

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JScrollPane

columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport

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 javax.swing.ScrollPaneConstants

COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

JConsole()
Default constructor.

Method Summary

JConsole.GUIMappedInputStream	createInputStream() Creates an input stream that reads its input from this component.
JConsole.GUIMappedOutputStream	createOutputStream() Creates an output stream that writes it output into this component.
JConsole.GUIMappedOutputStream	createOutputStream(java.io.OutputStream forwardTo) Creates an output stream that writes it output into this component.
JConsole.GUIMappedOutputStream	createOutputStream(java.io.OutputStream forwardTo, java.awt.Color color) Creates an output stream that writes it output into this component.
JConsole.GUIMappedOutputStream	createOutputStream(java.io.OutputStream forwardTo, java.awt.Color color, java.awt.Font font) Creates an output stream that writes it output into this component.
void	flush() Clears the text of the component.
javax.swing.JTextPane	getTextPane() Gets the text pane.
void	mapAll(boolean passThrough) Redirects the system output, error and input streams to this component.
java.io.PrintStream	mapSystemErr(boolean passThrough) Redirects the system error stream to this component.
java.io.InputStream	mapSystemIn() Redirects the system input stream to this component.
java.io.PrintStream	mapSystemOut(boolean passThrough) Redirects the system output stream to this component.
void	unmapAll() Reset the redirections caused by the mapAll(boolean) method.
void	writeText(java.lang.String text) Writes text to the console.
void	writeText(java.lang.String text, javax.swing.text.MutableAttributeSet attributeSet) Writes text to the console.

Methods inherited from class javax.swing.JScrollPane

createHorizontalScrollBar, createVerticalScrollBar, createViewport, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, paramString, setColumnHeader, setColumnHeaderView, setComponentOrientation, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setViewportView, setWheelScrollingEnabled, 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, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, 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, setFont, 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, transferFocusBackward, 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, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

JConsole

public JConsole()

Default constructor.

Method Detail

mapAll

public void mapAll(boolean passThrough)

Redirects the system output, error and input streams to this component.

Parameters:

passThrough - true Data written to System.out or System.err will also be echoed to the regular System.out/System.err stream
false Data written to System.out or System.err will appear only in this component.

unmapAll

public void unmapAll()

Reset the redirections caused by the mapAll(boolean) method.

mapSystemOut

public java.io.PrintStream mapSystemOut(boolean passThrough)

Redirects the system output stream to this component.

Parameters:

passThrough - true Data written to System.out will also be echoed to the regular System.out stream
false Data written to System.out will appear only in this component.

Returns:

The old value of System.out

mapSystemErr

public java.io.PrintStream mapSystemErr(boolean passThrough)

Redirects the system error stream to this component.

Parameters:

passThrough - true Data written to System.err will also be echoed to the regular System.err stream
false Data written to System.err will appear only in this component.

Returns:

The old value of System.err

mapSystemIn

public java.io.InputStream mapSystemIn()

Redirects the system input stream to this component.

Returns:

The old value of System.in

createOutputStream

public JConsole.GUIMappedOutputStream createOutputStream()

Creates an output stream that writes it output into this component.

Returns:

The new stream

createOutputStream

public JConsole.GUIMappedOutputStream createOutputStream(java.io.OutputStream forwardTo)

Creates an output stream that writes it output into this component.

Parameters:

forwardTo - If not null, the content written to the returned stream will also be echoed to this stream

Returns:

The new stream

createOutputStream

public JConsole.GUIMappedOutputStream createOutputStream(java.io.OutputStream forwardTo,
                                                         java.awt.Color color)

Creates an output stream that writes it output into this component.

Parameters:

forwardTo - If not null, the content written to the returned stream will also be echoed to this stream

color - Output text color for this stream

Returns:

The new stream

createOutputStream

public JConsole.GUIMappedOutputStream createOutputStream(java.io.OutputStream forwardTo,
                                                         java.awt.Color color,
                                                         java.awt.Font font)

Creates an output stream that writes it output into this component.

Parameters:

forwardTo - If not null, the content written to the returned stream will also be echoed to this stream

color - Output text color for this stream

font - Output font for this stream

Returns:

The new stream

createInputStream

public JConsole.GUIMappedInputStream createInputStream()

Creates an input stream that reads its input from this component.

Returns:

The new stream

flush

public void flush()

Clears the text of the component.

writeText

public void writeText(java.lang.String text)

Writes text to the console.

Parameters:

text - Text

writeText

public void writeText(java.lang.String text,
                      javax.swing.text.MutableAttributeSet attributeSet)

Writes text to the console.

Parameters:

text - Text

attributeSet - Attributes that should be given to the text or null to use default attributes

getTextPane

public javax.swing.JTextPane getTextPane()

Gets the text pane.