Package jmri.jmrit.roster

Class UpdateDecoderDefinitionAction

java.lang.Object

javax.swing.AbstractAction

jmri.util.swing.JmriAbstractAction

jmri.jmrit.roster.UpdateDecoderDefinitionAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

public class UpdateDecoderDefinitionAction
extends JmriAbstractAction

Update the decoder definitions in the roster.

When required, provides a user GUI to assist with replacing multiple-match definitions.

See Also:

• XmlFile
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
(package private) JButton	cancelButton
(package private) CombinedLocoSelTreePane	combinedLocoSelTree
(package private) int	cV7Value
(package private) int	cV8Value
(package private) DecoderIndexFile	di
(package private) JDialog	f
(package private) FocusListener	fListener
(package private) boolean	hasReplacementFamilyQuery
(package private) boolean	hasReplacementModelQuery
(package private) JLabel	lastActionDisplay	Displays the last-selected filter action.
(package private) final ProgModeSelector	modePane
static final String	QRY_PREFIX	The prefix string used to specify a query in decoder definition file replacementFamily and replacementModel elements.
static final String	QRY_SEPARATOR	The regex separator to split items in replacementFamily and replacementModel elements.
(package private) JToggleButton	replacementButton
(package private) String	replacementFamily	The replacementFamily attribute from the decoder definition file.
(package private) String	replacementFamilyString
(package private) List<DecoderFile>	replacementList	A List based on the combination of any replacementFamily and replacementModel suggestions.
(package private) String	replacementModel	The replacementModel attribute from the decoder definition file.
(package private) String	replacementModelString
(package private) JLabel	statusLabel
(package private) RosterEntry	tempRe	A temporary roster entry used in matching and replacement.
(package private) JToggleButton	versionButton
(package private) List<DecoderFile>	versionMatchList	The subset of the replacementList that also matches both the IdentifyDecoder manufacturerID stored in CV8 and the IdentifyDecoder versionID stored in CV7.

Fields inherited from class jmri.util.swing.JmriAbstractAction

context, hint, wi

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor	Description
UpdateDecoderDefinitionAction(String name)	Update the decoder definitions in the roster.
UpdateDecoderDefinitionAction(String name, Icon i, WindowInterface wi)	Update the decoder definitions in the roster.
UpdateDecoderDefinitionAction(String name, WindowInterface wi)	Update the decoder definitions in the roster.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)
(package private) void	decoderSelectionPane(RosterEntry theEntry)	Creates the "Replacement Definition" pane, which is similar in appearance to Create New Loco pane, likewise utilizing a customized instance of CombinedLocoSelTreePane.
(package private) JOptionPane	getOptionPane(JComponent source)	Fetch the JOptionPane associated with this JComponent.
(package private) void	makeMatchLists(RosterEntry theEntry)	Creates two ArrayLists for decoder matching.
JmriPanel	makePanel()	Never invoked, because we overrode actionPerformed above.
(package private) int	multiReplacementDialog(String text, boolean missing)	Creates the "Multiple Replacements Found" dialog box with custom buttons and tooltips.
(package private) void	setLastActionDisplay(String propertyName)	Updates the lastActionDisplay JLabel to be the text fetched by the key named "TextLastAction", after inclusion of the text fetched by the key named "propertyName".
(package private) void	updateMatchButtons(RosterEntry theEntry)	Updates the versionButton and replacementButton availability and tooltips, depending on whether versionMatchList and replacementList are empty or not.

Methods inherited from class jmri.util.swing.JmriAbstractAction

dispose, setContext, setHint, setName, setParameter, setParameter, setWindowInterface, toString

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.Action

accept

Field Details

QRY_PREFIX

public static final String QRY_PREFIX

The prefix string used to specify a query in decoder definition file replacementFamily and replacementModel elements.

See Also:

• Constant Field Values

QRY_SEPARATOR

public static final String QRY_SEPARATOR

The regex separator to split items in replacementFamily and replacementModel elements.

See Also:

• Constant Field Values

replacementFamily

String replacementFamily

The replacementFamily attribute from the decoder definition file.

replacementFamilyString

String replacementFamilyString

hasReplacementFamilyQuery

boolean hasReplacementFamilyQuery

replacementModel

String replacementModel

The replacementModel attribute from the decoder definition file.

replacementModelString

String replacementModelString

hasReplacementModelQuery

boolean hasReplacementModelQuery

cV7Value

int cV7Value

cV8Value

int cV8Value

lastActionDisplay

JLabel lastActionDisplay

Displays the last-selected filter action.

tempRe

transient volatile RosterEntry tempRe

A temporary roster entry used in matching and replacement.

replacementList

transient volatile List<DecoderFile> replacementList

A List based on the combination of any replacementFamily and replacementModel suggestions.

versionMatchList

transient volatile List<DecoderFile> versionMatchList

The subset of the replacementList that also matches both the IdentifyDecoder manufacturerID stored in CV8 and the IdentifyDecoder versionID stored in CV7.

di

transient volatile DecoderIndexFile di

fListener

transient volatile FocusListener fListener

statusLabel

transient volatile JLabel statusLabel

f

transient volatile JDialog f

modePane

final ProgModeSelector modePane

cancelButton

JButton cancelButton

versionButton

JToggleButton versionButton

replacementButton

JToggleButton replacementButton

combinedLocoSelTree

CombinedLocoSelTreePane combinedLocoSelTree

Constructor Details

UpdateDecoderDefinitionAction

public UpdateDecoderDefinitionAction(String name)

Update the decoder definitions in the roster.

Parameters:

name - the name (Action.NAME) for the action; a value of null is ignored

UpdateDecoderDefinitionAction

public UpdateDecoderDefinitionAction(String name,
 WindowInterface wi)

Update the decoder definitions in the roster.

Parameters:

name - the name (Action.NAME) for the action; a value of null is ignored

wi - the window interface controlling how this action is displayed

UpdateDecoderDefinitionAction

public UpdateDecoderDefinitionAction(String name,
 Icon i,
 WindowInterface wi)

Update the decoder definitions in the roster.

Parameters:

name - the name (Action.NAME) for the action; a value of null is ignored

i - the small icon (Action.SMALL_ICON) for the action; a value of null is ignored

wi - the window interface controlling how this action is displayed

Method Details

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

Overrides:

actionPerformed in class JmriAbstractAction

getOptionPane

JOptionPane getOptionPane(JComponent source)

Fetch the JOptionPane associated with this JComponent.

Note that:

• The source must be within (or itself be) a JOptionPane.
• If source is a JOptionPane, the returned element will be source

Parameters:

source - the JComponent

Returns:

the JOptionPane associated with source

multiReplacementDialog

int multiReplacementDialog(String text,
 boolean missing)

Creates the "Multiple Replacements Found" dialog box with custom buttons and tooltips.

Parameters:

text - the explanatory text to display

missing - if true, displays a "missing definition" title rather than a "multiple replacements" title

Returns:

sequence number of the button selected

decoderSelectionPane

void decoderSelectionPane(RosterEntry theEntry)

Creates the "Replacement Definition" pane, which is similar in appearance to Create New Loco pane, likewise utilizing a customized instance of CombinedLocoSelTreePane.

Parameters:

theEntry - an existing roster entry that needs replacement

setLastActionDisplay

void setLastActionDisplay(String propertyName)

Updates the lastActionDisplay JLabel to be the text fetched by the key named "TextLastAction", after inclusion of the text fetched by the key named "propertyName".

Parameters:

propertyName - the name of a ResourceBundle key

makeMatchLists

void makeMatchLists(RosterEntry theEntry)

Creates two ArrayLists for decoder matching.

They are:

• A replacementList based on the combination of any replacementFamily and replacementModel suggestions.
• A versionMatchList that is the subset of replacementList that also matches both a manufacturerID (from IdentifyDecoder mfgID) stored in CV8 and a versionID (from IdentifyDecoder modelID) stored in CV7.

Parameters:

theEntry - an existing roster entry that needs replacement

updateMatchButtons

void updateMatchButtons(RosterEntry theEntry)

Updates the versionButton and replacementButton availability and tooltips, depending on whether versionMatchList and replacementList are empty or not.

Parameters:

theEntry - an existing roster entry that needs replacement

makePanel

public JmriPanel makePanel()

Never invoked, because we overrode actionPerformed above.

Specified by:

makePanel in class JmriAbstractAction

Returns:

never because it deliberately throws an IllegalArgumentException