fr.cnes.genius.highLevel

Class GSliderAbstractWithLabel

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GSliderAbstractWithLabel

All Implemented Interfaces:

GDisplay, MouseWheelListener, EventListener

Direct Known Subclasses:

GSliderRealWithLabel, GSliderWithLabel

public class GSliderAbstractWithLabel
extends GContainer
implements GDisplay

Abstract class encapsulating the common methods for GSliderWithLabel and GSliderRealWithLabel.

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
GSliderAbstractWithLabel(String label, GSliderAbstract slider, GNumberFieldAbstract setValueEntry) Constructor.
GSliderAbstractWithLabel(String widgetId, String label, GSliderAbstract slider, GNumberFieldAbstract setValueEntry) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addGInterval(GIntervalAbstract interval) Adds a validity interval to the field.
void	attachCopyPasteMenu(String label, GComponent.CopyPasteOperation... operationList) Attach the copy and paste menu to this component.
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.
GLabelWithIndicator	getGLabelWithIndicator() Get the m_label.
GSliderAbstract	getGSlider() Get the m_slider as a GSliderAbstract.
protected Number	getNumber() Get the value of the slider as a Number so it can be used for both real and integer values.
GNumberFieldAbstract	getSetValueEntry() Get the m_slider as a GSliderAbstract.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
GComponent.CopyPasteOperation	isCopyPasteEvent(GEvent event) Checks if the event corresponds to one of the copy and paste menu operations.
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	removeGInterval(GIntervalAbstract interval) Remove a validity interval of the field.
protected void	setDefaultConstraints() Set default constraints.
void	setEnabled(boolean b) Set the enable status of the component.
void	setStringConstraint(String constraints) Set the constraint in string format for the component.
void	setToolTipText(String text) Set the tooltip text for the entry's label.
protected void	setUnitPoupList(GPopupList unitPopupList) Set the unit popupList component, used internally by the GSliderRealWithLabel.
void	updateGInterval(GIntervalAbstract oldInterval, GIntervalAbstract newInterval) Update a validity interval of the field.
void	updateStatus() Update the status of the field applying the defined validity intervals.

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

GSliderAbstractWithLabel

public GSliderAbstractWithLabel(String label,
                                GSliderAbstract slider,
                                GNumberFieldAbstract setValueEntry)

Constructor. The widget identifier is assigned automatically.

Parameters:

label - of the widget.

slider - the slider of the widget.

setValueEntry - entry field that sets / gets the value of the slider.

GSliderAbstractWithLabel

public GSliderAbstractWithLabel(String widgetId,
                                String label,
                                GSliderAbstract slider,
                                GNumberFieldAbstract setValueEntry)

Constructor.

Parameters:

widgetId - identifier of the widget.

label - of the widget.

slider - the slider of the widget.

setValueEntry - entry field that sets / gets the value of the slider.

Method Detail

setDefaultConstraints

protected void setDefaultConstraints()

Description copied from class: GComponent

Set default constraints.

Overrides:

setDefaultConstraints in class GComponent

setUnitPoupList

protected void setUnitPoupList(GPopupList unitPopupList)

Set the unit popupList component, used internally by the GSliderRealWithLabel.

Parameters:

unitPopupList - the unit popupList component.

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.

generic

public void generic()
             throws GException

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

Specified by:

generic in class GContainer

Throws:

GException - In case of problem.

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.

getNumber

protected Number getNumber()

Get the value of the slider as a Number so it can be used for both real and integer values.

Returns:

value as a Number.

getGSlider

public GSliderAbstract getGSlider()

Get the m_slider as a GSliderAbstract.

Returns:

the m_slider.

getSetValueEntry

public GNumberFieldAbstract getSetValueEntry()

Get the m_slider as a GSliderAbstract.

Returns:

the m_slider.

getGLabelWithIndicator

public GLabelWithIndicator getGLabelWithIndicator()

Get the m_label.

Returns:

the m_label.

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.

addGInterval

public void addGInterval(GIntervalAbstract interval)
                  throws GIntervalException

Adds a validity interval to the field.

Parameters:

interval - to add.

Throws:

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

updateGInterval

public void updateGInterval(GIntervalAbstract oldInterval,
                            GIntervalAbstract newInterval)
                     throws GIntervalException

Update a validity interval of the field.

Parameters:

oldInterval - to update.

newInterval - to update newInterval.

Throws:

GIntervalException - in case oldInterval is not found in the list of intervals defined for the field.

removeGInterval

public void removeGInterval(GIntervalAbstract interval)

Remove a validity interval of the field.

Parameters:

interval - to be removed

updateStatus

public void updateStatus()

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

isModified

public boolean isModified()

Description copied from class: GComponent

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.

setToolTipText

public void setToolTipText(String text)

Set the tooltip text for the entry's label.

Overrides:

setToolTipText in class GComponent

Parameters:

text - the tooltip text for the entry's label.

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.

isCopyPasteEvent

public GComponent.CopyPasteOperation isCopyPasteEvent(GEvent event)

Checks if the event corresponds to one of the copy and paste menu operations.

Overrides:

isCopyPasteEvent in class GComponent

Parameters:

event - to check.

Returns:

the operation matching the event of null if the event do not correspond to the copy and paste menu.

setStringConstraint

public void setStringConstraint(String constraints)

Set the constraint in string format for the component.

Overrides:

setStringConstraint in class GComponent

Parameters:

constraints - constraint in string format to set for the component.