Package jmri.jmrix.dccpp.swing.messages

Class MessagesPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jmri.jmrix.dccpp.swing.messages.MessagesPanel

All Implemented Interfaces:

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

public class MessagesPanel
extends JPanel
implements DCCppListener, MessagesConfiguration

Panel showing EXRAIL MESSAGE() broadcasts from a DCC-EX command station, styled like the Virtual LCD.

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
static final String	DEFAULT_SOUND_FILE

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

Method Summary

Modifier and Type	Method	Description
void	addMessage(String text)
void	clearMessages()
void	dispose()
int	getExpirySeconds()
int	getLineCount()
String	getLineText(int index)
int	getMaxLines()
DCCppSystemConnectionMemo	getMemo()
Color	getMessageBackground()
Color	getMessageForeground()
Dimension	getMessagesSize()
String	getNameString()
String	getSoundFile()
void	initComponents()
boolean	isAutoOpen()
(package private) boolean	isExpiryTimerRunning()
boolean	isMemoEditable()
boolean	isPlaySound()
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	setAutoOpen(boolean autoOpen)
void	setExpirySeconds(int seconds)
void	setMaxLines(int lines)
void	setMemo(DCCppSystemConnectionMemo memo)
void	setMessageBackground(Color color)
void	setMessageForeground(Color color)
void	setMessagesSize(Dimension size)	Fixed size as columns (width) and lines (height), or null to size to fit.
void	setPlaySound(boolean playSound)
void	setSoundFile(String path)
(package private) void	setSoundHooks(Predicate<URL> check, Consumer<URL> player)
(package private) void	tick()

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

DEFAULT_SOUND_FILE

public static final String DEFAULT_SOUND_FILE

See Also:

• Constant Field Values

Constructor Details

MessagesPanel

public MessagesPanel(@CheckForNull
 JmriJFrame frame,
 boolean isMemoEditable)

MessagesPanel

public MessagesPanel(@CheckForNull
 JmriJFrame frame,
 @CheckForNull
 Positionable pos,
 boolean isMemoEditable)

MessagesPanel

MessagesPanel(@CheckForNull
 JmriJFrame frame,
 @CheckForNull
 Positionable pos,
 boolean isMemoEditable,
 LongSupplier clock)

Method Details

initComponents

public void initComponents()

dispose

public void dispose()

addMessage

@InvokeOnGuiThread
public void addMessage(String text)

clearMessages

@InvokeOnGuiThread
public void clearMessages()

tick

@InvokeOnGuiThread
void tick()

isExpiryTimerRunning

boolean isExpiryTimerRunning()

getLineCount

public int getLineCount()

getLineText

public String getLineText(int index)

getNameString

public String getNameString()

setSoundHooks

void setSoundHooks(Predicate<URL> check,
 Consumer<URL> player)

setMemo

public void setMemo(DCCppSystemConnectionMemo memo)

Specified by:

setMemo in interface MessagesConfiguration

getMemo

public DCCppSystemConnectionMemo getMemo()

Specified by:

getMemo in interface MessagesConfiguration

isMemoEditable

public boolean isMemoEditable()

Specified by:

isMemoEditable in interface MessagesConfiguration

setExpirySeconds

public void setExpirySeconds(int seconds)

Specified by:

setExpirySeconds in interface MessagesConfiguration

getExpirySeconds

public int getExpirySeconds()

Specified by:

getExpirySeconds in interface MessagesConfiguration

setMaxLines

public void setMaxLines(int lines)

Specified by:

setMaxLines in interface MessagesConfiguration

getMaxLines

public int getMaxLines()

Specified by:

getMaxLines in interface MessagesConfiguration

setAutoOpen

public void setAutoOpen(boolean autoOpen)

Specified by:

setAutoOpen in interface MessagesConfiguration

isAutoOpen

public boolean isAutoOpen()

Specified by:

isAutoOpen in interface MessagesConfiguration

setPlaySound

public void setPlaySound(boolean playSound)

Specified by:

setPlaySound in interface MessagesConfiguration

isPlaySound

public boolean isPlaySound()

Specified by:

isPlaySound in interface MessagesConfiguration

setSoundFile

public void setSoundFile(String path)

Specified by:

setSoundFile in interface MessagesConfiguration

getSoundFile

public String getSoundFile()

Specified by:

getSoundFile in interface MessagesConfiguration

setMessageForeground

public void setMessageForeground(Color color)

Specified by:

setMessageForeground in interface MessagesConfiguration

getMessageForeground

public Color getMessageForeground()

Specified by:

getMessageForeground in interface MessagesConfiguration

setMessageBackground

public void setMessageBackground(Color color)

Specified by:

setMessageBackground in interface MessagesConfiguration

getMessageBackground

public Color getMessageBackground()

Specified by:

getMessageBackground in interface MessagesConfiguration

setMessagesSize

public void setMessagesSize(@CheckForNull
 Dimension size)

Description copied from interface: MessagesConfiguration

Fixed size as columns (width) and lines (height), or null to size to fit.

Specified by:

setMessagesSize in interface MessagesConfiguration

getMessagesSize

@CheckForNull
public Dimension getMessagesSize()

Specified by:

getMessagesSize in interface MessagesConfiguration

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.

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.

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.