fr.cnes.genius.lowLevel

Class GNumberFieldAbstract

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GTextField

fr.cnes.genius.lowLevel.GNumberFieldAbstract

All Implemented Interfaces:

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

Direct Known Subclasses:

GDateField, GIntField, GRealField

public abstract class GNumberFieldAbstract
extends GTextField

Abstract class defining the interface that shall be followed by the GIntField and GRealField.

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
GNumberFieldAbstract(String widgetId) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract GEnvironment.Format	getCurrentFormat() Get the current format of the field.
abstract String	getFormattedValue() Return the value contained by the field in the format that shall be used to read/write from/to file.
abstract String	getFormattedValue(Object value) Return the value contained by the field in the format that shall be used to read/write from/to file.
abstract int	getFracDigits() Get the number of fractinal digits of the field.
protected String	getIsNotAnInstanceIfNumberError() Get the error message to be displayed when an instance is not of the Number class.
abstract String	getUnitString() Get the unit string written directly in the field.
abstract Object	getValue() Get the current value of the widget.
abstract void	setValue(Object numberValue) Set the value of the widget.

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

actionPerformed, after, before, 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

Constructor Detail

GNumberFieldAbstract

public GNumberFieldAbstract(String widgetId)

Constructor.

Parameters:

widgetId - widget identifier.

Method Detail

getIsNotAnInstanceIfNumberError

protected String getIsNotAnInstanceIfNumberError()

Get the error message to be displayed when an instance is not of the Number class.

Returns:

the error message to be displayed when an instance is not of the Number class.

setValue

public abstract void setValue(Object numberValue)

Set the value of the widget.

Parameters:

numberValue - new value of the widget.

getValue

public abstract Object getValue()

Get the current value of the widget.

Returns:

the current value of the widget.

getFormattedValue

public abstract String getFormattedValue(Object value)

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

Parameters:

value - to format.

Returns:

the formatted value.

getFormattedValue

public abstract String getFormattedValue()

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

Returns:

the formatted value.

getUnitString

public abstract String getUnitString()

Get the unit string written directly in the field.

Returns:

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

getCurrentFormat

public abstract GEnvironment.Format getCurrentFormat()

Get the current format of the field.

Returns:

The current format

getFracDigits

public abstract int getFracDigits()

Get the number of fractinal digits of the field.

Returns:

the number of fractional digits