java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.text.JTextComponent
      - javax.swing.JTextArea
        
        apps.SystemConsole

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable
```
public final class SystemConsole
extends javax.swing.JTextArea
```
Class to direct standard output and standard error to a ( JTextArea ) TextAreaFIFO . This allows for easier clipboard operations etc.
This file is part of JMRI.
JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.
JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`class`	`SystemConsole.PopupListener`	Class to deal with handling popup menu
`static class`	`SystemConsole.Scheme`	Class holding details of each scheme

Nested classes/interfaces inherited from class javax.swing.JTextArea
javax.swing.JTextArea.AccessibleJTextArea

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent
javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.DropLocation, javax.swing.text.JTextComponent.KeyBinding

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
Modifier and Type	Field	Description
`int`	`MAX_CONSOLE_LINES`
`(package private) static java.util.ResourceBundle`	`rbc`
`static int`	`WRAP_STYLE_LINE`
`static int`	`WRAP_STYLE_NONE`
`static int`	`WRAP_STYLE_WORD`

Fields inherited from class javax.swing.text.JTextComponent
DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`	Stop logging System output and error streams to the console.
`static void`	`create()`	Initialise the system console ensuring both System.out and System.err streams are re-directed to the consoles JTextArea
`static javax.swing.JFrame`	`getConsole()`	Return the JFrame containing the console
`java.io.PrintStream`	`getErrorStream()`
`int`	`getFontSize()`	Retrieve the current console font size (default 12 point)
`int`	`getFontStyle()`	Retrieve the current console font style
`javax.swing.JFrame`	`getFrame()`
`static SystemConsole`	`getInstance()`	Get current SystemConsole instance.
`java.io.PrintStream`	`getOutputStream()`
`int`	`getScheme()`	Retrieve the current console colour scheme
`SystemConsole.Scheme[]`	`getSchemes()`
`int`	`getWrapStyle()`	Retrieve the current console wrapping style
`static boolean`	`isCreated()`	Test if the default instance exists.
`void`	`open()`	Start logging System output and error streams to the console.
`void`	`setFontSize(int size)`	Set the console font size
`void`	`setFontStyle(int style)`	Set the console font style
`void`	`setScheme(int which)`	Set the console colour scheme
`void`	`setWrapStyle(int style)`	Set the console wrapping style to one of the following:

Methods inherited from class javax.swing.JTextArea
append, createDefaultModel, getAccessibleContext, getColumns, getColumnWidth, getLineCount, getLineEndOffset, getLineOfOffset, getLineStartOffset, getLineWrap, getPreferredScrollableViewportSize, getPreferredSize, getRowHeight, getRows, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getTabSize, getUIClassID, getWrapStyleWord, insert, paramString, replaceRange, setColumns, setFont, setLineWrap, setRows, setTabSize, setWrapStyleWord

Methods inherited from class javax.swing.text.JTextComponent
addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, modelToView2D, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDocument, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, viewToModel2D, write

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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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, 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, 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, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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
  - rbc
```
static final java.util.ResourceBundle rbc
```
  - WRAP_STYLE_NONE
```
public static final int WRAP_STYLE_NONE
```
    See Also:
    
    Constant Field Values
  - WRAP_STYLE_LINE
```
public static final int WRAP_STYLE_LINE
```
    See Also:
    
    Constant Field Values
  - WRAP_STYLE_WORD
```
public static final int WRAP_STYLE_WORD
```
    See Also:
    
    Constant Field Values
  - MAX_CONSOLE_LINES
```
public final int MAX_CONSOLE_LINES
```
    See Also:
    
    Constant Field Values
- Method Detail
  - create
```
public static void create()
```
    Initialise the system console ensuring both System.out and System.err streams are re-directed to the consoles JTextArea
  - getInstance
```
public static SystemConsole getInstance()
```
    Get current SystemConsole instance. If one doesn't yet exist, create it.
    
    Returns:
    
    current SystemConsole instance
  - isCreated
```
public static boolean isCreated()
```
    Test if the default instance exists.
    
    Returns:
    
    true if default instance exists; false otherwise
  - getConsole
```
public static javax.swing.JFrame getConsole()
```
    Return the JFrame containing the console
    
    Returns:
    
    console JFrame
  - getFrame
```
public javax.swing.JFrame getFrame()
```
  - setWrapStyle
```
public void setWrapStyle(int style)
```
    Set the console wrapping style to one of the following:
    Parameters:
    
    style - one of the defined style attributes - one of
    
    WRAP_STYLE_NONE No wrapping
    WRAP_STYLE_LINE Wrap at end of line
    WRAP_STYLE_WORD Wrap by word boundaries
  - getWrapStyle
```
public int getWrapStyle()
```
    Retrieve the current console wrapping style
    Returns:
    
    current wrapping style - one of
    
    WRAP_STYLE_NONE No wrapping
    WRAP_STYLE_LINE Wrap at end of line
    WRAP_STYLE_WORD Wrap by word boundaries (default)
  - setFontSize
```
public void setFontSize(int size)
```
    Set the console font size
    
    Parameters:
    
    size - point size of font between 6 and 24 point
  - getFontSize
```
public int getFontSize()
```
    Retrieve the current console font size (default 12 point)
    
    Returns:
    
    selected font size in points
  - setFontStyle
```
public void setFontStyle(int style)
```
    Set the console font style
    
    Parameters:
    
    style - one of Font.BOLD, Font.ITALIC, Font.PLAIN (default)
  - getFontStyle
```
public int getFontStyle()
```
    Retrieve the current console font style
    
    Returns:
    
    selected font style - one of Font.BOLD, Font.ITALIC, Font.PLAIN (default)
  - setScheme
```
public void setScheme(int which)
```
    Set the console colour scheme
    
    Parameters:
    
    which - the scheme to use
  - getOutputStream
```
public java.io.PrintStream getOutputStream()
```
  - getErrorStream
```
public java.io.PrintStream getErrorStream()
```
  - close
```
public void close()
```
    Stop logging System output and error streams to the console.
  - open
```
public void open()
```
    Start logging System output and error streams to the console.
  - getScheme
```
public int getScheme()
```
    Retrieve the current console colour scheme
    
    Returns:
    
    selected colour scheme
  - getSchemes
```
public SystemConsole.Scheme[] getSchemes()
```

Class SystemConsole

Nested Class Summary

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

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

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.text.JTextComponent

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Method Summary

Methods inherited from class javax.swing.JTextArea

Methods inherited from class javax.swing.text.JTextComponent

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

rbc

WRAP_STYLE_NONE

WRAP_STYLE_LINE

WRAP_STYLE_WORD

MAX_CONSOLE_LINES

Method Detail

create

getInstance

isCreated

getConsole

getFrame

setWrapStyle

getWrapStyle

setFontSize

getFontSize

setFontStyle

getFontStyle

setScheme

getOutputStream

getErrorStream

close

open

getScheme

getSchemes