fr.cnes.genius.highLevel

Class GConsole

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GConsole

All Implemented Interfaces:

GTextAreaInterface, GClear, GDisplay, MouseWheelListener, EventListener

public class GConsole
extends GContainer
implements GDisplay, GClear, GTextAreaInterface

Specialized text area that can redirect the stdout and stderr from the current process.

Author:

jjct

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.genius.main.GComponent

GComponent.CopyPasteOperation, GComponent.DisplayIndicatorStatus, GComponent.ItemType, GComponent.Operation

Field Summary

Fields inherited from class fr.cnes.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GConsole() Constructor.
GConsole(String widgetId) Constructor.
GConsole(String widgetId, GTextAreaInterface textAreaInterface) Constructor.

Method Summary

Modifier and Type	Method and Description
void	appendLine(String line) Adds the text to the text area with adding a carriage return at the end.
void	clear() Called when the element is to be cleared, so it can perform the actions required to return to the last saved/loaded values.
void	display() Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.
void	generic() The prototype of the generic function that shall exist in all the descendants.
JTextArea	getJTextArea() Get the JTextArea associated with the component.
void	redirectSystemStreams(boolean redirectStdout, boolean redirectStderr) Redirect the standard output and/or the standard error streams to the GConsole object, using the UTF-8 encoding.
void	redirectSystemStreams(boolean redirectStdout, boolean redirectStderr, String encoding) Redirect the standard output and/or the standard error streams to the GConsole object.
void	reset() Called when the element is to be reset, so it can perform the actions required to return to inital state.
void	setConstraint(GConstraint constraint) Set the constraint for the component.
void	setCursorPositionAtBottom(boolean flag) Set if the cursor shall be always at the bottom.
void	setEditable(boolean b) Sets the specified boolean to indicate whether or not this TextComponent should be editable.
void	setInnerDescendantConstraint(GConstraint constraint, Integer... positionList) Set the constraint of the inner subcomponent.
void	setLineWrap(boolean flag) Sets the specified boolean to indicate whether the lines are wrapped in the widget or not.

Methods inherited from class fr.cnes.genius.lowLevel.GContainer

put

Methods inherited from class fr.cnes.genius.main.GComponent

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getComponent, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getSubComponent, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isEnabled, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setEnabled, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidgetId, setWidth, setWindowBusyCursor, updateIsModifiedIndicator, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem

Methods inherited from class java.lang.Object

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

Constructor Detail

GConsole

public GConsole()

Constructor. The widgetId will be created automatically.

GConsole

public GConsole(String widgetId)

Constructor.

Parameters:

widgetId - widget identifier.

GConsole

public GConsole(String widgetId,
                GTextAreaInterface textAreaInterface)

Constructor.

Parameters:

widgetId - widget identifier.

textAreaInterface - GTextAreaInterface to which the output and error will be sent, it can be null, in that case a GTextArea is created automatically. The objet shall extend GComponent if not a GRuntimeException will be launched.

Method Detail

redirectSystemStreams

public void redirectSystemStreams(boolean redirectStdout,
                                  boolean redirectStderr,
                                  String encoding)
                           throws UnsupportedEncodingException

Redirect the standard output and/or the standard error streams to the GConsole object.

Parameters:

redirectStdout - true if the stdout shall be redirected.

redirectStderr - true if the stderr shall be redirected.

encoding - to use for the redirection.

Throws:

UnsupportedEncodingException - if the encoding is not supported.

redirectSystemStreams

public void redirectSystemStreams(boolean redirectStdout,
                                  boolean redirectStderr)
                           throws UnsupportedEncodingException

Redirect the standard output and/or the standard error streams to the GConsole object, using the UTF-8 encoding.

Parameters:

redirectStdout - true if the stdout shall be redirected.

redirectStderr - true if the stderr shall be redirected.

Throws:

UnsupportedEncodingException - if the UTF-8 encoding is not supported.

generic

public void generic()
             throws GException

The prototype of the generic function that shall exist in all the descendants.

Specified by:

generic in class GContainer

Throws:

GException - In case of problem.

display

public void display()
             throws GException

Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.

Specified by:

display in interface GDisplay

Throws:

GException - in case of problem while reading the value from file.

appendLine

public void appendLine(String line)
                throws GException

Adds the text to the text area with adding a carriage return at the end.

Specified by:

appendLine in interface GTextAreaInterface

Parameters:

line - to be appended to the text area.

Throws:

GException - in case of problem appending the line.

reset

public void reset()
           throws GException

Called when the element is to be reset, so it can perform the actions required to return to inital state.

Specified by:

reset in interface GTextAreaInterface

Throws:

GException - in case of problem while reseting the values.

getJTextArea

public JTextArea getJTextArea()

Get the JTextArea associated with the component. If no JTextArea can be associated with the component a runtime exception is raised.

Specified by:

getJTextArea in interface GTextAreaInterface

Returns:

the JTextArea associated with the component.

setEditable

public void setEditable(boolean b)

Sets the specified boolean to indicate whether or not this TextComponent should be editable.

Specified by:

setEditable in interface GTextAreaInterface

Parameters:

b - the boolean to be set

setCursorPositionAtBottom

public void setCursorPositionAtBottom(boolean flag)

Set if the cursor shall be always at the bottom.

Specified by:

setCursorPositionAtBottom in interface GTextAreaInterface

Parameters:

flag - true it the cursor shall always be at the bottom of the text view, false otherwise.

setConstraint

public void setConstraint(GConstraint constraint)

Set the constraint for the component.

Overrides:

setConstraint in class GComponent

Parameters:

constraint - constraint to set for the component.

setInnerDescendantConstraint

public void setInnerDescendantConstraint(GConstraint constraint,
                                         Integer... positionList)

Set the constraint of the inner subcomponent.

Overrides:

setInnerDescendantConstraint in class GComponent

Parameters:

constraint - constraint to set.

positionList - the ordered subcomponent index.

setLineWrap

public void setLineWrap(boolean flag)

Sets the specified boolean to indicate whether the lines are wrapped in the widget or not.

Specified by:

setLineWrap in interface GTextAreaInterface

Parameters:

flag - true if the lines shall be wrapped, false otherwise.

clear

public void clear()
           throws GException

Called when the element is to be cleared, so it can perform the actions required to return to the last saved/loaded values.

Specified by:

clear in interface GClear

Throws:

GException - in case of problem while clearing the values.