fr.cnes.genius.lowLevel

Class GCheckBox

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GCheckBox

All Implemented Interfaces:

GClear, GDisplay, GReadWrite, ActionListener, MouseWheelListener, EventListener

public class GCheckBox
extends GComponent
implements GDisplay, GReadWrite, ActionListener, GClear

Class representing a checkbox widget. The widget can load/save to file. When selected the value is loaded/saved as "true", in other case it is set to "false".

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

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
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.
boolean	getDefaultValue() Getter for the selection by default.
JCheckBox	getJCheckBox() Get the internal Swing checkbox.
String	getText() Return the text associated with the checkbox.
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	setDefaultValue(boolean value) Setter for the selection by default.
void	setSelected(boolean b) Set the selection status of the widget.
void	setShortcut(int shorcutKey) Set the shortcut key for selecting the checkbox.
void	write() Implementaion of the routines that allow the component to be saved to a configuration file.

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, setEnabled, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, 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

GCheckBox

public GCheckBox(String label)

Constructor. The widget id is assigned automatically.

Parameters:

label - for the checkbox.

GCheckBox

public GCheckBox(String widgetId,
                 String label)

Constructor.

Parameters:

widgetId - identifier of the widget.

label - for the checkbox.

Method Detail

setDefaultValue

public void setDefaultValue(boolean value)

Setter for the selection by default.

Parameters:

value - true if CheckBox is selected by default.

getDefaultValue

public boolean getDefaultValue()

Getter for the selection by default.

Returns:

true if CheckBox is selected by default.

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

display

public void display()

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

getComponent

public Component getComponent()

Description copied from class: GComponent

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.

getJCheckBox

public JCheckBox getJCheckBox()

Get the internal Swing checkbox.

Returns:

internal Swing checkbox.

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.

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.

getText

public String getText()

Return the text associated with the checkbox.

Returns:

the text associated with the checkbox.

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.

setShortcut

public void setShortcut(int shorcutKey)

Set the shortcut key for selecting the checkbox.

Parameters:

shorcutKey - the shortcut key to be attached to the checkbox.