fr.cnes.genius.highLevel

Class GEntryInt

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GEntryNumberAbstract

fr.cnes.genius.highLevel.GEntryInt

All Implemented Interfaces:

GClear, GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

public class GEntryInt
extends GEntryNumberAbstract
implements GReadWrite, GClear, GListener

Entry class for integer numbers. The entry widget contains a label and an entry field. The entry does not allow the user to enter a string that is not an integer. The widget allows to save/load the value to the configuration file. The class inherits from class GEntryNumberAbstract which is in charge of validity range handling.

Author:

J. Fourcade

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , split 2" 0, 1 => (null)
1	GIntField	textField	(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
GEntryInt() Constructor by default
GEntryInt(String label, int value) Constructor, the widget identifier is set automatically.
GEntryInt(String widgetId, String label, 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.
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.
int	getSavedValue() Get the last saved value.
int	getValue() Get the value stored in the entry.
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	setDefaultValue(int value) Set the new default value.
void	setSavedValue(int value) Set the new saved value.
void	setValue(int value) Set the value of the entry.
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, generic, getGField, getGInterval, getGLabelWithIndicator, getGTextField, getNumber, getSubComponent, isCopyPasteEvent, isEnabled, removeGInterval, setDefaultConstraints, setEnabled, setShortcut, setStringConstraint, setToolTipText, setWidgetId, 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

GEntryInt

public GEntryInt()

Constructor by default

GEntryInt

public GEntryInt(String label,
                 int value)

Constructor, the widget identifier is set automatically.

Parameters:

label - of the entry.

value - initial value for the entry.

GEntryInt

public GEntryInt(String widgetId,
                 String label,
                 int value)

Constructor.

Parameters:

widgetId - identifier of the widget.

label - of the entry.

value - initial value for the entry.

Method Detail

getValue

public int getValue()

Get the value stored in the entry.

Returns:

the value stored in the entry.

setValue

public void setValue(int value)

Set the value of the entry.

Parameters:

value - to set.

setDefaultValue

public void setDefaultValue(int value)

Set the new default value.

Parameters:

value - new default value.

setSavedValue

public void setSavedValue(int value)

Set the new saved value.

Parameters:

value - new saved value.

getSavedValue

public int getSavedValue()

Get the last saved value.

Returns:

the last saved value.

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()

Description copied from class: GComponent

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

Description copied from interface: GClear

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.

before

public void before(GEvent e)
            throws GException

Description copied from interface: GListener

Called before the event is processed.

Specified by:

before in interface GListener

Parameters:

e - event to processed.

Throws:

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

after

public void after(GEvent e)
           throws GException,
                  GFileManipulatorException

Description copied from interface: GListener

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

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