Class CbusConfigPaneProvider
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JPanel
-
- jmri.util.swing.JmriPanel
-
- jmri.jmrix.can.swing.CanPanel
-
- jmri.jmrix.can.cbus.swing.modules.CbusConfigPaneProvider
-
- All Implemented Interfaces:
java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,javax.accessibility.Accessible
,CanPanelInterface
,JmriServiceProviderInterface
- Direct Known Subclasses:
Canacc8PaneProvider
,CanCmdPaneProvider
,CanisbPaneProvider
,PiSprog3PaneProvider
,Servo8BasePaneProvider
,Sol8BasePaneProvider
,Sprog3PlusPaneProvider
,UnknownPaneProvider
public abstract class CbusConfigPaneProvider extends CanPanel implements JmriServiceProviderInterface
Pane for configuring events in a CBUS module Definition of objects to handle configuring a CBUS module. Implementing classes must be registered as service providers of this type to be recognized and usable.General design documentation is available on the Structure of External System Connections page.
- See Also:
ServiceLoader
, Serialized Form
-
-
Nested Class Summary
-
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
-
-
Field Summary
Fields Modifier and Type Field Description protected AbstractEditNVPane
_nVarEditFrame
(package private) static java.util.Map<java.lang.String,CbusConfigPaneProvider>
instanceMap
-
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
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CbusConfigPaneProvider()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract AbstractEditNVPane
getEditNVFrame(CbusNodeNVTableDataModel editFrame, CbusNode node)
Create a new edit frameabstract AbstractEditNVPane
getEditNVFrameInstance()
Get the edit frame instancestatic java.util.Collection<CbusConfigPaneProvider>
getInstancesCollection()
Get all available instances as anCollections.unmodifiableCollection(java.util.Collection<? extends T>)
between the (localized) name and the pane.static java.util.Map<java.lang.String,CbusConfigPaneProvider>
getInstancesMap()
Get all available instances as anCollections.unmodifiableMap(java.util.Map<? extends K, ? extends V>)
between the (localized) name and the pane.abstract java.lang.String
getModuleType()
Get the manufacturer name for the classabstract java.lang.String
getNVNameByIndex(int index)
Get descriptive name of NVstatic CbusConfigPaneProvider
getProviderByName(java.lang.String name)
Get a module provider from a module namestatic CbusConfigPaneProvider
getProviderByNode(CbusNode node)
Get a module provider from a CBUS nodestatic void
loadInstances()
Load all the available instances.java.lang.String
toString()
Return string representation of the node-
Methods inherited from class jmri.jmrix.can.swing.CanPanel
getMemo, initComponents, initContext, prependConnToString
-
Methods inherited from class jmri.util.swing.JmriPanel
dispose, getHelpTarget, getMenus, getMinimumDimension, getTitle, 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, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Field Detail
-
_nVarEditFrame
protected AbstractEditNVPane _nVarEditFrame
-
instanceMap
static volatile java.util.Map<java.lang.String,CbusConfigPaneProvider> instanceMap
-
-
Constructor Detail
-
CbusConfigPaneProvider
protected CbusConfigPaneProvider()
-
-
Method Detail
-
getModuleType
@Nonnull public abstract java.lang.String getModuleType()
Get the manufacturer name for the class- Returns:
- the manufacturer
-
getNVNameByIndex
public abstract java.lang.String getNVNameByIndex(int index)
Get descriptive name of NV- Parameters:
index
- of the NV- Returns:
- the name as String. May be empty string if NV description is unknown or null if index is out of range
-
getEditNVFrameInstance
public abstract AbstractEditNVPane getEditNVFrameInstance()
Get the edit frame instance- Returns:
- the edit frame
-
getEditNVFrame
public abstract AbstractEditNVPane getEditNVFrame(CbusNodeNVTableDataModel editFrame, CbusNode node)
Create a new edit frame- Parameters:
editFrame
- the containing framenode
- the node to be edited- Returns:
- the edit frame
-
toString
public final java.lang.String toString()
Return string representation of the node- Overrides:
toString
in classjava.awt.Component
- Returns:
- name of object
-
getProviderByName
@CheckForNull public static final CbusConfigPaneProvider getProviderByName(java.lang.String name)
Get a module provider from a module name- Parameters:
name
- of the module- Returns:
- the module provider, null if not known
-
getProviderByNode
public static final CbusConfigPaneProvider getProviderByNode(CbusNode node)
Get a module provider from a CBUS node- Parameters:
node
- the node instance- Returns:
- the module provider
-
getInstancesMap
public static final java.util.Map<java.lang.String,CbusConfigPaneProvider> getInstancesMap()
Get all available instances as anCollections.unmodifiableMap(java.util.Map<? extends K, ? extends V>)
between the (localized) name and the pane. Note that this is a SortedMap in name order.- Returns:
- all instance map sorted in name order.
-
getInstancesCollection
public static final java.util.Collection<CbusConfigPaneProvider> getInstancesCollection()
Get all available instances as anCollections.unmodifiableCollection(java.util.Collection<? extends T>)
between the (localized) name and the pane.- Returns:
- unmodifiable collection.
-
loadInstances
public static final void loadInstances()
Load all the available instances. Note this only runs once; there's no reloading once the program is running.
-
-