fr.cnes.genius.highLevel

Class GEntryConstant

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GEntryNumberAbstract

fr.cnes.genius.highLevel.GEntryReal

fr.cnes.genius.highLevel.GEntryConstant

All Implemented Interfaces:

GClear, GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

public class GEntryConstant
extends GEntryReal

Class implementing a GEntryReal plus a GConstantSelector.

Author:

goesterjf

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , gapleft 0" 0, 1 => (null)
1	GRealField	textField	"skip 1"
2	GPopupList	units	(null)
3	GPEarthEqRadSelector	constantSelectorEqRad	"newline" (see table below)
4	GLabel	GLabel_222	"newline , spanx 2 , height 0"

Default Constraint(s) for constantSelectorEqRad:

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

Default Constraint(s) for dialog:

Index	Class	Item	Constraint
3, 1, 0	GComboBoxWithLabel	combobox	3, 1, 0, 0, 0 => "split 3" 3, 1, 0, 0, 1 => (null) 3, 1, 0, 1 => (null)
3, 1, 1	GLabel	label	"newline , split 3"
3, 1, 2	GLabel	valueLabel	(null)
3, 1, 3	GLabel	unitLabel	(null)
3, 1, 4	GButton	selectButton	"newline , pushx , pushy"
3, 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
GEntryConstant(String label, double initialValue, GUnit[] units, GConstantSelector constantSelector) Constructor.
GEntryConstant(String label, double initialValue, GUnit[] units, String buttonTitle, String dialogTitle, String[] labelList, double[] valueList, String unitString) Constructor.
GEntryConstant(String widgetId, String label, double initialValue, GUnit[] units, GConstantSelector constantSelector) Constructor.
GEntryConstant(String widgetId, String label, double initialValue, GUnit[] units, 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	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.
GConstantSelector	getGConstantSelector() Getter for the GConstantSelector which allows to select a value for the constant.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
void	setConstraint(int widgetGap) Setter for the constraints of the widget.
protected void	setDefaultConstraints() Set default constraints.
void	setEnabled(boolean b) Set the enable status of the component.
void	setWidgetId(String widgetId) Sets the widget identifier of the component.

Methods inherited from class fr.cnes.genius.highLevel.GEntryReal

before, clear, generic, getCurrentUnit, getDefaultValue, getGUnitsPopupList, getNumber, getSavedValue, getUnitsArray, getValue, isModified, read, setCurrentFormat, setDefaultValue, setFormatMode, setFracDigits, setSavedValue, setUnit, setValue, updateIsModifiedIndicator, updateStatus, write

Methods inherited from class fr.cnes.genius.highLevel.GEntryNumberAbstract

addGInterval, attachCopyPasteMenu, getGField, getGInterval, getGLabelWithIndicator, getGTextField, isCopyPasteEvent, isEnabled, removeGInterval, setShortcut, setStringConstraint, setToolTipText, updateGInterval, updateIntervalMessage

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

GEntryConstant

public GEntryConstant(String label,
                      double initialValue,
                      GUnit[] units,
                      String buttonTitle,
                      String dialogTitle,
                      String[] labelList,
                      double[] valueList,
                      String unitString)

Constructor. The widget identifier is created automatically.

Parameters:

label - to be shown in the widget

initialValue - initial value.

units - list of units to display in the unit menu.

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.

GEntryConstant

public GEntryConstant(String widgetId,
                      String label,
                      double initialValue,
                      GUnit[] units,
                      String buttonTitle,
                      String dialogTitle,
                      String[] labelList,
                      double[] valueList,
                      String unitString)

Constructor.

Parameters:

widgetId - widget identifier.

label - to be shown in the widget

initialValue - initial value.

units - list of units to display in the unit menu.

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.

GEntryConstant

public GEntryConstant(String label,
                      double initialValue,
                      GUnit[] units,
                      GConstantSelector constantSelector)

Constructor. The widget identifier is created automatically.

Parameters:

label - to be shown in the widget

initialValue - initial value.

units - list of units to display in the unit menu.

constantSelector - the constant selector.

GEntryConstant

public GEntryConstant(String widgetId,
                      String label,
                      double initialValue,
                      GUnit[] units,
                      GConstantSelector constantSelector)

Constructor.

Parameters:

widgetId - widget identifier.

label - to be shown in the widget

initialValue - initial value.

units - list of units to display in the unit menu.

constantSelector - the constant selector.

Method Detail

setWidgetId

public void setWidgetId(String widgetId)

Sets the widget identifier of the component.

Overrides:

setWidgetId in class GEntryReal

Parameters:

widgetId - the widget identifier of the component.

setConstraint

public void setConstraint(int widgetGap)

Setter for the constraints of the widget.

Parameters:

widgetGap - left gap from panel border to display the sub-widgets of the widget.

setDefaultConstraints

protected final void setDefaultConstraints()

Description copied from class: GComponent

Set default constraints.

Overrides:

setDefaultConstraints in class GEntryNumberAbstract

getGConstantSelector

public GConstantSelector getGConstantSelector()

Getter for the GConstantSelector which allows to select a value for the constant.

Returns:

the GConstantSelector which allows to select a value for the constant.

setEnabled

public void setEnabled(boolean b)

Set the enable status of the component.

Overrides:

setEnabled in class GEntryReal

Parameters:

b - new enable status of the component.

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

Overrides:

display in class GEntryNumberAbstract

Throws:

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

after

public void after(GEvent e)
           throws GException

Called after the event is processed.

Specified by:

after in interface GListener

Overrides:

after in class GEntryReal

Parameters:

e - processed event.

Throws:

GException - in case there is a problem managing the event.

getSubComponent

public GComponent getSubComponent(int position)
                           throws GComponentException

Gets the subcomponent occupying the position defined by position.

Overrides:

getSubComponent in class GEntryReal

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.