fr.cnes.genius.lowLevel

Class GIntField

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GTextField

fr.cnes.genius.lowLevel.GNumberFieldAbstract

fr.cnes.genius.lowLevel.GIntField

All Implemented Interfaces:

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

public class GIntField
extends GNumberFieldAbstract
implements GListener

Implements a field capable of formatting 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.

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 inherited from class fr.cnes.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GIntField(int value) Constructor.
GIntField(String widgetId, int 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.
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 written directly in the field.
Object	getValue() Get the current value of the widget.
boolean	isModified() Gets the modification status of the component against the last set of values loaded or saved.
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, 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

Constructor Detail

GIntField

public GIntField(int value)

Constructor. The widget identificator is generated automatically.

Parameters:

value - to display in the field.

GIntField

public GIntField(String widgetId,
                 int 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

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.

getUnitString

public String getUnitString()

Get the unit string written directly in the field.

Specified by:

getUnitString in class GNumberFieldAbstract

Returns:

the unit string written directly in the field, or null if no unit string was input by the user.

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.

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.

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.

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.

getCurrentFormat

public GEnvironment.Format getCurrentFormat()

Get the current format of the field.

Specified by:

getCurrentFormat in class GNumberFieldAbstract

Returns:

The current format

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