fr.cnes.genius.table

Class GTable

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.table.GTable

All Implemented Interfaces:

GDisplay, GReadWrite, MouseListener, MouseWheelListener, EventListener

public class GTable
extends GComponent
implements GDisplay, GReadWrite, MouseListener

Class that defines a GTable widget. This component consist of a JTable component, having both row and column headers. All headers are editable, as well as the cells of the table.

Author:

aamr

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
GTable(double[][] data, double[] absData, double[] ordData, GUnit rowHeaderUnit, GUnit columnHeaderUnit, GUnit dataUnit) Constructor.
GTable(int numberOfRows, int numberOfColums, GUnit rowHeaderUnit, GUnit columnHeaderUnit, GUnit dataUnit) Constructor.
GTable(String widgetId, double[][] data, double[] absData, double[] ordData, GUnit rowHeaderUnit, GUnit columnHeaderUnit, GUnit dataUnit) Constructor.
GTable(String widgetId, int numberOfRows, int numberOfColums, GUnit rowHeaderUnit, GUnit columnHeaderUnit, GUnit dataUnit, Double rowHeaderDefaultValue, Double columnHeaderDefaultValue, Double dataDefaultValue) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addColumn(int columnTableIndex, double[] newColumnValues, double headerValue) Method used to add a new column in the data table.
void	addRow(int rowTableIndex, double[] newRowValues, double rowHeaderValue) Method used to add a new row in the data table.
void	clear() Clear the table contents and units.
void	deleteColumn(int columnTableIndex) Method used to delete a specific column from the data table.
void	deleteRow(int rowTableIndex) Method used to delete a specific row from the data table.
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.
double[]	getAbsValues() Gets the array of column headers values.
Component	getComponent() Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
double[]	getOrdValues() Gets the array of row headers values.
double[][]	getValues() Gets the data values.
void	mouseClicked(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	read() Implementaion of the routines that allow the component to be loaded from a configuration file.
void	setColumnHeaderDefaultValue(double defaultValue) Set the default value for the column header cells.
void	setColumnHeaderFormat(GTableModel.Format newFormat) Set the format of the column headers.
void	setColumnHeaderFracDigits(int fracDigits) Set the column header fractional digits.
void	setColumnHeaderUnit(GUnit newUnit) Set the unit of the column headers.
void	setColumnHeaderValue(int columnIndex, double value) Sets a value into a column header cell.
void	setColumnWidth(int columnIndex, Integer minWidth, Integer maxWidth, Integer preferredWidth) Set the minimum, maximum and preferred with of a column.
void	setCurrentRowsColumns(Integer rowNumber, Integer columnNumber) Set the current number of rows and columns.
void	setDataDefaultValue(double defaultValue) Set the default value for the data cells.
void	setDataFormat(GTableModel.Format newFormat) Set the format of the data.
void	setDataFracDigits(int fracDigits) Set the data fractional digits.
void	setDataUnit(GUnit newUnit) Set the unit of the table data.
void	setDataValue(int rowIndex, int columnIndex, double value) Sets a value into a data cell.
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.
void	setRowHeaderDefaultValue(double defaultValue) Set the default value for the row header cells.
void	setRowHeaderFormat(GTableModel.Format newFormat) Set the format of the row headers.
void	setRowHeaderFracDigits(int fracDigits) Set the row header fractional digits.
void	setRowHeaderUnit(GUnit newUnit) Set the unit of the row headers.
void	setRowHeaderValue(int rowIndex, double value) Sets a value into a row header cell.
void	setValues(double[][] data, double[] columnHeaderValues, double[] rowHeaderValues) Set the values of the table.
int	setWidth(int width) Set the table width, this will resize the columns so the total size of the table matches the requested width.
void	write() Implementaion of the routines that allow the component to be saved to a configuration file.

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

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getSubComponent, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isEnabled, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setEnabled, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, 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

GTable

public GTable(int numberOfRows,
              int numberOfColums,
              GUnit rowHeaderUnit,
              GUnit columnHeaderUnit,
              GUnit dataUnit)

Constructor. The widget identified will be automatically assigned. The default values for the row and column headers and the data are 0.0.

Parameters:

numberOfRows - the initial number of rows used by the widget.

numberOfColums - the initial number of columns used by the widget.

rowHeaderUnit - unit for the row header or null if no unit is defined.

columnHeaderUnit - unit for the column header or null if no unit is defined.

dataUnit - unit for the data or null if no unit is defined.

GTable

public GTable(String widgetId,
              int numberOfRows,
              int numberOfColums,
              GUnit rowHeaderUnit,
              GUnit columnHeaderUnit,
              GUnit dataUnit,
              Double rowHeaderDefaultValue,
              Double columnHeaderDefaultValue,
              Double dataDefaultValue)

Constructor.

Parameters:

widgetId - widget identifier.

numberOfRows - the initial number of rows used by the widget.

numberOfColums - the initial number of columns used by the widget.

rowHeaderUnit - unit for the row header or null if no unit is defined.

columnHeaderUnit - unit for the column header or null if no unit is defined.

dataUnit - unit for the data or null if no unit is defined.

rowHeaderDefaultValue - default value for the row header cells.

columnHeaderDefaultValue - default value for the column header cells.

dataDefaultValue - default value for the data cells.

GTable

public GTable(double[][] data,
              double[] absData,
              double[] ordData,
              GUnit rowHeaderUnit,
              GUnit columnHeaderUnit,
              GUnit dataUnit)

Constructor. The widget identified will be automatically assigned.

Parameters:

data - the matrix containing the data values.

absData - the array with abscissa values.

ordData - the array with ordinates values.

rowHeaderUnit - unit for the row header or null if no unit is defined.

columnHeaderUnit - unit for the column header or null if no unit is defined.

dataUnit - unit for the data or null if no unit is defined.

GTable

public GTable(String widgetId,
              double[][] data,
              double[] absData,
              double[] ordData,
              GUnit rowHeaderUnit,
              GUnit columnHeaderUnit,
              GUnit dataUnit)

Constructor.

Parameters:

widgetId - widget identifier.

data - the matrix containing the data values.

absData - the array with abscissa values.

ordData - the array with ordinates values.

rowHeaderUnit - unit for the row header or null if no unit is defined.

columnHeaderUnit - unit for the column header or null if no unit is defined.

dataUnit - unit for the data or null if no unit is defined.

Method Detail

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.

addRow

public void addRow(int rowTableIndex,
                   double[] newRowValues,
                   double rowHeaderValue)

Method used to add a new row in the data table.

Parameters:

rowTableIndex - the index of the new row.

newRowValues - the array of new values to insert into the new row.

rowHeaderValue - the value of the header for the new row.

addColumn

public void addColumn(int columnTableIndex,
                      double[] newColumnValues,
                      double headerValue)

Method used to add a new column in the data table.

Parameters:

columnTableIndex - the index of the new column.

newColumnValues - the array of new values to insert into the new column.

headerValue - the value of the header for the new column.

deleteRow

public void deleteRow(int rowTableIndex)

Method used to delete a specific row from the data table.

Parameters:

rowTableIndex - the index of the row to be deleted.

deleteColumn

public void deleteColumn(int columnTableIndex)

Method used to delete a specific column from the data table.

Parameters:

columnTableIndex - the index of the column to be deleted.

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.

setWidth

public int setWidth(int width)

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.

Returns:

the resulting column width.

setRowHeaderUnit

public void setRowHeaderUnit(GUnit newUnit)

Set the unit of the row headers.

Parameters:

newUnit - of the row headers.

setColumnHeaderUnit

public void setColumnHeaderUnit(GUnit newUnit)

Set the unit of the column headers.

Parameters:

newUnit - of the rowHeaders.

setDataUnit

public void setDataUnit(GUnit newUnit)

Set the unit of the table data.

Parameters:

newUnit - of the table data.

setRowHeaderFracDigits

public void setRowHeaderFracDigits(int fracDigits)
                            throws GEntryRealException

Set the row header fractional digits.

Parameters:

fracDigits - number of fractional digits.

Throws:

GEntryRealException - in case the number of fractional digits is invalid (<0 or >15).

setColumnHeaderFracDigits

public void setColumnHeaderFracDigits(int fracDigits)
                               throws GEntryRealException

Set the column header fractional digits.

Parameters:

fracDigits - number of fractional digits.

Throws:

GEntryRealException - in case the number of fractional digits is invalid (<0 or >15).

setDataFracDigits

public void setDataFracDigits(int fracDigits)
                       throws GEntryRealException

Set the data fractional digits.

Parameters:

fracDigits - number of fractional digits.

Throws:

GEntryRealException - in case the number of fractional digits is invalid (<0 or >15).

setRowHeaderFormat

public void setRowHeaderFormat(GTableModel.Format newFormat)

Set the format of the row headers.

Parameters:

newFormat - the format of the row headers.

setColumnHeaderFormat

public void setColumnHeaderFormat(GTableModel.Format newFormat)

Set the format of the column headers.

Parameters:

newFormat - the format of the column headers.

setDataFormat

public void setDataFormat(GTableModel.Format newFormat)

Set the format of the data.

Parameters:

newFormat - the format of the data.

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

getComponent

public Component getComponent()

Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.

Overrides:

getComponent in class GComponent

Returns:

the Swing Component encapsulated by the class if any, otherwise returns null.

display

public 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.

Specified by:

display in interface GDisplay

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.

getOrdValues

public double[] getOrdValues()

Gets the array of row headers values.

Returns:

the array of row headers values.

getValues

public double[][] getValues()

Gets the data values.

Returns:

the data values.

getAbsValues

public double[] getAbsValues()

Gets the array of column headers values.

Returns:

the array of column headers values.

clear

public void clear()

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

setRowHeaderValue

public void setRowHeaderValue(int rowIndex,
                              double value)
                       throws GArithmeticException

Sets a value into a row header cell.

Parameters:

rowIndex - row index

value - to be set.

Throws:

GArithmeticException - if value is NaN

setColumnHeaderValue

public void setColumnHeaderValue(int columnIndex,
                                 double value)
                          throws GArithmeticException

Sets a value into a column header cell.

Parameters:

columnIndex - column index

value - to be set.

Throws:

GArithmeticException - if value is NaN

setDataValue

public void setDataValue(int rowIndex,
                         int columnIndex,
                         double value)
                  throws GArithmeticException

Sets a value into a data cell.

Parameters:

rowIndex - row index

columnIndex - column index

value - to be set.

Throws:

GArithmeticException - if value is NaN

setRowHeaderDefaultValue

public void setRowHeaderDefaultValue(double defaultValue)
                              throws GArithmeticException

Set the default value for the row header cells.

Parameters:

defaultValue - the default value for the row header cells.

Throws:

GArithmeticException - if defaultValue is NaN

setColumnHeaderDefaultValue

public void setColumnHeaderDefaultValue(double defaultValue)
                                 throws GArithmeticException

Set the default value for the column header cells.

Parameters:

defaultValue - the default value for the column header cells.

Throws:

GArithmeticException - if defaultValue is NaN

setDataDefaultValue

public void setDataDefaultValue(double defaultValue)
                         throws GArithmeticException

Set the default value for the data cells.

Parameters:

defaultValue - the default value for the data cells.

Throws:

GArithmeticException - if defaultValue is NaN

setMinMaxRowsColumns

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

Set the minimum and maximum number of rows and columns.

Parameters:

minRows - minimal number of rows.

maxRows - maxilam number of rows or -1 if not limited.

minColumns - minimal number of columns.

maxColumns - maximal number of columns or -1 if not limited.

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.