fr.cnes.genius.lowLevel

Class GTextArea

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GTextArea

All Implemented Interfaces:

GTextAreaInterface, GClear, GDisplay, KeyListener, MouseWheelListener, EventListener

public class GTextArea
extends GComponent
implements KeyListener, GDisplay, GClear, GTextAreaInterface

Text area class derives from the JTextArea. The class defines an area of several lines of text. Generally this component is included in a GPanel object in order to get vertical and horizontal scroll bars.

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
GTextArea() Constructor.
GTextArea(String widgetId) Constructor.

Method Summary

Modifier and Type	Method and Description
void	append(String text) Appends the text to the text area.
void	appendLine(String line) Adds the text to the text area with adding a carriage return at the end.
void	appendNewLine() Adds an empty new line to the text area.
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.
Component	getComponent() Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
JTextArea	getJTextArea() Get the JTextArea associated with the component.
String	getText() Get the string of text area.
boolean	isCursorPositionAtBottom() Get if the cursor shall be always at the bottom.
boolean	isEditable() Returns the boolean indicating whether this TextComponent is editable or not.
void	keyPressed(KeyEvent e)
void	keyReleased(KeyEvent e)
void	keyTyped(KeyEvent ev)
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	setDefaultText(String text) Set the default string of text area.
void	setEditable(boolean b) Sets the specified boolean to indicate whether or not this TextComponent should be editable.
void	setEnabled(boolean flag) Set the enable status of the component.
void	setLineWrap(boolean flag) Sets the specified boolean to indicate whether the lines are wrapped in the widget or not.
void	setText(String text) Set the string of text area.
void	setToolTipText(String text) Set the tooltip text for the entry's label.

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

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, 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, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, 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

GTextArea

public GTextArea()

Constructor. The widget identifier is automatically created.

GTextArea

public GTextArea(String widgetId)

Constructor.

Parameters:

widgetId - widget identifier.

Method Detail

keyTyped

public void keyTyped(KeyEvent ev)

Specified by:

keyTyped in interface KeyListener

keyPressed

public void keyPressed(KeyEvent e)

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent e)

Specified by:

keyReleased in interface KeyListener

appendLine

public void appendLine(String line)

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.

appendNewLine

public void appendNewLine()

Adds an empty new line to the text area.

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

isEditable

public boolean isEditable()

Returns the boolean indicating whether this TextComponent is editable or not.

Returns:

the boolean value

append

public void append(String text)

Appends the text to the text area.

Parameters:

text - to be appended to the text area.

setEnabled

public void setEnabled(boolean flag)

Set the enable status of the component.

Overrides:

setEnabled in class GComponent

Parameters:

flag - new enable status of the component.

display

public 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.

Specified by:

display in interface GDisplay

getComponent

public Component getComponent()

Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.

Overrides:

getComponent in class GComponent

Returns:

the Swing Component encapsulated by the class if any, otherwise returns null.

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.

setText

public void setText(String text)

Set the string of text area.

Parameters:

text - the string of text area.

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.

setDefaultText

public void setDefaultText(String text)

Set the default string of text area.

Parameters:

text - the string of text area.

getText

public String getText()

Get the string of text area.

Returns:

the string of text area.

clear

public 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.

Specified by:

clear in interface GClear

setToolTipText

public void setToolTipText(String text)

Set the tooltip text for the entry's label.

Overrides:

setToolTipText in class GComponent

Parameters:

text - the tooltip text for the entry's label.

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.

isCursorPositionAtBottom

public boolean isCursorPositionAtBottom()

Get if the cursor shall be always at the bottom.

Returns:

if the cursor shall be always at the bottom.

reset

public void reset()

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