fr.cnes.genius.highLevel

Class GCheckBoxWithIndicator

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GCheckBoxWithIndicator

All Implemented Interfaces:

GClear, GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

public class GCheckBoxWithIndicator
extends GContainer
implements GDisplay, GReadWrite, GListener, GClear

Implements a GCheckBox with a GLabelWithIndicator.

Author:

jjct

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , split 2" 0, 1 => (null)
1	GCheckBox	checkbox	(null)

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
GCheckBoxWithIndicator() Constructor by default
GCheckBoxWithIndicator(String label, boolean isSelected) Constructor.
GCheckBoxWithIndicator(String widgetId, String label, boolean isSelected) Constructor.

Method Summary

Modifier and Type	Method and Description
void	after(GEvent e) Called after the event is processed.
void	attachCopyPasteMenu(String label, GComponent.CopyPasteOperation... operationList) Attach the copy and paste menu to this component.
void	before(GEvent e) Called before the event is processed.
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.
String	getCommentInConfigFile() Gets the comment to be set in the configuration file.
boolean	getDefaultValue() Get the default value of the checkBox.
GCheckBox	getGCheckBox() Return the GCheckBox component.
GLabelWithIndicator	getGLabelWithIndicator() Return the GLabel component.
String	getNameInConfigFile() Get the name to be used when saving the component in the configuration file.
boolean	getSavedValue() Get the saved value.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
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.
boolean	isModified() Gets the modification status of the component against the last set of values loaded or saved.
boolean	isSelected() Checks if the checkbox is selected.
void	read() Implementaion of the routines that allow the component to be loaded from a configuration file.
void	setCommentInConfigFile(String text) Sets the comment to be set in the configuration file.
void	setDefaultValue(boolean value) Change the default value of the checkBox.
void	setEnabled(boolean b) Set the enable status of the component.
void	setNameInConfigFile(String text) Sets the name to be used when saving the component in the configuration file.
void	setSavedValue(boolean value) Change the saved value.
void	setSelected(boolean b) Set the selection status of the widget.
void	setStringConstraint(String constraints) Set the constraints for the components.
void	setToolTipText(String text) Set the tooltip text for the entry's label.
void	setWidgetId(String widgetId) Sets the widget identifier of the component.
protected void	updateIsModifiedIndicator() Updates the is modified indicator.
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, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getComponent, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isForcedStatus, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setPathInConfigFile, setStatus, 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

GCheckBoxWithIndicator

public GCheckBoxWithIndicator()

Constructor by default

GCheckBoxWithIndicator

public GCheckBoxWithIndicator(String label,
                              boolean isSelected)

Constructor. The widget identifier is created automatically. The values of the choices correspond to their indexes.

Parameters:

label - to display on the side of the checkbox.

isSelected - if true, the checkbox will be selected or not, otherwise.

GCheckBoxWithIndicator

public GCheckBoxWithIndicator(String widgetId,
                              String label,
                              boolean isSelected)

Constructor. The values of the choices correspond to their indexes.

Parameters:

widgetId - widget identifier.

label - to display on the side of the checkbox.

isSelected - if true, the checkbox will be selected or not, otherwise.

Method Detail

setWidgetId

public void setWidgetId(String widgetId)

Sets the widget identifier of the component.

Overrides:

setWidgetId in class GComponent

Parameters:

widgetId - the widget identifier of the component.

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.

getGLabelWithIndicator

public GLabelWithIndicator getGLabelWithIndicator()

Return the GLabel component.

Returns:

the GLabel component.

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.

getGCheckBox

public GCheckBox getGCheckBox()

Return the GCheckBox component.

Returns:

the GCheckBox component.

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.

isSelected

public boolean isSelected()

Checks if the checkbox is selected.

Returns:

true if the checkbox is selected, false otherwise.

setSelected

public void setSelected(boolean b)

Set the selection status of the widget.

Parameters:

b - true if the checkbox is selected, false otherwise.

setDefaultValue

public void setDefaultValue(boolean value)

Change the default value of the checkBox.

Parameters:

value - default value to set.

getDefaultValue

public boolean getDefaultValue()

Get the default value of the checkBox.

Returns:

the default value of the checkBox.

setSavedValue

public void setSavedValue(boolean value)

Change the saved value.

Parameters:

value - new saved value.

getSavedValue

public boolean getSavedValue()

Get the saved value.

Returns:

the last saved value.

updateIsModifiedIndicator

protected void updateIsModifiedIndicator()

Updates the is modified indicator.

Overrides:

updateIsModifiedIndicator in class GComponent

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.

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.

write

public void write()
           throws GException

Description copied from interface: GReadWrite

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.

before

public void before(GEvent e)
            throws GException

Description copied from interface: GListener

Called before the event is processed.

Specified by:

before in interface GListener

Parameters:

e - event to processed.

Throws:

GException - in case there is a problem managing the event.

after

public void after(GEvent e)
           throws GException,
                  GFileManipulatorException

Description copied from interface: GListener

Called after the event is processed.

Specified by:

after in interface GListener

Parameters:

e - processed event.

Throws:

GException - in case there is a problem managing the event.

GFileManipulatorException

isEnabled

public boolean isEnabled()

Gets the enable status of the widget.

Overrides:

isEnabled in class GComponent

Returns:

true if the component is enabled, false otherwise.

setEnabled

public void setEnabled(boolean b)

Set the enable status of the component.

Overrides:

setEnabled in class GComponent

Parameters:

b - new enable status of the component.

isModified

public boolean isModified()

Description copied from class: GComponent

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.

clear

public void clear()
           throws GException

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

Throws:

GException - in case of problem while clearing the values.

setStringConstraint

public void setStringConstraint(String constraints)

Set the constraints for the components.

Overrides:

setStringConstraint in class GComponent

Parameters:

constraints - to set.

setNameInConfigFile

public final void setNameInConfigFile(String text)

Sets the name to be used when saving the component in the configuration file.

Overrides:

setNameInConfigFile in class GComponent

Parameters:

text - to be used when saving the component in the configuration file.

getNameInConfigFile

public String getNameInConfigFile()

Get the name to be used when saving the component in the configuration file.

Overrides:

getNameInConfigFile in class GComponent

Returns:

the name to be used when saving the component in the configuration file.

setCommentInConfigFile

public final void setCommentInConfigFile(String text)

Sets the comment to be set in the configuration file. To delete the comment set it to null.

Overrides:

setCommentInConfigFile in class GComponent

Parameters:

text - to be set in the configuration file.

getCommentInConfigFile

public String getCommentInConfigFile()

Gets the comment to be set in the configuration file.

Overrides:

getCommentInConfigFile in class GComponent

Returns:

the comment to be set in the configuration file.