Package jmri.jmrix.openlcb.swing.hub

Class HubPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jmri.util.swing.JmriPanel

jmri.jmrix.openlcb.swing.hub.HubPane

All Implemented Interfaces:

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

Direct Known Subclasses:

CbusHubPane

public class HubPane
extends JmriPanel
implements CanListener, CanPanelInterface

Frame displaying,and more importantly starting, an OpenLCB TCP/IP hub

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
(package private) final Hub	hub
(package private) CanSystemConnectionMemo	memo
(package private) Thread	t
(package private) ArrayList<CanMessage>	workingMessageSet
(package private) ArrayList<CanReply>	workingReplySet
protected String	zero_conf_addr

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
HubPane()	Create a new HubPane with default options.
HubPane(int port)	Create a new HubPane with a specified port number.
HubPane(int port, boolean sendLineEndings)	Create a new HubPane with port number and default for sending line ends.

Method Summary

Modifier and Type	Method	Description
protected void	advertise(int port)
void	dispose()
protected GridConnectReply	getBlankReply()	Get an empty GridConnect Reply.
List<JMenu>	getMenus()	Creates a Menu List
protected GridConnectMessage	getMessageFrom(CanMessage m)	Get a GridConnect Message from a CanMessage.
String	getTitle()	Provide a recommended title for an enclosing frame.
void	initComponents(CanSystemConnectionMemo memo)	2nd stage of initialization, invoked after the Constructor is complete.
void	initContext(Object context)	3rd stage of initialization, invoked after Swing components exist.
void	message(CanMessage l)	Called when an outgoing message is sent to the CAN Network.
void	reply(CanReply reply)	Called when an incoming CanFrame is received from the CAN Network.
(package private) void	showRequireTerminationDialog(ActionEvent e)
(package private) void	showSendTerminationDialog(ActionEvent e)
(package private) void	startHubThread(int port)

Methods inherited from class jmri.util.swing.JmriPanel

getHelpTarget, getMinimumDimension, 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, 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

Methods inherited from interface jmri.jmrix.can.CanListener

addTc, addTc, removeTc, removeTc

Field Details

memo

CanSystemConnectionMemo memo

hub

final transient Hub hub

t

Thread t

workingReplySet

ArrayList<CanReply> workingReplySet

workingMessageSet

ArrayList<CanMessage> workingMessageSet

zero_conf_addr

protected String zero_conf_addr

Constructor Details

HubPane

public HubPane()

Create a new HubPane with default options.

HubPane

public HubPane(int port)

Create a new HubPane with a specified port number. Sends with Line Endings.

Parameters:

port - the port number to use.

HubPane

public HubPane(int port,
 boolean sendLineEndings)

Create a new HubPane with port number and default for sending line ends. This option may subsequently be ignored by user preference. Default is to NOT require line endings.

Parameters:

port - the port number to use.

sendLineEndings - if no user option is set, true to send line endings, else false.

Method Details

initContext

public void initContext(Object context)

Description copied from class: JmriPanel

3rd stage of initialization, invoked after Swing components exist.

Overrides:

initContext in class JmriPanel

Parameters:

context - the context that this panel may be initialized with

initComponents

public void initComponents(CanSystemConnectionMemo memo)

Description copied from interface: CanPanelInterface

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 CanPanelInterface

Parameters:

memo - system connection.

startHubThread

void startHubThread(int port)

advertise

protected void advertise(int port)

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

getMenus

public List<JMenu> getMenus()

Creates a Menu List

Settings : Line Termination

Overrides:

getMenus in class JmriPanel

Returns:

a list of menu items to add or an empty list

showSendTerminationDialog

void showSendTerminationDialog(ActionEvent e)

showRequireTerminationDialog

void showRequireTerminationDialog(ActionEvent e)

dispose

public void dispose()

Overrides:

dispose in class JmriPanel

message

public void message(CanMessage l)

Description copied from interface: CanListener

Called when an outgoing message is sent to the CAN Network.

Specified by:

message in interface CanListener

Parameters:

l - the CanMessage being sent.

getMessageFrom

protected GridConnectMessage getMessageFrom(CanMessage m)

Get a GridConnect Message from a CanMessage. Enables override of the particular type of GridConnectMessage.

Parameters:

m - the CanMessage

Returns:

a GridConnectMessage.

getBlankReply

protected GridConnectReply getBlankReply()

Get an empty GridConnect Reply. Enables override of the particular type of GridConnectReply.

Returns:

a GridConnectReply.

reply

public void reply(CanReply reply)

Description copied from interface: CanListener

Called when an incoming CanFrame is received from the CAN Network.

Specified by:

reply in interface CanListener

Parameters:

reply - the CanReply being received.