fr.cnes.genius.highLevel

Class GComboBoxWithLabel

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GComboBoxWithLabel

All Implemented Interfaces:

GClear, GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

Direct Known Subclasses:

GObjectComboBoxWithLabel

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

Implements a GComboBox with a GComboBoxWithLabel and adds the GReadWrite interface to save/load the selected value from the configuration file. The class allows a sole choice with the same function as the function of GChoice but the interface is implemented via a pop up menu GComboBox instead of a group of GRadioButtons.

Author:

jjct

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , split 2" 0, 1 => (null)
1	GComboBox	combobox	(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
GComboBoxWithLabel() Constructor by default.
GComboBoxWithLabel(String label, int value, int[] values, String... labels) Constructor.
GComboBoxWithLabel(String label, int value, String... labels) Constructor.
GComboBoxWithLabel(String widgetId, String label, Enum<?> enumItem) Constructor.
GComboBoxWithLabel(String widgetId, String label, int value, int[] valueList, String... labelList) Constructor.
GComboBoxWithLabel(String widgetId, String label, int value, int[] valueList, String[] labelList, String[] toolTipsList) Constructor.
GComboBoxWithLabel(String widgetId, String label, int value, String... labels) Constructor.

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.
int	getDefaultValue() Get the default value when calling clear.
Enum<?>	getDefaultValueEnum() Get the default value.
String[]	getErrorLabelsList() Get the list of labels that makes the combo box to be in error status.
GComboBox	getGComboBox() Return the GComboBox component.
GLabelWithIndicator	getGLabelWithIndicator() Return the GLabel component.
int	getSavedValue() Get the saved value.
Enum<?>	getSavedValueEnum() Get the saved value.
String	getSelectedItem() Return the label of the selected item.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
Integer	getValue() Get the selected value.
Enum<?>	getValueEnum() Get the selected value.
String[]	getWarningLabelsList() Get the list of labels that makes the combo box to be in warning status.
GComponent.CopyPasteOperation	isCopyPasteEvent(GEvent event) Checks if the event corresponds to one of the copy and paste menu operations.
boolean	isEnabled() Gets the enable status of 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 of the list.
void	setDefaultValueList(Enum<?> enumItem, Enum<?>[] enumItemList) Change the default list of values, the value and labels of the combobox.
void	setDefaultValueList(int value, int[] valueList, String[] labels) Change the default list of values, the value and labels of the combobox.
void	setDefaultValueList(int value, int[] valueList, String[] labels, String[] tooltips) Change the default list of values, the value and labels of the combobox.
void	setEnabled(boolean b) Set the enable status of the component.
void	setErrorLabelsList(String... errorLabels) Set the list of labels that makes the combo box to be in error status.
void	setSavedValue(Enum<?> value) Change the saved value.
void	setSavedValue(int value) Change the saved value.
void	setStringConstraint(String constraints) Set the constraints for the components.
void	setTooltipsList(String[] tooltipsList) Setter of tooltips to each item in the combo box.
void	setToolTipText(String text) Set the tooltip text for the entry's label.
void	setValue(Enum<?> value) Set a new value.
void	setValue(int value) Set a new 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... labels) Change the list of values, the selected value and the labels of the combobox.
void	setValueList(int value, int[] valueList, String[] labels, String[] tooltips) Change the list of values, the selected value and the labels of the combobox.
void	setWarningLabelsList(String... warningLabels) Set the list of labels that makes the combo box to be in warning status.
void	setWidgetId(String widgetId) Sets the widget identifier of the component.
protected void	updateIsModifiedIndicator() Updates the is modified indicator.
void	updateStatus() Update the status of the combobox depending on the selected item.
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, 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

GComboBoxWithLabel

public GComboBoxWithLabel()

Constructor by default.

GComboBoxWithLabel

public GComboBoxWithLabel(String widgetId,
                          String label,
                          int value,
                          String... labels)

Constructor. The values of the choices correspond to their indexes.

Parameters:

widgetId - widget identifier.

label - to display on the side of the combobox.

value - selected value.

labels - labels of the choices.

GComboBoxWithLabel

public GComboBoxWithLabel(String label,
                          int value,
                          String... labels)

Constructor. The widget identifier is created automatically. The values of the choices correspond to their indexes.

Parameters:

label - to display on the side of the combobox.

value - selected value.

labels - labels of the choices.

GComboBoxWithLabel

public GComboBoxWithLabel(String label,
                          int value,
                          int[] values,
                          String... labels)

Constructor. The widget identifier is created automatically.

Parameters:

label - to display on the side of the combobox.

value - selected value.

values - values for the different choices.

labels - labels of the choices.

GComboBoxWithLabel

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

Constructor.

Parameters:

widgetId - widget identifier.

label - to display on the side of the combobox.

value - selected value.

valueList - values for the different choices.

labelList - labels for the different choices.

GComboBoxWithLabel

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

Constructor.

Parameters:

widgetId - widget identifier.

label - to display on the side of the combobox.

enumItem - initially selected item of the enumerate of items

GComboBoxWithLabel

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

Constructor.

Parameters:

widgetId - widget identifier.

label - to display on the side of the combobox.

value - selected value.

valueList - values for the different choices.

labelList - labels for the different choices.

toolTipsList - tooltips for the different choices.

Method Detail

setWidgetId

public final void setWidgetId(String widgetId)

Sets the widget identifier of the component.

Overrides:

setWidgetId in class GComponent

Parameters:

widgetId - the widget identifier of the component.

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

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()

Gets the enable status of the widget.

Overrides:

isEnabled in class GComponent

Returns:

true if the component is enabled, false otherwise.

setEnabled

public void setEnabled(boolean b)

Set the enable status of the component.

Overrides:

setEnabled in class GComponent

Parameters:

b - new enable status of the component.

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 final void updateIsModifiedIndicator()

Updates the is modified indicator.

Overrides:

updateIsModifiedIndicator in class GComponent

getDefaultValue

public int getDefaultValue()

Get the default value when calling clear.

Returns:

the default value when calling clear..

getDefaultValueEnum

public Enum<?> getDefaultValueEnum()

Get the default value.

Returns:

the default value item.

getValue

public final Integer getValue()

Get the selected value.

Returns:

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

getValueEnum

public Enum<?> getValueEnum()

Get the selected value.

Returns:

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

getSelectedItem

public String getSelectedItem()

Return the label of the selected item.

Returns:

the label of the selected item.

setValue

public void setValue(int value)

Set a new value.

Parameters:

value - to set.

setValue

public void setValue(Enum<?> value)

Set a new value.

Parameters:

value - to set.

getGLabelWithIndicator

public GLabelWithIndicator getGLabelWithIndicator()

Return the GLabel component.

Returns:

the GLabel component.

setValueList

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

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.

labels - to display in the combobox.

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

labels - to display in the combobox.

tooltips - 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[] labels)

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

Parameters:

value - new default value.

valueList - new default value list.

labels - new default value list.

setDefaultValueList

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

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

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

Parameters:

value - new default value.

valueList - new default value list.

labels - new default value list.

tooltips - new default tooltips list.

setDefaultValue

public void setDefaultValue(int value)

Change the default value of the list.

Parameters:

value - default value to set.

setDefaultValue

public void setDefaultValue(Enum<?> value)

Change the default value of the list.

Parameters:

value - default value to set.

getGComboBox

public GComboBox getGComboBox()

Return the GComboBox component.

Returns:

the GComboBox component.

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.

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.

before

public void before(GEvent e)
            throws GException

Description copied from interface: GListener

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

Description copied from interface: GListener

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.

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.

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.

getSavedValue

public int getSavedValue()

Get the saved value.

Returns:

the last saved value.

getSavedValueEnum

public Enum<?> getSavedValueEnum()

Get the saved value.

Returns:

the saved value item..

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.

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.

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.

setStringConstraint

public void setStringConstraint(String constraints)

Set the constraints for the components.

Overrides:

setStringConstraint in class GComponent

Parameters:

constraints - to set.

setErrorLabelsList

public void setErrorLabelsList(String... errorLabels)

Set the list of labels that makes the combo box to be in error status.

Parameters:

errorLabels - list of labels for error status.

getErrorLabelsList

public String[] getErrorLabelsList()

Get the list of labels that makes the combo box to be in error status.

Returns:

the list of labels for error status.

setWarningLabelsList

public void setWarningLabelsList(String... warningLabels)

Set the list of labels that makes the combo box to be in warning status.

Parameters:

warningLabels - list of labels for warning status.

getWarningLabelsList

public String[] getWarningLabelsList()

Get the list of labels that makes the combo box to be in warning status.

Returns:

the list of labels for warning status.

updateStatus

public final void updateStatus()

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