fr.cnes.genius.lowLevel

Class GSliderReal

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GSliderAbstract

fr.cnes.genius.lowLevel.GSliderReal

All Implemented Interfaces:

GDisplay, MouseWheelListener, EventListener, ChangeListener

public class GSliderReal
extends GSliderAbstract
implements GDisplay, ChangeListener

Real slider class based on the JSlider widget in order to input real numbers. The configuration of the widget allows the definition of minimum, maximum, and initial values and the horizontal or vertical orientation of the slider, and in addition the number of digits after the point.

Author:

jjct

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
GSliderReal(String orientation, double minVal, double maxVal, double initVal, double spacing, int fracDigits) Creates a GSlider widget based on a JSlider.
GSliderReal(String widgetId, String orientation, double minVal, double maxVal, double initVal, double spacing, int fracDigits) Creates a GSlider widget based on a JSlider.

Method Summary

Modifier and Type	Method and Description
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.
Component	getComponent() Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
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.
JSlider	getJSlider() Get the Swing JSlider object.
Number	getMajorTickSpacing() This method gets the major tick spacing.
Number	getMaxVal() Get the maximum value of the slider.
Number	getMinVal() Get the minimum value of the slider.
boolean	getPaintLabels() Tells if labels are to be painted.
boolean	getPaintTicks() Tells if the track (area the slider slides in) is to be painted.
Number	getValue() Get the current value of the widget.
void	setFracDigits(int fracDigits) Set the number of fractional digits.
void	setMajorTickSpacing(Number spacing) This method sets the major tick spacing.
void	setMaxVal(double value) Set the value of the slider.
void	setMinVal(double value) Set the value of the slider.
void	setPaintLabels(boolean flag) Determines whether labels are painted on the slider.
void	setPaintTicks(boolean flag) Determines whether the track is painted on the slider.
void	setValue(Number value) Set the value of the widget.
void	stateChanged(ChangeEvent e)

Methods inherited from class fr.cnes.genius.main.GComponent

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getSubComponent, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isEnabled, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setEnabled, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidgetId, setWidth, setWindowBusyCursor, updateIsModifiedIndicator, 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

GSliderReal

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

Creates a GSlider widget based on a JSlider. The widget identifier is assigned automatically.

Parameters:

orientation - of the slider, can have the values "VERTICAL" or "HORIZONTAL", defaults to "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.

GSliderReal

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

Creates a GSlider widget based on a JSlider.

Parameters:

widgetId - widget identifier

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.

Method Detail

display

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

Specified by:

display in interface GDisplay

stateChanged

public void stateChanged(ChangeEvent e)

Specified by:

stateChanged in interface ChangeListener

getComponent

public Component getComponent()

Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.

Overrides:

getComponent in class GComponent

Returns:

the Swing Component encapsulated by the class if any, otherwise returns null.

getJSlider

public JSlider getJSlider()

Get the Swing JSlider object.

Specified by:

getJSlider in class GSliderAbstract

Returns:

JSlider swing component.

getPaintTicks

public boolean getPaintTicks()

Tells if the track (area the slider slides in) is to be painted.

Specified by:

getPaintTicks in class GSliderAbstract

Returns:

true if track is painted, else false.

setPaintTicks

public final void setPaintTicks(boolean flag)

Determines whether the track is painted on the slider. By default, this property is true.

Specified by:

setPaintTicks in class GSliderAbstract

Parameters:

flag - whether or not to paint the slider track.

getPaintLabels

public boolean getPaintLabels()

Tells if labels are to be painted.

Specified by:

getPaintLabels in class GSliderAbstract

Returns:

true if labels are painted, else false

setPaintLabels

public final void setPaintLabels(boolean flag)

Determines whether labels are painted on the slider. By default, this property is true.

Specified by:

setPaintLabels in class GSliderAbstract

Parameters:

flag - whether or not to paint labels

setMajorTickSpacing

public final void setMajorTickSpacing(Number spacing)

This method sets the major tick spacing. The argument represents the distance, measured in values, between each major tick mark.

Specified by:

setMajorTickSpacing in class GSliderAbstract

Parameters:

spacing - new value for the majorTickSpacing property.

getMajorTickSpacing

public Number getMajorTickSpacing()

This method gets the major tick spacing. The number returned represents the distance, measured in values, between each major tick mark.

Specified by:

getMajorTickSpacing in class GSliderAbstract

Returns:

spacing value for the majorTickSpacing property.

setFracDigits

public void setFracDigits(int fracDigits)

Set the number of fractional digits.

Parameters:

fracDigits - number of fractional digits.

getFracDigits

public int getFracDigits()

Get the number of fractional digits.

Returns:

the number of fractional digits.

getValue

public Number getValue()

Get the current value of the widget.

Specified by:

getValue in class GSliderAbstract

Returns:

the current value of the widget.

setValue

public void setValue(Number value)
              throws GArithmeticException

Set the value of the widget.

Specified by:

setValue in class GSliderAbstract

Parameters:

value - new value of the widget.

Throws:

GArithmeticException - if value is NaN

getMinVal

public Number getMinVal()

Get the minimum value of the slider.

Specified by:

getMinVal in class GSliderAbstract

Returns:

minimum value of the slider.

setMinVal

public void setMinVal(double value)

Set the value of the slider.

Parameters:

value - new value of the slider.

getMaxVal

public Number getMaxVal()

Get the maximum value of the slider.

Specified by:

getMaxVal in class GSliderAbstract

Returns:

the maximum value of the slider.

setMaxVal

public void setMaxVal(double value)

Set the value of the slider.

Parameters:

value - new value of the slider.

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.