Package jmri.jmrit.symbolicprog

Class DecVariableValue

java.lang.Object

jmri.jmrit.symbolicprog.AbstractValue

jmri.jmrit.symbolicprog.VariableValue

jmri.jmrit.symbolicprog.DecVariableValue

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.FocusListener, java.beans.PropertyChangeListener, java.util.EventListener

Direct Known Subclasses:

HexVariableValue, ShortAddrVariableValue

public class DecVariableValue
extends VariableValue
implements java.awt.event.ActionListener, java.awt.event.FocusListener

Decimal representation of a value.
The mask attribute represents the part of the value that's present in the CV.
Optional attributes factor and offset are applied when going from the variable value to the CV values, or vice-versa:

 Value to put in CVs = ((value in text field) -offset)/factor
 Value to put in text field = ((value in CVs) *factor) +offset
 

*

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DecVariableValue.VarTextField

Nested classes/interfaces inherited from class jmri.jmrit.symbolicprog.AbstractValue

AbstractValue.ValueState

Field Summary

Fields

Modifier and Type	Field	Description
(package private) java.awt.Color	_defaultColor
(package private) int	_factor
(package private) int	_maxVal
(package private) int	_minVal
(package private) int	_offset
(package private) javax.swing.JTextField	_value
(package private) java.lang.String	oldContents
(package private) java.util.List<java.awt.Component>	reps
(package private) java.util.ArrayList<DecVarSlider>	sliders

Fields inherited from class jmri.jmrit.symbolicprog.VariableValue

_cvMap, _status, _tooltipText

Fields inherited from class jmri.jmrit.symbolicprog.AbstractValue

prop

Constructor Summary

Constructors

Constructor	Description
DecVariableValue(java.lang.String name, java.lang.String comment, java.lang.String cvName, boolean readOnly, boolean infoOnly, boolean writeOnly, boolean opsOnly, java.lang.String cvNum, java.lang.String mask, int minVal, int maxVal, java.util.HashMap<java.lang.String,CvValue> v, javax.swing.JLabel status, java.lang.String stdname)
DecVariableValue(java.lang.String name, java.lang.String comment, java.lang.String cvName, boolean readOnly, boolean infoOnly, boolean writeOnly, boolean opsOnly, java.lang.String cvNum, java.lang.String mask, int minVal, int maxVal, java.util.HashMap<java.lang.String,CvValue> v, javax.swing.JLabel status, java.lang.String stdname, int offset, int factor)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(java.awt.event.ActionEvent e)	ActionListener implementations
void	dispose()	Dispose of the object.
(package private) void	enterField()
(package private) void	exitField()
(package private) int	fieldLength()
void	focusGained(java.awt.event.FocusEvent e)	FocusListener implementations
void	focusLost(java.awt.event.FocusEvent e)
(package private) java.awt.Color	getColor()
java.awt.Component	getCommonRep()	Get a display representation Object of this variable.
(package private) java.awt.Color	getDefaultColor()
int	getIntValue()	Get the value as a single integer.
java.awt.Component	getNewRep(java.lang.String format)	Creates a new Object representation for display purposes, using the specified format.
java.lang.Object	getValueObject()
java.lang.String	getValueString()
boolean	isChanged()	Determine whether this Variable is "changed", so that "read changes" and "write changes" will act on it.
void	propertyChange(java.beans.PropertyChangeEvent e)
java.lang.Object	rangeVal()	Gets a (usually text) description of the variable type and range.
void	readAll()	Always read the contents of this Variable.
void	readChanges()	Read the contents of this Variable if it's in a state that indicates it was "changed".
void	setAvailable(boolean a)	Sets the availability status of the object.
(package private) void	setColor(java.awt.Color c)	Method to handle color changes for states.
void	setCvState(AbstractValue.ValueState state)	Notify the connected CVs of a state change from above
void	setIntValue(int i)	Set the value from a single number.
void	setToolTipText(java.lang.String t)	Set tooltip text to be used by both the "value" and representations of this Variable.
void	setValue(int value)	Set a new value in the variable (text box), including notification as needed.
(package private) int	textToValue(java.lang.String s)
(package private) void	updatedTextField()	Invoked when a permanent change to the JTextField has been made.
CvValue[]	usesCVs()	Provide access to CVs used by this Variable.
(package private) java.lang.String	valueToText(int v)
void	writeAll()	Always write the contents of this Variable.
void	writeChanges()	Write the contents of this Variable if it's in a state that indicates it was "changed".

Methods inherited from class jmri.jmrit.symbolicprog.VariableValue

confirmAll, considerChanged, cvName, getComment, getCvDescription, getCvName, getCvNum, getInfoOnly, getLongValue, getMask, getMaxMask, getOpsOnly, getReadOnly, getState, getTextValue, getValueInCV, getWriteOnly, isBitMask, isBusy, isToRead, isToWrite, item, label, maskValAsInt, offsetVal, setBusy, setState, setToRead, setToWrite, setValue, setValueInCV, simplifyMask, updateRepresentation

Methods inherited from class jmri.jmrit.symbolicprog.AbstractValue

addPropertyChangeListener, getAvailable, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Field Detail

_maxVal

int _maxVal

_minVal

int _minVal

_offset

int _offset

_factor

int _factor

oldContents

java.lang.String oldContents

reps

java.util.List<java.awt.Component> reps

sliders

java.util.ArrayList<DecVarSlider> sliders

_defaultColor

java.awt.Color _defaultColor

_value

javax.swing.JTextField _value

Constructor Detail

DecVariableValue

public DecVariableValue(java.lang.String name,
                        java.lang.String comment,
                        java.lang.String cvName,
                        boolean readOnly,
                        boolean infoOnly,
                        boolean writeOnly,
                        boolean opsOnly,
                        java.lang.String cvNum,
                        java.lang.String mask,
                        int minVal,
                        int maxVal,
                        java.util.HashMap<java.lang.String,CvValue> v,
                        javax.swing.JLabel status,
                        java.lang.String stdname)

DecVariableValue

public DecVariableValue(java.lang.String name,
                        java.lang.String comment,
                        java.lang.String cvName,
                        boolean readOnly,
                        boolean infoOnly,
                        boolean writeOnly,
                        boolean opsOnly,
                        java.lang.String cvNum,
                        java.lang.String mask,
                        int minVal,
                        int maxVal,
                        java.util.HashMap<java.lang.String,CvValue> v,
                        javax.swing.JLabel status,
                        java.lang.String stdname,
                        int offset,
                        int factor)

Method Detail

setToolTipText

public void setToolTipText(java.lang.String t)

Description copied from class: VariableValue

Set tooltip text to be used by both the "value" and representations of this Variable.

This is expected to be overridden in subclasses to change their internal info.

Overrides:

setToolTipText in class VariableValue

Parameters:

t - the tooltip text to be used

See Also:

VariableValue.updateRepresentation(javax.swing.JComponent)

fieldLength

int fieldLength()

usesCVs

public CvValue[] usesCVs()

Description copied from class: VariableValue

Provide access to CVs used by this Variable.

Specified by:

usesCVs in class VariableValue

Returns:

an array of CVs used by this Variable

rangeVal

public java.lang.Object rangeVal()

Description copied from class: VariableValue

Gets a (usually text) description of the variable type and range.

Specified by:

rangeVal in class VariableValue

Returns:

description of the variable type and range

enterField

void enterField()

textToValue

int textToValue(java.lang.String s)

valueToText

java.lang.String valueToText(int v)

exitField

void exitField()

updatedTextField

void updatedTextField()

Invoked when a permanent change to the JTextField has been made. Note that this does _not_ notify property listeners; that should be done by the invoker, who may or may not know what the old value was. Can be overridden in subclasses that want to display the value differently.

Overrides:

updatedTextField in class VariableValue

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

ActionListener implementations

Specified by:

actionPerformed in interface java.awt.event.ActionListener

focusGained

public void focusGained(java.awt.event.FocusEvent e)

FocusListener implementations

Specified by:

focusGained in interface java.awt.event.FocusListener

focusLost

public void focusLost(java.awt.event.FocusEvent e)

Specified by:

focusLost in interface java.awt.event.FocusListener

getValueString

public java.lang.String getValueString()

Specified by:

getValueString in class VariableValue

Returns:

String that can (usually) be interpreted as an integer

setIntValue

public void setIntValue(int i)

Description copied from class: VariableValue

Set the value from a single number.

In some cases, e.g. speed tables, this will result in complex behavior, where setIntValue(getIntValue()) results in something unexpected.

Specified by:

setIntValue in class VariableValue

Parameters:

i - the integer value to set

getIntValue

public int getIntValue()

Description copied from class: VariableValue

Get the value as a single integer.

In some cases, e.g. speed tables, this will result in complex behavior, where setIntValue(getIntValue()) results in something unexpected.

Specified by:

getIntValue in class VariableValue

Returns:

the value as an integer

getValueObject

public java.lang.Object getValueObject()

Specified by:

getValueObject in class VariableValue

Returns:

Value as a native-form Object

getCommonRep

public java.awt.Component getCommonRep()

Description copied from class: VariableValue

Get a display representation Object of this variable.

The actual stored value of a variable is not the most interesting thing. Instead, you usually get an Object representation for display in a table, etc. Modification of the state of that object then gets reflected back, causing the underlying CV objects to change.

Specified by:

getCommonRep in class VariableValue

Returns:

the Object representation for display purposes

setAvailable

public void setAvailable(boolean a)

Description copied from class: AbstractValue

Sets the availability status of the object.

Overrides:

setAvailable in class AbstractValue

Parameters:

a - true if the object should be made available, false if should be made unavailable

getNewRep

public java.awt.Component getNewRep(java.lang.String format)

Description copied from class: VariableValue

Creates a new Object representation for display purposes, using the specified format.

Specified by:

getNewRep in class VariableValue

Parameters:

format - a name representing

Returns:

an Object representation for display purposes

setValue

public void setValue(int value)

Set a new value in the variable (text box), including notification as needed.

This does the conversion from string to int, so it's the place where formatting needs to be applied.

Parameters:

value - new value.

getDefaultColor

java.awt.Color getDefaultColor()

getColor

java.awt.Color getColor()

setColor

void setColor(java.awt.Color c)

Description copied from class: AbstractValue

Method to handle color changes for states.

Specified by:

setColor in class AbstractValue

Parameters:

c - the desired colour

setCvState

public void setCvState(AbstractValue.ValueState state)

Notify the connected CVs of a state change from above

Specified by:

setCvState in class VariableValue

Parameters:

state - the new state to set

isChanged

public boolean isChanged()

Description copied from class: VariableValue

Determine whether this Variable is "changed", so that "read changes" and "write changes" will act on it.

Specified by:

isChanged in class VariableValue

Returns:

true if Variable is "changed"

See Also:

VariableValue.considerChanged(jmri.jmrit.symbolicprog.CvValue)

readChanges

public void readChanges()

Description copied from class: VariableValue

Read the contents of this Variable if it's in a state that indicates it was "changed".

Specified by:

readChanges in class VariableValue

See Also:

VariableValue.isChanged()

writeChanges

public void writeChanges()

Description copied from class: VariableValue

Write the contents of this Variable if it's in a state that indicates it was "changed".

Specified by:

writeChanges in class VariableValue

See Also:

VariableValue.isChanged()

readAll

public void readAll()

Description copied from class: VariableValue

Always read the contents of this Variable.

Specified by:

readAll in class VariableValue

writeAll

public void writeAll()

Description copied from class: VariableValue

Always write the contents of this Variable.

Specified by:

writeAll in class VariableValue

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Specified by:

propertyChange in class VariableValue

dispose

public void dispose()

Description copied from class: VariableValue

Dispose of the object.

Specified by:

dispose in class VariableValue