fr.cnes.genius.highLevel

Class GSliderRealWithLabel

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GSliderAbstractWithLabel

fr.cnes.genius.highLevel.GSliderRealWithLabel

All Implemented Interfaces:

GClear, GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

public class GSliderRealWithLabel
extends GSliderAbstractWithLabel
implements GListener, GReadWrite, GClear

This class defines a real slider having a validity interval. The widget contains a label and a real slider. The widget allows to save/load the value of the slider to the configuration file.

Author:

jjct

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , split 2" 0, 1 => (null)
1	GRealField	setValueEntry	(null)
2	GPopupList	units	(null)
3	GSliderReal	slider	"newline"

Note:

The example is given for an HORIZONTAL slider.

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
GSliderRealWithLabel(String label, String orientation, double minVal, double maxVal, double initVal, double spacing, int fracDigits) Constructor.
GSliderRealWithLabel(String label, String orientation, double minVal, double maxVal, double initVal, double spacing, int fracDigits, GUnit[] units) Constructor.
GSliderRealWithLabel(String widgetId, String label, String orientation, double minVal, double maxVal, double initVal, double spacing, int fracDigits) Constructor.
GSliderRealWithLabel(String widgetId, String label, String orientation, double minVal, double maxVal, double initVal, double spacing, int fracDigits, GUnit[] units) 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.
String	getFormattedValue(Number value) Return the value of the slider in the SCIENTIFIC format that shall be used to read/write from/to file.
int	getFracDigits() Get the number of fractional digits.
double	getSavedValue() Get the saved value.
double	getValue() Get the value of the slider.
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(double memoryValue) Set the default value.
void	setFracDigits(int fracDigits) Set the number of fractional digits.
void	setSavedValue(double memoryValue) Set the saved value.
void	setValue(double value) Set the value of the slider.
protected void	updateIsModifiedIndicator() Updates the is modified indicator.
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.GSliderAbstractWithLabel

addGInterval, attachCopyPasteMenu, display, generic, getGLabelWithIndicator, getGSlider, getNumber, getSetValueEntry, getSubComponent, isCopyPasteEvent, isEnabled, removeGInterval, setDefaultConstraints, setEnabled, setStringConstraint, setToolTipText, setUnitPoupList, updateGInterval, updateStatus

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, 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

GSliderRealWithLabel

public GSliderRealWithLabel(String label,
                            String orientation,
                            double minVal,
                            double maxVal,
                            double initVal,
                            double spacing,
                            int fracDigits,
                            GUnit[] units)

Constructor. The widget identifier is set automatically.

Parameters:

label - of the widget.

orientation - of the slider; can have the value "VERTICAL" or "HORIZONTAL", default is "HORIZONTAL".

minVal - minimum value.

maxVal - maximum value.

initVal - initial value.

spacing - spacing between the ticks.

fracDigits - number of significant digits after the decimal point in the labels.

units - list of units to display in the unit menu.

GSliderRealWithLabel

public GSliderRealWithLabel(String label,
                            String orientation,
                            double minVal,
                            double maxVal,
                            double initVal,
                            double spacing,
                            int fracDigits)

Constructor. The widget identifier is set automatically, without units.

Parameters:

label - of the widget.

orientation - of the slider; can have the value "VERTICAL" or "HORIZONTAL", default is "HORIZONTAL".

minVal - minimum value.

maxVal - maximum value.

initVal - initial value.

spacing - spacing between the ticks.

fracDigits - number of significant digits after the decimal point in the labels.

GSliderRealWithLabel

public GSliderRealWithLabel(String widgetId,
                            String label,
                            String orientation,
                            double minVal,
                            double maxVal,
                            double initVal,
                            double spacing,
                            int fracDigits)

Constructor. The widget identifier is set automatically, without units.

Parameters:

widgetId - widget identifier.

label - of the widget.

orientation - of the slider; can have the value "VERTICAL" or "HORIZONTAL", default is "HORIZONTAL".

minVal - minimum value.

maxVal - maximum value.

initVal - initial value.

spacing - spacing between the ticks.

fracDigits - number of significant digits after the decimal point in the labels.

GSliderRealWithLabel

public GSliderRealWithLabel(String widgetId,
                            String label,
                            String orientation,
                            double minVal,
                            double maxVal,
                            double initVal,
                            double spacing,
                            int fracDigits,
                            GUnit[] units)

Constructor. The widget identifier is set automatically.

Parameters:

widgetId - widget identifier.

label - of the widget.

orientation - of the slider; can have the value "VERTICAL" or "HORIZONTAL", default is "HORIZONTAL".

minVal - minimum value.

maxVal - maximum value.

initVal - initial value.

spacing - spacing between the ticks.

fracDigits - number of significant digits after the decimal point in the labels.

units - list of units to display in the unit menu.

Method Detail

getValue

public double getValue()

Get the value of the slider.

Returns:

the value of the slider.

setValue

public void setValue(double value)
              throws GArithmeticException

Set the value of the slider.

Parameters:

value - to set.

Throws:

GArithmeticException - if value is NaN

setDefaultValue

public void setDefaultValue(double memoryValue)
                     throws GArithmeticException

Set the default value.

Parameters:

memoryValue - new default value.

Throws:

GArithmeticException - if memoryValue is NaN.

setSavedValue

public void setSavedValue(double memoryValue)
                   throws GArithmeticException

Set the saved value.

Parameters:

memoryValue - new saved value.

Throws:

GArithmeticException - if memoryValue is NaN.

getSavedValue

public double getSavedValue()

Get the saved value.

Returns:

the last saved value.

setFracDigits

public void setFracDigits(int fracDigits)
                   throws GEntryRealException

Set the number of fractional digits.

Parameters:

fracDigits - number of fractional digits.

Throws:

GEntryRealException - launched when the number of fractional digits is greater than MAX_FRAC_DIGITS.

getFracDigits

public int getFracDigits()

Get the number of fractional digits.

Returns:

the number of fractional digits.

getFormattedValue

public String getFormattedValue(Number value)

Return the value of the slider in the SCIENTIFIC format that shall be used to read/write from/to file.

Parameters:

value - to format.

Returns:

the formatted value.

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

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

Gets the modification status of the component against the last set of values loaded or saved.

Overrides:

isModified in class GSliderAbstractWithLabel

Returns:

the modification status of the component against the last set of values loaded or saved.

clear

public void clear()
           throws GException

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.

updateIsModifiedIndicator

protected void updateIsModifiedIndicator()

Updates the is modified indicator.

Overrides:

updateIsModifiedIndicator in class GComponent