fr.cnes.genius.highLevel

Class GListWithLabel

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GListWithLabel

All Implemented Interfaces:

GClear, GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

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

Implements a GList with a GLabelWithIndicator 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 list GList instead of a group of GRadioButtons.

Author:

dlancien HISTORIQUE VERSION:1.11:FA:FA-1144:10/11/2021:[GENIUS] Correction des non-conformites résiduelles GENIUS 1.10 VERSION:1.9:DM:DM-605:08/08/2019:[GENIUS] Objet Glist VERSION:1.9:DM:DM-615:08/08/2019:[GENIUS] Lecture sous objets et multi-objets VERSION:1.9:FA:FA-604:08/08/2019:[GENIUS/GENOPUS] Remarques documentaire - Bilan qualite v1.0 FIN-HISTORIQUE

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
GListWithLabel() Constructor by default.
GListWithLabel(String label, List<String> data) Constructor.
GListWithLabel(String widgetId, String label) Constructor.
GListWithLabel(String widgetId, String label, List<String> dataList) 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.
String[]	getErrorLabelsList() Get the list of labels that makes the combo box to be in error status.
GLabelWithIndicator	getGLabelWithIndicator() Return the GLabel component.
GList	getGList() Return the GList component.
static String	getLabelForValue(String[] labelsList, int[] valuesList, int value) Return the label associated to the value.
List<String>	getSelectedValues() Return the list of selected values.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
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	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	setSelectedValues(int[] newSelectedIndexes) Set the selected values of the component from their indexes.
void	setStringConstraint(String constraints) Set the constraints for the components.
void	setToolTipText(String text) Set the tooltip text for the entry's label.
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 list depending on the selected items.
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

GListWithLabel

public GListWithLabel()

Constructor by default.

GListWithLabel

public GListWithLabel(String label,
                      List<String> data)

Constructor. The widget identifier is created automatically.

Parameters:

label - to display on the side of the list.

data - text of the different choices.

GListWithLabel

public GListWithLabel(String widgetId,
                      String label)

Constructor.

Parameters:

widgetId - widget identifier.

label - to display on the side of the list.

GListWithLabel

public GListWithLabel(String widgetId,
                      String label,
                      List<String> dataList)

Constructor.

Parameters:

widgetId - widget identifier.

label - to display on the side of the list.

dataList - values for the different choices.

Method Detail

setWidgetId

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

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

getSelectedValues

public List<String> getSelectedValues()

Return the list of selected values.

Returns:

the values of the selected items.

setSelectedValues

public void setSelectedValues(int[] newSelectedIndexes)

Set the selected values of the component from their indexes.

Parameters:

newSelectedIndexes - to set.

getGLabelWithIndicator

public GLabelWithIndicator getGLabelWithIndicator()

Return the GLabel component.

Returns:

the GLabel component.

getGList

public GList getGList()

Return the GList component.

Returns:

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

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.

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 of problem while reading the value from file.

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.

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

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.

GFileManipulatorException

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

Throws:

GException - in case of problem while clearing the 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.

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.

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 list depending on the selected items.