fr.cnes.genius.highLevel

Class GEntryDate

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GEntryDate

All Implemented Interfaces:

GClear, GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

public class GEntryDate
extends GContainer
implements GDisplay, GReadWrite, GListener, GClear

Class representing a text entry with a label.

Author:

jjct

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , split 2" 0, 1 => (null)
1	GDateField	textField	"wmin 160"

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
GEntryDate() Constructor by default.
GEntryDate(String label, Date value) Constructor.
GEntryDate(String label, String value) Constructor.
GEntryDate(String widgetId, String label, Date value) Constructor.
GEntryDate(String widgetId, String label, String stringValue) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addGInterval(GIntervalDate interval) Adds a validity interval to the field.
void	after(GEvent e) Called after the event is processed.
void	attachCopyPasteMenu(String label, GComponent.CopyPasteOperation... operationList) Attach the copy and paste menu to this component.
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	display() Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.
void	generic() The prototype of the generic function that shall exist in all the descendants.
GDateField	getGDateField() Get the m_dateField.
GIntervalAbstract	getGInterval(int index) Get the interval of a given index in the list.
GLabelWithIndicator	getGLabelWithIndicator() Get the m_label.
String	getStringValue() Return the value of the field.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
Date	getValue() Return the value of the field.
GComponent.CopyPasteOperation	isCopyPasteEvent(GEvent event) Checks if the event corresponds to one of the copy and paste menu operations.
boolean	isEnabled() Gets the enable status of the widget.
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	removeGInterval(GIntervalDate interval) Remove a validity interval of the field.
protected void	setDefaultConstraints() Set default constraints.
void	setDefaultValue(Date newValue) Set default value.
void	setDefaultValue(String newValue) Set default value.
void	setEnabled(boolean b) Set the enable status of the component.
void	setSavedValue(Date value) Change the saved value.
void	setShortcut(int shorcutKey) Set the shortcut key for focusing the entryField.
void	setToolTipText(String text) Set the tooltip text for the entry's label.
void	setValue(Date value) Set the value of the field.
void	setValue(String stringValue) Set the value of the field.
void	updateGInterval(GIntervalDate oldInterval, GIntervalDate newInterval) Update a validity interval of the field.
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.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, setStringConstraint, setWidgetId, 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

GEntryDate

public GEntryDate()
           throws GDateFieldException,
                  GArithmeticException,
                  ParseException

Constructor by default.

Throws:

GArithmeticException - thrown if failed

GDateFieldException - thrown if failed

ParseException - thrown if failed

GEntryDate

public GEntryDate(String label,
                  String value)
           throws GDateFieldException,
                  GArithmeticException,
                  ParseException

Constructor. The widget identifier is set automatically.

Parameters:

label - of the entry.

value - value of the entry.

Throws:

GArithmeticException - thrown if failed

GDateFieldException - thrown if failed

ParseException - thrown if failed

GEntryDate

public GEntryDate(String widgetId,
                  String label,
                  String stringValue)
           throws GDateFieldException,
                  GArithmeticException

Constructor.

Parameters:

widgetId - identifier of the widget.

label - of the entry.

stringValue - value of the entry.

Throws:

GArithmeticException - thrown if failed

GDateFieldException - thrown if failed

GEntryDate

public GEntryDate(String label,
                  Date value)

Constructor. The widget identifier is set automatically.

Parameters:

label - of the entry.

value - value of the entry.

GEntryDate

public GEntryDate(String widgetId,
                  String label,
                  Date value)

Constructor.

Parameters:

widgetId - identifier of the widget.

label - of the entry.

value - value of the entry.

Method Detail

setDefaultConstraints

protected final void setDefaultConstraints()

Set default constraints.

Overrides:

setDefaultConstraints in class GComponent

getSubComponent

public GComponent getSubComponent(int position)
                           throws GComponentException

Gets the subcomponent occupying the position defined by position.

Overrides:

getSubComponent in class GComponent

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.

generic

public void generic()
             throws GException

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

Specified by:

generic in class GContainer

Throws:

GException - In case of problem.

display

public void display()
             throws GException

Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.

Specified by:

display in interface GDisplay

Throws:

GException - in case of problem while reading the value from file.

isEnabled

public boolean isEnabled()

Gets the enable status of the widget.

Overrides:

isEnabled in class GComponent

Returns:

true if the component is enabled, false otherwise.

setEnabled

public void setEnabled(boolean b)

Set the enable status of the component.

Overrides:

setEnabled in class GComponent

Parameters:

b - new enable status of the component.

getValue

public Date getValue()

Return the value of the field.

Returns:

value of the field.

getStringValue

public String getStringValue()

Return the value of the field.

Returns:

value of the field.

setValue

public void setValue(String stringValue)
              throws GDateFieldException,
                     GArithmeticException

Set the value of the field.

Parameters:

stringValue - to set in the field.

Throws:

GDateFieldException - in case the date in string format cannot be parsed.

GArithmeticException - in case the duration in string format cannot be parsed.

setValue

public void setValue(Date value)

Set the value of the field.

Parameters:

value - to set in the field.

setSavedValue

public void setSavedValue(Date value)

Change the saved value.

Parameters:

value - new 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

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.

addGInterval

public void addGInterval(GIntervalDate interval)
                  throws GIntervalException

Adds a validity interval to the field.

Parameters:

interval - to add.

Throws:

GIntervalException - in case the interval overlaps with an existing one.

getGInterval

public GIntervalAbstract getGInterval(int index)

Get the interval of a given index in the list.

Parameters:

index - of the wanted interval in the intervals list.

Returns:

wanted interval

updateGInterval

public void updateGInterval(GIntervalDate oldInterval,
                            GIntervalDate newInterval)
                     throws GIntervalException

Update a validity interval of the field.

Parameters:

oldInterval - to update.

newInterval - to update newInterval.

Throws:

GIntervalException - in case oldInterval is not found in the list of intervals defined for the field.

removeGInterval

public void removeGInterval(GIntervalDate interval)

Remove a validity interval of the field.

Parameters:

interval - to be removed

updateStatus

public void updateStatus()

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

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.

before

public void before(GEvent e)
            throws GException

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

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

getGLabelWithIndicator

public GLabelWithIndicator getGLabelWithIndicator()

Get the m_label.

Returns:

the m_label.

attachCopyPasteMenu

public void attachCopyPasteMenu(String label,
                                GComponent.CopyPasteOperation... operationList)

Attach the copy and paste menu to this component. The operations can be choosen using the operationList parameter: Copy, Paste, Import, Export.

Overrides:

attachCopyPasteMenu in class GComponent

Parameters:

label - of the copy&paste menu, if null no label is displayed.

operationList - list of operations to set in the menu. Valid values are Copy if the "Copy" menu is available, Paste if the "Paste" menu is available, Import if the "Import" menu is available, and Export if the "Export" menu is available.

isCopyPasteEvent

public GComponent.CopyPasteOperation isCopyPasteEvent(GEvent event)

Checks if the event corresponds to one of the copy and paste menu operations.

Overrides:

isCopyPasteEvent in class GComponent

Parameters:

event - to check.

Returns:

the operation matching the event of null if the event do not correspond to the copy and paste menu.

getGDateField

public GDateField getGDateField()

Get the m_dateField.

Returns:

the m_dateField.

updateIsModifiedIndicator

protected void updateIsModifiedIndicator()

Updates the is modified indicator.

Overrides:

updateIsModifiedIndicator in class GComponent

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.

setDefaultValue

public void setDefaultValue(Date newValue)

Set default value.

Parameters:

newValue - new default value.

setDefaultValue

public void setDefaultValue(String newValue)
                     throws GDateFieldException

Set default value.

Parameters:

newValue - new default value.

Throws:

GDateFieldException - in case the value can not be parsed.

setToolTipText

public void setToolTipText(String text)

Set the tooltip text for the entry's label.

Overrides:

setToolTipText in class GComponent

Parameters:

text - the tooltip text for the entry's label.

setShortcut

public void setShortcut(int shorcutKey)

Set the shortcut key for focusing the entryField.

Parameters:

shorcutKey - the shortcut key to be attached to the wigdet.