fr.cnes.genius.highLevel

Class GPopupList

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GPopupList

All Implemented Interfaces:

GClear, GDisplay, GListener, MouseWheelListener, EventListener

public class GPopupList
extends GContainer
implements GDisplay, GListener, GClear

The class implements a GPopupMenu associated with a GHyperlinkLabel. The menu is displayed when the user clicks on the hyperlink label with the left mouse button (by default, but it is possible to configure another button). The widget can be configured so that the text in GHyperlinkLabel will be updated with the selection in GPopupMenu, or not.

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
GPopupList(int rank, ArrayList<GMenuItem> menuItems) Constructor.
GPopupList(String widgetId, int rank, ArrayList<GMenuItem> menuItems) Constructor.
GPopupList(String widgetId, int rank, ArrayList<GMenuItem> menuItems, String[] toolTipsList) Constructor.
GPopupList(String title, List<GMenuItem> menuItems) Constructor.
GPopupList(String widgetId, String title, List<GMenuItem> menuItems) Constructor.
GPopupList(String widgetId, String title, List<GMenuItem> menuItems, String[] toolTipsList) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(GMenuItem menuItem) Add a menu item to the popup menu.
void	addSeparator() Add a separtor to the popup menu.
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.
void	generic() The prototype of the generic function that shall exist in all the descendants.
GConstraint	getConstraint() Return the current component constraint.
String	getDefaultValueLabel() Get label of item selected by default.
GHyperlinkLabel	getGHyperlinkLabel() Get the GHyperlinkLabel associated with the widget.
List<GMenuItem>	getGMenuItem() Get the GMenuItem array associated with the widget.
GPopupMenu	getGPopupMenu() Get the GPopupMenu associated with the widget.
String	getSelectedItem() Get the text associated with the selected menu item.
int	getValue() Get the rang of the selected menu item.
boolean	isEnabled() Gets the enable status of the widget.
void	setConstraint(GConstraint constraint) Set the constraint for the component.
void	setDefaultValue(int newDefaultRank) Set the item selected by default.
void	setEnabled(boolean b) Set the enable status of the component.
void	setMouseEvent(int event) Set the event that will launch the display of the popup menu.
void	setStringConstraint(String constraint) Set the constraint in string format for the component.
void	setTitle(String title) Set the text to be displayed in the hyperlink label.
void	setTooltipsList(String[] tooltipsList) Setter of tooltips to each item in the popup list.
void	setValue(int value) Set the rang of the selected menu item.
void	setWidgetId(String widgetId) Sets the widget identifier of the component.

Methods inherited from class fr.cnes.genius.lowLevel.GContainer

put

Methods inherited from class fr.cnes.genius.main.GComponent

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getComponent, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getSubComponent, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setToolTipText, 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

GPopupList

public GPopupList(String title,
                  List<GMenuItem> menuItems)

Constructor. The widget identifier is created automatically.

Parameters:

title - that will be displayed in the hyperlink label.

menuItems - list of menus to display in the popup menu.

GPopupList

public GPopupList(String widgetId,
                  String title,
                  List<GMenuItem> menuItems)

Constructor. Using this constructor implies that the hyperlink label will not be updated with the contents of the selected menu item.

Parameters:

widgetId - widget identifier.

title - that will be displayed in the hyperlink label.

menuItems - list of menus to display in the popup menu.

GPopupList

public GPopupList(String widgetId,
                  String title,
                  List<GMenuItem> menuItems,
                  String[] toolTipsList)

Constructor. Using this constructor implies that the hyperlink label will not be updated with the contents of the selected menu item. A list of tooltips for each element is given.

Parameters:

widgetId - widget identifier.

title - that will be displayed in the hyperlink label.

menuItems - list of menus to display in the popup menu.

toolTipsList - for the different items.

GPopupList

public GPopupList(int rank,
                  ArrayList<GMenuItem> menuItems)

Constructor. This constructor will set the text of the hyperlink label to the text of the selected menu item. The widget identifier will be created automatically.

Parameters:

rank - of the selected menu item.

menuItems - list of menus to display in the popup menu.

GPopupList

public GPopupList(String widgetId,
                  int rank,
                  ArrayList<GMenuItem> menuItems)

Constructor. This constructor will set the text of the hyperlink label to the text of the selected menu item.

Parameters:

widgetId - widget identifier.

rank - of the selected menu item.

menuItems - list of menus to display in the popup menu.

GPopupList

public GPopupList(String widgetId,
                  int rank,
                  ArrayList<GMenuItem> menuItems,
                  String[] toolTipsList)

Constructor. This constructor will set the text of the hyperlink label to the text of the selected menu item. A list of tooltips for each element is given.

Parameters:

widgetId - widget identifier.

rank - of the selected menu item.

menuItems - list of menus to display in the popup menu.

toolTipsList - for the different items.

Method Detail

setConstraint

public void setConstraint(GConstraint constraint)

Set the constraint for the component.

Overrides:

setConstraint in class GComponent

Parameters:

constraint - constraint to set for the component.

getConstraint

public GConstraint getConstraint()

Return the current component constraint.

Overrides:

getConstraint in class GComponent

Returns:

the current component constraint.

setStringConstraint

public void setStringConstraint(String constraint)

Set the constraint in string format for the component.

Overrides:

setStringConstraint in class GComponent

Parameters:

constraint - constraint in string format to set for the component.

generic

public void generic()
             throws GException

Description copied from class: GContainer

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

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

Throws:

GException - in case of problem while reading the value from file.

getGHyperlinkLabel

public GHyperlinkLabel getGHyperlinkLabel()

Get the GHyperlinkLabel associated with the widget.

Returns:

the GHyperlinkLabel associated with the widget.

getGPopupMenu

public GPopupMenu getGPopupMenu()

Get the GPopupMenu associated with the widget.

Returns:

the GPopupMenu associated with the widget.

getGMenuItem

public List<GMenuItem> getGMenuItem()

Get the GMenuItem array associated with the widget.

Returns:

the GMenuItem array associated with the widget.

setWidgetId

public void setWidgetId(String widgetId)

Description copied from class: GComponent

Sets the widget identifier of the component.

Overrides:

setWidgetId in class GComponent

Parameters:

widgetId - the widget identifier of the component.

setTitle

public void setTitle(String title)

Set the text to be displayed in the hyperlink label.

Parameters:

title - text to be displayed in the hyperlink label.

add

public void add(GMenuItem menuItem)

Add a menu item to the popup menu.

Parameters:

menuItem - menu item to add to the popup menu.

addSeparator

public void addSeparator()

Add a separtor to the popup menu.

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.

getSelectedItem

public String getSelectedItem()

Get the text associated with the selected menu item.

Returns:

the text associated with the selected menu item.

getValue

public int getValue()

Get the rang of the selected menu item.

Returns:

the rang of the selected menu item.

setValue

public void setValue(int value)

Set the rang of the selected menu item.

Parameters:

value - the rang of the selected menu item.

setMouseEvent

public void setMouseEvent(int event)

Set the event that will launch the display of the popup menu.

Parameters:

event - that will launch the display of the popup menu.

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.

setDefaultValue

public void setDefaultValue(int newDefaultRank)

Set the item selected by default.

Parameters:

newDefaultRank - new rank of the item selected by default.

getDefaultValueLabel

public String getDefaultValueLabel()
                            throws GException

Get label of item selected by default.

Returns:

the label of the item selected by default.

Throws:

GException - in case of wrong default item rank.

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 final void setTooltipsList(String[] tooltipsList)

Setter of tooltips to each item in the popup list.

Parameters:

tooltipsList - the ordered list of tooltips to be set.