fr.cnes.genius.lowLevel

Class GTime

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.lowLevel.GTime

All Implemented Interfaces:

GClear, GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

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

Author:

dqj HISTORIQUE VERSION:1.12.1:FA:FA-1646:26/05/2023:[GENIUS] Bug avec le GPlot contexte db puis contexte madona VERSION:1.12:FA:FA-1602:06/04/2023:[GENIUS] Divers bugs dans la classe Gtime VERSION:1.12:DM:DM-1603:06/04/2023:[GENIUS] Format d'affichage de Gtime VERSION:1.12:DM:DM-1524:06/04/2023:[GENIUS] Possibilite de charger / sauvegarder une configuration pour GPlotPanel VERSION:1.12:DM:DM-1500:06/04/2023:[GENIUS] Buffered console dans l'IHM standard VERSION:1.11:DM:DM-949:10/11/2021:[GENIUS] Prise en compte equations simples dans GPlotPanel VERSION:1.11:FA:FA-1144:10/11/2021:[GENIUS] Correction des non-conformites résiduelles GENIUS 1.10 VERSION:1.11:DM:DM-1127:10/11/2021:[GENIUS] GPlotPanel VERSION:1.11:DM:DM-1274:10/11/2021:[GENIUS] Widget Gtime FIN-HISTORIQUE

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , gapleft 0 , split 2" 0, 1 => (null)
1	GPDateOffsetField	offsetField	"split 2"
2	GPopupList	popupListUnits	(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
GTime() Empty constructor.
GTime(String label) Constructor.
GTime(String label, double duration) Constructor.
GTime(String widgetId, String label) Constructor.
GTime(String widgetId, String label, double duration) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addGInterval(GInterval interval) Adds a validity interval to the duration value.
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.
GDateUtils.GDateFormat	getCurrentDurationFormat() Getter for the duration format.
double	getDefaultValue() Get default duration from GTime.
double	getDuration() Getter for the duration value.
String	getDurationString() Get duration from GTime.
GLabelWithIndicator	getGlabel() Getter for the label of the widget.
GPopupList	getGPopupList() Getter for the GPopupList defining the unit of a fractional offset.
GTextField	getGTextField() Getter for the duration field.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
double	getValue() Get duration from GTime.
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(GInterval interval) Remove a validity interval of the field.
void	setConstraint(int labelGap) Setter for the constraints of the widget.
void	setCurrentFormat(GDateUtils.GDateFormat durationFormat) Setter for the duration format.
void	setDefaultDuration(double defaultDuration) Set default duration value.
void	setDefaultDuration(String defaultDuration) Set default duration value.
void	setDuration(double duration) Setter for the duration value in seconds.
void	setEnabled(boolean b) Set the enable status of the component.
void	setUnit(GUnit durationUnit) Setter for the duration unit.
void	setValue(String stringDuration) Set duration from string.
void	setWidgetId(String widgetId) Sets the widget identifier of the component.
void	updateIsModifiedIndicator() Updates the isModified indicator, this method shall be overwritten by the child classes that need to.
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, isCopyPasteEvent, 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, 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

GTime

public GTime()
      throws GDateFieldException,
             GArithmeticException

Empty constructor.

Throws:

GArithmeticException - thrown if failed

GDateFieldException - thrown if failed

GTime

public GTime(String label)
      throws GDateFieldException,
             GArithmeticException

Constructor. Widget Id is assigned automatically.

Parameters:

label - text to display in the label.

Throws:

GArithmeticException - thrown if failed

GDateFieldException - thrown if failed

GTime

public GTime(String label,
             double duration)
      throws GDateFieldException,
             GArithmeticException

Constructor. The widgetId will be assigned automatically.

Parameters:

label - text to display in the label.

duration - duration to set. Its absolute value must be lower than Long.MAX_VALUE

Throws:

GArithmeticException - thrown if failed

GDateFieldException - thrown if failed

GTime

public GTime(String widgetId,
             String label)
      throws GDateFieldException,
             GArithmeticException

Constructor.

Parameters:

widgetId - widget identifier.

label - text to display in the label.

Throws:

GArithmeticException - thrown if failed

GDateFieldException - thrown if failed

GTime

public GTime(String widgetId,
             String label,
             double duration)
      throws GArithmeticException

Constructor.

Parameters:

widgetId - widget identifier.

label - text to display in the label.

duration - duration to set. Its absolute value must be lower than Long.MAX_VALUE

Throws:

GArithmeticException - thrown if failed

Method Detail

setWidgetId

public final void setWidgetId(String widgetId)

Sets the widget identifier of the component.

Overrides:

setWidgetId in class GComponent

Parameters:

widgetId - the widget identifier of the component.

getGlabel

public GLabelWithIndicator getGlabel()

Getter for the label of the widget.

Returns:

the label of the widget.

getGTextField

public GTextField getGTextField()

Getter for the duration field.

Returns:

the duration field.

getGPopupList

public GPopupList getGPopupList()

Getter for the GPopupList defining the unit of a fractional offset.

Returns:

the GPopupList defining the unit of a fractional offset.

setDuration

public void setDuration(double duration)
                 throws GArithmeticException

Setter for the duration value in seconds.

Parameters:

duration - the duration in seconds to set.

Throws:

GArithmeticException - if duration is NaN.

setUnit

public void setUnit(GUnit durationUnit)
             throws GDateFieldException

Setter for the duration unit.

Parameters:

durationUnit - format in which the duration will be shown in the widget.

Throws:

GDateFieldException - if given unit is not available in the widget.

setValue

public void setValue(String stringDuration)
              throws GDateFieldException,
                     GArithmeticException

Set duration from string.

Parameters:

stringDuration - string duration to set.

Throws:

GArithmeticException - if duration cannot be parseds

GDateFieldException - if duration is in bad format

setDefaultDuration

public void setDefaultDuration(double defaultDuration)
                        throws GDateFieldException,
                               GArithmeticException

Set default duration value.

Parameters:

defaultDuration - new default duration value.

Throws:

GDateFieldException - in case the value can not be parsed.

GArithmeticException - thrown if failed

setDefaultDuration

public void setDefaultDuration(String defaultDuration)
                        throws GDateFieldException

Set default duration value.

Parameters:

defaultDuration - new default string value.

Throws:

GDateFieldException - in case the value can not be parsed.

getValue

public double getValue()
                throws GArithmeticException

Get duration from GTime.

Returns:

duration

Throws:

GArithmeticException - thrown if failed

getDefaultValue

public double getDefaultValue()

Get default duration from GTime.

Returns:

mDefaultDuration

getDurationString

public String getDurationString()
                         throws GArithmeticException

Get duration from GTime.

Returns:

duration as string

Throws:

GArithmeticException - thrown if failed

getCurrentDurationFormat

public GDateUtils.GDateFormat getCurrentDurationFormat()

Getter for the duration format.

Returns:

format in which the duration is shown in the widget.

setCurrentFormat

public void setCurrentFormat(GDateUtils.GDateFormat durationFormat)

Setter for the duration format.

Parameters:

durationFormat - format in which the duration will be shown in the widget.

setConstraint

public final void setConstraint(int labelGap)

Setter for the constraints of the widget.

Parameters:

labelGap - left gap from panel border to display the label

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.

addGInterval

public void addGInterval(GInterval interval)
                  throws GIntervalException

Adds a validity interval to the duration value.

Parameters:

interval - real interval to add.

Throws:

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

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.

updateStatus

public final void updateStatus()

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

updateIsModifiedIndicator

public void updateIsModifiedIndicator()

Updates the isModified indicator, this method shall be overwritten by the child classes that need to.

Overrides:

updateIsModifiedIndicator in class GComponent

removeGInterval

public void removeGInterval(GInterval interval)

Remove a validity interval of the field.

Parameters:

interval - to be removed

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.

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.

generic

public void generic()

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

Specified by:

generic in class GContainer

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.

before

public void before(GEvent e)

Called before the event is processed.

Specified by:

before in interface GListener

Parameters:

e - event to processed.

after

public void after(GEvent e)
           throws GDateFieldException

Called after the event is processed.

Specified by:

after in interface GListener

Parameters:

e - processed event.

Throws:

GDateFieldException

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.

clear

public 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.

Specified by:

clear in interface GClear

getDuration

public double getDuration()

Getter for the duration value.

Returns:

the duration value.