fr.cnes.genius.table

Class GTable2D

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GPanel

fr.cnes.genius.table.GTable2D

All Implemented Interfaces:

GCondensedStatusInterface, GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

public class GTable2D
extends GPanel
implements GReadWrite, GListener, GCondensedStatusInterface

GTable with labels and units for the data, the rows and the columns.

Author:

jjct

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabel	dataLabel	"newline , spanx 2 , split 2 , alignx Center"
1	GLabel	columnHeaderLabel	"newline , spanx 2 , split 2 , alignx Center"
2	GLabel	rowHeaderLabel	"newline , split 2 , flowy"
3	GTable	table	(null)
4	GPopupList	dataUnitPopupList	"gapleft 2"
5	GPopupList	columnHeaderUnitPopupList	"gapleft 2"
6	GPopupList	rowHeaderUnitPopupList	(null)

Nested Class Summary

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
GTable2D(double[] absData, String columnHeaderTitle, GUnit[] columnHeaderUnitList, double[] ordData, String rowHeaderTitle, GUnit[] rowHeaderUnitList, double[][] data, String dataTitle, GUnit[] dataUnitList) Constructor.
GTable2D(int numberOfRows, int numberOfColums, String rowHeaderTitle, GUnit[] rowHeaderUnitList, String columnHeaderTitle, GUnit[] columnHeaderUnitList, String dataTitle, GUnit[] dataUnitList) Constructor.
GTable2D(String widgetId, double[] absData, String columnHeaderTitle, GUnit[] columnHeaderUnitList, double[] ordData, String rowHeaderTitle, GUnit[] rowHeaderUnitList, double[][] data, String dataTitle, GUnit[] dataUnitList) Constructor.
GTable2D(String widgetId, int numberOfRows, int numberOfColums, String rowHeaderTitle, GUnit[] rowHeaderUnitList, String columnHeaderTitle, GUnit[] columnHeaderUnitList, String dataTitle, GUnit[] dataUnitList) Constructor.
GTable2D(String widgetId, int numberOfRows, int numberOfColums, String rowHeaderTitle, GUnit[] rowHeaderUnitList, String columnHeaderTitle, GUnit[] columnHeaderUnitList, String dataTitle, GUnit[] dataUnitList, Double rowHeaderDefaultValue, Double columnHeaderDefaultValue, Double dataDefaultValue) 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	clear() Clear the table contents and units.
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.
GTable	getGTable() Get the GTable.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
void	read() Implementaion of the routines that allow the component to be loaded from a configuration file.
void	setColumnWidth(int columnIndex, Integer minWidth, Integer maxWidth, Integer preferredWidth) Set the minimum, maximum and preferred with of a column.
void	setCommentInConfigFile(String comment) Sets the comment to be set in the configuration file.
void	setCurrentRowsColumns(Integer rowNumber, Integer columnNumber) Set the current number of rows and columns.
protected void	setDefaultConstraints() set the defaults constraints
void	setDefaultValues(Double rowHeaderDefaultValue, Double columnHeaderDefaultValue, Double dataDefaultValue) Set the table default values for the row header, the column header and the data.
void	setGlobalColumnWidth(Integer minWidth, Integer maxWidth, Integer preferredWidth) Set the minimum, maximum and preferred width of the columns of the table.
void	setMinMaxRowsColumns(Integer minRows, Integer maxRows, Integer minColumns, Integer maxColumns) Set the minimum and maximum number of rows and columns allowed in the table2D list.
void	setNameInConfigFile(String name) Sets the name to be used when saving the component in the configuration file.
void	setValues(double[][] data, double[] columnHeaderValues, double[] rowHeaderValues) Set the values of the table.
void	setWidgetId(String widgetId) Sets the widget identifier of the component.
void	setWidth(int width) Set the table width, this will resize the columns so the total size of the table matches the requested width.
void	updateCondensedStatus(GCondensedStatus condensedStatus) Update a condensed status object with the status of one or more components.
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, 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, isCopyPasteEvent, isEnabled, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, setBusyCursor, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setEnabled, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, 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

GTable2D

public GTable2D(int numberOfRows,
                int numberOfColums,
                String rowHeaderTitle,
                GUnit[] rowHeaderUnitList,
                String columnHeaderTitle,
                GUnit[] columnHeaderUnitList,
                String dataTitle,
                GUnit[] dataUnitList)

Constructor. The widget identifier is automatically assigned.

Parameters:

numberOfRows - number of rows.

numberOfColums - number of columns.

rowHeaderTitle - row header title.

rowHeaderUnitList - row unit list.

columnHeaderTitle - column header title.

columnHeaderUnitList - column unit list.

dataTitle - data title.

dataUnitList - data unit list.

GTable2D

public GTable2D(String widgetId,
                int numberOfRows,
                int numberOfColums,
                String rowHeaderTitle,
                GUnit[] rowHeaderUnitList,
                String columnHeaderTitle,
                GUnit[] columnHeaderUnitList,
                String dataTitle,
                GUnit[] dataUnitList)

Constructor.

Parameters:

widgetId - widget identifier.

numberOfRows - number of rows.

numberOfColums - number of columns.

rowHeaderTitle - row header title.

rowHeaderUnitList - row unit list.

columnHeaderTitle - column header title.

columnHeaderUnitList - column unit list.

dataTitle - data title.

dataUnitList - data unit list.

GTable2D

public GTable2D(String widgetId,
                int numberOfRows,
                int numberOfColums,
                String rowHeaderTitle,
                GUnit[] rowHeaderUnitList,
                String columnHeaderTitle,
                GUnit[] columnHeaderUnitList,
                String dataTitle,
                GUnit[] dataUnitList,
                Double rowHeaderDefaultValue,
                Double columnHeaderDefaultValue,
                Double dataDefaultValue)

Constructor.

Parameters:

widgetId - widget identifier.

numberOfRows - number of rows.

numberOfColums - number of columns.

rowHeaderTitle - row header title.

rowHeaderUnitList - row unit list.

columnHeaderTitle - column header title.

columnHeaderUnitList - column unit list.

dataTitle - data title.

dataUnitList - data unit list.

rowHeaderDefaultValue - default value for the row header cells.

columnHeaderDefaultValue - default value for the column header cells.

dataDefaultValue - default value for the data cells.

GTable2D

public GTable2D(double[] absData,
                String columnHeaderTitle,
                GUnit[] columnHeaderUnitList,
                double[] ordData,
                String rowHeaderTitle,
                GUnit[] rowHeaderUnitList,
                double[][] data,
                String dataTitle,
                GUnit[] dataUnitList)

Constructor. The widget identifier is automatically assigned.

Parameters:

data - the matrix containing the data values.

absData - the array with abscissa values.

ordData - the array with ordinates values.

rowHeaderTitle - row header title.

rowHeaderUnitList - row unit list.

columnHeaderTitle - column header title.

columnHeaderUnitList - column unit list.

dataTitle - data title.

dataUnitList - data unit list.

GTable2D

public GTable2D(String widgetId,
                double[] absData,
                String columnHeaderTitle,
                GUnit[] columnHeaderUnitList,
                double[] ordData,
                String rowHeaderTitle,
                GUnit[] rowHeaderUnitList,
                double[][] data,
                String dataTitle,
                GUnit[] dataUnitList)

Constructor.

Parameters:

widgetId - widget identifier.

data - the matrix containing the data values.

absData - the array with abscissa values.

ordData - the array with ordinates values.

rowHeaderTitle - row header title.

rowHeaderUnitList - row unit list.

columnHeaderTitle - column header title.

columnHeaderUnitList - column unit list.

dataTitle - data title.

dataUnitList - data unit list.

Method Detail

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.

setDefaultConstraints

protected final void setDefaultConstraints()

Description copied from class: GPanel

set the defaults constraints

Overrides:

setDefaultConstraints in class GPanel

getGTable

public GTable getGTable()

Get the GTable.

Returns:

the GTable.

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

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

Specified by:

generic in class GPanel

Throws:

GException - in case of problem.

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

Description copied from interface: GReadWrite

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.

clear

public void clear()

Clear the table contents and units. It restores the first unit in the units popup lists, removes all rows and columns (but the first cell) and sets the default values for row header, column header and data.

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.

setCommentInConfigFile

public void setCommentInConfigFile(String comment)

Sets the comment to be set in the configuration file. To delete the comment set it to null.

Overrides:

setCommentInConfigFile in class GComponent

Parameters:

comment - to be set in the configuration file.

setNameInConfigFile

public void setNameInConfigFile(String name)

Sets the name to be used when saving the component in the configuration file.

Overrides:

setNameInConfigFile in class GComponent

Parameters:

name - to be used when saving the component in the configuration file.

setWidth

public void setWidth(int width)
              throws GTable2DException

Set the table width, this will resize the columns so the total size of the table matches the requested width. The width of the row header is subtracted from the requested width before computing the column widths.

Parameters:

width - table width.

Throws:

GTable2DException - in case the resulting column widths are zero or negative.

setGlobalColumnWidth

public void setGlobalColumnWidth(Integer minWidth,
                                 Integer maxWidth,
                                 Integer preferredWidth)

Set the minimum, maximum and preferred width of the columns of the table.

Parameters:

minWidth - value of the minimum allowed width, if null the minimum width of the columns is not modified.

maxWidth - value of the maximum allowed width, if null the maximum width of the columns is not modified.

preferredWidth - value of the preferred allowed width, if null the preferred width of the columsn is not modified.

setColumnWidth

public void setColumnWidth(int columnIndex,
                           Integer minWidth,
                           Integer maxWidth,
                           Integer preferredWidth)

Set the minimum, maximum and preferred with of a column.

Parameters:

columnIndex - index of the column.

minWidth - value of the minimum allowed width, if null the minimum width of the column is not modified.

maxWidth - value of the maximum allowed width, if null the maximum width of the column is not modified.

preferredWidth - value of the preferred allowed width, if null the preferred width of the column is not modified.

updateCondensedStatus

public void updateCondensedStatus(GCondensedStatus condensedStatus)

Update a condensed status object with the status of one or more components. In almost 100% of cases the implementation of this method should just make :

condensedStatus.update(widget1, widget2, etc)

Being widget_i the widgets contained in current component with a status defined. These widgets might be simple components that have redefined the setStatus(GStatus) method or complex components, having other subcomponents and implementing also this interface.

Specified by:

updateCondensedStatus in interface GCondensedStatusInterface

Parameters:

condensedStatus - the condensed status object to be updated.

setMinMaxRowsColumns

public void setMinMaxRowsColumns(Integer minRows,
                                 Integer maxRows,
                                 Integer minColumns,
                                 Integer maxColumns)

Set the minimum and maximum number of rows and columns allowed in the table2D list.

Parameters:

minRows - minimum number of rows, if null do not change the current value.

maxRows - maximum number of rows, if null do not change the current value, if -1 do limit the maximum number of rows.

minColumns - minimum number of columns, if null do not change the current value.

maxColumns - maximum number of columns, if null do not change the current value, if -1 do limit the maximum number of columns.

setCurrentRowsColumns

public void setCurrentRowsColumns(Integer rowNumber,
                                  Integer columnNumber)

Set the current number of rows and columns.

Parameters:

rowNumber - number of rows, if null do not change the current value.

columnNumber - number of columns,if null do not change the current value.

setValues

public void setValues(double[][] data,
                      double[] columnHeaderValues,
                      double[] rowHeaderValues)
               throws GArithmeticException

Set the values of the table.

Parameters:

data - data values.

columnHeaderValues - column header values.

rowHeaderValues - row header values.

Throws:

GArithmeticException - if any of the data, column header or row header values is NaN.

setDefaultValues

public void setDefaultValues(Double rowHeaderDefaultValue,
                             Double columnHeaderDefaultValue,
                             Double dataDefaultValue)
                      throws GArithmeticException

Set the table default values for the row header, the column header and the data. To modify only one default value set the others to null.

Parameters:

rowHeaderDefaultValue - the default value for the row header.

columnHeaderDefaultValue - the default value for the column header.

dataDefaultValue - the default value for the data table.

Throws:

GArithmeticException - if rowHeaderDefaultValue, columnHeaderDefaultValue or dataDefaultValue values is NaN.

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.