fr.cnes.genius.highLevel

Class GEntryNumberAbstract

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GEntryNumberAbstract

All Implemented Interfaces:

GClear, GDisplay, MouseWheelListener, EventListener

Direct Known Subclasses:

GEntryInt, GEntryReal

public abstract class GEntryNumberAbstract
extends GContainer
implements GDisplay, GClear

Abstract vector class encapsulating the common methods to GEntryIntVector and GEntryRealVector.

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
GEntryNumberAbstract(String widgetId, String label, GNumberFieldAbstract field) 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.
GNumberFieldAbstract	getGField() Get the m_textField as a GNumberFieldAbstract.
GIntervalAbstract	getGInterval(int index) Get the interval of a given index in the list.
GLabelWithIndicator	getGLabelWithIndicator() Get the m_label.
GTextField	getGTextField() Get the m_textField as a GTextField.
protected Number	getNumber() Get the value of the entry as a Number so it can be used for real and integer values.
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.
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	setShortcut(int shorcutKey) Set the shortcut key for focusing the entryField.
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.
void	setWidgetId(String widgetId) Sets the widget identifier of the component.
void	updateGInterval(GIntervalAbstract oldInterval, GIntervalAbstract newInterval) Update a validity interval of the field.
protected void	updateIntervalMessage(GUnit currentUnit, GIntervalFormatAbstract formatter) Updates the interval message taking into account the current unit and message of the entry.
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, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, 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

Methods inherited from interface fr.cnes.genius.main.GClear

clear

Constructor Detail

GEntryNumberAbstract

public GEntryNumberAbstract(String widgetId,
                            String label,
                            GNumberFieldAbstract field)

Constructor.

Parameters:

widgetId - widget identifier, if null an identifier will be automatically created.

label - text to display in the label.

field - to use to represent the value.

Method Detail

setDefaultConstraints

protected void setDefaultConstraints()

Description copied from class: GComponent

Set default constraints.

Overrides:

setDefaultConstraints in class GComponent

getSubComponent

public GComponent getSubComponent(int position)
                           throws GComponentException

Description copied from class: GComponent

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.

setWidgetId

public void setWidgetId(String widgetId)

Sets the widget identifier of the component.

Overrides:

setWidgetId in class GComponent

Parameters:

widgetId - the widget identifier of the component.

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 entry as a Number so it can be used for real and integer values.

Returns:

value as a Number.

getGField

public GNumberFieldAbstract getGField()

Get the m_textField as a GNumberFieldAbstract.

Returns:

the m_textField.

getGTextField

public GTextField getGTextField()

Get the m_textField as a GTextField.

Returns:

the m_textField.

getGLabelWithIndicator

public GLabelWithIndicator getGLabelWithIndicator()

Get the m_label.

Returns:

the m_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.

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.

updateIntervalMessage

protected void updateIntervalMessage(GUnit currentUnit,
                                     GIntervalFormatAbstract formatter)

Updates the interval message taking into account the current unit and message of the entry.

Parameters:

currentUnit - the current unit of the entry.

formatter - Necessary data to format the message (normal/scientific format and fractional digits)

removeGInterval

public void removeGInterval(GIntervalAbstract interval)

Remove a validity interval of the field.

Parameters:

interval - to be removed

getGInterval

public GIntervalAbstract getGInterval(int index)

Get the interval of a given index in the list.

Parameters:

index - of the wanted interval in the intervals list.

Returns:

wanted interval

updateStatus

public void updateStatus()

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

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.

setShortcut

public void setShortcut(int shorcutKey)

Set the shortcut key for focusing the entryField.

Parameters:

shorcutKey - the shortcut key to be attached to the widget.

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.