fr.cnes.genius.highLevel

Class GEntryReal

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GEntryNumberAbstract

fr.cnes.genius.highLevel.GEntryReal

All Implemented Interfaces:

GClear, GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

Direct Known Subclasses:

GEntryConstant

public class GEntryReal
extends GEntryNumberAbstract
implements GReadWrite, GListener, GClear

Entry widget accepting real numbers in scientific and normal notation, and unit management. The class defines an input field for real number value. It is composed of a label and an object GRealField, and of a pop-up menu GPopupList for display and selection of unit when unit is defined for the field. The class implements save / load of values in the configuration. The class inherits of class GEntryNumberAbstract which is in charge of validity range handling.

Author:

jjct

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , split 2" 0, 1 => (null)
1	GRealField	textField	(null)
2	GPopupList	units	(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
GEntryReal() Constructor by default.
GEntryReal(String label, double value) Constructor.
GEntryReal(String label, double value, GUnit[] units) Constructor.
GEntryReal(String widgetId, String label, double memoryValue) Constructor.
GEntryReal(String widgetId, String label, double memoryValue, GUnit[] units) 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	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	generic() The prototype of the generic function that shall exist in all the descendants.
GUnit	getCurrentUnit() Return the currently selected unit.
double	getDefaultValue() Get the default value of the entry as a double.
GPopupList	getGUnitsPopupList() Gettern for the units popupList.
protected Number	getNumber() Get the value of the entry as a Number so it can be used for real and integer values.
double	getSavedValue() Get the saved value.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
GUnit[]	getUnitsArray() Method to get the the units as an array or null if it has not units.
double	getValue() Get the value of the entry as a double.
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	setCurrentFormat(GEnvironment.Format formatMode) Sets the current format.
void	setDefaultValue(double memoryValue) Set the default value.
void	setEnabled(boolean b) Set the enable status of the component.
void	setFormatMode(GEnvironment.Format formatMode) Sets the format allowed for the field.
void	setFracDigits(int fracDigits) Set the number of fractional digits.
void	setSavedValue(double memoryValue) Set the saved value.
void	setUnit(String unit) Sets the unit of the entry, the value displayed in the entry is converted to the new unit.
void	setValue(double memoryValue) Set the value of the entry.
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 field applying the defined validity intervals.
void	write() Implementaion of the routines that allow the component to be saved to a configuration file.

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

addGInterval, attachCopyPasteMenu, display, getGField, getGInterval, getGLabelWithIndicator, getGTextField, isCopyPasteEvent, isEnabled, removeGInterval, setDefaultConstraints, 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

GEntryReal

public GEntryReal()

Constructor by default.

GEntryReal

public GEntryReal(String label,
                  double value)

Constructor. The widgetId will be assigned automatically. No units will be available.

Parameters:

label - for the entry.

value - initial value.

GEntryReal

public GEntryReal(String label,
                  double value,
                  GUnit[] units)

Constructor. The widgetId will be assigned automatically.

Parameters:

label - for the entry.

value - initial value.

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

Throws:

GEntryRealException

GEntryReal

public GEntryReal(String widgetId,
                  String label,
                  double memoryValue)

Constructor. No units will be available.

Parameters:

widgetId - widged identifier.

label - for the entry.

memoryValue - initial value.

GEntryReal

public GEntryReal(String widgetId,
                  String label,
                  double memoryValue,
                  GUnit[] units)

Constructor.

Parameters:

widgetId - widged identifier.

label - for the entry.

memoryValue - initial value.

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

Method Detail

getGUnitsPopupList

public GPopupList getGUnitsPopupList()

Gettern for the units popupList.

Returns:

the units popupList

getSubComponent

public GComponent getSubComponent(int position)
                           throws GComponentException

Gets the subcomponent occupying the position defined by position.

Overrides:

getSubComponent in class GEntryNumberAbstract

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.

setWidgetId

public void setWidgetId(String widgetId)

Sets the widget identifier of the component.

Overrides:

setWidgetId in class GEntryNumberAbstract

Parameters:

widgetId - the widget identifier of the component.

setFormatMode

public void setFormatMode(GEnvironment.Format formatMode)

Sets the format allowed for the field. If the format is NORMAL the value is formatted using the standard format. If the format is SCIENTIFIC the value is formatted using the scientific format. If the format is BOTH then a menu is enabled allowing the user to change between formats.

Parameters:

formatMode - allowed for the field.

setCurrentFormat

public void setCurrentFormat(GEnvironment.Format formatMode)

Sets the current format.

Parameters:

formatMode - the current format.

setFracDigits

public void setFracDigits(int fracDigits)
                   throws GEntryRealException

Set the number of fractional digits.

Parameters:

fracDigits - number of fractional digits.

Throws:

GEntryRealException - in case the number of fractionary digits is bigger than MAX_FRAC_DIGITS (defaults to 15).

getNumber

protected Number getNumber()

Get the value of the entry as a Number so it can be used for real and integer values.

Overrides:

getNumber in class GEntryNumberAbstract

Returns:

value as a Number.

generic

public void generic()
             throws GException

The prototype of the generic function that shall exist in all the descendants.

Overrides:

generic in class GEntryNumberAbstract

Throws:

GException - In case of problem.

setEnabled

public void setEnabled(boolean b)

Set the enable status of the component.

Overrides:

setEnabled in class GEntryNumberAbstract

Parameters:

b - new enable status of the component.

getUnitsArray

public GUnit[] getUnitsArray()

Method to get the the units as an array or null if it has not units.

Returns:

the the units as an array or null if it has not units.

getValue

public double getValue()

Get the value of the entry as a double.

Returns:

the value of the entry as a double

getDefaultValue

public double getDefaultValue()

Get the default value of the entry as a double.

Returns:

the default value of the entry as a double

setValue

public void setValue(double memoryValue)
              throws GArithmeticException

Set the value of the entry. The unit of the value are supposed to be the memory unit, the value is converted to the selected unit in the entry field before being displayed. If the entry field does not have units, no conversion is performed.

Parameters:

memoryValue - to set for the entry.

Throws:

GArithmeticException - if memoryValue is NaN, positive infinity or negative infinity.

setDefaultValue

public void setDefaultValue(double memoryValue)
                     throws GArithmeticException

Set the default value.

Parameters:

memoryValue - new default value.

Throws:

GArithmeticException - if memoryValue is NaN, positive infinity or negative infinity.

setSavedValue

public void setSavedValue(double memoryValue)
                   throws GArithmeticException

Set the saved value.

Parameters:

memoryValue - new saved value.

Throws:

GArithmeticException - if memoryValue is NaN, positive infinity or negative infinity.

getSavedValue

public double getSavedValue()

Get the saved value.

Returns:

the last saved value.

setUnit

public void setUnit(String unit)

Sets the unit of the entry, the value displayed in the entry is converted to the new unit.

Parameters:

unit - name.

getCurrentUnit

public GUnit getCurrentUnit()

Return the currently selected unit.

Returns:

the currently selected unit.

before

public void before(GEvent e)

Called before the event is processed.

Specified by:

before in interface GListener

Parameters:

e - event to processed.

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

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.

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.

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.

updateIsModifiedIndicator

protected void updateIsModifiedIndicator()

Updates the is modified indicator.

Overrides:

updateIsModifiedIndicator in class GComponent

updateStatus

public void updateStatus()

Update the status of the field applying the defined validity intervals.

Overrides:

updateStatus in class GEntryNumberAbstract