java.lang.Object

jmri.jmrix.AbstractConnectionConfig

jmri.jmrix.AbstractSerialConnectionConfig

All Implemented Interfaces:: ConnectionConfig

Direct Known Subclasses:: AbstractDCCppSerialConnectionConfig, AbstractXNetSerialConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig

public abstract class AbstractSerialConnectionConfig
extends AbstractConnectionConfig

Abstract base class for common implementation of the SerialConnectionConfig.

Nested Class Summary

Nested Classes

Modifier and Type Class Description

(package private) class AbstractSerialConnectionConfig.ComboBoxRenderer

Nested classes/interfaces inherited from class jmri.jmrix.AbstractConnectionConfig
AbstractConnectionConfig.Option

Field Summary

Fields
Modifier and Type	Field	Description
`protected SerialPortAdapter`	`adapter`
`protected JComboBox<String>`	`baudBox`
`protected JLabel`	`baudBoxLabel`
`protected String[]`	`baudList`
`protected boolean`	`init`
`(package private) String`	`invalidPort`
`(package private) Vector<String>`	`originalList`
`protected JLabel`	`outputIntervalLabel`
`protected JButton`	`outputIntervalReset`
`protected JSpinner`	`outputIntervalSpinner`
`(package private) UserPreferencesManager`	`p`
`protected JComboBox<String>`	`portBox`
`protected JLabel`	`portBoxLabel`
`(package private) Vector<String>`	`v`

Fields inherited from class jmri.jmrix.AbstractConnectionConfig

_details, additionalItems, cL, connectionNameField, connectionNameLabel, cR, gbLayout, NUMOPTIONS, options, showAdvanced, systemPrefixField, systemPrefixLabel

Constructor Summary

Constructors
Constructor	Description
`AbstractSerialConnectionConfig()`	Ctor for a functional object with no preexisting adapter.
`AbstractSerialConnectionConfig(PortAdapter p)`	Ctor for an object being created during load process.
`AbstractSerialConnectionConfig(SerialPortAdapter p)`

Method Summary

Modifier and Type	Method	Description
`protected int`	`addStandardDetails(boolean incAdvanced, int i)`
`protected void`	`addToActionList()`	Deprecated. since 4.19.7 without direct replacement
`protected void`	`checkInitDone()`	Complete connection adapter initialization, adding desired options to the Connection Configuration pane.
`void`	`dispose()`	Done with this ConnectionConfig object.
`protected ResourceBundle`	`getActionModelResourceBundle()`	This is purely here for systems that do not implement the SystemConnectionMemo and can be removed once they have been migrated.
`SerialPortAdapter`	`getAdapter()`
`String`	`getConnectionName()`
`boolean`	`getDisabled()`
`String`	`getInfo()`
`String`	`getManufacturer()`
`protected String[]`	`getPortFriendlyNames()`	This provides a method to return potentially meaningful names that are used in OS to help identify ports against Hardware.
`protected Vector<String>`	`getPortNames()`
`boolean`	`isBaudAdvanced()`
`boolean`	`isPortAdvanced()`
`void`	`loadDetails(JPanel details)`	Load the Swing widgets needed to configure this connection into a specified JPanel.
`void`	`refreshPortBox()`
`protected void`	`removeFromActionList()`	Deprecated. since 4.19.7 without direct replacement
`void`	`setDisabled(boolean disabled)`
`protected abstract void`	`setInstance()`	Load the adapter with an appropriate object unless it's already been set.
`void`	`setManufacturer(String manufacturer)`
`protected void`	`showAdvancedItems()`
`void`	`updateAdapter()`
`protected static void`	`updateSerialPortNames(String portName, JComboBox<String> portCombo, Vector<String> portList)`	Handle friendly port names.

Methods inherited from class jmri.jmrix.AbstractConnectionConfig

addNameEntryCheckers, addStandardDetails, isDirty, isRestartRequired, register

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jmri.jmrix.ConnectionConfig

name

Field Details
- init
  
  protected boolean init
- p
  
  UserPreferencesManager p
- portBox
  
  protected JComboBox<String> portBox
- portBoxLabel
  
  protected JLabel portBoxLabel
- baudBox
  
  protected JComboBox<String> baudBox
- baudBoxLabel
  
  protected JLabel baudBoxLabel
- baudList
  
  protected String[] baudList
- outputIntervalSpinner
  
  protected JSpinner outputIntervalSpinner
- outputIntervalLabel
  
  protected JLabel outputIntervalLabel
- outputIntervalReset
  
  protected JButton outputIntervalReset
- adapter
  
  protected SerialPortAdapter adapter
- v
  
  Vector<String> v
- originalList
  
  Vector<String> originalList
- invalidPort
  
  String invalidPort
Constructor Details
- AbstractSerialConnectionConfig
  
  public AbstractSerialConnectionConfig(PortAdapter p)
  
  Ctor for an object being created during load process.
  
  Parameters:
  
  p - port being configured
- AbstractSerialConnectionConfig
  
  public AbstractSerialConnectionConfig(SerialPortAdapter p)
- AbstractSerialConnectionConfig
  
  public AbstractSerialConnectionConfig()
  
  Ctor for a functional object with no preexisting adapter. Expect that the subclass setInstance() will fill the adapter member.
Method Details
- getAdapter
  
  public SerialPortAdapter getAdapter()
- checkInitDone
  
  protected void checkInitDone()
  Complete connection adapter initialization, adding desired options to the Connection Configuration pane. Required action: set init to true. Optional actions:
  
  fill in connectionNameField
  
  add ActionListeners to config fields eg. systemPrefixField to update adapter after change by the user
  Specified by:
  
  checkInitDone in class AbstractConnectionConfig
- updateAdapter
  
  public void updateAdapter()
  
  Specified by:
  
  updateAdapter in class AbstractConnectionConfig
- setInstance
  
  protected abstract void setInstance()
  
  Load the adapter with an appropriate object unless it's already been set.
  
  Specified by:
  
  setInstance in class AbstractConnectionConfig
- getInfo
  
  public String getInfo()
  
  Specified by:
  
  getInfo in interface ConnectionConfig
  
  Specified by:
  
  getInfo in class AbstractConnectionConfig
- refreshPortBox
  
  public void refreshPortBox()
- loadDetails
  
  public void loadDetails(JPanel details)
  
  Load the Swing widgets needed to configure this connection into a specified JPanel. Used during the configuration process to fill out the preferences window with content specific to this Connection type. The JPanel contents need to handle their own gets/sets to the underlying Connection content.
  
  Specified by:
  
  loadDetails in interface ConnectionConfig
  
  Specified by:
  
  loadDetails in class AbstractConnectionConfig
  
  Parameters:
  
  details - the specific Swing object to be configured and filled
- showAdvancedItems
  
  protected void showAdvancedItems()
  
  Specified by:
  
  showAdvancedItems in class AbstractConnectionConfig
- addStandardDetails
  
  protected int addStandardDetails(boolean incAdvanced, int i)
- isPortAdvanced
  
  public boolean isPortAdvanced()
- isBaudAdvanced
  
  public boolean isBaudAdvanced()
- getManufacturer
  
  public String getManufacturer()
  
  Specified by:
  
  getManufacturer in interface ConnectionConfig
  
  Specified by:
  
  getManufacturer in class AbstractConnectionConfig
- setManufacturer
  
  public void setManufacturer(String manufacturer)
  
  Specified by:
  
  setManufacturer in interface ConnectionConfig
  
  Specified by:
  
  setManufacturer in class AbstractConnectionConfig
- getDisabled
  
  public boolean getDisabled()
  
  Specified by:
  
  getDisabled in interface ConnectionConfig
  
  Specified by:
  
  getDisabled in class AbstractConnectionConfig
- setDisabled
  
  public void setDisabled(boolean disabled)
  
  Specified by:
  
  setDisabled in interface ConnectionConfig
  
  Specified by:
  
  setDisabled in class AbstractConnectionConfig
- getConnectionName
  
  public String getConnectionName()
  
  Specified by:
  
  getConnectionName in interface ConnectionConfig
  
  Specified by:
  
  getConnectionName in class AbstractConnectionConfig
- dispose
  
  public void dispose()
  
  Description copied from interface: ConnectionConfig
  
  Done with this ConnectionConfig object. Invoked in JmrixConfigPane when switching away from this particular mode.
  
  Specified by:
  
  dispose in interface ConnectionConfig
  
  Overrides:
  
  dispose in class AbstractConnectionConfig
- updateSerialPortNames
  
  protected static void updateSerialPortNames(String portName, JComboBox<String> portCombo, Vector<String> portList)
  
  Handle friendly port names. Note that this changes the selection in portCombo, so that should be tracked after this returns.
  
  Parameters:
  
  portName - The currently-selected port name
  
  portCombo - The combo box that's displaying the available ports
  
  portList - The list of valid (unfriendly) port names
- getPortNames
  
  protected Vector<String> getPortNames()
- getPortFriendlyNames
  
  protected String[] getPortFriendlyNames()
  
  This provides a method to return potentially meaningful names that are used in OS to help identify ports against Hardware.
  
  Returns:
  
  array of friendly port names
- getActionModelResourceBundle
  
  protected ResourceBundle getActionModelResourceBundle()
  
  This is purely here for systems that do not implement the SystemConnectionMemo and can be removed once they have been migrated.
  
  Returns:
  
  Resource bundle for action model
- addToActionList
  
  @Deprecated protected final void addToActionList()
  
  Deprecated.
  since 4.19.7 without direct replacement
- removeFromActionList
  
  @Deprecated protected void removeFromActionList()
  
  Deprecated.
  since 4.19.7 without direct replacement

Class AbstractSerialConnectionConfig

Nested Class Summary

Nested classes/interfaces inherited from class jmri.jmrix.AbstractConnectionConfig