fr.cnes.genius.lowLevel

Class GSliderAbstract

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GSliderAbstract

All Implemented Interfaces:

MouseWheelListener, EventListener

Direct Known Subclasses:

GSlider, GSliderReal

public abstract class GSliderAbstract
extends GComponent

Abstract class encapsulating the common methods for GSlider and GSliderReal.

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
GSliderAbstract(String widgetId) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract JSlider	getJSlider() Get the Swing JSlider object.
abstract Number	getMajorTickSpacing() This method gets the major tick spacing.
abstract Number	getMaxVal() Get the maximum value of the slider.
abstract Number	getMinVal() Get the minimum value of the slider.
abstract boolean	getPaintLabels() Tells if labels are to be painted.
abstract boolean	getPaintTicks() Tells if the track (area the slider slides in) is to be painted.
abstract Number	getValue() Get the current value of the widget.
abstract void	setMajorTickSpacing(Number spacing) This method sets the major tick spacing.
abstract void	setPaintLabels(boolean flag) Determines whether labels are painted on the slider.
abstract void	setPaintTicks(boolean flag) Determines whether the track is painted on the slider.
abstract void	setValue(Number numberValue) Set the value of the widget.

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

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

GSliderAbstract

public GSliderAbstract(String widgetId)

Constructor.

Parameters:

widgetId - widget identifier

Method Detail

setValue

public abstract void setValue(Number numberValue)
                       throws GArithmeticException

Set the value of the widget.

Parameters:

numberValue - new value of the widget.

Throws:

GArithmeticException - if numberValue is NaN

getValue

public abstract Number getValue()

Get the current value of the widget.

Returns:

the current value of the widget.

getMaxVal

public abstract Number getMaxVal()

Get the maximum value of the slider.

Returns:

the maximum value of the slider.

getMinVal

public abstract Number getMinVal()

Get the minimum value of the slider.

Returns:

the minimum value of the slider.

getJSlider

public abstract JSlider getJSlider()

Get the Swing JSlider object.

Returns:

JSlider swing component.

getPaintTicks

public abstract boolean getPaintTicks()

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

Returns:

true if track is painted, else false

setPaintTicks

public abstract void setPaintTicks(boolean flag)

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

Parameters:

flag - whether or not to paint the slider track.

getPaintLabels

public abstract boolean getPaintLabels()

Tells if labels are to be painted.

Returns:

true if labels are painted, else false.

setPaintLabels

public abstract void setPaintLabels(boolean flag)

Determines whether labels are painted on the slider.

Parameters:

flag - whether or not to paint labels.

setMajorTickSpacing

public abstract void setMajorTickSpacing(Number spacing)

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

Parameters:

spacing - new value for the majorTickSpacing property.

getMajorTickSpacing

public abstract Number getMajorTickSpacing()

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

Returns:

spacing value for the majorTickSpacing property.