jmri.jmrix.loconet
Class AbstractBoardProgPanel

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BDL16Panel, DS64Panel, PM4Panel, SE8Panel

public abstract class AbstractBoardProgPanel
extends LnPanel
implements LocoNetListener

Display and modify an Digitrax board configuration.

The read and write require a sequence of operations, which we handle with a state variable.

Programming of the board is done via configuration messages, so the board should not be put into programming mode via the built-in pushbutton while this tool is in use.

Throughout, the terminology is "closed" == true, "thrown" == false. Variables are named for their closed state.

Some of the message formats used in this class are Copyright Digitrax, Inc. 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 Digitrax Inc for separate permission.

Author:

Bob Jacobsen Copyright (C) 2004, 2007

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

boolean	onlyOneOperation
protected boolean[]	opsw True is "closed", false is "thrown".
boolean	read
JToggleButton	readAllButton
JToggleButton	writeAllButton

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

memo

Fields inherited from class javax.swing.JComponent

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

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

protected	AbstractBoardProgPanel() Constructor which assumes the board ID number is 1
protected	AbstractBoardProgPanel(int boardNum) Constructor which allows the caller to pass in the board ID number

Method Summary

protected void	appendLine(JComponent c) Handle layout details during construction.
protected abstract void	copyToOpsw() Copy from the GUI to the opsw array.
void	dispose()
void	initComponents() 2nd stage of initialization, invoked after the constuctor is complete.
void	initComponents(LocoNetSystemConnectionMemo memo) 2nd stage of initialization, invoked after the constuctor is complete.
void	message(LocoNetMessage m) Processes incoming LocoNet messages for OpSw read and write operations, and automatically advances to the next OpSw operation as directed by nextState()
protected abstract int	nextState(int state) Specify which opsw (and which sequence) need to be read/written
protected JPanel	provideAddressing(String type) Provide read, write buttons and address
protected JComponent	provideStatusLine() provide the status line for the GUI
void	readAll()
protected void	setStatus(String msg)
protected void	setTypeWord(int type) Configure the type word in the LocoNet messages.
protected abstract void	updateDisplay()
void	writeOne(int startIndex)

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

getTitle, initContext

Methods inherited from class jmri.util.swing.JmriPanel

getHelpTarget, getMenus, getTitle, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, transferFocusBackward, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

readAllButton

public JToggleButton readAllButton

writeAllButton

public JToggleButton writeAllButton

read

public boolean read

onlyOneOperation

public boolean onlyOneOperation

opsw

protected boolean[] opsw

True is "closed", false is "thrown". This matches how we do the check boxes also, where we use the terminology for the "closed" option. Note that opsw[0] is not a legal OpSwitch.

Constructor Detail

AbstractBoardProgPanel

protected AbstractBoardProgPanel()

Constructor which assumes the board ID number is 1

AbstractBoardProgPanel

protected AbstractBoardProgPanel(int boardNum)

Constructor which allows the caller to pass in the board ID number

Parameters:

boardNum -

Method Detail

initComponents

public void initComponents(LocoNetSystemConnectionMemo memo)

Description copied from interface: LnPanelInterface

2nd stage of initialization, invoked after the constuctor 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

provideAddressing

protected JPanel provideAddressing(String type)

Provide read, write buttons and address

provideStatusLine

protected JComponent provideStatusLine()

provide the status line for the GUI

setStatus

protected void setStatus(String msg)

appendLine

protected void appendLine(JComponent c)

Handle layout details during construction.

Parameters:

c - component to put on a single line

readAll

public void readAll()

setTypeWord

protected void setTypeWord(int type)

Configure the type word in the LocoNet messages.

Known values:

• 0x70 - PM4
• 0x71 - BDL16
• 0x72 - SE8

copyToOpsw

protected abstract void copyToOpsw()

Copy from the GUI to the opsw array.

Used before write operations start

updateDisplay

protected abstract void updateDisplay()

nextState

protected abstract int nextState(int state)

Specify which opsw (and which sequence) need to be read/written

writeOne

public void writeOne(int startIndex)

message

public void message(LocoNetMessage m)

Processes incoming LocoNet messages for OpSw read and write operations, and automatically advances to the next OpSw operation as directed by nextState()

Specified by:

message in interface LocoNetListener

Parameters:

m -

initComponents

public void initComponents()

Description copied from class: JmriPanel

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

Overrides:

initComponents in class JmriPanel

dispose

public void dispose()

Overrides:

dispose in class JmriPanel