fr.cnes.genius.highLevel

Class GTable1D

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GPanel

fr.cnes.genius.highLevel.GTable1D

All Implemented Interfaces:

GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

public class GTable1D
extends GPanel
implements GReadWrite, GListener

The class implements a table for functions of a single variable x, the same variable for all represented functions. The table may be represented horizontally or vertically. It is composed of a group of objects GEntryIntVector and GEntryRealVector. It is possible to mix the two types of vectors. The class GTable1D contains an abstract object GEntryVectorAbstract for vectors handling. The class allows inserting or deleting lines / columns depending of orientation of the table.

Author:

J. Fourcade

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabel	title	"wrap"
1	GEntryRealVector	realVector	"newline" (see table below)
2	GEntryIntVector	intVector	"newline" (see table below)
3	GEntryDateVector	dateVector	"newline" (see table below)
...	...	...	...
numVec+1	GPopupList	popup_0	(null)
numVec+2	GPopupList	popup_1	(null)
numVec+3	GPopupList	popup_2	(null)
...	...	...	...
numVec+i+1	GPopupList	popup_i	(null)

Default Constraint(s) for realVector:

Index	Class	Item	Constraint
1, 0	GLabelWithIndicator	label	1, 0, 0 => "split 2 , alignx Center" 1, 0, 1 => (null)
1, 1	GRealField	field_1	"newline"
1, 2	GRealField	field_2	"newline"
...	...	...	...
1, i	GRealField	field_i	"newline"
1, 3	GPopupList	unitPopup	"alignx Center , cell 0 1"

Default Constraint(s) for intVector:

Index	Class	Item	Constraint
2, 0	GLabelWithIndicator	label	2, 0, 0 => "split 2 , alignx Center" 2, 0, 1 => (null)
2, 1	GIntField	field_1	""
2, 2	GIntField	field_2	""
...	...	...	...
2, i	GIntField	field_i	""

Default Constraint(s) for dateVector:

Index	Class	Item	Constraint
3, 0	GLabelWithIndicator	label	3, 0, 0 => "split 2 , alignx Center" 3, 0, 1 => (null)
3, 1	GDateField	field_1	"wmin 160"
3, 2	GDateField	field_2	"wmin 160"
...	...	...	...
3, i	GDateField	field_i	"wmin 160"

Note:

The example is given for a VERTICAL orientation table.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GTable1D.TableOrientation Defines the orientation of the table.

Nested classes/interfaces inherited from class fr.cnes.genius.lowLevel.GPanel

GPanel.Panel, GPanel.ScrollBarVisibility

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
GTable1D(String name, GTable1D.TableOrientation orientation, GEntryVectorAbstract... vectors) Constructor.
GTable1D(String widgetId, String label, GTable1D.TableOrientation orientation, GEntryVectorAbstract... vectors) Constructor.

Method Summary

Modifier and Type	Method and Description
void	after(GEvent e) Called after the event is processed.
void	attachCopyPasteMenu(String label, GComponent.CopyPasteOperation... operationList) Attach the copy and paste menu to this component.
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() Abstract generic function that need to be implemented by the descendants.
GEntryVectorAbstract	getGVector(int index) Getter for the vector with the specified index.
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	read() Implementaion of the routines that allow the component to be loaded from a configuration file.
void	setCopyPasteMenuEnabled(boolean b) Set the enable status of the copy-paste menu associated to the component.
protected void	setDefaultConstraints() set the defaults constraints
void	setDefaultValues(Object... defaultValues) Setter for the default values for each vector of the table.
void	setEnabled(boolean flag) Set the enable status of the component.
void	setSavedValues(Object[]... vectors) Setter for the table saved values.
void	setValues(Object[]... vectors) Setter for the table values.
void	setWidgetId(String widgetId) Sets the widget identifier of the component.
protected void	updateIsModifiedIndicator() Updates the is modified indicator.
void	updateStatus() Update status.
void	write() Implementaion of the routines that allow the component to be saved to a configuration file.

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

clearConstraint, getClassConstraint, getComponent, getHorizontalScroll, getInnerDescendantClassConstraint, getJPanel, getJScrollPane, getLayoutConstraints, getStringClassConstraint, getVerticalScroll, mainClear, mainDisplay, processMouseWheelEvent, put, setClassConstraint, setColumnConstraints, setConstraint, setHorizontalScroll, setInnerDescendantClassConstraint, setLayoutConstraints, setMargins, setPanelConstraints, setPreferredSize, setRowConstraints, setUnitIncrement, setVerticalScroll, unput

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

activateConstraintsByType, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, 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, setBusyCursor, setCommentInConfigFile, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, 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

GTable1D

public GTable1D(String name,
                GTable1D.TableOrientation orientation,
                GEntryVectorAbstract... vectors)

Constructor.

Parameters:

name - of the table, the name is used in the configuration file.

orientation - of the table, it can be HORIZONTAL or VERTICAL.

vectors - array of GEntryVectorAbstract with the values for the different functions f(x), g(x), etc to display.

GTable1D

public GTable1D(String widgetId,
                String label,
                GTable1D.TableOrientation orientation,
                GEntryVectorAbstract... vectors)

Constructor.

Parameters:

widgetId - widget identifier.

label - of the table, it is also used in the configuration file.

orientation - of the table, it can be HORIZONTAL or VERTICAL.

vectors - array of GEntryVectorAbstract with the values for the different functions f(x), g(x), etc to display.

Method Detail

setDefaultConstraints

protected final void setDefaultConstraints()

Description copied from class: GPanel

set the defaults constraints

Overrides:

setDefaultConstraints in class GPanel

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.

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.

getGVector

public GEntryVectorAbstract getGVector(int index)

Getter for the vector with the specified index.

Parameters:

index - of the vector to get.

Returns:

the GEntryVectorAbstract correspoding to the requested index.

generic

public void generic()
             throws GException

Abstract generic function that need to be implemented by the descendants.

Specified by:

generic in class GPanel

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.

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.

read

public void read()
          throws GException

Implementaion of the routines that allow the component to be loaded from a configuration file.

Specified by:

read in interface GReadWrite

Throws:

GException - in case of problem while reading the value from file.

write

public void write()
           throws GException

Implementaion of the routines that allow the component to be saved to a configuration file.

Specified by:

write in interface GReadWrite

Throws:

GException - in case of problem while writing the value to file.

updateStatus

public final void updateStatus()

Update status.

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.

setCopyPasteMenuEnabled

public void setCopyPasteMenuEnabled(boolean b)

Set the enable status of the copy-paste menu associated to the component.

Overrides:

setCopyPasteMenuEnabled in class GComponent

Parameters:

b - new enable status.

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.

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.

setValues

public void setValues(Object[]... vectors)
               throws GArithmeticException,
                      GException

Setter for the table values.

Parameters:

vectors - array of vectors to set in the table

Throws:

GArithmeticException - if vectors contains is NaN

GException - if the number of vectors in the array does not correspond to the table or if the vectors have different sizes.

setDefaultValues

public void setDefaultValues(Object... defaultValues)
                      throws GArithmeticException,
                             GException

Setter for the default values for each vector of the table.

Parameters:

defaultValues - array of default values for each vector of the table

Throws:

GException - if the number of default values does not correspond to the table.

GArithmeticException - if defaultValues is NaN.

setSavedValues

public void setSavedValues(Object[]... vectors)
                    throws GArithmeticException,
                           GException

Setter for the table saved values.

Parameters:

vectors - array of vectors with the saved values to set in the table

Throws:

GArithmeticException - if vectors contains NaN.

GException - if the number of vectors in the array does not correspond to the table or if the vectors have different sizes.

updateIsModifiedIndicator

protected void updateIsModifiedIndicator()

Updates the is modified indicator.

Overrides:

updateIsModifiedIndicator in class GComponent

isModified

public boolean isModified()

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.