jmri.jmrix.can.swing.send
Class CanSendPane

Show UML class diagram

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  jmri.util.swing.JmriPanel
                      jmri.jmrix.can.swing.CanPanel
                          jmri.jmrix.can.swing.send.CanSendPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, AbstractMRListener, CanListener, CanPanelInterface

public class CanSendPane
extends CanPanel
implements CanListener

User interface for sending CAN frames to exercise the system

When sending a sequence of operations:

• Send the next message and start a timer
• When the timer trips, repeat if buttons still down.

See Also:

Serialized Form

Nested Class Summary

static class

CanSendPane.Default Nested class to create one of these using old-style defaults

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

(package private) JLabel	jLabel1
(package private) static org.slf4j.Logger	log
(package private) static int	MAXSEQUENCE
(package private) JTextField[]	mDelayField
(package private) int	mNextSequenceElement
(package private) JTextField[]	mPacketField
(package private) JToggleButton	mRunButton
(package private) JCheckBox[]	mUseField
(package private) JTextField	packetTextField
(package private) JButton	sendButton
(package private) Timer	timer

Fields inherited from class jmri.jmrix.can.swing.CanPanel

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

CanSendPane()

Method Summary

(package private) CanMessage	createPacket(String s) Create a well-formed message from a String String is expected to be space seperated hex bytes or CbusAddress, e.g.: 12 34 56 +n4e1
void	dispose() When the window closes, stop any sequences running
String	getHelpTarget() Provide a help target string which an enclosing frame can provide as a help reference.
String	getTitle() Provide a recommended title for an enclosing frame.
void	initComponents(CanSystemConnectionMemo memo) 2nd stage of initialization, invoked after the constuctor is complete.
void	message(CanMessage m) Don't pay attention to messages
void	reply(CanReply m) Don't pay attention to replies
protected void	restartTimer(int delay) Internal routine to handle timer starts & restarts
void	runButtonActionPerformed(ActionEvent e) Run button pressed down, start the sequence operation
void	sendButtonActionPerformed(ActionEvent e)
(package private) void	sendNextItem() Send next item; may be used for the first item or when a delay has elapsed.
(package private) void	startSequenceDelay() Echo has been heard, start delay for next packet
protected void	timeout() Internal routine to handle a timeout and send next item

Methods inherited from class jmri.jmrix.can.swing.CanPanel

initContext

Methods inherited from class jmri.util.swing.JmriPanel

getMenus, getWindowInterface, initComponents, 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

jLabel1

JLabel jLabel1

sendButton

JButton sendButton

packetTextField

JTextField packetTextField

MAXSEQUENCE

static final int MAXSEQUENCE

See Also:

Constant Field Values

mPacketField

JTextField[] mPacketField

mUseField

JCheckBox[] mUseField

mDelayField

JTextField[] mDelayField

mRunButton

JToggleButton mRunButton

mNextSequenceElement

int mNextSequenceElement

timer

Timer timer

log

static org.slf4j.Logger log

Constructor Detail

CanSendPane

public CanSendPane()

Method Detail

initComponents

public void initComponents(CanSystemConnectionMemo memo)

Description copied from interface: CanPanelInterface

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 CanPanelInterface

Overrides:

initComponents in class CanPanel

getHelpTarget

public String getHelpTarget()

Description copied from class: JmriPanel

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

getTitle

public String getTitle()

Description copied from class: JmriPanel

Provide a recommended title for an enclosing frame.

Overrides:

getTitle in class JmriPanel

sendButtonActionPerformed

public void sendButtonActionPerformed(ActionEvent e)

restartTimer

protected void restartTimer(int delay)

Internal routine to handle timer starts & restarts

timeout

protected void timeout()

Internal routine to handle a timeout and send next item

runButtonActionPerformed

public void runButtonActionPerformed(ActionEvent e)

Run button pressed down, start the sequence operation

Parameters:

e -

startSequenceDelay

void startSequenceDelay()

Echo has been heard, start delay for next packet

sendNextItem

void sendNextItem()

Send next item; may be used for the first item or when a delay has elapsed.

createPacket

CanMessage createPacket(String s)

Create a well-formed message from a String String is expected to be space seperated hex bytes or CbusAddress, e.g.: 12 34 56 +n4e1

Parameters:

s -

Returns:

The packet, with contents filled-in

message

public void message(CanMessage m)

Don't pay attention to messages

Specified by:

message in interface CanListener

reply

public void reply(CanReply m)

Don't pay attention to replies

Specified by:

reply in interface CanListener

dispose

public void dispose()

When the window closes, stop any sequences running

Overrides:

dispose in class JmriPanel