Package etomica.graphics

Class DeviceSlider

java.lang.Object

etomica.graphics.Device

etomica.graphics.DeviceSlider

Direct Known Subclasses:

DeviceNSelector

public class DeviceSlider
extends Device

Device the changes a property using a graphical slider, via a Modifier.

See Also:

ModifierGeneral

Nested Class Summary

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

Device.ActionSet

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.Object	component	Object with property being modulated
protected ModifyAction	modifyAction	Modifier connecting the slider to the property
protected java.lang.String	property	Property being modulated
protected DecimalSlider	slider	Subclass of Swing slider displayed to screen located in utility package
protected boolean	suppressAction
protected IAction	targetAction
protected javax.swing.JTextField	textField	To show the values of slider

Fields inherited from class etomica.graphics.Device

controller, unit

Constructor Summary

Constructors

Constructor	Description
DeviceSlider(Controller controller)
DeviceSlider(Controller controller, int precision)
DeviceSlider(Controller controller, Modifier m)	Constructs a slider connected to the get/set Value methods of the given Modifier
DeviceSlider(Controller controller, Modifier m, int precision)
DeviceSlider(Controller controller, java.lang.Object object, java.lang.String property)	Constructs a slider connected to the given property of the given object
DeviceSlider(Controller controller, java.lang.Object object, java.lang.String property, int precision)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<java.lang.Void>	doAction(IAction action)	Method called by subclasses to execute the action of the device.
void	doUpdate()
java.lang.Object	getComponent()
boolean	getEditValues()
java.lang.String	getLabel()
double	getMaximum()
double	getMinimum()
Modifier	getModifier()
int	getNMajor()
int	getNMinor()
javax.swing.JPanel	getPanel()
int	getPrecision()
java.lang.String	getProperty()
boolean	getShowSlider()
boolean	getShowValues()
DecimalSlider	getSlider()
javax.swing.JTextField	getTextField()
double	getValue()
java.awt.Component	graphic()	Returns the GUI element for display in the simulation.
boolean	isEnabled()
boolean	isShowBorder()
void	setBorderAlignment(int align)
void	setComponent(java.lang.Object obj)
void	setEditValues(boolean b)
void	setEnabled(boolean isEnabled)	Sets the deivce's slider and textfield to be enabled or not.
void	setLabel(java.lang.String s)	Sets the value of a descriptive label using the given string.
void	setMaximum(double max)	Sets maximum value of slider; should be called after any calls to setPrecision.
void	setMinimum(double min)	Sets minimum value of slider; should be called after any calls to setPrecision.
void	setModifier(Modifier m)
void	setNMajor(int n)
void	setNMinor(int n)
void	setPrecision(int n)
void	setProperty(java.lang.String s)
void	setShowBorder(boolean b)
void	setShowSlider(boolean b)
void	setShowValues(boolean b)
void	setSliderValueShape(java.lang.String s)
void	setSliderVerticalOrientation(boolean b)
void	setUnit(Unit u)	Override superclass setUnit method to update label when unit is changed
void	setValue(double d)

Methods inherited from class etomica.graphics.Device

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

modifyAction

protected ModifyAction modifyAction

Modifier connecting the slider to the property

slider

protected DecimalSlider slider

Subclass of Swing slider displayed to screen located in utility package

component

protected java.lang.Object component

Object with property being modulated

property

protected java.lang.String property

Property being modulated

textField

protected javax.swing.JTextField textField

To show the values of slider

targetAction

protected IAction targetAction

suppressAction

protected boolean suppressAction

Constructor Detail

DeviceSlider

public DeviceSlider(Controller controller)

DeviceSlider

public DeviceSlider(Controller controller,
                    int precision)

DeviceSlider

public DeviceSlider(Controller controller,
                    java.lang.Object object,
                    java.lang.String property)

Constructs a slider connected to the given property of the given object

DeviceSlider

public DeviceSlider(Controller controller,
                    java.lang.Object object,
                    java.lang.String property,
                    int precision)

DeviceSlider

public DeviceSlider(Controller controller,
                    Modifier m)

Constructs a slider connected to the get/set Value methods of the given Modifier

DeviceSlider

public DeviceSlider(Controller controller,
                    Modifier m,
                    int precision)

Method Detail

setEnabled

public void setEnabled(boolean isEnabled)

Sets the deivce's slider and textfield to be enabled or not.

isEnabled

public boolean isEnabled()

setUnit

public void setUnit(Unit u)

Override superclass setUnit method to update label when unit is changed

Overrides:

setUnit in class Device

setBorderAlignment

public void setBorderAlignment(int align)

setModifier

public void setModifier(Modifier m)

getModifier

public final Modifier getModifier()

doUpdate

public void doUpdate()

doAction

public java.util.concurrent.CompletableFuture<java.lang.Void> doAction(IAction action)

Description copied from class: Device

Method called by subclasses to execute the action of the device. Action is specified by the subclass as the targetAction field; if this field is null, not action is performed. The action is normally performed by calling the doActionNow method of the controller, which causes the controller's thread to perform the action as soon as possible after suspending all simulation activities. If a controller has not been defined (is null), then the action is performed on the thread calling this method.

Overrides:

doAction in class Device

getProperty

public java.lang.String getProperty()

setProperty

public void setProperty(java.lang.String s)

getComponent

public java.lang.Object getComponent()

setComponent

public void setComponent(java.lang.Object obj)

getMinimum

public double getMinimum()

setMinimum

public void setMinimum(double min)

Sets minimum value of slider; should be called after any calls to setPrecision.

getMaximum

public double getMaximum()

setMaximum

public void setMaximum(double max)

Sets maximum value of slider; should be called after any calls to setPrecision.

setNMajor

public void setNMajor(int n)

getNMajor

public int getNMajor()

setNMinor

public void setNMinor(int n)

getNMinor

public int getNMinor()

getShowSlider

public boolean getShowSlider()

setShowSlider

public void setShowSlider(boolean b)

getShowValues

public boolean getShowValues()

setShowValues

public void setShowValues(boolean b)

setSliderValueShape

public void setSliderValueShape(java.lang.String s)

setSliderVerticalOrientation

public void setSliderVerticalOrientation(boolean b)

getEditValues

public boolean getEditValues()

setEditValues

public void setEditValues(boolean b)

getPrecision

public int getPrecision()

setPrecision

public void setPrecision(int n)

getValue

public double getValue()

setValue

public void setValue(double d)

graphic

public java.awt.Component graphic()

Returns the GUI element for display in the simulation.

Specified by:

graphic in class Device

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

setShowBorder

public void setShowBorder(boolean b)

isShowBorder

public boolean isShowBorder()

getSlider

public DecimalSlider getSlider()

Returns:

a handle to the DecimalSlider instance used by this slider device

getTextField

public javax.swing.JTextField getTextField()

Returns:

a handle to the JTextField instance used by this slider device

getPanel

public javax.swing.JPanel getPanel()

Returns:

a handle to the JPanel instance used by this slider device