fr.cnes.genius.highLevel

Class GTextAreaWithLabel

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GTextAreaWithLabel

All Implemented Interfaces:

GClear, GDisplay, GReadWrite, MouseWheelListener, EventListener

public class GTextAreaWithLabel
extends GContainer
implements GDisplay, GClear, GReadWrite

Class defining a textArea with a label.

Author:

jjct

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabel	label	"newline"
1	GTextArea	this.widgetId	"newline"

Note:

The Item name of the first GTextArea is equal to the one given to the GTextAreaWithLabel itself.

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
GTextAreaWithLabel() Constructor.
GTextAreaWithLabel(String widgetId) Constructor.
GTextAreaWithLabel(String widgetId, String label) Constructor.

Method Summary

Modifier and Type	Method and Description
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.
GLabel	getGLabel() Get the GLabel component.
GTextArea	getGTextArea() Get the GTextArea component.
String	getSavedValue() Get the saved value.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
boolean	isEnabled() Gets the enable status of the widget.
boolean	isModified() Gets the modification status of the component against the last set of values loaded or saved.
void	read() Implementaion of the routines that allow the component to be loaded from a configuration file.
protected void	setDefaultConstraints() Set default constraints.
void	setEnabled(boolean flag) Set the enable status of the component.
void	setStringConstraint(String constraints) Set the constraint in string format for the component.
void	setWidgetId(String widgetId) Sets the widget identifier of the component.
void	write() Implementaion of the routines that allow the component to be saved to a configuration file.

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, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isForcedStatus, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setToolTipText, 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

GTextAreaWithLabel

public GTextAreaWithLabel()

Constructor. The widget identifier will be automatically assigned.

GTextAreaWithLabel

public GTextAreaWithLabel(String widgetId)

Constructor.

Parameters:

widgetId - widget identifier.

GTextAreaWithLabel

public GTextAreaWithLabel(String widgetId,
                          String label)

Constructor.

Parameters:

widgetId - widget identifier.

label - for the text area.

Method Detail

setDefaultConstraints

protected void setDefaultConstraints()

Description copied from class: GComponent

Set default constraints.

Overrides:

setDefaultConstraints in class GComponent

getSubComponent

public GComponent getSubComponent(int position)
                           throws GComponentException

Gets the subcomponent occupying the position defined by position.

Overrides:

getSubComponent in class GComponent

Parameters:

position - position of the requested component.

Returns:

the subcomponent occupying the position defined by position.

Throws:

GComponentException - in case the position argument is invalid.

getGTextArea

public GTextArea getGTextArea()

Get the GTextArea component.

Returns:

the GTextArea component.

getGLabel

public GLabel getGLabel()

Get the GLabel component.

Returns:

the GLabel component.

setWidgetId

public void setWidgetId(String widgetId)

Description copied from class: GComponent

Sets the widget identifier of the component.

Overrides:

setWidgetId in class GComponent

Parameters:

widgetId - the widget identifier of the component.

generic

public void generic()
             throws GException

Description copied from class: GContainer

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

Description copied from interface: GDisplay

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.

setEnabled

public void setEnabled(boolean flag)

Description copied from class: GComponent

Set the enable status of the component.

Overrides:

setEnabled in class GComponent

Parameters:

flag - new enable status of the component.

isEnabled

public boolean isEnabled()

Description copied from class: GComponent

Gets the enable status of the widget.

Overrides:

isEnabled in class GComponent

Returns:

true if the component is enabled, false otherwise.

clear

public void clear()

Description copied from interface: GClear

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

setStringConstraint

public void setStringConstraint(String constraints)

Set the constraint in string format for the component.

Overrides:

setStringConstraint in class GComponent

Parameters:

constraints - constraint in string format to set for the component.

read

public void read()
          throws GException

Description copied from interface: GReadWrite

Implementaion of the routines that allow the component to be loaded from a configuration file.

Specified by:

read in interface GReadWrite

Throws:

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

isModified

public boolean isModified()

Gets the modification status of the component against the last set of values loaded or saved.

Overrides:

isModified in class GComponent

Returns:

the modification status of the component against the last set of values loaded or saved.

write

public void write()
           throws GException

Implementaion of the routines that allow the component to be saved to a configuration file.

Specified by:

write in interface GReadWrite

Throws:

GException - in case of problem while writing the value to file.

getSavedValue

public String getSavedValue()

Get the saved value.

Returns:

the saved value.