fr.cnes.genius.highLevel

Class GObjectComboBoxWithLabel<T>

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GComboBoxWithLabel

fr.cnes.genius.highLevel.GObjectComboBoxWithLabel<T>

Type Parameters:

T - The type of the list of objects associated to the combobox.

All Implemented Interfaces:

GClear, GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

public class GObjectComboBoxWithLabel<T>
extends GComboBoxWithLabel

It is a GComboBoxWithLabel linked to a list of objects of a generic type T.
Methods:
- setObject(Object),
- setObjectList(Object, Object[], String...),
- setObjectList(Object, Object[], String[], String[]),
- setDefaultObject(Object),
- setDefaultObjectList(Object, Object[], String[]),
- setDefaultObjectList(Object, Object[], String[], String[]),
- setSavedObject(Object)
replace methods:
- setValue(int),
- setValue(Enum),
- setValueList(Enum, Enum...),
- setValueList(int, int[], String...),
- setValueList(int, int[], String[], String[]),
- setDefaultValue(Enum),
- setDefaultValue(int),
- setDefaultValueList(Enum, Enum[]),
- setDefaultValueList(int, int[], String[]),
- setDefaultValueList(int, int[], String[], String[]),
- setSavedValue(Enum),
- setSavedValue(int)
which cannot be used directly to avoid disalignment between the combobox labels list and the objects list.

Author:

ffsm

Default Constraint(s):

Index	Class	Item	Constraint
toto	(undefined)	(undefined)	(undefined)

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
GObjectComboBoxWithLabel(String widgetId, String label, T object, T[] objects) Constructor.
GObjectComboBoxWithLabel(String widgetId, String label, T object, T[] objects, String... labels) Constructor.
GObjectComboBoxWithLabel(String widgetId, String label, T object, T[] objects, String[] labels, String[] toolTips) Constructor.
GObjectComboBoxWithLabel(String label, T object, T[] objects) Constructor.
GObjectComboBoxWithLabel(String label, T object, T[] objects, String... labels) Constructor.

Method Summary

Modifier and Type	Method and Description
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.
T	getDefaultObject() Get the default object.
T	getObject() Return the selected object.
T[]	getObjectList() Get the list of objects of the combobox.
T	getSavedObject() Get the saved object.
void	setDefaultObject(T defaultObject) Change the default object of the list.
void	setDefaultObjectList(T defaultObject, T[] defaultObjects, String[] defaultLabels) Change the default list of objects, the object and labels of the combobox.
void	setDefaultObjectList(T defaultObject, T[] defaultObjects, String[] defaultLabels, String[] defaultTooltips) Change the default list of objects, the object and labels of the combobox.
void	setDefaultValue(Enum<?> value) Unsupported method! Change the default value of the list.
void	setDefaultValue(int value) Unsupported method! Change the default value of the list.
void	setDefaultValueList(Enum<?> enumItem, Enum<?>[] enumItemList) Unsupported method! Change the default list of values, the value and labels of the combobox.
void	setDefaultValueList(int value, int[] valueList, String[] labels) Unsupported method! Change the default list of values, the value and labels of the combobox.
void	setDefaultValueList(int value, int[] valueList, String[] labels, String[] tooltips) Unsupported method! Change the default list of values, the value and labels of the combobox.
void	setObject(T object) Set a new object.
void	setObjectList(T object, T[] objects, String... labels) Change the list of objects, the selected object and the labels of the combobox.
void	setObjectList(T object, T[] objects, String[] labels, String[] tooltips) Change the list of objects, the selected object and the labels of the combobox.
void	setSavedObject(T savedObject) Change the saved object.
void	setSavedValue(Enum<?> value) Unsupported method! Change the saved value.
void	setSavedValue(int value) Unsupported method! Change the saved value.
void	setValue(Enum<?> value) Unsupported method! Set a new value.
void	setValue(int value) Unsupported method! Set a new value.
void	setValueList(Enum<?> enumItem, Enum<?>... enumItemList) Unsupported method! 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... labels) Unsupported method! Change the list of values, the selected value and the labels of the combobox.
void	setValueList(int value, int[] valueList, String[] labels, String[] tooltips) Unsupported method! Change the list of values, the selected value and the labels of the combobox.

Methods inherited from class fr.cnes.genius.highLevel.GComboBoxWithLabel

after, attachCopyPasteMenu, before, display, generic, getDefaultValue, getDefaultValueEnum, getErrorLabelsList, getGComboBox, getGLabelWithIndicator, getSavedValue, getSavedValueEnum, getSelectedItem, getSubComponent, getValue, getValueEnum, getWarningLabelsList, isCopyPasteEvent, isEnabled, isModified, read, setEnabled, setErrorLabelsList, setStringConstraint, setTooltipsList, setToolTipText, setWarningLabelsList, setWidgetId, updateIsModifiedIndicator, updateStatus, write

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

GObjectComboBoxWithLabel

public GObjectComboBoxWithLabel(String label,
                                T object,
                                T[] objects,
                                String... labels)

Constructor. The widget identifier is created automatically.

Parameters:

label - to display on the side of the combobox.

object - selected object.

objects - objects for the different choices.

labels - labels of the choices.

GObjectComboBoxWithLabel

public GObjectComboBoxWithLabel(String label,
                                T object,
                                T[] objects)

Constructor. The widget identifier is created automatically. The label for each object is the result of its Object.toString() method.

Parameters:

label - to display on the side of the combobox.

object - selected object.

objects - objects for the different choices.

GObjectComboBoxWithLabel

public GObjectComboBoxWithLabel(String widgetId,
                                String label,
                                T object,
                                T[] objects,
                                String... labels)

Constructor.

Parameters:

widgetId - widget identifier.

label - to display on the side of the combobox.

object - selected object.

objects - objects for the different choices.

labels - labels for the different choices.

GObjectComboBoxWithLabel

public GObjectComboBoxWithLabel(String widgetId,
                                String label,
                                T object,
                                T[] objects)

Constructor. The label for each object is the result of its Object.toString() method.

Parameters:

widgetId - widget identifier.

label - to display on the side of the combobox.

object - selected object.

objects - objects for the different choices.

GObjectComboBoxWithLabel

public GObjectComboBoxWithLabel(String widgetId,
                                String label,
                                T object,
                                T[] objects,
                                String[] labels,
                                String[] toolTips)

Constructor.

Parameters:

widgetId - widget identifier.

label - to display on the side of the combobox.

object - selected object (might be null, then the first object is selected). It must be one of the objects argument.

objects - object for the different choices.

labels - labels for the different choices.

toolTips - tooltips for the different choices.

Method Detail

setObject

public void setObject(T object)
               throws GException

Set a new object.

Parameters:

object - to set.

Throws:

GException - if the object is not available in the widget

getObject

public T getObject()

Return the selected object.

Returns:

the selected object or null if no object is selected.

setObjectList

public void setObjectList(T object,
                          T[] objects,
                          String... labels)
                   throws GException

Change the list of objects, the selected object and the labels of the combobox.

Parameters:

object - new object to select.

objects - new objects list.

labels - new labels list.

Throws:

GException - if the object is not available in the widget

setObjectList

public final void setObjectList(T object,
                                T[] objects,
                                String[] labels,
                                String[] tooltips)
                         throws GException

Change the list of objects, the selected object and the labels of the combobox.

Parameters:

object - new object to select (might be null, then the first object is selected).

objects - new objects list.

labels - new labels list.

tooltips - new tooltips list.

Throws:

GException - if the object is not available in the widget

getObjectList

public T[] getObjectList()

Get the list of objects of the combobox.

Returns:

the objects list.

setDefaultObject

public void setDefaultObject(T defaultObject)
                      throws GException

Change the default object of the list.

Parameters:

defaultObject - new default object.

Throws:

GException - if the object is not available in the default list

getDefaultObject

public T getDefaultObject()

Get the default object.

Returns:

the last default object.

setDefaultObjectList

public void setDefaultObjectList(T defaultObject,
                                 T[] defaultObjects,
                                 String[] defaultLabels)
                          throws GException

Change the default list of objects, the object and labels of the combobox.

Parameters:

defaultObject - new default object.

defaultObjects - new default objects list.

defaultLabels - new default labels list.

Throws:

GException - if the object is not available in the default list

setDefaultObjectList

public final void setDefaultObjectList(T defaultObject,
                                       T[] defaultObjects,
                                       String[] defaultLabels,
                                       String[] defaultTooltips)
                                throws GException

Change the default list of objects, the object and labels of the combobox.

Parameters:

defaultObject - new default object.

defaultObjects - new default objects list.

defaultLabels - new default labels list.

defaultTooltips - new default tooltips list.

Throws:

GException - if the object is not available in the default list

setSavedObject

public void setSavedObject(T savedObject)
                    throws GException

Change the saved object.

Parameters:

savedObject - new saved object.

Throws:

GException - if the object is not available in the widget

getSavedObject

public T getSavedObject()

Get the saved object.

Returns:

the last saved object.

clear

public void clear()
           throws GException

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

Overrides:

clear in class GComboBoxWithLabel

Throws:

GException - in case of problem while clearing the values.

setValue

public void setValue(int value)

Unsupported method! Set a new value.

Overrides:

setValue in class GComboBoxWithLabel

Parameters:

value - to set.

setValue

public void setValue(Enum<?> value)

Unsupported method! Set a new value.

Overrides:

setValue in class GComboBoxWithLabel

Parameters:

value - to set.

setValueList

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

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

Overrides:

setValueList in class GComboBoxWithLabel

Parameters:

enumItem - new enumerate item to select.

enumItemList - new enumerate items list.

setValueList

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

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

Overrides:

setValueList in class GComboBoxWithLabel

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 - to display in the combobox.

setValueList

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

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

Overrides:

setValueList in class GComboBoxWithLabel

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 - to display in the combobox.

tooltips - to display for each element in the combobox.

setDefaultValue

public void setDefaultValue(Enum<?> value)

Unsupported method! Change the default value of the list.

Overrides:

setDefaultValue in class GComboBoxWithLabel

Parameters:

value - default value to set.

setDefaultValue

public void setDefaultValue(int value)

Unsupported method! Change the default value of the list.

Overrides:

setDefaultValue in class GComboBoxWithLabel

Parameters:

value - default value to set.

setDefaultValueList

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

Unsupported method! Change the default list of values, the value and labels of the combobox.

Overrides:

setDefaultValueList in class GComboBoxWithLabel

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)

Unsupported method! Change the default list of values, the value and labels of the combobox.

Overrides:

setDefaultValueList in class GComboBoxWithLabel

Parameters:

value - new default value.

valueList - new default value list.

labels - new default value list.

setDefaultValueList

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

Unsupported method! Change the default list of values, the value and labels of the combobox.

Overrides:

setDefaultValueList in class GComboBoxWithLabel

Parameters:

value - new default value.

valueList - new default value list.

labels - new default value list.

tooltips - new default tooltips list.

setSavedValue

public void setSavedValue(Enum<?> value)

Unsupported method! Change the saved value.

Overrides:

setSavedValue in class GComboBoxWithLabel

Parameters:

value - new saved value.

setSavedValue

public void setSavedValue(int value)

Unsupported method! Change the saved value.

Overrides:

setSavedValue in class GComboBoxWithLabel

Parameters:

value - new saved value.