fr.cnes.genius.highLevel

Class GObjectSelector<T>

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GObjectSelector<T>

Type Parameters:

T - type of object to be selected.

All Implemented Interfaces:

GDisplay, GListener, MouseWheelListener, EventListener

public abstract class GObjectSelector<T>
extends GContainer
implements GDisplay, GListener

Class implementing a GButton and a GDialog allowing the selection of objects from a list provided by the user.

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
GObjectSelector(String buttonTitle, String dialogTitle, String[] labelList, T[] objectList, String unitString) Constructor.
GObjectSelector(String widgetId, String buttonTitle, String dialogTitle, String[] labelList, T[] objectList, String unitString) Constructor.

Method Summary

Modifier and Type	Method and Description
void	after(GEvent e) Called after the event is processed.
void	before(GEvent e) Called before the event is processed.
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.
GConstraint	getConstraint() Return the current component constraint.
T	getObject() Get the selected object or null if no object is currently selected.
protected abstract String	getObjectValue(int comboboxValue) Method to compose the string associated to the selected object to be used to fulfill the object value label.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
boolean	isEnabled() Gets the enable status of the widget.
void	setConstraint(GConstraint constraint) Set the constraint for the component.
void	setDialogTooltip(String text) Set the tooltip to display in the dialog label.
void	setEnabled(boolean flag) Set the enable status of the component.
void	setStringConstraint(String constraint) Set the constraint in string format for the component.
void	setToolTipText(String text) Set the tooltip text for the entry's label.

Methods inherited from class fr.cnes.genius.lowLevel.GContainer

put

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

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getComponent, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, 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

GObjectSelector

public GObjectSelector(String buttonTitle,
                       String dialogTitle,
                       String[] labelList,
                       T[] objectList,
                       String unitString)

Constructor. The widget identifier is created automatically.

Parameters:

buttonTitle - of the button.

dialogTitle - of the dialog.

labelList - list of labels to display in the object selector.

objectList - list of objects associated with the labels.

unitString - string of the unit to be displayed along with the object, null if no unit is to be displayed.

GObjectSelector

public GObjectSelector(String widgetId,
                       String buttonTitle,
                       String dialogTitle,
                       String[] labelList,
                       T[] objectList,
                       String unitString)

Constructor. The widget identifier is created automatically.

Parameters:

widgetId - widget identifier.

buttonTitle - of the button.

dialogTitle - of the dialog.

labelList - list of labels to display in the object selector.

objectList - list of objects associated with the labels.

unitString - string of the unit to be displayed along with the object, null if no unit is to be displayed.

Method Detail

setConstraint

public void setConstraint(GConstraint constraint)

Set the constraint for the component.

Overrides:

setConstraint in class GComponent

Parameters:

constraint - constraint to set for the component.

getConstraint

public GConstraint getConstraint()

Return the current component constraint.

Overrides:

getConstraint in class GComponent

Returns:

the current component constraint.

getObject

public T getObject()

Get the selected object or null if no object is currently selected.

Returns:

the selected object or null if no object is currently selected.

getObjectValue

protected abstract String getObjectValue(int comboboxValue)

Method to compose the string associated to the selected object to be used to fulfill the object value label.

Parameters:

comboboxValue - selected in the selector combobox.

Returns:

the string to be shown in the object value label.

setEnabled

public void setEnabled(boolean flag)

Set the enable status of the component.

Overrides:

setEnabled in class GComponent

Parameters:

flag - new enable status of the component.

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.

before

public void before(GEvent e)
            throws GException

Called before the event is processed.

Specified by:

before in interface GListener

Parameters:

e - event to processed.

Throws:

GException - in case there is a problem managing the event.

after

public void after(GEvent e)
           throws GException

Called after the event is processed.

Specified by:

after in interface GListener

Parameters:

e - processed event.

Throws:

GException - in case there is a problem managing the event.

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.

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.

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.

setDialogTooltip

public void setDialogTooltip(String text)

Set the tooltip to display in the dialog label.

Parameters:

text - tooltip to display in the dialog label.

setStringConstraint

public void setStringConstraint(String constraint)

Set the constraint in string format for the component.

Overrides:

setStringConstraint in class GComponent

Parameters:

constraint - constraint in string format to set for the 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.