Package etomica.graphics

Class DisplayTable

java.lang.Object

etomica.graphics.Display

etomica.graphics.DisplayTable

All Implemented Interfaces:

DataSetListener, DataTableListener

public class DisplayTable
extends Display
implements DataTableListener

Presents data in a tabular form.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	autoRowLabels
protected int	c0
protected java.lang.String[]	columnHeaders
protected DataSinkTable	dataTable
protected int	digits
protected java.util.Formatter	formatter
protected double	maxFloat
protected double	minFloat
protected int	nColumns
protected javax.swing.JPanel	panel
protected java.lang.String	rowLabelColumnHeader
protected java.lang.String[]	rowLabels
protected boolean	showingColumnHeaders
protected boolean	showingRowLabels
protected boolean	showingUnits
protected java.lang.StringBuilder	stringBuilder
protected boolean	transposed
protected Unit[]	units

Fields inherited from class etomica.graphics.Display

label, support

Constructor Summary

Constructors

Constructor	Description
DisplayTable()
DisplayTable(DataSinkTable dataTable)

Method Summary

Modifier and Type	Method	Description
void	dataChanged(DataSet dummyTable)	Causes the display of the plot to be updated.
void	dataCountChanged(DataSet dummyTable)	Updates the units array for any new or deleted columns, using the default units for new columns.
DataSinkTable	getDataTable()
int	getNumDigitColumns()
int	getPrecision()	Accessor method of the precision, which specifies the number of significant figures to be displayed.
java.lang.String	getRowLabelColumnHeader()	Returns the header of the row-label column.
java.lang.String[]	getRowLabels()	Descriptive text for each row.
Unit	getUnit(int i)	Returns the unit assign to the i-th column (as defined before any transpose).
java.awt.Component	graphic()	Method of Simulation.GraphicElement interface.
boolean	isFitToWindow()	Accessor method for flag determining if table is squeezed to fit in window.
boolean	isShowingColumnHeaders()
boolean	isShowingRowLabels()	Accessor method for flag indicating if table should include a column of "x" values.
boolean	isShowingUnits()
boolean	isTransposed()	If true, each data set fills a row; if false, data are arranged to fill columns.
static void	main(java.lang.String[] args)	Demonstrates how this class is implemented.
protected void	recomputeColumnHeaders()	Reconstruct the column headers array.
protected void	recomputeUnits()	Reconstruct the units array.
void	setAllUnits(Unit newUnit)	Sets the units of all columns to the given unit.
void	setColumnHeader(DataTag[] tags, java.lang.String newHeader)
void	setFitToWindow(boolean b)	If true, columns will be squeezed so table fits to window; if false, table will exceed window size, and to view full width must be placed in a scroll pane.
void	setNumDigitColumns(int n)
void	setPrecision(int n)	Accessor method of the precision, which specifies the number of significant figures to be displayed.
void	setRowLabelColumnHeader(java.lang.String rowLabelColumnHeader)	Sets the header of the row-label column.
void	setRowLabels(java.lang.String[] newRowLabels)	Sets values for descriptive text for each row (as defined before transpose).
void	setShowingColumnHeaders(boolean showingColumnHeaders)
void	setShowingRowLabels(boolean b)	Mutator method for whether table should include a column of "x" values.
void	setShowingUnits(boolean showingUnits)	Flag indicating whether a units suffix applied to the column headers (or row labels, if transposing).
void	setTransposed(boolean transposed)	If fillHorizontal is true, each data set fills a row; if false, data are arranged to fill columns.
void	setUnit(DataTag[] dataTags, Unit newUnit)
javax.swing.table.AbstractTableModel	tableModel()
void	tableRowCountChanged(DataSinkTable dummyTable)	Part of the DataTableListener interface.
void	tableRowHeadersChanged(DataSinkTable dummyTable)	Method called to indicate that the row headers in the table have changed.

Methods inherited from class etomica.graphics.Display

addPropertyChangeListener, getLabel, removePropertyChangeListener, setLabel, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

dataTable

protected final DataSinkTable dataTable

panel

protected final javax.swing.JPanel panel

showingRowLabels

protected boolean showingRowLabels

showingColumnHeaders

protected boolean showingColumnHeaders

showingUnits

protected boolean showingUnits

transposed

protected boolean transposed

c0

protected int c0

rowLabels

protected java.lang.String[] rowLabels

autoRowLabels

protected boolean autoRowLabels

rowLabelColumnHeader

protected java.lang.String rowLabelColumnHeader

columnHeaders

protected java.lang.String[] columnHeaders

units

protected Unit[] units

digits

protected int digits

nColumns

protected int nColumns

maxFloat

protected double maxFloat

minFloat

protected double minFloat

formatter

protected final java.util.Formatter formatter

stringBuilder

protected final java.lang.StringBuilder stringBuilder

Constructor Detail

DisplayTable

public DisplayTable()

DisplayTable

public DisplayTable(DataSinkTable dataTable)

Method Detail

getDataTable

public DataSinkTable getDataTable()

dataChanged

public void dataChanged(DataSet dummyTable)

Causes the display of the plot to be updated.

Specified by:

dataChanged in interface DataSetListener

dataCountChanged

public void dataCountChanged(DataSet dummyTable)

Updates the units array for any new or deleted columns, using the default units for new columns.

Specified by:

dataCountChanged in interface DataSetListener

Parameters:

dummyTable - the Data object that has been added

tableRowHeadersChanged

public void tableRowHeadersChanged(DataSinkTable dummyTable)

Description copied from interface: DataTableListener

Method called to indicate that the row headers in the table have changed. Method is called after the change takes place.

Specified by:

tableRowHeadersChanged in interface DataTableListener

tableRowCountChanged

public void tableRowCountChanged(DataSinkTable dummyTable)

Part of the DataTableListener interface. Updates the row headers.

Specified by:

tableRowCountChanged in interface DataTableListener

isTransposed

public boolean isTransposed()

If true, each data set fills a row; if false, data are arranged to fill columns.

setTransposed

public void setTransposed(boolean transposed)

If fillHorizontal is true, each data set fills a row; if false, data are arranged to fill columns.

setFitToWindow

public void setFitToWindow(boolean b)

If true, columns will be squeezed so table fits to window; if false, table will exceed window size, and to view full width must be placed in a scroll pane. Default is true.

isFitToWindow

public boolean isFitToWindow()

Accessor method for flag determining if table is squeezed to fit in window.

setShowingRowLabels

public void setShowingRowLabels(boolean b)

Mutator method for whether table should include a column of "x" values.

isShowingRowLabels

public boolean isShowingRowLabels()

Accessor method for flag indicating if table should include a column of "x" values.

getPrecision

public int getPrecision()

Accessor method of the precision, which specifies the number of significant figures to be displayed.

setPrecision

public void setPrecision(int n)

Accessor method of the precision, which specifies the number of significant figures to be displayed.

getNumDigitColumns

public int getNumDigitColumns()

setNumDigitColumns

public void setNumDigitColumns(int n)

graphic

public java.awt.Component graphic()

Description copied from class: Display

Method of Simulation.GraphicElement interface. Default action is to return this Display (which is a Panel) as the graphic object. May override in subclass to return a more appropriate graphical element, or none at all.

Specified by:

graphic in class Display

tableModel

public javax.swing.table.AbstractTableModel tableModel()

getRowLabels

public java.lang.String[] getRowLabels()

Descriptive text for each row.

setRowLabels

public void setRowLabels(java.lang.String[] newRowLabels)

Sets values for descriptive text for each row (as defined before transpose). Display of labels is determined by value of showingRowLabels (if not transposing) or showingColumnHeaders (if transposing). Setting the row labels will persist. To cause the row labels to be taken from the IDataInfo again after calling setRowLabels, setRowLabels must be called again with null argument.

setUnit

public void setUnit(DataTag[] dataTags,
                    Unit newUnit)

recomputeUnits

protected void recomputeUnits()

Reconstruct the units array. Manually-set units for columns are stored in a HashMap (keyed to the column), so this method looks for units in the HashMap and if that fails, uses the column's dimension's default unit. Old units (from old columns) are not removed from the hash, because the DataSinkTables doesn't know with certainty that it no longer contains a column. If the column magically comes back, we need to use any previously-set unit.

recomputeColumnHeaders

protected void recomputeColumnHeaders()

Reconstruct the column headers array. Manually-set headers for columns are used if they were set and if not, uses the column's own header is used.

setAllUnits

public void setAllUnits(Unit newUnit)

Sets the units of all columns to the given unit.

getUnit

public Unit getUnit(int i)

Returns the unit assign to the i-th column (as defined before any transpose).

Parameters:

i - column index, numbered from zero, not including the row-label column

Returns:

the unit of the indicated column

isShowingColumnHeaders

public boolean isShowingColumnHeaders()

Returns:

Returns the showingColumnHeaders flag.

setShowingColumnHeaders

public void setShowingColumnHeaders(boolean showingColumnHeaders)

Parameters:

showingColumnHeaders - The showingColumnHeaders flag to set.

isShowingUnits

public boolean isShowingUnits()

Returns:

Returns the showingUnits flag, which indicates whether a units suffix is applied to the column headers (or row labels, if transposing).

setShowingUnits

public void setShowingUnits(boolean showingUnits)

Flag indicating whether a units suffix applied to the column headers (or row labels, if transposing). Default is true.

Parameters:

showingUnits - The showingUnits flag to set.

getRowLabelColumnHeader

public java.lang.String getRowLabelColumnHeader()

Returns the header of the row-label column. Not used if showingRowLabels is false. Default is empty string.

setRowLabelColumnHeader

public void setRowLabelColumnHeader(java.lang.String rowLabelColumnHeader)

Sets the header of the row-label column. Not used if showingRowLabels is false.

setColumnHeader

public void setColumnHeader(DataTag[] tags,
                            java.lang.String newHeader)

main

public static void main(java.lang.String[] args)

Demonstrates how this class is implemented.