DeviceBox

java.lang.Object
- etomica.graphics.Device
- - etomica.graphics.DeviceBox

All Implemented Interfaces:

DeviceBoxValueChangedListener, java.util.EventListener, javax.swing.event.ChangeListener
```
public class DeviceBox
extends Device
implements javax.swing.event.ChangeListener, DeviceBoxValueChangedListener
```
A simple device the permits editing of a single value via a textbox with an associated label.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DeviceBox.LabelType
Typed constant used to indicate the type of label to be used with the display.
- Nested classes/interfaces inherited from class etomica.graphics.Device
  Device.ActionSet

Nested Classes
Modifier and Type	Class	Description
`static class`	`DeviceBox.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`	`label`	Descriptive text label to be displayed with the value
`protected java.lang.String`	`labelString`
`protected ModifyAction`	`modifyAction`	Modifier connecting the slider to the property
`protected javax.swing.JPanel`	`panel`	Displayed panel that holds the label and value (not yet used; meant to implement to make lightweight display)
`protected int`	`precision`	Integer specifying the number of significant figures to be displayed.
`protected javax.swing.JTextField`	`textField`	Object for displaying the value as a text field

Fields inherited from class etomica.graphics.Device
controller, unit

Constructor Summary

Constructors
Constructor Description

DeviceBox()

DeviceBox(Controller controller)

Constructors
Constructor	Description
`DeviceBox()`
`DeviceBox(Controller controller)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addValueChangedListener(DeviceBoxValueChangedListener dbListener)`	Add an object to be notified when the DeviceBox value to changes
`void`	`deviceBoxValueChanged(DeviceBoxValueChangedEvent ev)`
`void`	`doUpdate()`	Updates the display of the box with the current value given by the modifier.
`java.lang.String`	`getLabel()`
`Constants.CompassDirection`	`getLabelPosition()`
`DeviceBox.LabelType`	`getLabelType()`
`Modifier`	`getModifier()`	Accessor method for the modifier that receives the edit.
`int`	`getPrecision()`	Accessor method of the precision, which specifies the number of significant figures to be displayed.
`java.awt.Color`	`getTextBackground()`
`java.awt.Component`	`graphic()`
`boolean`	`isEditable()`
`boolean`	`isInteger()`
`void`	`removeAllValueChangedListeners()`	Removes all objects that are listening for a value changed event.
`void`	`removeValueChangedListener(DeviceBoxValueChangedListener dbListener)`	Remove an object that is listening for the DeviceBox value to change
`void`	`setBorderBackground(java.awt.Color color)`
`void`	`setEditable(boolean b)`
`void`	`setInteger(boolean b)`	Sets a flag indicating if the value should be displayed as an integer.
`void`	`setLabel(java.lang.String s)`	Sets the value of a descriptive label using the given string.
`void`	`setLabelPosition(Constants.CompassDirection position)`
`void`	`setLabelType(DeviceBox.LabelType newLabelType)`	Sets the label type to "border" or "string".
`void`	`setModifier(Modifier m)`	Specifies the modifier that receives the edit.
`void`	`setPrecision(int n)`	Accessor method of the precision, which specifies the number of significant figures to be displayed.
`void`	`setTextBackground(java.awt.Color color)`
`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.Device
doAction, getController, getDimension, getPostAction, getPreAction, getUnit, setController, setPostAction, setPreAction

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - label
```
protected javax.swing.JLabel label
```
    Descriptive text label to be displayed with the value
  - labelString
```
protected java.lang.String labelString
```
  - textField
```
protected javax.swing.JTextField textField
```
    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)
  - modifyAction
```
protected ModifyAction modifyAction
```
    Modifier connecting the slider to the property
  - precision
```
protected int precision
```
    Integer specifying the number of significant figures to be displayed. Default is 4.
- Constructor Detail
  - DeviceBox
```
public DeviceBox()
```
  - DeviceBox
```
public DeviceBox(Controller controller)
```
- Method Detail
  - 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
  - doUpdate
```
public void doUpdate()
```
    Updates the display of the box with the current value given by the modifier.
  - setEditable
```
public void setEditable(boolean b)
```
  - isEditable
```
public boolean isEditable()
```
  - setUnit
```
public void setUnit(Unit u)
```
    Accessor method to set the physical units of the displayed value. Text describing unit is used in label.
    
    Overrides:
    
    setUnit in class Device
  - graphic
```
public java.awt.Component graphic()
```
    Specified by:
    
    graphic in class Device
  - 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.
  - setInteger
```
public void setInteger(boolean b)
```
    Sets a flag indicating if the value should be displayed as an integer.
  - isInteger
```
public boolean isInteger()
```
  - setModifier
```
public void setModifier(Modifier m)
```
    Specifies the modifier that receives the edit.
  - getModifier
```
public Modifier getModifier()
```
    Accessor method for the modifier that receives the edit.
  - setLabel
```
public void setLabel(java.lang.String s)
```
    Sets the value of a descriptive label using the given string.
  - getLabel
```
public java.lang.String getLabel()
```
    Returns:
    
    the current value of the descriptive label.
  - setLabelType
```
public void setLabelType(DeviceBox.LabelType newLabelType)
```
    Sets the label type to "border" or "string". With border, the label text is part of the border. With "string", the label is inside the border.
  - getLabelType
```
public DeviceBox.LabelType getLabelType()
```
  - setLabelPosition
```
public void setLabelPosition(Constants.CompassDirection position)
```
  - setTextBackground
```
public void setTextBackground(java.awt.Color color)
```
  - getTextBackground
```
public java.awt.Color getTextBackground()
```
  - setBorderBackground
```
public void setBorderBackground(java.awt.Color color)
```
  - getLabelPosition
```
public Constants.CompassDirection getLabelPosition()
```
  - addValueChangedListener
```
public void addValueChangedListener(DeviceBoxValueChangedListener dbListener)
```
    Add an object to be notified when the DeviceBox value to changes
  - removeValueChangedListener
```
public void removeValueChangedListener(DeviceBoxValueChangedListener dbListener)
```
    Remove an object that is listening for the DeviceBox value to change
  - removeAllValueChangedListeners
```
public void removeAllValueChangedListeners()
```
    Removes all objects that are listening for a value changed event.
  - deviceBoxValueChanged
```
public void deviceBoxValueChanged(DeviceBoxValueChangedEvent ev)
```
    Specified by:
    
    deviceBoxValueChanged in interface DeviceBoxValueChangedListener

Class DeviceBox

Nested Class Summary

Nested classes/interfaces inherited from class etomica.graphics.Device

Field Summary

Fields inherited from class etomica.graphics.Device

Constructor Summary

Method Summary

Methods inherited from class etomica.graphics.Device

Methods inherited from class java.lang.Object

Field Detail

label

labelString

textField

panel

modifyAction

precision

Constructor Detail

DeviceBox

DeviceBox

Method Detail

stateChanged

doUpdate

setEditable

isEditable

setUnit

graphic

getPrecision

setPrecision

setInteger

isInteger

setModifier

getModifier

setLabel

getLabel

setLabelType

getLabelType

setLabelPosition

setTextBackground

getTextBackground

setBorderBackground

getLabelPosition

addValueChangedListener

removeValueChangedListener

removeAllValueChangedListeners

deviceBoxValueChanged