Package apps

Class SystemConsole

java.lang.Object

apps.SystemConsole

public final class SystemConsole
extends Object

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.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
int	MAX_CONSOLE_LINES
(package private) static final ResourceBundle	rbc
static final int	WRAP_STYLE_LINE
static final int	WRAP_STYLE_NONE
static final int	WRAP_STYLE_WORD

Method Summary

Modifier and Type	Method	Description
void	close()	Stop logging System output and error streams to the console.
static JFrame	getConsole()	Return the JFrame containing the console
PrintStream	getErrorStream()
int	getFontSize()	Retrieve the current console font size (default 12 point)
int	getFontStyle()	Retrieve the current console font style
JFrame	getFrame()
static SystemConsole	getInstance()	Get current SystemConsole instance.
PrintStream	getOutputStream()
int	getScheme()	Retrieve the current console colour scheme
SystemConsole.Scheme[]	getSchemes()
int	getWrapStyle()	Retrieve the current console wrapping style
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 java.lang.Object

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

Field Details

rbc

static final 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 int MAX_CONSOLE_LINES

Method Details

getInstance

public static SystemConsole getInstance()

Get current SystemConsole instance. If one doesn't yet exist, create it.

Returns:

current SystemConsole instance

getConsole

public static JFrame getConsole()

Return the JFrame containing the console

Returns:

console JFrame

getFrame

public 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 PrintStream getOutputStream()

getErrorStream

public 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()