Package jmri.jmrix.bidib.swing

Class BiDiBSignalMastAddPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jmri.jmrit.beantable.signalmast.SignalMastAddPane

jmri.jmrix.bidib.swing.BiDiBSignalMastAddPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, JmriServiceProviderInterface

public class BiDiBSignalMastAddPane
extends SignalMastAddPane

A pane for configuring BiDiBSignalMast objects

Since:

4.11.2

See Also:

• SignalMastAddPane
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	BiDiBSignalMastAddPane.BiDiBAspectPanel	JPanel to define properties of an Aspect for a DCC Signal Mast.
static class	BiDiBSignalMastAddPane.SignalMastAddPaneProvider

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) JCheckBox	allowUnLit
(package private) JTextField	bidibAccesoryAddressField
(package private) JLabel	bidibAccesoryAddressLabel
(package private) LinkedHashMap<String,BiDiBSignalMastAddPane.BiDiBAspectPanel>	bidibAspect
(package private) JPanel	bidibMastPanel
(package private) JScrollPane	bidibMastScroll
(package private) BiDiBSignalMast	currentMast
(package private) SignalSystem	sigsys
(package private) JComboBox<String>	systemPrefixBox
(package private) JLabel	systemPrefixBoxLabel
(package private) JTextField	unLitAspectField

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

Method Summary

Modifier and Type	Method	Description
protected void	addUsableConnections()	//Check all BiDiB connections if they have native (not DCC) Accessory functions.
boolean	canHandleMast(SignalMast mast)	Can this pane edit a specific mast object, i.e. an object of its type?
protected BiDiBSignalMast	constructMast(String name)	Create a mast of the specific subtype.
(package private) void	copyFromAnotherBiDiBMastAspect(String strMast)	Copy aspects by name from another DccSignalMast.
(package private) JComboBox<String>	copyFromMastSelection()
boolean	createMast(String sigsysname, String mastname, String username)	Called to either "create and register" a new, or "update" an existing mast from the given information.
protected String	getNamePrefix()	Get the first part of the system name for the specific mast type.
String	getPaneName()
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.
(package private) static boolean	validateAspectId(String strAspect)	Check if the given aspect string is a valid BiDiB aspect.

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

bidibMastScroll

JScrollPane bidibMastScroll

bidibMastPanel

JPanel bidibMastPanel

systemPrefixBoxLabel

JLabel systemPrefixBoxLabel

systemPrefixBox

JComboBox<String> systemPrefixBox

bidibAccesoryAddressLabel

JLabel bidibAccesoryAddressLabel

bidibAccesoryAddressField

JTextField bidibAccesoryAddressField

allowUnLit

JCheckBox allowUnLit

unLitAspectField

JTextField unLitAspectField

bidibAspect

LinkedHashMap<String,BiDiBSignalMastAddPane.BiDiBAspectPanel> bidibAspect

currentMast

BiDiBSignalMast currentMast

sigsys

SignalSystem sigsys

Constructor Details

BiDiBSignalMastAddPane

public BiDiBSignalMastAddPane()

Method Details

getPaneName

@Nonnull
public String getPaneName()

Specified by:

getPaneName in class SignalMastAddPane

Returns:

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

addUsableConnections

protected void addUsableConnections()

//Check all BiDiB connections if they have native (not DCC) Accessory functions. Check all BiDiB connections if they are enabled. Add those to the systemPrefixBox

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

validateAspectId

static boolean validateAspectId(@Nonnull
 String strAspect)

Check if the given aspect string is a valid BiDiB aspect. Only numeric values between 0 and 31 are allowed

Parameters:

strAspect - name of aspect

Returns:

true if valid

getNamePrefix

@Nonnull
protected String getNamePrefix()

Get the first part of the system name for the specific mast type.

Returns:

name prefix

constructMast

protected BiDiBSignalMast constructMast(@Nonnull
 String name)

Create a mast of the specific subtype.

Parameters:

name - system name to create

Returns:

the new signal

createMast

public boolean createMast(@Nonnull
 String sigsysname,
 @Nonnull
 String mastname,
 @Nonnull
 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

copyFromMastSelection

@Nonnull
JComboBox<String> copyFromMastSelection()

copyFromAnotherBiDiBMastAspect

void copyFromAnotherBiDiBMastAspect(@Nonnull
 String strMast)

Copy aspects by name from another DccSignalMast.

Parameters:

strMast - name