fr.cnes.genius.highLevel

Class GConstantSelector

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GConstantSelector

All Implemented Interfaces:

GDisplay, GListener, MouseWheelListener, EventListener

public class GConstantSelector
extends GContainer
implements GDisplay, GListener

Class implementing a GButton and a GDialog allowing the selection of constants from a list provided by the user.

Author:

jjct

Default Constraint(s):

Index	Class	Item	Constraint
0	GButton	button	"newline"
1	GConstantSelelectorDialog	dialog	"newline , pushx , pushy , growx , growy" (see table below)

Default Constraint(s) for dialog:

Index	Class	Item	Constraint
1, 0	GComboBoxWithLabel	combobox	1, 0, 0, 0 => "split 3" 1, 0, 0, 1 => (null) 1, 0, 1 => (null)
1, 1	GLabel	label	"newline , split 3"
1, 2	GLabel	valueLabel	(null)
1, 3	GLabel	unitLabel	(null)
1, 4	GButton	selectButton	"newline , pushx , pushy"
1, 5	GButton	cancelButton	(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
GConstantSelector(String buttonTitle, String dialogTitle, String[] labelList, double[] valueList, String unitString) Constructor.
GConstantSelector(String widgetId, String buttonTitle, String dialogTitle, String[] labelList, double[] valueList, String unitString) Constructor.

Method Summary

Modifier and Type	Method and Description
void	after(GEvent e) Called after the event is processed.
void	before(GEvent e) Called before the event is processed.
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[]	getLabelList() Getter for the list of labels.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
String	getUnitString() Getter for the unit string.
Double	getValue() Get the selected constant of null if no constant is currently selected.
double[]	getValueList() Getter for the list of values.
boolean	isEnabled() Gets the enable status of the widget.
void	setConstraint(GConstraint constraint) Set the constraint for the component.
void	setDialogTooltip(String text) Set the tooltip to display in the dialog label.
void	setEnabled(boolean flag) Set the enable status of the component.
void	setStringConstraint(String constraint) Set the constraint in string format for the component.
void	setToolTipText(String text) Set the tooltip text for the entry's label.
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, 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, 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

GConstantSelector

public GConstantSelector(String buttonTitle,
                         String dialogTitle,
                         String[] labelList,
                         double[] valueList,
                         String unitString)

Constructor. The widget identifier is created automatically.

Parameters:

buttonTitle - of the button.

dialogTitle - of the dialog.

labelList - list of labels to display in the constant selector.

valueList - list of values associated with the labels.

unitString - string of the unit to be displayed along with the value, null if no unit is to be displayed.

GConstantSelector

public GConstantSelector(String widgetId,
                         String buttonTitle,
                         String dialogTitle,
                         String[] labelList,
                         double[] valueList,
                         String unitString)

Constructor. The widget identifier is created automatically.

Parameters:

widgetId - widget identifier.

buttonTitle - of the button.

dialogTitle - of the dialog.

labelList - list of labels to display in the constant selector.

valueList - list of values associated with the labels.

unitString - string of the unit to be displayed along with the value, null if no unit is to be displayed.

Method Detail

getLabelList

public String[] getLabelList()

Getter for the list of labels.

Returns:

the list of labels.

getValueList

public double[] getValueList()

Getter for the list of values.

Returns:

the list of values.

getUnitString

public String getUnitString()

Getter for the unit string.

Returns:

the unit string.

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.

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.

getValue

public Double getValue()

Get the selected constant of null if no constant is currently selected.

Returns:

the selected constant of null if no constant is currently selected.

setEnabled

public void setEnabled(boolean flag)

Description copied from class: GComponent

Set the enable status of the component.

Overrides:

setEnabled in class GComponent

Parameters:

flag - new enable status of the component.

isEnabled

public boolean isEnabled()

Description copied from class: GComponent

Gets the enable status of the widget.

Overrides:

isEnabled in class GComponent

Returns:

true if the component is enabled, false otherwise.

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.

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.

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.

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.

setDialogTooltip

public void setDialogTooltip(String text)

Set the tooltip to display in the dialog label.

Parameters:

text - tooltip to display in the dialog label.

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.

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.