Package jmri.jmrix.dccpp.swing.virtuallcd

Class VirtualLCDPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jmri.jmrix.dccpp.swing.virtuallcd.VirtualLCDPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, AbstractMRListener, DCCppListener, VirtualLCDConfiguration

public class VirtualLCDPanel
extends JPanel
implements DCCppListener, VirtualLCDConfiguration

Panel to image the DCC-EX command station's OLED display. Also sends request to DCC-EX to send copies of all LCD messages to this instance of JMRI.

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

Nested classes/interfaces inherited from interface jmri.jmrix.dccpp.swing.virtuallcd.VirtualLCDConfiguration

VirtualLCDConfiguration.DisplayConfig

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final int	TOTALLINES

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
VirtualLCDPanel(JmriJFrame frame, boolean isMemoEditable)
VirtualLCDPanel(JmriJFrame frame, Positionable pos, boolean isMemoEditable)

Method Summary

Modifier and Type	Method	Description
void	dispose()
VirtualLCDConfiguration.DisplayConfig	getDisplayConfig()
int	getDisplayNo()
Dimension	getLCDSize()	Get the size of the LCD display.
int	getMaxDisplayNo()
DCCppSystemConnectionMemo	getMemo()
int	getMinDisplayNo()
String	getNameString()
Set<Integer>	getSelectedDisplays()
void	initComponents()
boolean	isMemoEditable()
void	message(DCCppMessage msg)	Member function that will be invoked by a DCCppInterface implementation to forward a DCC-EX message sent to the layout.
void	message(DCCppReply msg)	Member function that will be invoked by a DCCppInterface implementation to forward a DCC-EX message from the layout.
void	notifyTimeout(DCCppMessage msg)	Member function invoked by an DCCppInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue.
void	reset()
void	setDisplayConfig(VirtualLCDConfiguration.DisplayConfig displayConfig)
void	setDisplayNo(int displayNo)
void	setLCDSize(Dimension d)	Set the size of the LCD display.
void	setMaxDisplayNo(int maxDisplayNo)
void	setMemo(DCCppSystemConnectionMemo memo)
void	setMinDisplayNo(int minDisplayNo)
void	setSelectedDisplays(Set<Integer> displays)

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

TOTALLINES

static final int TOTALLINES

See Also:

• Constant Field Values

Constructor Details

VirtualLCDPanel

public VirtualLCDPanel(JmriJFrame frame,
 boolean isMemoEditable)

VirtualLCDPanel

public VirtualLCDPanel(JmriJFrame frame,
 Positionable pos,
 boolean isMemoEditable)

Method Details

initComponents

public void initComponents()

reset

public void reset()

dispose

public void dispose()

setMemo

public void setMemo(DCCppSystemConnectionMemo memo)

Specified by:

setMemo in interface VirtualLCDConfiguration

getMemo

public DCCppSystemConnectionMemo getMemo()

Specified by:

getMemo in interface VirtualLCDConfiguration

isMemoEditable

public boolean isMemoEditable()

Specified by:

isMemoEditable in interface VirtualLCDConfiguration

setDisplayConfig

public void setDisplayConfig(VirtualLCDConfiguration.DisplayConfig displayConfig)

Specified by:

setDisplayConfig in interface VirtualLCDConfiguration

getDisplayConfig

public VirtualLCDConfiguration.DisplayConfig getDisplayConfig()

Specified by:

getDisplayConfig in interface VirtualLCDConfiguration

setDisplayNo

public void setDisplayNo(int displayNo)

Specified by:

setDisplayNo in interface VirtualLCDConfiguration

getDisplayNo

public int getDisplayNo()

Specified by:

getDisplayNo in interface VirtualLCDConfiguration

setMinDisplayNo

public void setMinDisplayNo(int minDisplayNo)

Specified by:

setMinDisplayNo in interface VirtualLCDConfiguration

getMinDisplayNo

public int getMinDisplayNo()

Specified by:

getMinDisplayNo in interface VirtualLCDConfiguration

setMaxDisplayNo

public void setMaxDisplayNo(int maxDisplayNo)

Specified by:

setMaxDisplayNo in interface VirtualLCDConfiguration

getMaxDisplayNo

public int getMaxDisplayNo()

Specified by:

getMaxDisplayNo in interface VirtualLCDConfiguration

setSelectedDisplays

public void setSelectedDisplays(Set<Integer> displays)

Specified by:

setSelectedDisplays in interface VirtualLCDConfiguration

getSelectedDisplays

public Set<Integer> getSelectedDisplays()

Specified by:

getSelectedDisplays in interface VirtualLCDConfiguration

setLCDSize

public void setLCDSize(@CheckForNull
 Dimension d)

Description copied from interface: VirtualLCDConfiguration

Set the size of the LCD display.

Specified by:

setLCDSize in interface VirtualLCDConfiguration

Parameters:

d - the size or null if dynamic size

getLCDSize

@CheckForNull
public Dimension getLCDSize()

Description copied from interface: VirtualLCDConfiguration

Get the size of the LCD display.

Specified by:

getLCDSize in interface VirtualLCDConfiguration

Returns:

the size or null if dynamic size

getNameString

public String getNameString()

message

public void message(DCCppMessage msg)

Member function that will be invoked by a DCCppInterface implementation to forward a DCC-EX message sent to the layout. Normally, this function will do nothing.

Specified by:

message in interface DCCppListener

Parameters:

msg - The received DCC-EX message. Note that this same object may be presented to multiple users. It should not be modified here.

message

public void message(DCCppReply msg)

Member function that will be invoked by a DCCppInterface implementation to forward a DCC-EX message from the layout.

Specified by:

message in interface DCCppListener

Parameters:

msg - The received DCC-EX message. Note that this same object may be presented to multiple users. It should not be modified here.

notifyTimeout

public void notifyTimeout(DCCppMessage msg)

Member function invoked by an DCCppInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue.

Specified by:

notifyTimeout in interface DCCppListener

Parameters:

msg - the message that timed out.