Package etomica.graphics

Class DisplayTextBox

java.lang.Object

etomica.graphics.Display

etomica.graphics.DisplayTextBox

All Implemented Interfaces:

IDataSink, java.util.EventListener, javax.swing.event.ChangeListener

Direct Known Subclasses:

DisplayTimer

public class DisplayTextBox
extends Display
implements IDataSink, javax.swing.event.ChangeListener

A simple display of a single value in a textbox with an associated label. Value is obtained from an associated DataSource. A label and unit is associated with the value.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DisplayTextBox.LabelType	Typed constant used to indicate the type of label to be used with the display.

Field Summary

Fields

Modifier and Type	Field	Description
protected javax.swing.JLabel	jLabel	Descriptive text label to be displayed with the value
protected javax.swing.JPanel	panel	Displayed panel that holds the label and value (not yet used; meant to implement to make lightweight display)
protected Unit	unit	Physical units associated with the displayed value.
protected javax.swing.JTextField	value	Object for displaying the value as a text field

Fields inherited from class etomica.graphics.Display

label, support

Constructor Summary

Constructors

Constructor	Description
DisplayTextBox()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	format(double d, int precision)	Formats a double with a specified number of digits.
java.lang.String	getLabel()	Accessor method of the label describing the display.
Constants.CompassDirection	getLabelPosition()
DisplayTextBox.LabelType	getLabelType()
int	getPrecision()	Accessor method of the precision, which specifies the number of significant figures to be displayed.
Unit	getUnit()	Returns the physical units of the displayed value.
java.awt.Component	graphic()	Method of Simulation.GraphicElement interface.
boolean	isIntegerDisplay()
void	putData(IData data)	Sets the display text to reflect the desired value from the datasource.
void	putDataInfo(IDataInfo dataInfo)	Informs the DataSink of the type of Data it should expect to receive.
void	setDefaultLabel(java.lang.String defaultLabel)	Sets label to the given value if it was not previously set.
void	setIntegerDisplay(boolean integerDisplay)
void	setLabel(java.lang.String s)	Sets the value of a descriptive label using the given string.
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 u)	Accessor method to set the physical units of the displayed value.
void	stateChanged(javax.swing.event.ChangeEvent evt)	calls doUpdate method.

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

jLabel

protected javax.swing.JLabel jLabel

Descriptive text label to be displayed with the value

value

protected javax.swing.JTextField value

Object for displaying the value as a text field

panel

protected javax.swing.JPanel panel

Displayed panel that holds the label and value (not yet used; meant to implement to make lightweight display)

unit

protected Unit unit

Physical units associated with the displayed value. Default is null (dimensionless).

Constructor Detail

DisplayTextBox

public DisplayTextBox()

Method Detail

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

stateChanged

public void stateChanged(javax.swing.event.ChangeEvent evt)

calls doUpdate method. Implementation of ChangeListener interface.

Specified by:

stateChanged in interface javax.swing.event.ChangeListener

setUnit

public void setUnit(Unit u)

Accessor method to set the physical units of the displayed value. Text describing unit is used in label.

getUnit

public Unit getUnit()

Returns the physical units of 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

isIntegerDisplay

public boolean isIntegerDisplay()

Returns:

Returns the integerDisplay.

setIntegerDisplay

public void setIntegerDisplay(boolean integerDisplay)

Parameters:

integerDisplay - The integerDisplay to set.

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)

Sets the value of a descriptive label using the given string.

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 current value of the descriptive label.

setDefaultLabel

public void setDefaultLabel(java.lang.String defaultLabel)

Sets label to the given value if it was not previously set. If setLabel was previously called, this method has no effect. This method is usually invoked automatically when this data sink is attached to a data pipe.

setLabelType

public void setLabelType(DisplayTextBox.LabelType labelType)

getLabelType

public DisplayTextBox.LabelType getLabelType()

setLabelPosition

public void setLabelPosition(Constants.CompassDirection position)

getLabelPosition

public Constants.CompassDirection getLabelPosition()

putData

public void putData(IData data)

Sets the display text to reflect the desired value from the datasource.

Specified by:

putData in interface IDataSink

format

public static java.lang.String format(double d,
                                      int precision)

Formats a double with a specified number of digits. When java converts a double to a String it retains the full precision of the number. This can generate 15 decimal places! This method truncates this output to some specified number of decimal places.

Parameters:

d - the double to format

precision - the number of digits desired

Returns:

returns the formatted string Taken from the comphys package of Richard Gonsalves of the SUNY Buffalo Department of Physics