Package jmri.jmrit.conditional

Class ConditionalTreeEdit

java.lang.Object

jmri.jmrit.conditional.ConditionalEditBase

jmri.jmrit.conditional.ConditionalTreeEdit

public class ConditionalTreeEdit
extends ConditionalEditBase

A tree based editor for maintaining Logix Conditionals, State Variables and Actions.

The tree has 3 levels. The first level are the conditionals contained in the selected Logix. The second level contains the antecedent, logic type and trigger mode settings. The third level contains the detail Variable and Action lines.

Compare with the other Conditional Edit tool ConditionalListEdit

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	ConditionalTreeEdit.ActionTypeListener	Listener for _actionTypeBox.
(package private) static class	ConditionalTreeEdit.ConditionalTreeNode	Conditional Tree Node Definition.

Nested classes/interfaces inherited from class jmri.jmrit.conditional.ConditionalEditBase

ConditionalEditBase.LogixEventListener, ConditionalEditBase.NameBoxListener, ConditionalEditBase.PickSingleListener, ConditionalEditBase.SelectionMode

Field Summary

Fields

Modifier and Type	Field	Description
(package private) ConditionalTreeEdit.ConditionalTreeNode	_actHead
(package private) JComboBox<String>	_actionBox
(package private) JLabel	_actionBoxLabel
(package private) JComboBox<Conditional.ItemType>	_actionItemBox
(package private) JLabel	_actionLabel
(package private) List<ConditionalAction>	_actionList
(package private) JTextField	_actionNameField
(package private) JLabel	_actionNameLabel
(package private) JComboBox<String>	_actionOptionBox
(package private) JButton	_actionSetButton
(package private) JLabel	_actionsLabel
(package private) JComboBox<Conditional.Action>	_actionTypeBox
(package private) JLabel	_actionTypeLabel
(package private) ConditionalTreeEdit.ActionTypeListener	_actionTypeListener
(package private) ConditionalTreeEdit.ConditionalTreeNode	_actNode
(package private) JPanel	_addButtonPanel
(package private) String	_antecedent
(package private) JLabel	_antecedentLabel
(package private) JButton	_cancelAction
(package private) TreeSelectionListener	_cdlListener
(package private) DefaultTreeModel	_cdlModel
(package private) ConditionalTreeEdit.ConditionalTreeNode	_cdlNode
(package private) DefaultMutableTreeNode	_cdlRoot
(package private) JTree	_cdlTree
(package private) JPanel	_checkButtonPanel
(package private) NamedBeanComboBox<?>	_comboNameBox
(package private) JLabel	_conditionalLabel
(package private) ConditionalAction	_curAction
(package private) Conditional.ItemType	_curActionItem
(package private) Conditional	_curConditional
(package private) String	_curConditionalName
(package private) JPanel	_curDetailPanel
(package private) ConditionalTreeEdit.ConditionalTreeNode	_curNode
(package private) String	_curNodeName
(package private) int	_curNodeRow
(package private) String	_curNodeText
(package private) String	_curNodeType
(package private) TreePath	_curTreePath
(package private) ConditionalVariable	_curVariable
(package private) Conditional.ItemType	_curVariableItem
(package private) JPanel	_deleteButtonPanel
(package private) JPanel	_detailFooter
(package private) JPanel	_detailGrid
(package private) boolean	_editActive
(package private) JTextField	_editAntecedent
(package private) JTextField	_editConditionalUserName
(package private) JTextField	_editLogixUserName
(package private) JComboBox<Conditional.AntecedentOperator>	_editOperatorMode
(package private) JPanel	_gridPanel
(package private) JPanel	_helpButtonPanel
(package private) JPanel	_labelPanel
(package private) ConditionalTreeEdit.ConditionalTreeNode	_leafNode
(package private) JPanel	_leftButtonBar
(package private) Conditional.AntecedentOperator	_logicType
(package private) JLabel	_logicTypeLabel
(package private) JLabel	_longActionLabel
(package private) JTextField	_longActionString
(package private) JPanel	_moveButtonPanel
(package private) boolean	_newActionItem
(package private) boolean	_newVariableItem
(package private) TreeSet<String>	_oldTargetNames
(package private) String	_pickCommand
(package private) Conditional.ItemType	_pickItem
(package private) JComboBox<String>	_selectConditionalBox
(package private) ArrayList<String>	_selectConditionalList
(package private) JComboBox<String>	_selectLogixBox
(package private) TreeMap<String,String>	_selectLogixMap
(package private) JLabel	_shortActionLabel
(package private) JTextField	_shortActionString
(package private) JPanel	_toggleButtonPanel
(package private) boolean	_triggerMode
(package private) JLabel	_triggerModeLabel
(package private) JButton	_updateAction
(package private) ConditionalTreeEdit.ConditionalTreeNode	_varHead
(package private) JComboBox<String>	_variableCompareOpBox
(package private) JComboBox<Conditional.Type>	_variableCompareTypeBox
(package private) JTextField	_variableData1Field
(package private) JTextField	_variableData2Field
(package private) JComboBox<Conditional.ItemType>	_variableItemBox
(package private) JLabel	_variableLabel
(package private) List<ConditionalVariable>	_variableList
(package private) JLabel	_variableMemoryValueLabel
(package private) JTextField	_variableNameField
(package private) JLabel	_variableNameLabel
(package private) JCheckBox	_variableNegated
(package private) JComboBox<String>	_variableOperBox
(package private) JComboBox<String>	_variableSignalBox
(package private) JLabel	_variablesLabel
(package private) JComboBox<Conditional.Type>	_variableStateBox
(package private) JCheckBox	_variableTriggerActions
(package private) ConditionalTreeEdit.ConditionalTreeNode	_varNode
(package private) ActionListener	actionSignalHeadNameListener
(package private) ActionListener	actionSignalMastNameListener
(package private) ActionListener	compareTypeBoxListener
(package private) JFileChooser	defaultFileChooser
(package private) FocusListener	detailFocusEvent	Focus gained implies intent to make changes, set up for edit.
(package private) ScriptFileChooser	scriptFileChooser
(package private) ActionListener	selectConditionalBoxListener
(package private) ActionListener	selectLogixBoxListener
(package private) JFileChooser	sndFileChooser
(package private) ActionListener	variableSignalHeadNameListener
(package private) ActionListener	variableSignalMastNameListener
(package private) ActionListener	variableSignalTestStateListener

Fields inherited from class jmri.jmrit.conditional.ConditionalEditBase

_conditionalManager, _curLogix, _editLogixFrame, _inEditMode, _logixManager, _pickListener, _pickSingleFrame, _pickTable, _pickTables, _pickTabPane, _selectionMode, _showReminder, _suppressIndirectRef, _suppressReminder, listenerList, logixData

Constructor Summary

Constructors

Constructor	Description
ConditionalTreeEdit()
ConditionalTreeEdit(String sName)	Create a new Conditional Tree View editor.

Method Summary

Modifier and Type	Method	Description
(package private) void	actionItemChanged(Conditional.ItemType type)	Respond to a change in an Action Type comboBox.
(package private) void	addPressed()	Add new items: Conditionals, Variables or Actions.
(package private) void	antecedentChanged(String antecedentText)	Update the antecedent.
(package private) void	appendToAntecedent()	Add a R# to the antecedent statement.
(package private) void	buildActionComponents()	Called once during class initialization to define the GUI objects.
(package private) void	buildConditionalComponents()	Initialize conditional components.
(package private) JTree	buildConditionalTree()	Create the conditional tree structure using the current Logix.
(package private) String	buildNodeText(String nodeType, Object component, int idx)	Create the localized node text display strings based on node type.
(package private) void	buildVariableComponents()	Called once during class initialization to define the GUI objects.
(package private) void	cancelEditAction()	Respond to Cancel action button and window closer of the Edit Action window.
(package private) void	cancelEditVariable()	Respond to Cancel variable button
(package private) void	cancelPressed()	Cancel the current node edit.
(package private) boolean	checkIsAction(String name, Conditional.ItemType itemType)	Check that a state variable is not also used as an action
(package private) boolean	checkIsVariable(String name, Conditional.ItemType itemType)	Check that an action is not also used as a state variable
(package private) void	checkPressed()	Refresh the Conditional or Variable state.
(package private) void	cleanUpAction()	Clean up Update and Delete Action buttons.
(package private) void	cleanUpVariable()	Clean up: Cancel, Update and Delete Variable buttons.
(package private) void	createConditionalContent()	Create the tree content.
(package private) void	deletePressed()	Process the node delete request.
(package private) void	donePressed()	Clean up, notify the parent Logix that edit session is done.
(package private) void	doPickList()	Create a Variable or Action based tabbed PickList with appropriate tab selected.
(package private) void	doPickSingle()	Create a Variable or Action based single pane PickList.
(package private) void	downPressed()	Move a conditional, variable or action row down 1 row.
(package private) void	editPressed()	Set up the edit environment for the selected node Called from treeRowSelected(jmri.jmrit.conditional.ConditionalTreeEdit.ConditionalTreeNode).
protected String	getClassName()
(package private) void	helpPressed()	Respond to Help button press in the Edit Logix menu bar.
(package private) void	initializeActionVariables()	Set display to show current action (curAction) parameters.
(package private) void	initializeStateVariables()	Set display to show current state variable (curVariable) parameters.
(package private) void	loadJComboBoxWithHeadAppearances(JComboBox<String> box, String signalHeadName)	Fetch valid localized appearances for a given Signal Head.
(package private) void	loadJComboBoxWithMastAspects(JComboBox<String> box, String mastName)	Fetch valid aspects for a given Signal Mast.
(package private) void	loadSelectConditionalBox(String logixName)	Load the Conditional selection box.
(package private) void	loadSelectLogixBox()	Load the Logix selection box.
(package private) void	logicTypeChanged(Conditional.AntecedentOperator newType)	Respond to a change of Logic Type in the dialog window by showing/hiding the _antecedentPanel when Mixed is selected.
(package private) void	makeAntecedent()	Build the antecedent statement.
(package private) void	makeAntecedentGrid(GridBagConstraints c)	This grid is used to edit the Antecedent when the Logic Type is Mixed.
(package private) void	makeChangeTriggerActionGrid(GridBagConstraints c)	Add the change/trigger box the grid.
(package private) void	makeConditionalGrid(GridBagConstraints c)	This grid is used to edit the Conditional User Name.
(package private) void	makeConditionalVariableGrid(GridBagConstraints c)	Create the Logix and Conditional rows and the State row.
(package private) void	makeDetailGrid(String gridType)	Build new GridBag content.
(package private) void	makeEditLogixWindow()	Create the edit logix window.
(package private) void	makeEmptyActionGrid(GridBagConstraints c)	Create a one row grid with just the Action Item box.
(package private) void	makeEmptyGrid(GridBagConstraints c)	This grid is used when there are no edit grids required.
(package private) void	makeEmptyVariableGrid(GridBagConstraints c)	Create a one row grid with just the Variable Type box.
(package private) void	makeFastClockVariableGrid(GridBagConstraints c)	Create the Fast Clock start and end time rows.
(package private) void	makeFileActionGrid(GridBagConstraints c)	Add the file selection components.
(package private) void	makeLogicTypeGrid(GridBagConstraints c)	This grid is used to edit the Logic Type.
(package private) void	makeMemoryVariableGrid(GridBagConstraints c)	Create the Memory specific rows.
(package private) void	makeNameTypeActionGrid(GridBagConstraints c, boolean finalRow)	Create the standard Name and Type rows.
(package private) void	makeOptionsVariableGrid(GridBagConstraints c)
(package private) void	makeShortFieldActionGrid(GridBagConstraints c, boolean includeBox)	Add the short name field to the grid.
(package private) void	makeSignalAspectVariableGrid(GridBagConstraints c)	Add the Aspect field for signal heads and signal masts.
(package private) void	makeStandardActionGrid(GridBagConstraints c, boolean finalRow)	Add the action box to the grid.
(package private) void	makeStandardVariableGrid(GridBagConstraints c)	Create the standard Name and State rows.
(package private) void	makeTypeActionGrid(GridBagConstraints c, boolean finalRow)	Create the standard Type row.
(package private) void	makeTypeShortActionGrid(GridBagConstraints c)	Just a short text field, no name field.
(package private) void	moveTreeNode(String direction)	Move a tree node in response to a up or down request.
(package private) void	newAction()	Create a new action Can be invoked by a Actions or Action node.
(package private) void	newVariable()	Create a new variable Can be invoked by a Variables or Variable node.
(package private) void	removeActionTimers()	Remove Action timers and listeners before Action list structure changes.
(package private) void	setActionNameBox(Conditional.ItemType itemType)	Update the name combo box selection based on the current contents of the name field.
(package private) void	setEditMode(boolean active)	Enable/disable buttons based on edit state.
(package private) void	setFileLocation(ActionEvent e)	Respond to the [...] button in the Edit Action window action section.
(package private) void	setFocusListeners()	Add the focus listener to each detail edit field.
(package private) void	setMoveButtons()	Enable/Disable the Up and Down buttons based on the postion in the list.
(package private) void	setPickWindow(String cmd, Conditional.ItemType item)	Ceate tabbed Pick Taba;e or Pick Single based on Selection Mode.
(package private) void	setVariableNameBox(Conditional.ItemType itemType)	Update the name combo box selection based on the current contents of the name field.
(package private) void	showNodeEditMessage()	Display reminder to finish a node before starting another.
(package private) void	togglePressed()	Update the Actions trigger mode, adjust the Action descriptions.
(package private) void	treeRowSelected(ConditionalTreeEdit.ConditionalTreeNode selectedNode)	Change the button row based on the currently selected node type.
(package private) void	updateAction()	Respond to Update button.
(package private) void	updateActionList()	Update the conditional action list and refresh the local copy.
(package private) void	updatePressed()	Apply the updates to the current node.
(package private) void	updateVariable()	Respond to Update Variable button in the Edit Variable pane.
(package private) void	updateVariableList()	Update the conditional variable list and refresh the local copy.
(package private) void	updateVariableNegation()	Update the variable negation.
(package private) void	updateVariableOperator()	Update the variable operation.
(package private) void	upPressed()	Move a conditional, variable or action row up 1 row.
(package private) void	userNameChanged(String newName)	Change the conditional user name.
(package private) boolean	validateAction()	Validate Action data from Edit Action Window, and transfer it to current action object as appropriate.
(package private) boolean	validateAntecedent(String antecedentText)	Check the antecedent and logic type.
(package private) boolean	validateVariable()	Validate Variable data from Edit Variable panel, and transfer it to current variable object as appropriate.

Methods inherited from class jmri.jmrit.conditional.ConditionalEditBase

addLogixEventListener, appendToAntecedent, bringToFront, checkConditionalReferences, checkConditionalUserName, closeSinglePanelPickList, confirmActionAsVariable, confirmIndirectMemory, createNameBox, createSinglePanelPickList, displayBadNumberReference, findPickListTabPane, fireLogixEvent, formatTime, getLight, hidePickListTable, loadReferenceNames, loadSelectionMode, locateAt, makeAntecedent, messageDuplicateConditionalUserName, messageInvalidActionItemName, openPickListTable, parseTime, removeLogixEventListener, setPickListTab, showSaveReminder, translateAntecedent, updateWhereUsed, validateAntecedent, validateAudioReference, validateConditionalReference, validateEntryExitReference, validateIntensity, validateIntensityReference, validateLightReference, validateLogixReference, validateMemoryReference, validateOBlockReference, validateRouteReference, validateSensorReference, validateSignalHeadReference, validateSignalMastReference, validateTime, validateTimeReference, validateTurnoutReference, validateWarrantReference

Methods inherited from class java.lang.Object

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

Field Details

_curDetailPanel

JPanel _curDetailPanel

_editLogixUserName

JTextField _editLogixUserName

_comboNameBox

NamedBeanComboBox<?> _comboNameBox

_detailGrid

JPanel _detailGrid

_detailFooter

JPanel _detailFooter

_gridPanel

JPanel _gridPanel

_editConditionalUserName

JTextField _editConditionalUserName

_editAntecedent

JTextField _editAntecedent

_editOperatorMode

JComboBox<Conditional.AntecedentOperator> _editOperatorMode

_editActive

boolean _editActive

_cancelAction

JButton _cancelAction

_updateAction

JButton _updateAction

_pickCommand

String _pickCommand

_pickItem

Conditional.ItemType _pickItem

_cdlTree

JTree _cdlTree

_cdlModel

DefaultTreeModel _cdlModel

_cdlRoot

DefaultMutableTreeNode _cdlRoot

_cdlListener

TreeSelectionListener _cdlListener

_curTreePath

TreePath _curTreePath

_cdlNode

ConditionalTreeEdit.ConditionalTreeNode _cdlNode

_varHead

ConditionalTreeEdit.ConditionalTreeNode _varHead

_varNode

ConditionalTreeEdit.ConditionalTreeNode _varNode

_actHead

ConditionalTreeEdit.ConditionalTreeNode _actHead

_actNode

ConditionalTreeEdit.ConditionalTreeNode _actNode

_leafNode

ConditionalTreeEdit.ConditionalTreeNode _leafNode

_curNode

ConditionalTreeEdit.ConditionalTreeNode _curNode

_curNodeName

String _curNodeName

_curNodeType

String _curNodeType

_curNodeText

String _curNodeText

_curNodeRow

int _curNodeRow

_leftButtonBar

JPanel _leftButtonBar

_labelPanel

JPanel _labelPanel

_addButtonPanel

JPanel _addButtonPanel

_toggleButtonPanel

JPanel _toggleButtonPanel

_checkButtonPanel

JPanel _checkButtonPanel

_moveButtonPanel

JPanel _moveButtonPanel

_deleteButtonPanel

JPanel _deleteButtonPanel

_helpButtonPanel

JPanel _helpButtonPanel

_conditionalLabel

JLabel _conditionalLabel

_antecedentLabel

JLabel _antecedentLabel

_logicTypeLabel

JLabel _logicTypeLabel

_triggerModeLabel

JLabel _triggerModeLabel

_variablesLabel

JLabel _variablesLabel

_variableLabel

JLabel _variableLabel

_actionsLabel

JLabel _actionsLabel

_actionLabel

JLabel _actionLabel

_curConditional

Conditional _curConditional

_variableList

List<ConditionalVariable> _variableList

_actionList

List<ConditionalAction> _actionList

_curVariable

ConditionalVariable _curVariable

_curAction

ConditionalAction _curAction

_curVariableItem

Conditional.ItemType _curVariableItem

_curActionItem

Conditional.ItemType _curActionItem

_curConditionalName

String _curConditionalName

_antecedent

String _antecedent

_logicType

Conditional.AntecedentOperator _logicType

_triggerMode

boolean _triggerMode

_newActionItem

boolean _newActionItem

_newVariableItem

boolean _newVariableItem

_oldTargetNames

TreeSet<String> _oldTargetNames

_selectLogixBox

JComboBox<String> _selectLogixBox

_selectConditionalBox

JComboBox<String> _selectConditionalBox

_selectLogixMap

TreeMap<String,String> _selectLogixMap

_selectConditionalList

ArrayList<String> _selectConditionalList

_variableItemBox

JComboBox<Conditional.ItemType> _variableItemBox

_variableStateBox

JComboBox<Conditional.Type> _variableStateBox

_variableOperBox

JComboBox<String> _variableOperBox

_variableNegated

JCheckBox _variableNegated

_variableTriggerActions

JCheckBox _variableTriggerActions

_variableNameField

JTextField _variableNameField

_variableNameLabel

JLabel _variableNameLabel

_variableCompareOpBox

JComboBox<String> _variableCompareOpBox

_variableSignalBox

JComboBox<String> _variableSignalBox

_variableCompareTypeBox

JComboBox<Conditional.Type> _variableCompareTypeBox

_variableMemoryValueLabel

JLabel _variableMemoryValueLabel

_variableData1Field

JTextField _variableData1Field

_variableData2Field

JTextField _variableData2Field

_actionItemBox

JComboBox<Conditional.ItemType> _actionItemBox

_actionTypeBox

JComboBox<Conditional.Action> _actionTypeBox

_actionTypeLabel

JLabel _actionTypeLabel

_actionNameField

JTextField _actionNameField

_actionNameLabel

JLabel _actionNameLabel

_actionBox

JComboBox<String> _actionBox

_actionBoxLabel

JLabel _actionBoxLabel

_longActionString

JTextField _longActionString

_longActionLabel

JLabel _longActionLabel

_shortActionString

JTextField _shortActionString

_shortActionLabel

JLabel _shortActionLabel

_actionOptionBox

JComboBox<String> _actionOptionBox

_actionSetButton

JButton _actionSetButton

detailFocusEvent

transient FocusListener detailFocusEvent

Focus gained implies intent to make changes, set up for edit.

variableSignalHeadNameListener

transient ActionListener variableSignalHeadNameListener

variableSignalMastNameListener

transient ActionListener variableSignalMastNameListener

variableSignalTestStateListener

transient ActionListener variableSignalTestStateListener

selectLogixBoxListener

transient ActionListener selectLogixBoxListener

selectConditionalBoxListener

transient ActionListener selectConditionalBoxListener

compareTypeBoxListener

transient ActionListener compareTypeBoxListener

sndFileChooser

JFileChooser sndFileChooser

scriptFileChooser

ScriptFileChooser scriptFileChooser

defaultFileChooser

JFileChooser defaultFileChooser

_actionTypeListener

ConditionalTreeEdit.ActionTypeListener _actionTypeListener

actionSignalHeadNameListener

transient ActionListener actionSignalHeadNameListener

actionSignalMastNameListener

transient ActionListener actionSignalMastNameListener

Constructor Details

ConditionalTreeEdit

public ConditionalTreeEdit(String sName)

Create a new Conditional Tree View editor.

Parameters:

sName - The system name of the current Logix

ConditionalTreeEdit

public ConditionalTreeEdit()

Method Details

makeEditLogixWindow

void makeEditLogixWindow()

Create the edit logix window.

The left side contains a tree structure containing the conditionals for the current Logix. The right side contains detail edit panes based on the current tree row selection.

buildConditionalComponents

void buildConditionalComponents()

Initialize conditional components.

makeDetailGrid

void makeDetailGrid(String gridType)

Build new GridBag content. The grid panel is hidden, emptied, re-built and made visible.

Parameters:

gridType - The type of grid to create

makeEmptyGrid

void makeEmptyGrid(GridBagConstraints c)

This grid is used when there are no edit grids required.

Parameters:

c - The constraints object used for the grid construction

makeConditionalGrid

void makeConditionalGrid(GridBagConstraints c)

This grid is used to edit the Conditional User Name.

Parameters:

c - The constraints object used for the grid construction

makeAntecedentGrid

void makeAntecedentGrid(GridBagConstraints c)

This grid is used to edit the Antecedent when the Logic Type is Mixed.

Parameters:

c - The constraints object used for the grid construction

makeLogicTypeGrid

void makeLogicTypeGrid(GridBagConstraints c)

This grid is used to edit the Logic Type.

Parameters:

c - The constraints object used for the grid construction

addPressed

void addPressed()

Add new items: Conditionals, Variables or Actions.

newVariable

void newVariable()

Create a new variable Can be invoked by a Variables or Variable node.

newAction

void newAction()

Create a new action Can be invoked by a Actions or Action node.

editPressed

void editPressed()

Set up the edit environment for the selected node Called from treeRowSelected(jmri.jmrit.conditional.ConditionalTreeEdit.ConditionalTreeNode). This takes the place of an actual button.

updatePressed

void updatePressed()

Apply the updates to the current node.

userNameChanged

void userNameChanged(String newName)

Change the conditional user name.

Parameters:

newName - The proposed new name

logicTypeChanged

void logicTypeChanged(Conditional.AntecedentOperator newType)

Respond to a change of Logic Type in the dialog window by showing/hiding the _antecedentPanel when Mixed is selected.

Parameters:

newType - The selected logic type

antecedentChanged

void antecedentChanged(String antecedentText)

Update the antecedent.

Parameters:

antecedentText - the new antecedent

makeAntecedent

void makeAntecedent()

Build the antecedent statement.

appendToAntecedent

void appendToAntecedent()

Add a R# to the antecedent statement.

validateAntecedent

boolean validateAntecedent(String antecedentText)

Check the antecedent and logic type.

Parameters:

antecedentText - The user supplied antecedent text

Returns:

false if antecedent can't be validated

togglePressed

void togglePressed()

Update the Actions trigger mode, adjust the Action descriptions.

checkPressed

void checkPressed()

Refresh the Conditional or Variable state.

deletePressed

void deletePressed()

Process the node delete request.

upPressed

void upPressed()

Move a conditional, variable or action row up 1 row.

downPressed

void downPressed()

Move a conditional, variable or action row down 1 row.

removeActionTimers

void removeActionTimers()

Remove Action timers and listeners before Action list structure changes. This relates to moving and deleting rows. New actions at the end are not problem. The issue is that the timer listeners are tied to the action row number. This can result in orphan timers and listeners that keep running.

Since:

4.11.2

moveTreeNode

void moveTreeNode(String direction)

Move a tree node in response to a up or down request.

Parameters:

direction - The direction of movement, Up or Down

setMoveButtons

void setMoveButtons()

Enable/Disable the Up and Down buttons based on the postion in the list.

helpPressed

void helpPressed()

Respond to Help button press in the Edit Logix menu bar. Only visible when using mixed mode and an antecedent node is selected.

cancelPressed

void cancelPressed()

Cancel the current node edit.

donePressed

void donePressed()

Clean up, notify the parent Logix that edit session is done.

buildConditionalTree

JTree buildConditionalTree()

Create the conditional tree structure using the current Logix.

Returns:

_cdlTree The tree ddefinition with its content

createConditionalContent

void createConditionalContent()

Create the tree content. Level 1 are the conditionals, Level 2 includes the antecedent, logic type, trigger mode and parent nodes for Variables and Actions, Level 3 contains the detail Variable and Action entries.

treeRowSelected

void treeRowSelected(ConditionalTreeEdit.ConditionalTreeNode selectedNode)

Change the button row based on the currently selected node type. Invoke edit where appropriate.

Parameters:

selectedNode - The node object

buildNodeText

String buildNodeText(String nodeType,
 Object component,
 int idx)

Create the localized node text display strings based on node type.

Parameters:

nodeType - The type of the node

component - The conditional object or child object

idx - Optional index value

Returns:

nodeText containing the text to display on the node

showNodeEditMessage

void showNodeEditMessage()

Display reminder to finish a node before starting another. This is a session reminder.

setFocusListeners

void setFocusListeners()

Add the focus listener to each detail edit field.

setEditMode

void setEditMode(boolean active)

Enable/disable buttons based on edit state. Open pick lists based on the current SelectionMode. The edit state controls the ability to select tree nodes.

Parameters:

active - True to make edit active, false to make edit inactive

setPickWindow

void setPickWindow(String cmd,
 Conditional.ItemType item)

Ceate tabbed Pick Taba;e or Pick Single based on Selection Mode. Called by setEditMode(boolean) when edit mode becomes active. Called by variableTypeChanged(jmri.Conditional.ItemType) and actionItemChanged(jmri.Conditional.ItemType) when item type changes.

Parameters:

cmd - The source or action to be performed.

item - The item type for Variable or Action or zero

doPickList

void doPickList()

Create a Variable or Action based tabbed PickList with appropriate tab selected.

doPickSingle

void doPickSingle()

Create a Variable or Action based single pane PickList.

buildVariableComponents

void buildVariableComponents()

Called once during class initialization to define the GUI objects. Where possible, the combo box content is loaded.

makeEmptyVariableGrid

void makeEmptyVariableGrid(GridBagConstraints c)

Create a one row grid with just the Variable Type box. This is the base for larger grids as well as the initial grid for new State Variables.

Parameters:

c - the constraints object used for the grid construction

makeOptionsVariableGrid

void makeOptionsVariableGrid(GridBagConstraints c)

makeStandardVariableGrid

void makeStandardVariableGrid(GridBagConstraints c)

Create the standard Name and State rows. The name field will be either a text field or a combo box. The name field label is a variable to support run time changes.

Parameters:

c - The constraints object used for the grid construction

makeSignalAspectVariableGrid

void makeSignalAspectVariableGrid(GridBagConstraints c)

Add the Aspect field for signal heads and signal masts.

Parameters:

c - The constraints object used for the grid construction

makeConditionalVariableGrid

void makeConditionalVariableGrid(GridBagConstraints c)

Create the Logix and Conditional rows and the State row.

Parameters:

c - The constraints object used for the grid construction

makeMemoryVariableGrid

void makeMemoryVariableGrid(GridBagConstraints c)

Create the Memory specific rows.

Parameters:

c - The constraints object used for the grid construction

makeFastClockVariableGrid

void makeFastClockVariableGrid(GridBagConstraints c)

Create the Fast Clock start and end time rows.

Parameters:

c - The constraints object used for the grid construction

initializeStateVariables

void initializeStateVariables()

Set display to show current state variable (curVariable) parameters.

setVariableNameBox

void setVariableNameBox(Conditional.ItemType itemType)

Update the name combo box selection based on the current contents of the name field. Called by variableItemChanged.

Parameters:

itemType - The item type, such as sensor or turnout.

Since:

4.7.3

cancelEditVariable

void cancelEditVariable()

Respond to Cancel variable button

updateVariable

void updateVariable()

Respond to Update Variable button in the Edit Variable pane.

cleanUpVariable

void cleanUpVariable()

Clean up: Cancel, Update and Delete Variable buttons.

loadSelectLogixBox

void loadSelectLogixBox()

Load the Logix selection box. Set the selection to the current Logix.

Since:

4.7.4

loadSelectConditionalBox

void loadSelectConditionalBox(String logixName)

Load the Conditional selection box. The first row is a prompt.

Parameters:

logixName - The Logix system name for selecting the owned Conditionals

Since:

4.7.4

loadJComboBoxWithHeadAppearances

void loadJComboBoxWithHeadAppearances(JComboBox<String> box,
 String signalHeadName)

Fetch valid localized appearances for a given Signal Head.

Warn if head is not found.

Parameters:

box - the comboBox on the setup pane to fill

signalHeadName - user or system name of the Signal Head

loadJComboBoxWithMastAspects

void loadJComboBoxWithMastAspects(JComboBox<String> box,
 String mastName)

Fetch valid aspects for a given Signal Mast.

Warn if mast is not found.

Parameters:

box - the comboBox on the setup pane to fill

mastName - user or system name of the Signal Mast

validateVariable

boolean validateVariable()

Validate Variable data from Edit Variable panel, and transfer it to current variable object as appropriate.

Messages are sent to the user for any errors found. This routine returns false immediately after finding the first error, even if there might be more errors.

Returns:

true if all data checks out OK, otherwise false

updateVariableOperator

void updateVariableOperator()

Update the variable operation. If a change has occurred, also update the antecedent and antecedent tree node.

updateVariableNegation

void updateVariableNegation()

Update the variable negation. If a change has occurred, also update the antecedent and antecedent tree node.

updateVariableList

void updateVariableList()

Update the conditional variable list and refresh the local copy. The parent Logix is de-activated and re-activated. This ensures that listeners are properly handled.

Since:

4.11.2

buildActionComponents

void buildActionComponents()

Called once during class initialization to define the GUI objects. Where possible, the combo box content is loaded.

makeEmptyActionGrid

void makeEmptyActionGrid(GridBagConstraints c)

Create a one row grid with just the Action Item box. This is the base for larger grids as well as the initial grid for new Actions.

Parameters:

c - the constraints object used for the grid construction

makeNameTypeActionGrid

void makeNameTypeActionGrid(GridBagConstraints c,
 boolean finalRow)

Create the standard Name and Type rows. The name field will be either a text field or a combo box. The name field label is a variable to support run time changes.

Parameters:

c - The constraints object used for the grid construction

finalRow - Controls whether the tigger combo box is included

makeTypeActionGrid

void makeTypeActionGrid(GridBagConstraints c,
 boolean finalRow)

Create the standard Type row.

Parameters:

c - The constraints object used for the grid construction

finalRow - Controls whether the tigger combo box is included

makeStandardActionGrid

void makeStandardActionGrid(GridBagConstraints c,
 boolean finalRow)

Add the action box to the grid.

Parameters:

c - The constraints object used for the grid construction

finalRow - Controls whether the tigger combo box is included

makeShortFieldActionGrid

void makeShortFieldActionGrid(GridBagConstraints c,
 boolean includeBox)

Add the short name field to the grid.

Parameters:

c - The constraints object used for the grid construction

includeBox - Controls whether the normal action type combo box is included

makeTypeShortActionGrid

void makeTypeShortActionGrid(GridBagConstraints c)

Just a short text field, no name field. Used by set clock and jython command.

Parameters:

c - The constraints object used for the grid construction

makeFileActionGrid

void makeFileActionGrid(GridBagConstraints c)

Add the file selection components.

Parameters:

c - The constraints object used for the grid construction

makeChangeTriggerActionGrid

void makeChangeTriggerActionGrid(GridBagConstraints c)

Add the change/trigger box the grid. This is the last item in an Action and is usually called from one of the other entry points.

Parameters:

c - The constraints object used for the grid construction

initializeActionVariables

void initializeActionVariables()

Set display to show current action (curAction) parameters.

actionItemChanged

void actionItemChanged(Conditional.ItemType type)

Respond to a change in an Action Type comboBox.

Set components visible for the selected type.

Parameters:

type - index of the newly selected Action type

setActionNameBox

void setActionNameBox(Conditional.ItemType itemType)

Update the name combo box selection based on the current contents of the name field.

Parameters:

itemType - The item type, such as sensor or turnout.

Since:

4.7.3

cancelEditAction

void cancelEditAction()

Respond to Cancel action button and window closer of the Edit Action window.

Also does cleanup of Update and Delete buttons.

updateAction

void updateAction()

Respond to Update button.

cleanUpAction

void cleanUpAction()

Clean up Update and Delete Action buttons.

setFileLocation

void setFileLocation(ActionEvent e)

Respond to the [...] button in the Edit Action window action section.

Ask user to select an audio or python script file on disk.

Parameters:

e - the event heard

validateAction

boolean validateAction()

Validate Action data from Edit Action Window, and transfer it to current action object as appropriate.

Messages are sent to the user for any errors found. This routine returns false immediately after finding an error, even if there might be more errors.

Returns:

true if all data checks out OK, otherwise false.

updateActionList

void updateActionList()

Update the conditional action list and refresh the local copy. The parent Logix is de-activated and re-activated. This ensures that listeners are properly handled, specifically the delayed sensor and turnout options.

Since:

4.11.2

checkIsAction

boolean checkIsAction(String name,
 Conditional.ItemType itemType)

Check that a state variable is not also used as an action

Parameters:

name - of the state variable

itemType - item type of the state variable

Returns:

true if variable is not an action of if the user OK's its use as an action also.

checkIsVariable

boolean checkIsVariable(String name,
 Conditional.ItemType itemType)

Check that an action is not also used as a state variable

Parameters:

name - of the action

itemType - item type of the action

Returns:

true if action is not a state variable of if the user OK's its use as such.

getClassName

protected String getClassName()

Overrides:

getClassName in class ConditionalEditBase