Package jmri.jmrit.symbolicprog

Class ConstantValue

java.lang.Object

jmri.jmrit.symbolicprog.AbstractValue

jmri.jmrit.symbolicprog.VariableValue

jmri.jmrit.symbolicprog.ConstantValue

All Implemented Interfaces:

PropertyChangeListener, EventListener

public class ConstantValue
extends VariableValue

Extends VariableValue to represent a constant enum-like-thing. Note that there's no CV associated with this.

Nested Class Summary

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) String[]	_itemArray
(package private) int	_nstored
(package private) JComboBox<Integer>	_value
(package private) List<JCheckBox>	comboCBs
(package private) List<JRadioButton>	comboRBs

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
ConstantValue()	Create a null object.
ConstantValue(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	dispose()	Dispose of the object.
Component	getCommonRep()	Get a display representation Object of this variable.
String	getCvDescription()	Provide a user-readable description of the CVs accessed by 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.
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	propertyChange(PropertyChangeEvent e)
Object	rangeVal()	Gets a (usually text) description of the variable type and range.
void	readAll()	Skip actually reading, but set states and notifications anyway.
void	readChanges()	Read the contents of this Variable if it's in a state that indicates it was "changed".
(package private) void	setColor(Color c)	Method to handle color changes for states.
void	setCvState(AbstractValue.ValueState state)	No connected CV, so this notify does nothing
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	setToRead(boolean state)	Mark whether this object needs to be read.
void	setToWrite(boolean state)	Mark whether this object needs to be written.
void	setValue(int value)
CvValue[]	usesCVs()	Provide access to CVs used by this Variable.
void	writeAll()	Skip actually writing, but set states and notifications anyway.
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, getCvNum, getInfoOnly, getLongValue, getMask, getMaxMask, getOpsOnly, getReadOnly, getState, getTextValue, getValueInCV, getWriteOnly, isBitMask, isBusy, item, label, maskValAsInt, offsetVal, setBusy, setState, setValue, setValueInCV, simplifyMask, updatedTextField, updateRepresentation

Methods inherited from class jmri.jmrit.symbolicprog.AbstractValue

addPropertyChangeListener, getAvailable, removePropertyChangeListener, setAvailable

Methods inherited from class java.lang.Object

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

Field Details

_value

JComboBox<Integer> _value

_itemArray

String[] _itemArray

_nstored

int _nstored

_defaultColor

Color _defaultColor

comboCBs

List<JCheckBox> comboCBs

comboRBs

List<JRadioButton> comboRBs

Constructor Details

ConstantValue

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

ConstantValue

public ConstantValue()

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

getCvDescription

public String getCvDescription()

Provide a user-readable description of the CVs accessed by this variable.

Overrides:

getCvDescription in class VariableValue

Returns:

a user-readable description

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)

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

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

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

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)

No connected CV, so this notify does nothing

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)

setToRead

public void setToRead(boolean state)

Description copied from class: VariableValue

Mark whether this object needs to be read.

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

Overrides:

setToRead in class VariableValue

Parameters:

state - true if the object needs to be read, false otherwise

See Also:

• AbstractValue

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

setToWrite

public void setToWrite(boolean state)

Description copied from class: VariableValue

Mark whether this object needs to be written.

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

Overrides:

setToWrite in class VariableValue

Parameters:

state - true if the object needs to be written, 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()

Skip actually reading, but set states and notifications anyway.

This sets the state to READ so that you can have algorithms like "write all variables that aren't in READ state" This is different from the 'normal' VariableValue objects, which rely on the associated CV objects to drive state changes at the end of the write.

Specified by:

readAll in class VariableValue

writeAll

public void writeAll()

Skip actually writing, but set states and notifications anyway.

This sets the state to STORED so that you can have algorithms like "write all variables that aren't in STORED state" This is different from the 'normal' VariableValue objects, which rely on the associated CV objects to drive state changes at the end of the write.

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