fr.cnes.genius.lowLevel

Interface GTextAreaInterface

All Known Implementing Classes:

GBufferedTextArea, GConsole, GTextArea

public interface GTextAreaInterface

Interface defining the methods that shall be implemented by the classes that can subsititute a GTextArea in a GCommandLauncher, or a GConsole for example.

Author:

jjct

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.
JTextArea	getJTextArea() Get the JTextArea associated with the component.
void	reset() Called when the element is to be reset, so it can perform the actions required to return to inital state.
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	setLineWrap(boolean flag) Sets the specified boolean to indicate whether the lines are wrapped in the widget or not.

Method Detail

appendLine

void appendLine(String line)
         throws GException

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

Parameters:

line - to be appended to the text area.

Throws:

GException - in case of problem appending the line.

reset

void reset()
    throws GException

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

Throws:

GException - in case of problem while reseting the values.

getJTextArea

JTextArea getJTextArea()

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

Returns:

the JTextArea associated with the component.

setEditable

void setEditable(boolean b)

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

Parameters:

b - the boolean to be set

setCursorPositionAtBottom

void setCursorPositionAtBottom(boolean flag)

Set if the cursor shall be always at the bottom.

Parameters:

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

setLineWrap

void setLineWrap(boolean flag)

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

Parameters:

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