Package jmri.jmrix.loconet.swing.lncvprog

Class LncvProgPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jmri.util.swing.JmriPanel

jmri.jmrix.loconet.swing.LnPanel

jmri.jmrix.loconet.swing.lncvprog.LncvProgPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, LocoNetListener, LnPanelInterface

public class LncvProgPane
extends LnPanel
implements LocoNetListener

Frame for discovery and display of LocoNet LNCV boards. Derived from xbee node config. Verified with Digikeijs DR5033 hardware.

Some of the message formats used in this class are Copyright Uhlenbrock.de and used with permission as part of the JMRI project. That permission does not extend to uses in other software products. If you wish to use this code, algorithm or these message formats outside of JMRI, please contact Uhlenbrock.

Buttons in table row allows to add roster entry for device, and switch to the DecoderPro ops mode programmer.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected JTextField	addressField
protected JLabel	addressFieldLabel
protected int	adr
protected JToggleButton	allProgButton
protected int	art
protected JTextField	articleField
protected JLabel	articleFieldLabel
protected int	cv
protected JTextField	cvField
protected JLabel	cvFieldLabel
protected JCheckBox	directCheckBox
protected JToggleButton	modProgButton
protected JTable	moduleTable
protected LncvProgTableModel	moduleTableModel
protected JCheckBox	rawCheckBox
protected JButton	readButton
protected String	reply
protected JTextArea	result
static final int	ROW_HEIGHT
protected JLabel	statusText1
protected JLabel	statusText2
protected JPanel	tablePanel
protected int	val
protected JTextField	valueField
protected JLabel	valueFieldLabel
protected JButton	writeButton
(package private) boolean	writeConfirmed

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
LncvProgPane()	Constructor method

Method Summary

Modifier and Type	Method	Description
void	allProgButtonActionPerformed()	GENERALPROG button.
void	allProgFinished(String error)	AllProg Session callback.
void	copyEntry(int art, int mod)
protected void	directActionPerformed()
void	dispose()
protected String	getAddressEntry()
protected String	getArticleEntry()	Testing methods.
String	getHelpTarget()	Provide a help target string which an enclosing frame can provide as a help reference.
protected LncvDevice	getModule(int i)
protected String	getMonitorContents()
protected JPanel	getMonitorPanel()
String	getTitle()	Provide a recommended title for an enclosing frame.
void	handleCloseEvent()	Give user feedback on closing of any open programming sessions when tool window is closed.
protected JPanel	initButtonPanel()
void	initComponents()	Initialize the config window
void	initComponents(LocoNetSystemConnectionMemo memo)	2nd stage of initialization, invoked after the constructor is complete.
protected JPanel	initStatusPanel()
void	message(LocoNetMessage m)	Member function that will be invoked by a LocoNetInterface implementation to forward a LocoNet message from the layout.
void	modProgButtonActionPerformed()	Handle Start/End Module Prog button.
void	readButtonActionPerformed()	Handle Read CV button, assemble LNCV read message.
protected void	renumber(boolean range2)	Renumber the checkbox labels to match LED numbers.
protected void	setCvFields(int cvNum, int cvVal)
protected void	setDirect(boolean range2)	Handle SetDirect button, assemble LNCV Direct Set message.
void	writeButtonActionPerformed()	Handle Write button click, assemble LNCV write message.

Methods inherited from class jmri.jmrix.loconet.swing.LnPanel

getTitle, getTitleHelper, initContext

Methods inherited from class jmri.util.swing.JmriPanel

getMenus, getMinimumDimension, getWindowInterface, isMultipleInstances, setWindowInterface

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Details

allProgButton

protected JToggleButton allProgButton

modProgButton

protected JToggleButton modProgButton

readButton

protected JButton readButton

writeButton

protected JButton writeButton

articleField

protected JTextField articleField

addressField

protected JTextField addressField

cvField

protected JTextField cvField

valueField

protected JTextField valueField

directCheckBox

protected JCheckBox directCheckBox

rawCheckBox

protected JCheckBox rawCheckBox

moduleTable

protected JTable moduleTable

moduleTableModel

protected LncvProgTableModel moduleTableModel

ROW_HEIGHT

public static final int ROW_HEIGHT

tablePanel

protected JPanel tablePanel

statusText1

protected JLabel statusText1

statusText2

protected JLabel statusText2

articleFieldLabel

protected JLabel articleFieldLabel

addressFieldLabel

protected JLabel addressFieldLabel

cvFieldLabel

protected JLabel cvFieldLabel

valueFieldLabel

protected JLabel valueFieldLabel

result

protected JTextArea result

reply

protected String reply

art

protected int art

adr

protected int adr

cv

protected int cv

val

protected int val

writeConfirmed

boolean writeConfirmed

Constructor Details

LncvProgPane

public LncvProgPane()

Constructor method

Method Details

getHelpTarget

public String getHelpTarget()

Provide a help target string which an enclosing frame can provide as a help reference.

This automatically provides a reference to the usual place for JMRI window-specific help pages that are named for the implementing class, but note this is a Pane class, not a Frame class.

Overrides:

getHelpTarget in class JmriPanel

Returns:

the target String

getTitle

public String getTitle()

Description copied from class: JmriPanel

Provide a recommended title for an enclosing frame.

Overrides:

getTitle in class JmriPanel

Returns:

the title; a null value will be treated as "" by the enclosing frame

initComponents

public void initComponents()

Initialize the config window

Overrides:

initComponents in class JmriPanel

initComponents

public void initComponents(LocoNetSystemConnectionMemo memo)

Description copied from class: LnPanel

2nd stage of initialization, invoked after the constructor is complete.

This needs to be connected to the initContext() method in implementing classes.

Specified by:

initComponents in interface LnPanelInterface

Overrides:

initComponents in class LnPanel

Parameters:

memo - a LocoNetSystemConnectionMemo object

getMonitorPanel

protected JPanel getMonitorPanel()

initButtonPanel

protected JPanel initButtonPanel()

initStatusPanel

protected JPanel initStatusPanel()

allProgButtonActionPerformed

public void allProgButtonActionPerformed()

GENERALPROG button.

modProgButtonActionPerformed

public void modProgButtonActionPerformed()

Handle Start/End Module Prog button.

readButtonActionPerformed

public void readButtonActionPerformed()

Handle Read CV button, assemble LNCV read message. Requires presence of memo.

writeButtonActionPerformed

public void writeButtonActionPerformed()

Handle Write button click, assemble LNCV write message. Requires presence of memo.

directActionPerformed

protected void directActionPerformed()

renumber

protected void renumber(boolean range2)

Renumber the checkbox labels to match LED numbers.

Parameters:

range2 - false for LEDs 0-15, true for LEDs 16-31

setDirect

protected void setDirect(boolean range2)

Handle SetDirect button, assemble LNCV Direct Set message. Requires presence of memo to send.

Parameters:

range2 - false for LEDs 0-15, true for LEDs 16-31

copyEntry

public void copyEntry(int art,
 int mod)

message

public void message(LocoNetMessage m)

Member function that will be invoked by a LocoNetInterface implementation to forward a LocoNet message from the layout. Compare to LnOpsModeProgrammer.message(jmri.jmrix.loconet.LocoNetMessage)

Specified by:

message in interface LocoNetListener

Parameters:

m - a message received and analysed for LNCV characteristics

allProgFinished

public void allProgFinished(String error)

AllProg Session callback.

Parameters:

error - feedback from Finish process

handleCloseEvent

public void handleCloseEvent()

Give user feedback on closing of any open programming sessions when tool window is closed.

See Also:

• for actual closing of sessions

dispose

public void dispose()

Overrides:

dispose in class JmriPanel

getArticleEntry

protected String getArticleEntry()

Testing methods.

Returns:

text currently in Article field

getAddressEntry

protected String getAddressEntry()

getMonitorContents

protected String getMonitorContents()

setCvFields

protected void setCvFields(int cvNum,
 int cvVal)

getModule

protected LncvDevice getModule(int i)