fr.cnes.genius.highLevel

Class GLabelWithIndicator

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GLabelWithIndicator

All Implemented Interfaces:

GDisplay, MouseWheelListener, EventListener

public class GLabelWithIndicator
extends GContainer
implements GDisplay

Class composed of a label, a "isModified" indicator and the icons to represent the status of another widget (OK, WARN, ERROR).

Author:

jjct

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabel	this.widgetId	"newline , split 2"
1	GLabel	indicator	(null)

Note:

The Item name of the first GLabel, containing the text, is equal to the one given to the GLabelWithIndicator 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
GLabelWithIndicator(String text) Constructor.
GLabelWithIndicator(String widgetId, String text) Constructor.

Method Summary

Modifier and Type	Method and Description
void	attachCopyPasteMenu(String label, GComponent.CopyPasteOperation... operationList) Attach the copy and paste menu to this component.
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.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
String	getText() Get the text of the label.
GComponent.CopyPasteOperation	isCopyPasteEvent(GEvent event) Checks if the event corresponds to one of the copy and paste menu operations.
boolean	isEnabled() Gets the enable status of the widget.
void	setCopyPasteMenuEnabled(boolean b) Set the enable status of the copy-paste menu associated to the component.
protected void	setDefaultConstraints() Set default constraints.
void	setEnabled(boolean flag) Set the enable status of the component.
static void	setErrorColor(Color errorColor) Setter of the ERROR color to update the status.
static void	setErrorIcon(ImageIcon errorIcon) Setter of the ERROR icon to update the status.
void	setIndicatorVisible(boolean flag) Set the isModified indicator to true.
void	setNominalColor(Color nominalColor) Setter of the label color when it is in OK status.
void	setStatus(GIntervalAbstract.GStatus status) Set the status of the widget.
void	setStringConstraint(String constraints) Set the constraint in string format for the component.
void	setText(String text) Sets the text of the label.
void	setToolTipText(String text) Empty method to be overwrite by the components at a higher level if needed.
static void	setWarningColor(Color warningColor) Setter of the WARNING color to update the status.
static void	setWarningIcon(ImageIcon warningIcon) Setter of the WARNING icon to update the status.
void	setWidgetId(String widgetId) Sets the widget identifier of the component.
protected void	updateIsModifiedIndicator() Updates the is modified indicator.
void	updateStatus() Update the status of the field applying the defined validity intervals.

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

put

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

activateConstraintsByType, 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, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setWidth, setWindowBusyCursor, 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

GLabelWithIndicator

public GLabelWithIndicator(String text)

Constructor. The widget identifier is assigned automatically.

Parameters:

text - for the label.

GLabelWithIndicator

public GLabelWithIndicator(String widgetId,
                           String text)

Constructor.

Parameters:

widgetId - widget identifier.

text - for the label.

Method Detail

setDefaultConstraints

protected final void setDefaultConstraints()

Description copied from class: GComponent

Set default constraints.

Overrides:

setDefaultConstraints in class GComponent

getSubComponent

public GComponent getSubComponent(int position)
                           throws GComponentException

Description copied from class: GComponent

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.

setWidgetId

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

setCopyPasteMenuEnabled

public void setCopyPasteMenuEnabled(boolean b)

Description copied from class: GComponent

Set the enable status of the copy-paste menu associated to the component.

Overrides:

setCopyPasteMenuEnabled in class GComponent

Parameters:

b - new enable status.

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.

setStatus

public void setStatus(GIntervalAbstract.GStatus status)

Description copied from class: GComponent

Set the status of the widget.

Overrides:

setStatus in class GComponent

Parameters:

status - the new status of the widget.

setText

public void setText(String text)

Sets the text of the label.

Parameters:

text - of the label.

getText

public String getText()

Get the text of the label.

Returns:

the text of the label.

getGLabel

public GLabel getGLabel()

Get the GLabel.

Returns:

the GLabel of the component.

setIndicatorVisible

public void setIndicatorVisible(boolean flag)

Set the isModified indicator to true.

Parameters:

flag - true if the indicator shall be displayed, false otherwise.

setErrorIcon

public static void setErrorIcon(ImageIcon errorIcon)

Setter of the ERROR icon to update the status.

Parameters:

errorIcon - to be set.

setWarningIcon

public static void setWarningIcon(ImageIcon warningIcon)

Setter of the WARNING icon to update the status.

Parameters:

warningIcon - to be set.

setErrorColor

public static void setErrorColor(Color errorColor)

Setter of the ERROR color to update the status.

Parameters:

errorColor - to be set.

setWarningColor

public static void setWarningColor(Color warningColor)

Setter of the WARNING color to update the status.

Parameters:

warningColor - to be set.

setNominalColor

public void setNominalColor(Color nominalColor)

Setter of the label color when it is in OK status.

Parameters:

nominalColor - to be set to the label.

updateStatus

public void updateStatus()

Update the status of the field applying the defined validity intervals.

setToolTipText

public void setToolTipText(String text)

Empty method to be overwrite by the components at a higher level if needed.

Overrides:

setToolTipText in class GComponent

Parameters:

text - to set in the tooltip.

attachCopyPasteMenu

public void attachCopyPasteMenu(String label,
                                GComponent.CopyPasteOperation... operationList)

Attach the copy and paste menu to this component. The operations can be choosen using the operationList parameter: Copy, Paste, Import, Export.

Overrides:

attachCopyPasteMenu in class GComponent

Parameters:

label - of the copy&paste menu, if null no label is displayed.

operationList - list of operations to set in the menu. Valid values are Copy if the "Copy" menu is available, Paste if the "Paste" menu is available, Import if the "Import" menu is available, and Export if the "Export" menu is available.

isCopyPasteEvent

public GComponent.CopyPasteOperation isCopyPasteEvent(GEvent event)

Checks if the event corresponds to one of the copy and paste menu operations.

Overrides:

isCopyPasteEvent in class GComponent

Parameters:

event - to check.

Returns:

the operation matching the event of null if the event do not correspond to the copy and paste menu.

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.

updateIsModifiedIndicator

protected void updateIsModifiedIndicator()

Updates the is modified indicator.

Overrides:

updateIsModifiedIndicator in class GComponent