Package jmri.jmrit.symbolicprog

Class SplitEnumVariableValue

java.lang.Object

jmri.jmrit.symbolicprog.AbstractValue

jmri.jmrit.symbolicprog.VariableValue

jmri.jmrit.symbolicprog.SplitEnumVariableValue

All Implemented Interfaces:

ActionListener, FocusListener, PropertyChangeListener, EventListener

public class SplitEnumVariableValue
extends VariableValue
implements ActionListener, FocusListener

Extends VariableValue to represent a variable split across multiple CVs with values from a pre-selected range each of which is associated with a text name (aka, a drop down)
The mask attribute represents the part of the value that's present in each CV; higher-order bits are loaded to subsequent CVs.
It is possible to assign a specific mask for each CV by providing a space separated list of masks, starting with the lowest, and matching the order of CVs

The original use was for addresses of stationary (accessory) decoders.
The original version only allowed two CVs, with the second CV specified by the attributes highCV and upperMask.

The preferred technique is now to specify all CVs in the CV attribute alone, as documented at expandCvList(String).

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
(package private) static class	SplitEnumVariableValue.CvItem	Class to hold CV parameters for CVs used.
(package private) static class	SplitEnumVariableValue.TreeLeafNode
static class	SplitEnumVariableValue.VarComboBox

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

AbstractValue.ValueState

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	_columns
(package private) String	_cvNum
(package private) Color	_defaultColor
(package private) boolean	_fieldShrink
(package private) String	_mask
(package private) String[]	_maskArray
(package private) long	_maxVal
(package private) long	_minVal
(package private) String	_name
(package private) int	_progState
(package private) String	_uppermask
(package private) JComboBox<String>	_value
(package private) int	atest
(package private) static final int	bitCount
(package private) int	currentOffset
(package private) int	cvCount
(package private) List<SplitEnumVariableValue.CvItem>	cvList
(package private) static final int	IDLE
(package private) static final long	intMask
(package private) int	mFactor
(package private) int	mOffset
(package private) String	mSecondCV
(package private) String	oldContents
(package private) static final int	READING_FIRST
(package private) List<Component>	reps
int	retry
(package private) Deque<DefaultMutableTreeNode>	treeNodes
(package private) static final int	WRITING_FIRST

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
SplitEnumVariableValue(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, String pSecondCV, int pFactor, int pOffset, String uppermask, String extra1, String extra2, String extra3, String extra4)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)	ActionListener implementation.
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)
void	dispose()	Dispose of the object.
(package private) void	disposeReps()
void	endGroup()
(package private) void	enterField()	Saves selected item from _value (enumField) to oldContents.
(package private) void	exitField()	Contains numeric-value specific code.
void	focusGained(FocusEvent e)	FocusListener implementations.
void	focusLost(FocusEvent e)
Component	getCommonRep()	Get a display representation Object of this variable.
String	getCvDescription()	Provide a user-readable description of the CVs accessed by this variable.
String	getCvNum()	Get the first CV from the set used to define this variable
(package private) int[]	getCvValsFromSingleInt(long newEntry)
int	getIntValue()	Get the value as a single integer.
long	getLongValue()	Get the value as an unsigned long.
String	getMask()	Multiple masks can be defined for the CVs accessed by this variable.
protected String	getMask(int i)	Access a specific mask, used in tests
Component	getNewRep(String format)	Creates a new Object representation for display purposes, using the specified format.
(package private) String	getTextFromValue(long v)
String	getTextValue()
(package private) long	getValueFromText(String s)
Object	getValueObject()
String	getValueString()
boolean	isChanged()	Determine whether this Variable is "changed", so that "read changes" and "write changes" will act on it.
boolean	isToRead()	Ask whether this object needs to be read.
boolean	isToWrite()	Ask whether this object needs to be written.
void	lastItem()
void	nItems(int n)
(package private) int	priorityValue(AbstractValue.ValueState state)	Assigns a priority value to a given state.
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)	Select a specific value in the JComboBox display or, if need be, create another one
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	setLongValue(long value)
void	setToolTipText(String t)	Set tooltip text to be used by both the "value" and representations of this Variable.
void	setValue(int value)	Set value from a String value.
void	startGroup(String name)
void	stepOneActions(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, String pSecondCV, int pFactor, int pOffset, String uppermask, String extra1, String extra2, String extra3, String extra4)	Subclasses can override this to pick up constructor-specific attributes and perform other actions before cvList has been built.
void	stepTwoActions()	Subclasses can override this to invoke further actions after cvList has been built.
(package private) void	updatedDropDown()
(package private) void	updateVariableValue(int[] intVals)	Contains numeric-value specific code.
CvValue[]	usesCVs()	Simple request getter for the CVs composing 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, getCvName, getInfoOnly, getMaxMask, getOpsOnly, getReadOnly, getState, getValueInCV, getWriteOnly, isBitMask, isBusy, 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

atest

int atest

_value

JComboBox<String> _value

treeNodes

Deque<DefaultMutableTreeNode> treeNodes

mSecondCV

String mSecondCV

_uppermask

String _uppermask

mFactor

int mFactor

mOffset

int mOffset

_name

String _name

_mask

String _mask

_maskArray

String[] _maskArray

_cvNum

String _cvNum

cvList

List<SplitEnumVariableValue.CvItem> cvList

cvCount

int cvCount

currentOffset

int currentOffset

_minVal

long _minVal

_maxVal

long _maxVal

oldContents

String oldContents

_fieldShrink

boolean _fieldShrink

_defaultColor

Color _defaultColor

_columns

int _columns

reps

List<Component> reps

retry

public int retry

_progState

int _progState

IDLE

static final int IDLE

See Also:

• Constant Field Values

READING_FIRST

static final int READING_FIRST

See Also:

• Constant Field Values

WRITING_FIRST

static final int WRITING_FIRST

See Also:

• Constant Field Values

bitCount

static final int bitCount

intMask

static final long intMask

Constructor Details

SplitEnumVariableValue

public SplitEnumVariableValue(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,
 String pSecondCV,
 int pFactor,
 int pOffset,
 String uppermask,
 String extra1,
 String extra2,
 String extra3,
 String extra4)

Method Details

stepOneActions

public void stepOneActions(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,
 String pSecondCV,
 int pFactor,
 int pOffset,
 String uppermask,
 String extra1,
 String extra2,
 String extra3,
 String extra4)

Subclasses can override this to pick up constructor-specific attributes and perform other actions before cvList has been built.

Parameters:

name - name.

comment - comment.

cvName - cv name.

readOnly - true for read only, else false.

infoOnly - true for info only, else false.

writeOnly - true for write only, else false.

opsOnly - true for ops only, else false.

cvNum - cv number.

mask - cv mask.

minVal - minimum value.

maxVal - maximum value.

v - hashmap of string and cv value.

status - status.

stdname - std name.

pSecondCV - second cv (no longer preferred, specify in cv)

pFactor - factor.

pOffset - offset.

uppermask - upper mask (no longer preferred, specify in mask)

extra1 - extra 1.

extra2 - extra 2.

extra3 - extra 3.

extra4 - extra 4.

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)

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)

stepTwoActions

public void stepTwoActions()

Subclasses can override this to invoke further actions after cvList has been built.

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

usesCVs

public CvValue[] usesCVs()

Simple request getter for the CVs composing this variable

Specified by:

usesCVs in class VariableValue

Returns:

Array of CvValue for all of associated CVs

getMask

public String getMask()

Multiple masks can be defined for the CVs accessed by this variable.
Actual individual masks are returned in getCvDescription().

Overrides:

getMask in class VariableValue

Returns:

The legacy two-CV mask if highCV is specified.
The mask if highCV is not specified.

getMask

protected String getMask(int i)

Access a specific mask, used in tests

Parameters:

i - index of CV in variable

Returns:

a single mask as string in the form XXXXVVVV, or empty string if index out of bounds

getCvDescription

public String getCvDescription()

Provide a user-readable description of the CVs accessed by this variable.
Actual individual masks are added to CVs if more are present.

Overrides:

getCvDescription in class VariableValue

Returns:

A user-friendly CV(s) and bitmask(s) description

getCvNum

public String getCvNum()

Get the first CV from the set used to define this variable

Overrides:

getCvNum in class VariableValue

Returns:

The legacy two-CV mask if highCV is specified.

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

getValueFromText

long getValueFromText(String s)

getTextFromValue

String getTextFromValue(long v)

updateVariableValue

void updateVariableValue(int[] intVals)

Contains numeric-value specific code.

Calculates new value for _enumField and invokes setLongValue(newVal) to make and notify the change

Parameters:

intVals - array of new CV values

enterField

void enterField()

Saves selected item from _value (enumField) to oldContents.

exitField

void exitField()

Contains numeric-value specific code.
firePropertyChange for "Value" with new and old contents of _enumField

updatedDropDown

void updatedDropDown()

getCvValsFromSingleInt

int[] getCvValsFromSingleInt(long newEntry)

actionPerformed

public void actionPerformed(ActionEvent e)

ActionListener implementation. Called by new selection in the JComboBox representation.

Invokes exitField()

Specified by:

actionPerformed in interface ActionListener

Parameters:

e - the action event

focusGained

public void focusGained(FocusEvent e)

FocusListener implementations.

Specified by:

focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent e)

Specified by:

focusLost in interface FocusListener

getValueString

public String getValueString()

Specified by:

getValueString in class VariableValue

Returns:

String that can (usually) be interpreted as an integer

setValue

public void setValue(int value)

Set value from a String value.

Parameters:

value - a string representing the Long value to be set

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

getLongValue

public long getLongValue()

Get the value as an unsigned long.

Overrides:

getLongValue in class VariableValue

Returns:

the value as a long

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

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

setLongValue

public void setLongValue(long value)

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

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

selectValue

protected void selectValue(int value)

Select a specific value in the JComboBox display or, if need be, create another one

Parameters:

value - The new numerical value for the complete enum variable.

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

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)

isToRead

public boolean isToRead()

Description copied from class: VariableValue

Ask whether this object needs to be read.

Simple implementation for the case of a single CV. Intended to be sufficient for many subclasses.

Overrides:

isToRead in class VariableValue

Returns:

true if the object needs to be read, false otherwise

See Also:

• AbstractValue

isToWrite

public boolean isToWrite()

Description copied from class: VariableValue

Ask whether this object needs to be written.

Simple implementation for the case of a single CV. Intended to be sufficient for many subclasses.

Overrides:

isToWrite in class VariableValue

Returns:

true if the object needs to be written, false otherwise

See Also:

• AbstractValue

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

priorityValue

int priorityValue(AbstractValue.ValueState state)

Assigns a priority value to a given state.

Parameters:

state - State to be converted to a priority value

Returns:

Priority value from state, with UNKNOWN numerically highest

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()