Package jmri.jmrix.mqtt

Class MqttSignalMastAddPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jmri.jmrit.beantable.signalmast.SignalMastAddPane

jmri.jmrix.mqtt.MqttSignalMastAddPane

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, JmriServiceProviderInterface

public class MqttSignalMastAddPane
extends SignalMastAddPane

A pane for configuring VirtualSignalMast objects.

See Also:

SignalMastAddPane, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MqttSignalMastAddPane.SignalMastAddPaneProvider

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
(package private) javax.swing.JCheckBox	allowUnLit
(package private) javax.swing.JTextField	aspectAddressField
(package private) javax.swing.JLabel	aspectAddressLabel
(package private) MqttSignalMast	currentMast
(package private) java.util.LinkedHashMap<java.lang.String,javax.swing.JCheckBox>	disabledAspects
(package private) javax.swing.JPanel	disabledAspectsPanel
(package private) java.text.DecimalFormat	paddedNumber

Fields inherited from class jmri.jmrit.beantable.signalmast.SignalMastAddPane

NOTIONAL_ASPECT_COUNT

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
MqttSignalMastAddPane()

Method Summary

Modifier and Type	Method	Description
(package private) javax.swing.JPanel	addressDataPane()
boolean	canHandleMast(SignalMast mast)	Can this pane edit a specific mast object, i.e. an object of its type?
boolean	createMast(java.lang.String sigsysname, java.lang.String mastname, java.lang.String username)	Called to either "create and register" a new, or "update" an existing mast from the given information.
java.lang.String	getPaneName()
(package private) void	initPanel()
void	setAspectNames(SignalAppearanceMap map, SignalSystem sigSystem)	Provide a new list of aspects in the signal system.
void	setMast(SignalMast mast)	Load this pane with information from a mast.

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 Detail

aspectAddressLabel

javax.swing.JLabel aspectAddressLabel

aspectAddressField

javax.swing.JTextField aspectAddressField

allowUnLit

javax.swing.JCheckBox allowUnLit

disabledAspects

java.util.LinkedHashMap<java.lang.String,javax.swing.JCheckBox> disabledAspects

disabledAspectsPanel

javax.swing.JPanel disabledAspectsPanel

currentMast

MqttSignalMast currentMast

paddedNumber

java.text.DecimalFormat paddedNumber

Constructor Detail

MqttSignalMastAddPane

public MqttSignalMastAddPane()

Method Detail

initPanel

final void initPanel()

addressDataPane

javax.swing.JPanel addressDataPane()

getPaneName

@Nonnull
public java.lang.String getPaneName()

Specified by:

getPaneName in class SignalMastAddPane

Returns:

human-preferred name for type of signal mast, in local language

setAspectNames

public void setAspectNames(@Nonnull
                           SignalAppearanceMap map,
                           @Nonnull
                           SignalSystem sigSystem)

Provide a new list of aspects in the signal system. Must be done at startup before the pane is shown. May be done later, to update to a newly selected system.

Specified by:

setAspectNames in class SignalMastAddPane

Parameters:

map - the signal appearance map.

sigSystem - the signal system.

canHandleMast

public boolean canHandleMast(@Nonnull
                             SignalMast mast)

Can this pane edit a specific mast object, i.e. an object of its type?

Specified by:

canHandleMast in class SignalMastAddPane

Parameters:

mast - the SignalMast to possibly display

Returns:

true if this pane can handle that mast type; false if can't

setMast

public void setMast(SignalMast mast)

Load this pane with information from a mast. Do not invoke this if SignalMastAddPane.canHandleMast(SignalMast) on that mast returns false.

Specified by:

setMast in class SignalMastAddPane

Parameters:

mast - the SignalMast to display or null to reset a previous setting

createMast

public boolean createMast(@Nonnull
                          java.lang.String sigsysname,
                          @Nonnull
                          java.lang.String mastname,
                          @Nonnull
                          java.lang.String username)

Called to either "create and register" a new, or "update" an existing mast from the given information.

Specified by:

createMast in class SignalMastAddPane

Parameters:

sigsysname - the name of the signal system in use

mastname - the mast type name

username - user name value

Returns:

false if the operation failed, in which case the user should have already been notified