fr.cnes.genius.interval

Class GIntervalFormatDuration

java.lang.Object

fr.cnes.genius.interval.GIntervalFormatAbstract

fr.cnes.genius.interval.GIntervalFormatDuration

public class GIntervalFormatDuration
extends GIntervalFormatAbstract

Abstract class defining an interval formatter used to update the format of the tooltip message of a GTime.

Author:

ffsm HISTORIQUE VERSION:1.12:DM:DM-1603:06/04/2023:[GENIUS] Format d'affichage de Gtime VERSION:1.11:DM:DM-1274:10/11/2021:[GENIUS] Widget Gtime 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 FIN-HISTORIQUE

Constructor Summary

Constructors

Constructor and Description
GIntervalFormatDuration() Empty constructor.
GIntervalFormatDuration(GDateUtils.GDateFormat format, GUnit unit) Constructor.

Method Summary

Modifier and Type	Method and Description
String	format(Object object) Create the message from the value in the field.
void	update(GDateUtils.GDateFormat format, GUnit unit) Update the class attributes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GIntervalFormatDuration

public GIntervalFormatDuration()

Empty constructor.

GIntervalFormatDuration

public GIntervalFormatDuration(GDateUtils.GDateFormat format,
                               GUnit unit)

Constructor.

Parameters:

format - calendar or fractional for the interval edges to be shown in the message

unit - current unit needed to determine the number of fractional digits for the interval edges to be shown in the message

Method Detail

format

public String format(Object object)

Create the message from the value in the field. The object must be of Number type.

Specified by:

format in class GIntervalFormatAbstract

Parameters:

object - the value of the field.

Returns:

the tooltip message correctly formated.

update

public void update(GDateUtils.GDateFormat format,
                   GUnit unit)

Update the class attributes.

Parameters:

format - calendar or fractional for the interval edges to be shown in the message

unit - current unit needed to determine the number of fractional digits for the interval edges to be shown in the message