Package jmri.jmrit.symbolicprog

Class EnumVariableValue

java.lang.Object

jmri.jmrit.symbolicprog.AbstractValue

jmri.jmrit.symbolicprog.VariableValue

jmri.jmrit.symbolicprog.EnumVariableValue

All Implemented Interfaces:

ActionListener, PropertyChangeListener, EventListener

Direct Known Subclasses:

CompositeVariableValue

public class EnumVariableValue
extends VariableValue
implements 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) Color	_defaultColor
(package private) int	_maxVal
(package private) int	_minVal
(package private) JComboBox<String>	_value
(package private) Deque<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(String name, String comment, String cvName, boolean readOnly, boolean infoOnly, boolean writeOnly, boolean opsOnly, String cvNum, String mask, int minVal, int maxVal, HashMap<String,CvValue> v, JLabel status, String stdname)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)
void	addItem(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(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()
Component	getCommonRep()	Get a display representation Object of this variable.
int	getIntValue()	Get the value as a single integer.
Component	getNewRep(String format)	Creates a new Object representation for display purposes, using the specified format.
String	getTextValue()
Object	getValueObject()
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(PropertyChangeEvent e)
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(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(String t)	Set tooltip text to be used by both the "value" and representations of this Variable.
void	setValue(int value)
void	startGroup(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

Methods inherited from class java.lang.Object

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

Field Details

_value

JComboBox<String> _value

treeNodes

Deque<DefaultMutableTreeNode> treeNodes

_maxVal

int _maxVal

_minVal

int _minVal

_defaultColor

Color _defaultColor

Constructor Details

EnumVariableValue

public EnumVariableValue(String name,
 String comment,
 String cvName,
 boolean readOnly,
 boolean infoOnly,
 boolean writeOnly,
 boolean opsOnly,
 String cvNum,
 String mask,
 int minVal,
 int maxVal,
 HashMap<String,CvValue> v,
 JLabel status,
 String stdname)

EnumVariableValue

public EnumVariableValue()

Create a null object. Normally only used for tests and to pre-load classes.

Method Details

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

nItems

public void nItems(int n)

addItem

public void addItem(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(String s,
 int value)

Create a new item in the enumeration, with a specified associated value.

Parameters:

s - Name of the enumeration item

value - item value.

startGroup

public void startGroup(String name)

endGroup

public void endGroup()

lastItem

public void lastItem()

setToolTipText

public void setToolTipText(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)

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

rangeVal

public 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

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

getValueString

public 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

getTextValue

public String getTextValue()

Overrides:

getTextValue in class VariableValue

Returns:

User-desired value, which may or may not be an integer

getValueObject

public Object getValueObject()

Specified by:

getValueObject in class VariableValue

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 class VariableValue

Returns:

the value as an integer

getCommonRep

public 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

setValue

public void setValue(int value)

getNewRep

public Component getNewRep(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

setColor

void setColor(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(PropertyChangeEvent e)

Specified by:

propertyChange in interface 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

disposeReps

void disposeReps()