Package etomica.graphics

Class DisplayTextBoxesCAE

java.lang.Object

etomica.graphics.Display

etomica.graphics.DisplayTextBoxesCAE

All Implemented Interfaces:

IDataSink

public class DisplayTextBoxesCAE
extends Display
implements IDataSink

Display that presents three boxes with the current value, average, and error, respectively, given by an AccumulatorAverage.

Field Summary

Fields

Modifier and Type	Field	Description
AccumulatorAverage	accumulatorAverage
DisplayTextBox	averageBox
DisplayTextBox	corBox
DisplayTextBox	currentBox
protected boolean	doShowCorrelation
protected boolean	doShowCurrent
DisplayTextBox	errorBox
protected Constants.CompassDirection	labelPosition
protected DisplayTextBox.LabelType	labelType
javax.swing.JPanel	panelParentGroup

Fields inherited from class etomica.graphics.Display

label, support

Constructor Summary

Constructors

Constructor	Description
DisplayTextBoxesCAE()

Method Summary

Modifier and Type	Method	Description
AccumulatorAverage	getAccumulator()	Accessor method for the data source that generates the displayed value.
boolean	getDoShowCurrent()
java.lang.String	getLabel()	Accessor method of the label describing the display.
int	getPrecision()	Accessor method of the precision, which specifies the number of significant figures to be displayed.
Unit	getUnit()
java.awt.Component	graphic()	Method of Simulation.GraphicElement interface.
static void	main(java.lang.String[] args)
void	putData(IData data)	Gives data to DataSink for processing, display, or whatever it does.
void	putDataInfo(IDataInfo dataInfo)	Informs the DataSink of the type of Data it should expect to receive.
void	setAccumulator(AccumulatorAverage accumulatorAverage)	Specifies the accumulator that generates the displayed values.
void	setDoShowCorrelation(boolean newDoShowCorrelation)
void	setDoShowCurrent(boolean newDoShowCurrent)
void	setLabel(java.lang.String s)	Accessor method of the label describing the display.
void	setLabelPosition(Constants.CompassDirection position)
void	setLabelType(DisplayTextBox.LabelType labelType)
void	setPrecision(int n)	Accessor method of the precision, which specifies the number of significant figures to be displayed.
void	setUnit(Unit unit)

Methods inherited from class etomica.graphics.Display

addPropertyChangeListener, removePropertyChangeListener, toString

Methods inherited from class java.lang.Object

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

Field Detail

accumulatorAverage

public AccumulatorAverage accumulatorAverage

currentBox

public DisplayTextBox currentBox

averageBox

public DisplayTextBox averageBox

errorBox

public DisplayTextBox errorBox

corBox

public DisplayTextBox corBox

panelParentGroup

public javax.swing.JPanel panelParentGroup

doShowCurrent

protected boolean doShowCurrent

doShowCorrelation

protected boolean doShowCorrelation

labelPosition

protected Constants.CompassDirection labelPosition

labelType

protected DisplayTextBox.LabelType labelType

Constructor Detail

DisplayTextBoxesCAE

public DisplayTextBoxesCAE()

Method Detail

setDoShowCurrent

public void setDoShowCurrent(boolean newDoShowCurrent)

getDoShowCurrent

public boolean getDoShowCurrent()

setDoShowCorrelation

public void setDoShowCorrelation(boolean newDoShowCorrelation)

putDataInfo

public void putDataInfo(IDataInfo dataInfo)

Description copied from interface: IDataSink

Informs the DataSink of the type of Data it should expect to receive.

Specified by:

putDataInfo in interface IDataSink

setAccumulator

public void setAccumulator(AccumulatorAverage accumulatorAverage)

Specifies the accumulator that generates the displayed values. Sets up this display to receive the current, average, and error values from the accumulator.

getAccumulator

public AccumulatorAverage getAccumulator()

Accessor method for the data source that generates the displayed value.

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

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.

setLabel

public void setLabel(java.lang.String s)

Description copied from class: Display

Accessor method of the label describing the display.

Overrides:

setLabel in class Display

Parameters:

s - The label string describing the display

getLabel

public java.lang.String getLabel()

Description copied from class: Display

Accessor method of the label describing the display.

Overrides:

getLabel in class Display

Returns:

The given label

setLabelPosition

public void setLabelPosition(Constants.CompassDirection position)

setLabelType

public void setLabelType(DisplayTextBox.LabelType labelType)

putData

public void putData(IData data)

Description copied from interface: IDataSink

Gives data to DataSink for processing, display, or whatever it does.

Specified by:

putData in interface IDataSink

setUnit

public void setUnit(Unit unit)

getUnit

public Unit getUnit()

main

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