fr.cnes.genius.highLevel

Class GMultipleChoice

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GMultipleChoice

All Implemented Interfaces:

GClear, GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

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

Widget implementing a group of GCheckBox controls. The class allows a multiple choices among a list of options. This list is preceded by a label with the name. The different options are represented by GCheckBox objects. Each option has an associated integer value. By default, the associated value corresponds to the rank number in the list, but it is possible to associate arbitrary values. At any time, the list of choices can be modified dynamically by the application maker and the display is updated. The class allows also to save or to load to the configuration file.

Author:

jjct

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , split 2" 0, 1 => (null)
1	GCheckBox	checkBox0	"split 1"
2	GCheckBox	checkBox1	(null)
...	...	...	...
i+1	GCheckBox	checkBoxi	(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
GMultipleChoice() Constructor by default
GMultipleChoice(String label, int[] selectedValues, int[] valueList, String... labels) Constructor when values are identical to the index of the choices.The widget identifier is created automatically.
GMultipleChoice(String label, int[] selectedValues, String... labels) Constructor when values are identical to the index of the choices.The widget identifier is created automatically.
GMultipleChoice(String widgetId, String label, int[] selectedValues, int[] valueList, String... labels) Constructor when values are identical to the index of the choices.
GMultipleChoice(String widgetId, String label, int[] selectedValues, int[] valueList, String[] labels, String[] tooltips) Constructor when values are identical to the index of the choices.
GMultipleChoice(String widgetId, String label, int[] selectedValues, String... labels) Constructor when values are identical to the index of the choices.

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.
ArrayList<GCheckBox>	getGCheckBoxList() Get the array of GCheckBoxes associated with the component.
GLabelWithIndicator	getLabel() Get the GLabel associated with the component.
int[]	getSavedSelectedValueList() Get the last saved list of selected values.
int[]	getSelectedValues() Get the list of selected values.
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() Return the enable/disable status of the component.
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.
void	setDefaultValue(int[] values) Change the default list of selected values.
void	setDefaultValueList(int[] values, int[] valueList, String... labels) Change the default list of selected values, the value list and labels of the multiple choice.
void	setDefaultValueList(int[] values, int[] valueList, String[] labels, String[] tooltips) Change the default list of selected values, the value list and labels of the multiple choice.
void	setEnabled(boolean b) Set the enable/disable status of the component.
void	setSavedSelectedValueList(int[] values) Change the saved list of selected values of the multiple choice.
void	setSelectedValues(int[] selectedValues) Set the selected values of the component.
void	setShortcut(int... shorcutKeyList) Set the shortcut keys for selecting the corresponding value.
void	setStatusMessages(String okMess, String warnMess, String errorMess) Method to set the tooltip status messages
void	setStringConstraint(String constraints) Set the constraint in string format for the component.
void	setTooltipsList(String[] tooltipsList) Set the list of tooltips associated to each item in the GMultipleChoice.
void	setToolTipText(String text) Set the tooltip text for the entry's label.
void	setValueList(int[] selectedValues, int[] values, String... buttonsText) Change the list of values, the selected value list and the labels of the checkboxes.
void	setValueList(int[] selectedValues, int[] values, String[] buttonsText, String[] tooltips) Change the list of values, the selected value list and the labels of the checkboxes.
void	setValueList(int[] selectedValues, String... labels) Change the list of checkboxes labels and set the selected value.
protected void	updateIsModifiedIndicator() Updates the is modified indicator.
void	updateStatus() Update the status of the multiple choice depending on the selected values.
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, getCommentInConfigFile, getComponent, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isForcedStatus, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setWidgetId, 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

GMultipleChoice

public GMultipleChoice()

Constructor by default

GMultipleChoice

public GMultipleChoice(String widgetId,
                       String label,
                       int[] selectedValues,
                       String... labels)

Constructor when values are identical to the index of the choices.

Parameters:

widgetId - Widget identifier.

label - to display for the list of choices.

selectedValues - to be selected at construction.

labels - text of the different choices.

GMultipleChoice

public GMultipleChoice(String label,
                       int[] selectedValues,
                       String... labels)

Constructor when values are identical to the index of the choices.The widget identifier is created automatically.

Parameters:

label - to display for the list of choices.

selectedValues - to be selected at construction.

labels - text of the different choices.

GMultipleChoice

public GMultipleChoice(String label,
                       int[] selectedValues,
                       int[] valueList,
                       String... labels)

Constructor when values are identical to the index of the choices.The widget identifier is created automatically.

Parameters:

label - to display for the list of choices.

selectedValues - to be selected at construction.

valueList - list of values to associate to the different choices.

labels - text of the different choices.

GMultipleChoice

public GMultipleChoice(String widgetId,
                       String label,
                       int[] selectedValues,
                       int[] valueList,
                       String... labels)

Constructor when values are identical to the index of the choices.

Parameters:

widgetId - Widget identifier.

label - to display for the list of choices.

selectedValues - to be selected at construction.

valueList - list of values to associate to the different choices.

labels - text of the different choices.

GMultipleChoice

public GMultipleChoice(String widgetId,
                       String label,
                       int[] selectedValues,
                       int[] valueList,
                       String[] labels,
                       String[] tooltips)

Constructor when values are identical to the index of the choices.

Parameters:

widgetId - Widget identifier.

label - to display for the list of choices.

selectedValues - to be selected at construction.

valueList - list of values to associate to the different choices.

labels - text of the different choices.

tooltips - for the different choices.

Method Detail

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.

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.

isEnabled

public boolean isEnabled()

Return the enable/disable status of the component.

Overrides:

isEnabled in class GComponent

Returns:

true if the button is enabled, false otherwise.

setEnabled

public void setEnabled(boolean b)

Set the enable/disable status of the component.

Overrides:

setEnabled in class GComponent

Parameters:

b - if true the component is enabled, otherwise is disabled.

getSelectedValues

public int[] getSelectedValues()

Get the list of selected values.

Returns:

the array of selected values.

setSelectedValues

public void setSelectedValues(int[] selectedValues)

Set the selected values of the component. The corresponding CheckBoxes are automatically selected.

Parameters:

selectedValues - to set.

setValueList

public final void setValueList(int[] selectedValues,
                               int[] values,
                               String[] buttonsText,
                               String[] tooltips)

Change the list of values, the selected value list and the labels of the checkboxes.

Parameters:

selectedValues - new values to select.

values - new values list; it can be null if the values are the indexes of the elements in the checkboxes.

buttonsText - text of the different choices.

tooltips - for the different choices.

setValueList

public void setValueList(int[] selectedValues,
                         int[] values,
                         String... buttonsText)

Change the list of values, the selected value list and the labels of the checkboxes.

Parameters:

selectedValues - new values to select.

values - new values list; it can be null if the values are the indexes of the elements in the checkboxes.

buttonsText - text of the different choices.

setValueList

public void setValueList(int[] selectedValues,
                         String... labels)

Change the list of checkboxes labels and set the selected value. The values of the choices correspond to their index.

Parameters:

selectedValues - new value to select.

labels - text of the different choices.

getLabel

public GLabelWithIndicator getLabel()

Get the GLabel associated with the component.

Returns:

the GLabel associated with the component.

getGCheckBoxList

public ArrayList<GCheckBox> getGCheckBoxList()

Get the array of GCheckBoxes associated with the component.

Returns:

the array of GCheckBoxes associated with the component.

before

public void before(GEvent e)
            throws GException

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

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.

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.

read

public void read()
          throws GException

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

Specified by:

read in interface GReadWrite

Throws:

GException

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

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.

setStatusMessages

public void setStatusMessages(String okMess,
                              String warnMess,
                              String errorMess)

Method to set the tooltip status messages

Parameters:

okMess - message if OK

warnMess - message if warning

errorMess - message if error

updateStatus

public void updateStatus()

Update the status of the multiple choice depending on the selected values.

updateIsModifiedIndicator

protected void updateIsModifiedIndicator()

Updates the is modified indicator.

Overrides:

updateIsModifiedIndicator in class GComponent

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.

setDefaultValue

public void setDefaultValue(int[] values)

Change the default list of selected values.

Parameters:

values - new default selected values.

setDefaultValueList

public void setDefaultValueList(int[] values,
                                int[] valueList,
                                String... labels)

Change the default list of selected values, the value list and labels of the multiple choice.

Parameters:

values - new default selected values.

valueList - new default value list.

labels - default labels.

setDefaultValueList

public final void setDefaultValueList(int[] values,
                                      int[] valueList,
                                      String[] labels,
                                      String[] tooltips)

Change the default list of selected values, the value list and labels of the multiple choice.

Parameters:

values - new default selected values.

valueList - new default value list.

labels - default labels.

tooltips - default tooltips.

setSavedSelectedValueList

public final void setSavedSelectedValueList(int[] values)

Change the saved list of selected values of the multiple choice.

Parameters:

values - new saved values.

getSavedSelectedValueList

public int[] getSavedSelectedValueList()

Get the last saved list of selected values.

Returns:

the last saved list of selected values.

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.

setShortcut

public void setShortcut(int... shorcutKeyList)
                 throws GException

Set the shortcut keys for selecting the corresponding value.

Parameters:

shorcutKeyList - the shortcut key list to be attached to the widget.

Throws:

GException - in case of giving a list with wrong number of shortcut keys.

setTooltipsList

public void setTooltipsList(String[] tooltipsList)

Set the list of tooltips associated to each item in the GMultipleChoice.

Parameters:

tooltipsList - the list of tooltips for the choices.

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.