fr.cnes.genius.lowLevel

Class GRealField

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GTextField

fr.cnes.genius.lowLevel.GNumberFieldAbstract

fr.cnes.genius.lowLevel.GRealField

All Implemented Interfaces:

GDisplay, GListener, ActionListener, FocusListener, KeyListener, MouseWheelListener, EventListener

public class GRealField
extends GNumberFieldAbstract
implements GListener

This class implements a field which allows entering and displaying only real numbers, double values in normal and scientific formats. It also controls the input from the user to avoid having values that are not doubles. The precision of the field can also be controlled. It is possible to configure the maximum number of digits after the point. One can enter data values in standard or scientific formats. Display can be in standard or scientific format. The user can switch between the 2 formats by a popup menu. Implementation of the class GRealField guarantees no loss of precision from display format. It limits dynamically the number of digits that the user can enter. *

Author:

jjct

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.genius.lowLevel.GTextField

GTextField.GDocumentFieldFilterAbstract

Nested classes/interfaces inherited from class fr.cnes.genius.main.GComponent

GComponent.CopyPasteOperation, GComponent.DisplayIndicatorStatus, GComponent.ItemType, GComponent.Operation

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_FRAC_DIGITS

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

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GRealField(double value) Constructor.
GRealField(String widgetId, double value) 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.
String	formatValue(double value, GEnvironment.Format format) Format the value to display according to the formatting options of the field.
GEnvironment.Format	getCurrentFormat() Get the current format of the field.
String	getFormattedValue() Return the value contained by the field in the format that shall be used to read/write from/to file.
String	getFormattedValue(Object value) Return the value contained by the field in the format that shall be used to read/write from/to file.
int	getFracDigits() Get the number of fractinal digits of the field.
String	getUnitString() Get the unit string present in the field or null if no unit is present.
Object	getValue() Get the current value of the widget.
void	setCurrentFormat(GEnvironment.Format formatMode) Sets the current format.
void	setFormatMode(GEnvironment.Format formatMode) Sets the format allowed for the field.
void	setFracDigits(int fracDigits) Set the number of fractional digits.
void	setValue(Object numberValue) Set the value of the widget.

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

getIsNotAnInstanceIfNumberError

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

actionPerformed, computeDefaultWidth, display, focusGained, focusLost, getCharWidth, getComponent, getJTextField, getText, keyPressed, keyReleased, keyTyped, setDocumentFilter, setEnabled, setText

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

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

Field Detail

MAX_FRAC_DIGITS

public static final int MAX_FRAC_DIGITS

See Also:

Constant Field Values

Constructor Detail

GRealField

public GRealField(double value)

Constructor. The widget identificator is generated automatically.

Parameters:

value - to display in the field.

GRealField

public GRealField(String widgetId,
                  double value)

Constructor. By default the number of significant digits is set to 15. The format is automatic between scientific and normal. The normal format is used when 10e4 >= value >= 10e-3.

Parameters:

widgetId - widget identificator.

value - to display in the widget.

Method Detail

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.

getCurrentFormat

public GEnvironment.Format getCurrentFormat()

Get the current format of the field.

Specified by:

getCurrentFormat in class GNumberFieldAbstract

Returns:

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 - if fracDigits <= 0 or > 15.

formatValue

public String formatValue(double value,
                          GEnvironment.Format format)

Format the value to display according to the formatting options of the field.

Parameters:

value - value to format.

format - used to format the value, either NORMAL or SCIENTIFIC.

Returns:

the formatted value.

before

public void before(GEvent e)
            throws GException

Called before the event is processed.

Specified by:

before in interface GListener

Overrides:

before in class GTextField

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

Overrides:

after in class GTextField

Parameters:

e - processed event.

Throws:

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

setValue

public void setValue(Object numberValue)

Set the value of the widget.

Specified by:

setValue in class GNumberFieldAbstract

Parameters:

numberValue - new value of the widget.

getValue

public Object getValue()

Get the current value of the widget.

Specified by:

getValue in class GNumberFieldAbstract

Returns:

the current value of the widget.

getUnitString

public String getUnitString()

Get the unit string present in the field or null if no unit is present.

Specified by:

getUnitString in class GNumberFieldAbstract

Returns:

the unit string present in the field or null if no unit is present.

getFormattedValue

public String getFormattedValue()

Return the value contained by the field in the format that shall be used to read/write from/to file.

Specified by:

getFormattedValue in class GNumberFieldAbstract

Returns:

the formatted value.

getFormattedValue

public String getFormattedValue(Object value)

Return the value contained by the field in the format that shall be used to read/write from/to file.

Specified by:

getFormattedValue in class GNumberFieldAbstract

Parameters:

value - to format.

Returns:

the formatted value.

getFracDigits

public int getFracDigits()

Get the number of fractinal digits of the field.

Specified by:

getFracDigits in class GNumberFieldAbstract

Returns:

the number of fractional digits