Package jmri.jmrit.symbolicprog
Class EnumVariableValue
- java.lang.Object
-
- jmri.jmrit.symbolicprog.AbstractValue
-
- jmri.jmrit.symbolicprog.VariableValue
-
- jmri.jmrit.symbolicprog.EnumVariableValue
-
- All Implemented Interfaces:
java.awt.event.ActionListener
,java.beans.PropertyChangeListener
,java.util.EventListener
- Direct Known Subclasses:
CompositeVariableValue
public class EnumVariableValue extends VariableValue implements java.awt.event.ActionListener
Extends VariableValue to represent an enumerated variable.- See Also:
VariableValue
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
EnumVariableValue.TreeLeafNode
static class
EnumVariableValue.VarComboBox
-
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
_maxVal
(package private) int
_minVal
(package private) javax.swing.JComboBox<java.lang.String>
_value
(package private) java.util.Deque<javax.swing.tree.DefaultMutableTreeNode>
treeNodes
-
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 EnumVariableValue()
Create a null object.EnumVariableValue(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)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
actionPerformed(java.awt.event.ActionEvent e)
void
addItem(java.lang.String s)
Create a new item in the enumeration, with an associated value one more than the last item (or zero if this is the first one added)void
addItem(java.lang.String s, int value)
Create a new item in the enumeration, with a specified associated value.void
dispose()
Dispose of the object.(package private) void
disposeReps()
void
endGroup()
java.awt.Component
getCommonRep()
Get a display representationObject
of this variable.int
getIntValue()
Get the value as a single integer.java.awt.Component
getNewRep(java.lang.String format)
Creates a newObject
representation for display purposes, using the specified format.java.lang.String
getTextValue()
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
lastItem()
void
nItems(int n)
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".protected void
selectValue(int value)
Set to a specific value.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 abovevoid
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)
void
startGroup(java.lang.String name)
CvValue[]
usesCVs()
Provide access to CVs used by this Variable.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, getValueInCV, getWriteOnly, isBitMask, isBusy, isToRead, isToWrite, item, label, maskValAsInt, offsetVal, setBusy, setState, setToRead, setToWrite, setValue, setValueInCV, simplifyMask, updatedTextField, updateRepresentation
-
Methods inherited from class jmri.jmrit.symbolicprog.AbstractValue
addPropertyChangeListener, getAvailable, removePropertyChangeListener
-
-
-
-
Field Detail
-
_value
javax.swing.JComboBox<java.lang.String> _value
-
treeNodes
java.util.Deque<javax.swing.tree.DefaultMutableTreeNode> treeNodes
-
_maxVal
int _maxVal
-
_minVal
int _minVal
-
_defaultColor
java.awt.Color _defaultColor
-
-
Constructor Detail
-
EnumVariableValue
public EnumVariableValue(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)
-
EnumVariableValue
public EnumVariableValue()
Create a null object. Normally only used for tests and to pre-load classes.
-
-
Method Detail
-
usesCVs
public CvValue[] usesCVs()
Description copied from class:VariableValue
Provide access to CVs used by this Variable.- Specified by:
usesCVs
in classVariableValue
- Returns:
- an array of CVs used by this Variable
-
nItems
public void nItems(int n)
-
addItem
public void addItem(java.lang.String s)
Create a new item in the enumeration, with an associated value one more than the last item (or zero if this is the first one added)- Parameters:
s
- Name of the enumeration item
-
addItem
public void addItem(java.lang.String s, int value)
Create a new item in the enumeration, with a specified associated value.- Parameters:
s
- Name of the enumeration itemvalue
- item value.
-
startGroup
public void startGroup(java.lang.String name)
-
endGroup
public void endGroup()
-
lastItem
public void lastItem()
-
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 classVariableValue
- Parameters:
t
- the tooltip text to be used- See Also:
VariableValue.updateRepresentation(javax.swing.JComponent)
-
setAvailable
public void setAvailable(boolean a)
Description copied from class:AbstractValue
Sets the availability status of the object.- Overrides:
setAvailable
in classAbstractValue
- Parameters:
a
-true
if the object should be made available,false
if should be made unavailable
-
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 classVariableValue
- Returns:
- description of the variable type and range
-
actionPerformed
public void actionPerformed(java.awt.event.ActionEvent e)
- Specified by:
actionPerformed
in interfacejava.awt.event.ActionListener
-
getValueString
public java.lang.String getValueString()
- Specified by:
getValueString
in classVariableValue
- 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 classVariableValue
- Parameters:
i
- the integer value to set
-
getTextValue
public java.lang.String getTextValue()
- Overrides:
getTextValue
in classVariableValue
- Returns:
- User-desired value, which may or may not be an integer
-
getValueObject
public java.lang.Object getValueObject()
- Specified by:
getValueObject
in classVariableValue
- Returns:
- Value as a native-form Object
-
selectValue
protected void selectValue(int value)
Set to a specific value.This searches for the displayed value, and sets the enum to that particular one. It used to work off an index, but now it looks for the value.
If the value is larger than any defined, a new one is created.
- Parameters:
value
- What to set to.
-
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 classVariableValue
- Returns:
- the value as an integer
-
getCommonRep
public java.awt.Component getCommonRep()
Description copied from class:VariableValue
Get a display representationObject
of this variable.
The actual stored value of a variable is not the most interesting thing. Instead, you usually get anObject
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 classVariableValue
- Returns:
- the
Object
representation for display purposes
-
setValue
public void setValue(int value)
-
getNewRep
public java.awt.Component getNewRep(java.lang.String format)
Description copied from class:VariableValue
Creates a newObject
representation for display purposes, using the specified format.- Specified by:
getNewRep
in classVariableValue
- Parameters:
format
- a name representing- Returns:
- an
Object
representation for display purposes
-
setColor
void setColor(java.awt.Color c)
Description copied from class:AbstractValue
Method to handle color changes for states.- Specified by:
setColor
in classAbstractValue
- 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 classVariableValue
- 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 classVariableValue
- 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 classVariableValue
- 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 classVariableValue
- See Also:
VariableValue.isChanged()
-
readAll
public void readAll()
Description copied from class:VariableValue
Always read the contents of this Variable.- Specified by:
readAll
in classVariableValue
-
writeAll
public void writeAll()
Description copied from class:VariableValue
Always write the contents of this Variable.- Specified by:
writeAll
in classVariableValue
-
propertyChange
public void propertyChange(java.beans.PropertyChangeEvent e)
- Specified by:
propertyChange
in interfacejava.beans.PropertyChangeListener
- Specified by:
propertyChange
in classVariableValue
-
dispose
public void dispose()
Description copied from class:VariableValue
Dispose of the object.- Specified by:
dispose
in classVariableValue
-
disposeReps
void disposeReps()
-
-