fr.cnes.genius.highLevel

Class GChoice

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GChoice

All Implemented Interfaces:

GClear, GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

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

Widget implementing a group of GChoice controls. The class allows a sole choice among a list of options. This list is preceded by a label with the name. The different options are represented by GRadioButton 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 choice 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	GRadioButton	radioButton0	"split"
2	GRadioButton	radioButton1	(null)
...	...	...	...
i+1	GRadioButton	radioButtoni	(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
GChoice() Constructor by default.
GChoice(String label, int value, int[] valueList, String... labels) Constructor when values are identical to the index of the choices.
GChoice(String label, int value, String... labels) Constructor when values are identical to the index of the choices.
GChoice(String widgetId, String label, Enum<?> enumItem) Constructor from an enum.
GChoice(String widgetId, String label, int value, int[] valueList, String... labels) Constructor when values are identical to the index of the choices.
GChoice(String widgetId, String label, int value, int[] valueList, String[] labels, String[] tooltips) Constructor when values are identical to the index of the choices.
GChoice(String widgetId, String label, int value, 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.
GLabelWithIndicator	getGLabel() Get the GLabel associated with the component.
ArrayList<GRadioButton>	getGRadioButtonList() Get the array of GRadioButtons associated with the component.
static int[]	getIndexesArray(Enum<?> enumItem) Gets an ordered array of integers with the indexes of each item contained in the enumerate.
static String	getLabelForValue(String[] labelsList, int[] valuesList, int value) Return the label associated to the value.
static String[]	getNamesArray(Enum<?> enumItem) Gets an ordered array of strings with the names of each item contained in the enumerate.
String[]	getSavedLabels() Get the last saved labels.
int	getSavedSelectedValue() Get the last saved selected value.
int[]	getSavedValueList() Get the array of last saved value list.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
int	getValue() Get the value of the component.
Enum<?>	getValueEnum() Return the value of the selected item.
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	isEnumCompat(Enum<?> value) Check compatibility of an enum item with 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.
void	setDefaultValue(Enum<?> value) Change the default value of the list.
void	setDefaultValue(int value) Change the default value.
void	setDefaultValueList(Enum<?> enumItem, Enum<?>[] enumItemList) Change the default list of values by means of an enumerate.
void	setDefaultValueList(int value, int[] valueList, String... labels) Change the default list of values, the value and labels of the choices.
void	setDefaultValueList(int value, int[] valueList, String[] labels, String[] tooltips) Change the default list of values, the value and labels of the choices.
void	setEnabled(boolean b) Set the enable/disable status of the component.
void	setSavedValue(Enum<?> value) Change the saved value.
void	setSavedValue(int value) Change the saved value.
void	setSavedValueList(int value, int[] valueList, String... labels) Change the saved list of values, the value and labels of the choices.
void	setShortcut(int... shorcutKeyList) Set the shortcut keys for selecting the corresponding value.
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 GChoice.
void	setToolTipText(String text) Set the tooltip text for the entry's label.
void	setValue(Enum<?> value) Set the selected item by value.
void	setValue(int newValue) Set the value of the component.
void	setValueList(Enum<?> enumItem, Enum<?>[] enumItemList) Change the list of values, the selected value and the labels of the choices by means of an enumerate.
void	setValueList(int value, int[] valueList, String... labels) Change the list of values, the selected value and the labels of the choices.
void	setValueList(int value, int[] valueList, String[] labels, String[] tooltips) Change the list of values, the selected value and the labels of the choices.
void	setValueList(int value, String... labels) Change the list of choices labels and set the selected value.
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, 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

GChoice

public GChoice(String widgetId,
               String label,
               Enum<?> enumItem)

Constructor from an enum.

Parameters:

widgetId - identifier of the widget.

label - to display for the list of choices.

enumItem - initially selected item of the enumerate of items

GChoice

public GChoice()

Constructor by default.

GChoice

public GChoice(String widgetId,
               String label,
               int value,
               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.

value - to be selected at construction.

labels - text of the different choices.

GChoice

public GChoice(String label,
               int value,
               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.

value - to be selected at construction.

labels - text of the different choices.

GChoice

public GChoice(String label,
               int value,
               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.

value - to be selected at construction.

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

labels - text of the different choices.

GChoice

public GChoice(String widgetId,
               String label,
               int value,
               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.

value - to be selected at construction.

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

labels - text of the different choices.

GChoice

public GChoice(String widgetId,
               String label,
               int value,
               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.

value - 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

getIndexesArray

public static int[] getIndexesArray(Enum<?> enumItem)

Gets an ordered array of integers with the indexes of each item contained in the enumerate.

Parameters:

enumItem - enumerate single item.

Returns:

array with all enumerate items indexes (by means of Enum.ordinal() method)

getNamesArray

public static String[] getNamesArray(Enum<?> enumItem)

Gets an ordered array of strings with the names of each item contained in the enumerate.

Parameters:

enumItem - enumerate single item.

Returns:

array with all enumerate items names (by means of Enum.toString() method)

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.

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.

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.

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.

getValue

public int getValue()

Get the value of the component.

Returns:

the value of selected radioButton.

getValueEnum

public Enum<?> getValueEnum()

Return the value of the selected item.

Returns:

the value of the selected item, if no item is selected returns null.

setValue

public void setValue(int newValue)

Set the value of the component. The corresponding radioButton is automatically selected.

Parameters:

newValue - to set.

setValue

public final void setValue(Enum<?> value)

Set the selected item by value.

Parameters:

value - of the item to select.

setValueList

public void setValueList(int value,
                         int[] valueList,
                         String[] labels,
                         String[] tooltips)

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

Parameters:

value - new value to select.

valueList - new value list, it can be null if the values are the indexes of the elements in the combobox.

labels - text of the different choices.

tooltips - for the different choices.

setValueList

public void setValueList(Enum<?> enumItem,
                         Enum<?>[] enumItemList)

Change the list of values, the selected value and the labels of the choices by means of an enumerate.

Parameters:

enumItem - new enumerate item to select.

enumItemList - new enumerate items list.

setValueList

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

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

Parameters:

value - new value to select.

valueList - new value list, it can be null if the values are the indexes of the elements in the combobox.

labels - text of the different choices.

setValueList

public void setValueList(int value,
                         String... labels)

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

Parameters:

value - new value to select.

labels - text of the different choices.

getGLabel

public GLabelWithIndicator getGLabel()

Get the GLabel associated with the component.

Returns:

the GLabel associated with the component.

getGRadioButtonList

public ArrayList<GRadioButton> getGRadioButtonList()

Get the array of GRadioButtons associated with the component.

Returns:

the array of GRadioButtons associated with the component.

getLabelForValue

public static String getLabelForValue(String[] labelsList,
                                      int[] valuesList,
                                      int value)
                               throws GException

Return the label associated to the value.

Parameters:

labelsList - list of labels.

valuesList - list of values.

value - value for which the corresponding label is searched.

Returns:

the label for the given value.

Throws:

GException - in case of empty list of labels, empty list of values, different length for the lists or value not found in the list of values.

before

public void before(GEvent e)

Called before the event is processed.

Specified by:

before in interface GListener

Parameters:

e - event to processed.

after

public void after(GEvent e)
           throws GFileManipulatorException

Called after the event is processed.

Specified by:

after in interface GListener

Parameters:

e - processed event.

Throws:

GFileManipulatorException

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 - in case the value in the file is not defined in the list of values of the component.

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.

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.

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.

updateIsModifiedIndicator

protected void updateIsModifiedIndicator()

Updates the is modified indicator.

Overrides:

updateIsModifiedIndicator in class GComponent

setSavedValueList

public void setSavedValueList(int value,
                              int[] valueList,
                              String... labels)

Change the saved list of values, the value and labels of the choices.

Parameters:

value - new saved value.

valueList - new saved value list.

labels - new saved labels.

setDefaultValue

public void setDefaultValue(int value)

Change the default value.

Parameters:

value - default value to set.

setDefaultValue

public void setDefaultValue(Enum<?> value)

Change the default value of the list.

Parameters:

value - new default value.

setDefaultValueList

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

Change the default list of values, the value and labels of the choices.

Parameters:

value - new default value.

valueList - new default value list.

labels - new default labels.

setDefaultValueList

public void setDefaultValueList(Enum<?> enumItem,
                                Enum<?>[] enumItemList)

Change the default list of values by means of an enumerate.

Parameters:

enumItem - new enumerate item to be set as default one.

enumItemList - new enumerate items list to be set as default one.

setDefaultValueList

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

Change the default list of values, the value and labels of the choices.

Parameters:

value - new default value.

valueList - new default value list.

labels - new default labels.

tooltips - new default tooltips.

setSavedValue

public void setSavedValue(int value)

Change the saved value.

Parameters:

value - new saved value.

setSavedValue

public void setSavedValue(Enum<?> value)

Change the saved value.

Parameters:

value - new saved value.

getSavedSelectedValue

public int getSavedSelectedValue()

Get the last saved selected value.

Returns:

the last saved selected value of the widget.

getSavedValueList

public int[] getSavedValueList()

Get the array of last saved value list.

Returns:

the array of last saved value list of the widget.

getSavedLabels

public String[] getSavedLabels()

Get the last saved labels.

Returns:

the last saved labels of the widget.

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 GChoice.

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.

isEnumCompat

public boolean isEnumCompat(Enum<?> value)

Check compatibility of an enum item with the widget.

Parameters:

value - enum item to check

Returns:

true if the enum item is compatible with the widget.