fr.cnes.genius.lowLevel

Class GComboBox

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GComboBox

All Implemented Interfaces:

GClear, GDisplay, GListener, ActionListener, MouseWheelListener, EventListener

public class GComboBox
extends GComponent
implements GDisplay, GClear, GListener, ActionListener

ComboBox widget used to select one input in a list of labels. The returned value connected to the selected label can be either its rank in the list, or an arbitrary integer. The list of labels and the connected values can be modified dynamically during execution of the software. The widget can save or load the selected value in a configuration file.

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
GComboBox(int value, int[] valueList, String... labels) Constructor.
GComboBox(int value, String... labels) Constructor.
GComboBox(String widgetId, Enum<?> enumItem) Constructor from an enum.
GComboBox(String widgetId, int value, int[] valueList, String... labelList) Constructor.
GComboBox(String widgetId, int value, int[] valueList, String[] labelList, String[] toolTipsList) Constructor.
GComboBox(String widgetId, int value, String... labels) Constructor.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
void	after(GEvent e) Called after the event is processed.
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.
Component	getComponent() Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
String[]	getDefaultLabelList() Get the default list of labels associated with the combobox.
int	getDefaultValue() Get the default value of the list.
Enum<?>	getDefaultValueEnum() Get the default value of the list.
String	getDefaultValueLabel() Get the label corresponding to the the default value of the list.
int[]	getDefaultValueList() Get the default list of values associated with the combobox.
String[]	getErrorLabelList() Get the list of labels associated to ERROR status.
static int[]	getIndexesArray(Enum<?> enumItem) Gets an ordered array of integers with the indexes of each item contained in the enumerate.
JComboBox	getJComboBox() Get the JComboBox associated with the widget.
String[]	getLabelList() Get the list of labels associated with the combobox.
static String[]	getNamesArray(Enum<?> enumItem) Gets an ordered array of strings with the names of each item contained in the enumerate.
String	getSelectedItem() Return the label of the selected item.
Integer	getValue() Return the value of the selected item.
Enum<?>	getValueEnum() Return the value of the selected item.
int	getValueForRank(int rank) Return the value corresponding to rank.
int[]	getValueList() Get the list of values associated with the combobox.
String[]	getWarningLabelList() Get the list of labels associated to WARNING status.
boolean	isEnumCompat(Enum<?> value) Check compatibility of an enum item with the combobox.
void	setDefaultValue(Enum<?> value) Change the default value of the list.
void	setDefaultValue(int value) Change the default value of the list.
void	setDefaultValueList(Enum<?> enumItem, Enum<?>[] enumItemList) Change the list of default values.
void	setDefaultValueList(int value, int[] valueList, String... labelList) Change the list of default values.
void	setDefaultValueList(int value, int[] valueList, String[] labelList, String[] tooltipsList) Change the list of default values.
void	setErrorLabelList(String[] mErrorLabelList) Set the error label list.
void	setTooltipsList(String[] tooltipsList) Setter of tooltips to each item in the combo box.
void	setValue(Enum<?> value) Set the selected item by value.
void	setValue(int value) Set the selected item by value.
void	setValueList(Enum<?> enumItem, Enum<?>[] enumItemList) Change the list of values, the selected value and the labels of the combobox by means of an enumerate.
void	setValueList(int value, int[] valueList, String... labelList) Change the list of values, the selected value and the labels of the combobox.
void	setValueList(int value, int[] valueList, String[] labelList, String[] toolTipsList) Change the list of values, the selected value and the labels of the combobox.
void	setWarningLabelList(String[] mWarningLabelList) Set the warning label list.
void	updateStatus() Update the status of the combobox depending on the selected item.

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

GComboBox

public GComboBox(int value,
                 String... labels)

Constructor. The widget identifier is created automatically.

Parameters:

value - index of the selected item.

labels - for the different items.

GComboBox

public GComboBox(String widgetId,
                 int value,
                 String... labels)

Constructor.

Parameters:

widgetId - identifier of the widget.

value - index of the selected item.

labels - for the different items.

GComboBox

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

Constructor. The widget identifier is created automatically.

Parameters:

value - index of the selected item.

valueList - list of values for the items.

labels - for the different items.

GComboBox

public GComboBox(String widgetId,
                 int value,
                 int[] valueList,
                 String... labelList)

Constructor.

Parameters:

widgetId - identifier of the widget.

value - index of the selected item.

valueList - list of values for the items.

labelList - for the different items.

GComboBox

public GComboBox(String widgetId,
                 Enum<?> enumItem)

Constructor from an enum.

Parameters:

widgetId - identifier of the widget.

enumItem - initially selected item of the enumerate of items

GComboBox

public GComboBox(String widgetId,
                 int value,
                 int[] valueList,
                 String[] labelList,
                 String[] toolTipsList)

Constructor.

Parameters:

widgetId - identifier of the widget.

value - index of the selected item.

valueList - list of values for the items.

labelList - for the different items.

toolTipsList - for the different items.

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)

getErrorLabelList

public String[] getErrorLabelList()

Get the list of labels associated to ERROR status.

Returns:

the list of labels associated to ERROR status.

getWarningLabelList

public String[] getWarningLabelList()

Get the list of labels associated to WARNING status.

Returns:

the list of labels associated to WARNING status.

setErrorLabelList

public void setErrorLabelList(String[] mErrorLabelList)

Set the error label list.

Parameters:

mErrorLabelList - List of labels that should update the status to ERROR level.

setWarningLabelList

public void setWarningLabelList(String[] mWarningLabelList)

Set the warning label list.

Parameters:

mWarningLabelList - List of labels that should update the status to WARNING level.

updateStatus

public final void updateStatus()

Update the status of the combobox depending on the selected item.

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

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

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.

getJComboBox

public JComboBox getJComboBox()

Get the JComboBox associated with the widget.

Returns:

the JComboBox associated with the widget.

getSelectedItem

public String getSelectedItem()

Return the label of the selected item.

Returns:

the label of the selected item.

getValueForRank

public int getValueForRank(int rank)

Return the value corresponding to rank.

Parameters:

rank - of the value to get.

Returns:

if the value list is defined the value associated with the rank, otherwise the rank. The rank is restricted to [0, number_of_choices], if rank < 0 then the value of the first choice is returned, if rank > number_of_choices the value of the last choice is returned.

getValue

public Integer getValue()

Return the value of the selected item.

Returns:

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

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.

getDefaultValueList

public int[] getDefaultValueList()

Get the default list of values associated with the combobox.

Returns:

the default list of values associated with the combobox.

getDefaultLabelList

public String[] getDefaultLabelList()

Get the default list of labels associated with the combobox.

Returns:

the default list of labels associated with the combobox.

getValueList

public int[] getValueList()

Get the list of values associated with the combobox.

Returns:

the list of values associated with the combobox.

getLabelList

public String[] getLabelList()

Get the list of labels associated with the combobox.

Returns:

the list of labels associated with the combobox.

setValue

public final void setValue(Enum<?> value)

Set the selected item by value.

Parameters:

value - of the item to select.

setValue

public final void setValue(int value)

Set the selected item by value.

Parameters:

value - of the item to select.

setValueList

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

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

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.

labelList - to display in the combobox.

setValueList

public void setValueList(int value,
                         int[] valueList,
                         String[] labelList,
                         String[] toolTipsList)

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

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.

labelList - to display in the combobox.

toolTipsList - to display for each element in the combobox.

setValueList

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

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

Parameters:

enumItem - new enumerate item to select.

enumItemList - new enumerate items list.

setDefaultValueList

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

Change the list of default values.

Parameters:

value - new default value.

valueList - new default value list.

labelList - new default label list.

setDefaultValueList

public void setDefaultValueList(int value,
                                int[] valueList,
                                String[] labelList,
                                String[] tooltipsList)

Change the list of default values.

Parameters:

value - new default value.

valueList - new default value list.

labelList - new default label list.

tooltipsList - new default tooltips list.

setDefaultValueList

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

Change the list of default values.

Parameters:

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

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

setDefaultValue

public void setDefaultValue(Enum<?> value)

Change the default value of the list.

Parameters:

value - new default value.

setDefaultValue

public void setDefaultValue(int value)

Change the default value of the list.

Parameters:

value - new default value.

getDefaultValue

public int getDefaultValue()

Get the default value of the list.

Returns:

the default value.

getDefaultValueEnum

public Enum<?> getDefaultValueEnum()

Get the default value of the list.

Returns:

the default value.

getDefaultValueLabel

public String getDefaultValueLabel()
                            throws GException

Get the label corresponding to the the default value of the list.

Returns:

the label associated to the default value or null if it is not defined.

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.

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.

setTooltipsList

public void setTooltipsList(String[] tooltipsList)

Setter of tooltips to each item in the combo box.

Parameters:

tooltipsList - the ordered list of tooltips to be set.

isEnumCompat

public boolean isEnumCompat(Enum<?> value)

Check compatibility of an enum item with the combobox.

Parameters:

value - enum item to check

Returns:

true if the enum item is compatible with the combobox.

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.