fr.cnes.genius.highLevel

Class GPopupListWithLabel

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GPopupListWithLabel

All Implemented Interfaces:

GClear, GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

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

The class implements a label GLabelWithIndicator, and a GPopupList. The class implements save and load of selected value in the configuration file.

Author:

jjct

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , split 2" 0, 1 => (null)
1	GPopupList	popupList	(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
GPopupListWithLabel() Constructor by default
GPopupListWithLabel(String label, int selectedRank, String... menuLabelList) Constructor.
GPopupListWithLabel(String widgetId, String label, int selectedRank, String... menuLabelList) Constructor.
GPopupListWithLabel(String widgetId, String label, int selectedRank, String[] menuLabelList, String[] toolTipsList) 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.
GLabelWithIndicator	getGLabel() Get the GLabel component.
GPopupList	getGPopupList() Get the GPopupList component.
int	getSavedRank() Get the saved selected rank.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
int	getValue() Get the rank of the selected value in the popup list.
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.
protected void	setDefaultConstraints() Set default constraints.
void	setDefaultValue(int defaultSelectedRank) Set the new default value.
void	setEnabled(boolean b) Set the enable status of the component.
void	setSavedRank(int rank) Set saved selected rank.
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 popup list.
void	setToolTipText(String text) Set the tooltip text for the entry's label.
void	setValue(int rank) Set the rank of the selected value in the popup list.
void	setWidgetId(String widgetId) Sets the widget identifier of the component.
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, 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

GPopupListWithLabel

public GPopupListWithLabel()

Constructor by default

GPopupListWithLabel

public GPopupListWithLabel(String label,
                           int selectedRank,
                           String... menuLabelList)

Constructor. The identifier of the widget will be automatically generated.

Parameters:

label - text of the label to display.

selectedRank - rank of the selected menu item.

menuLabelList - list of labels of the contextual menu.

GPopupListWithLabel

public GPopupListWithLabel(String widgetId,
                           String label,
                           int selectedRank,
                           String... menuLabelList)

Constructor. The identifier of the widget will be automatically generated.

Parameters:

widgetId - widget identifier.

label - text of the label to display.

selectedRank - rank of the selected menu item.

menuLabelList - list of labels of the contextual menu.

GPopupListWithLabel

public GPopupListWithLabel(String widgetId,
                           String label,
                           int selectedRank,
                           String[] menuLabelList,
                           String[] toolTipsList)

Constructor. The identifier of the widget will be automatically generated.

Parameters:

widgetId - widget identifier.

label - text of the label to display.

selectedRank - rank of the selected menu item.

menuLabelList - list of labels of the contextual menu.

toolTipsList - for the different items.

Method Detail

setDefaultConstraints

protected final void setDefaultConstraints()

Description copied from class: GComponent

Set default constraints.

Overrides:

setDefaultConstraints in class GComponent

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

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.

getValue

public int getValue()

Get the rank of the selected value in the popup list.

Returns:

the rank of the selected value in the popup list.

setValue

public void setValue(int rank)

Set the rank of the selected value in the popup list.

Parameters:

rank - of the selected value in the popup list.

getGLabel

public GLabelWithIndicator getGLabel()

Get the GLabel component.

Returns:

the GLabel component.

getGPopupList

public GPopupList getGPopupList()

Get the GPopupList component.

Returns:

the GPopupList component.

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.

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

setSavedRank

public void setSavedRank(int rank)

Set saved selected rank.

Parameters:

rank - new saved rank.

getSavedRank

public int getSavedRank()

Get the saved selected rank.

Returns:

the last saved selected rank.

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.

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.

setTooltipsList

public void setTooltipsList(String[] tooltipsList)

Set the list of tooltips associated to each item in the popup list.

Parameters:

tooltipsList - the list of tooltips from the popup list items.

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.

setDefaultValue

public void setDefaultValue(int defaultSelectedRank)

Set the new default value.

Parameters:

defaultSelectedRank - new rank of the item selected by default (starting from 0).