fr.cnes.genopus.bodies

Class GPCelestialBody

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GComboBoxWithLabel

fr.cnes.genius.highLevel.GObjectComboBoxWithLabel<fr.cnes.sirius.patrius.bodies.CelestialBody>

fr.cnes.genopus.bodies.GPCelestialBody

All Implemented Interfaces:

fr.cnes.genius.main.GClear, fr.cnes.genius.main.GDisplay, fr.cnes.genius.main.GListener, fr.cnes.genius.main.GReadWrite, GPPatrius<fr.cnes.sirius.patrius.bodies.CelestialBody>, MouseWheelListener, EventListener

public class GPCelestialBody
extends fr.cnes.genius.highLevel.GObjectComboBoxWithLabel<fr.cnes.sirius.patrius.bodies.CelestialBody>
implements GPPatrius<fr.cnes.sirius.patrius.bodies.CelestialBody>

Class implementing a combo box to select a celestial body.

Author:

ffsm

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , split 2" 0, 1 => (null)
1	GComboBox	combobox	(null)

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.genius.main.GComponent

fr.cnes.genius.main.GComponent.CopyPasteOperation, fr.cnes.genius.main.GComponent.DisplayIndicatorStatus, fr.cnes.genius.main.GComponent.ItemType, fr.cnes.genius.main.GComponent.Operation

Field Summary

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

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GPCelestialBody() Empty constructor.
GPCelestialBody(String label) Constructor.
GPCelestialBody(String widgetId, String label) Constructor.
GPCelestialBody(String widgetId, String label, fr.cnes.sirius.patrius.bodies.CelestialBody initialBody, fr.cnes.sirius.patrius.bodies.CelestialBody[] availableBodies) Constructor.

Method Summary

Modifier and Type	Method and Description
fr.cnes.sirius.patrius.bodies.CelestialBody	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
void	setObjectList(fr.cnes.sirius.patrius.bodies.CelestialBody... bodiesToShow) Setter for the list of celestial bodies available in the widget.

Methods inherited from class fr.cnes.genius.highLevel.GObjectComboBoxWithLabel

clear, getDefaultObject, getObject, getObjectList, getSavedObject, setDefaultObject, setDefaultObjectList, setDefaultObjectList, setDefaultValue, setDefaultValue, setDefaultValueList, setDefaultValueList, setDefaultValueList, setObject, setObjectList, setObjectList, setSavedObject, setSavedValue, setSavedValue, setValue, setValue, setValueList, setValueList, setValueList

Methods inherited from class fr.cnes.genius.highLevel.GComboBoxWithLabel

after, attachCopyPasteMenu, before, display, generic, getDefaultValue, getDefaultValueEnum, getErrorLabelsList, getGComboBox, getGLabelWithIndicator, getSavedValue, getSavedValueEnum, getSelectedItem, getSubComponent, getValue, getValueEnum, getWarningLabelsList, isCopyPasteEvent, isEnabled, isModified, read, setEnabled, setErrorLabelsList, setStringConstraint, setTooltipsList, setToolTipText, setWarningLabelsList, setWidgetId, updateIsModifiedIndicator, updateStatus, write

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, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, 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

GPCelestialBody

public GPCelestialBody()

Empty constructor. The widget identifier is created automatically.

Throws:

fr.cnes.sirius.patrius.utils.exception.PatriusException

GPCelestialBody

public GPCelestialBody(String label)

Constructor. The widget identifier is created automatically.

Parameters:

label - to display on the side of the combobox.

Throws:

fr.cnes.sirius.patrius.utils.exception.PatriusException

GPCelestialBody

public GPCelestialBody(String widgetId,
                       String label)

Constructor.

Parameters:

widgetId - widget identifier.

label - to display on the side of the combobox.

Throws:

fr.cnes.sirius.patrius.utils.exception.PatriusException

GPCelestialBody

public GPCelestialBody(String widgetId,
                       String label,
                       fr.cnes.sirius.patrius.bodies.CelestialBody initialBody,
                       fr.cnes.sirius.patrius.bodies.CelestialBody[] availableBodies)

Constructor.

Parameters:

widgetId - widget identifier.

label - to display on the side of the combobox.

initialBody - initial body to be selected. It must be a body available in the widget, otherwise it will throw a GRuntimeException.

availableBodies - list of available bodies to be present in the combobox.

Throws:

fr.cnes.sirius.patrius.utils.exception.PatriusException

Method Detail

getPatriusObject

public fr.cnes.sirius.patrius.bodies.CelestialBody getPatriusObject()
                                                             throws fr.cnes.genius.exception.GException

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatrius<fr.cnes.sirius.patrius.bodies.CelestialBody>

Returns:

the PATRIUS object associated to the widget.

Throws:

fr.cnes.genius.exception.GException - if the PATRIUS object cannot be created from the widget data

setObjectList

public void setObjectList(fr.cnes.sirius.patrius.bodies.CelestialBody... bodiesToShow)

Setter for the list of celestial bodies available in the widget. The current selected body must be one of them. If the list of bodies is null or empty, all of them will be shown.

Parameters:

bodiesToShow - an array of CelestialBody with the list of celestial bodies to show in the widget. If null or empty: all bodies will be shown.