java.lang.Object

jmri.jmrix.AbstractConnectionConfig

All Implemented Interfaces:: ConnectionConfig

Direct Known Subclasses:: AbstractNetworkConnectionConfig, AbstractSerialConnectionConfig, AbstractSimulatorConnectionConfig, AbstractStreamConnectionConfig, AbstractUsbConnectionConfig, IpocsConnectionConfig, RaspberryPiConnectionConfig

public abstract class AbstractConnectionConfig
extends Object
implements ConnectionConfig

Abstract base class for common implementation of the ConnectionConfig.

Nested Class Summary

Nested Classes

Modifier and Type Class Description

protected static class AbstractConnectionConfig.Option

Field Summary

Fields
Modifier and Type	Field	Description
`protected JPanel`	`_details`
`protected ArrayList<JComponent>`	`additionalItems`
`protected GridBagConstraints`	`cL`
`protected JTextField`	`connectionNameField`
`protected JLabel`	`connectionNameLabel`
`protected GridBagConstraints`	`cR`
`protected GridBagLayout`	`gbLayout`
`protected int`	`NUMOPTIONS`
`protected Map<String,AbstractConnectionConfig.Option>`	`options`
`protected JCheckBox`	`showAdvanced`
`protected ValidatedTextField`	`systemPrefixField`
`protected JLabel`	`systemPrefixLabel`

Constructor Summary

Constructors

Constructor Description

AbstractConnectionConfig()
Ctor for a functional object with no preexisting adapter.

Method Summary

Modifier and Type	Method	Description
`protected void`	`addNameEntryCheckers(PortAdapter adapter)`
`protected int`	`addStandardDetails(PortAdapter adapter, boolean incAdvanced, int i)`
`protected abstract void`	`checkInitDone()`	Complete connection adapter initialization, adding desired options to the Connection Configuration pane.
`void`	`dispose()`	Done with this ConnectionConfig object.
`abstract String`	`getConnectionName()`
`abstract boolean`	`getDisabled()`
`abstract String`	`getInfo()`
`abstract String`	`getManufacturer()`
`boolean`	`isDirty()`	Determine if configuration needs to be written to disk.
`boolean`	`isRestartRequired()`	Determine if application needs to be restarted for configuration changes to be applied.
`abstract void`	`loadDetails(JPanel details)`	Load the Swing widgets needed to configure this connection into a specified JPanel.
`void`	`register()`	Register the ConnectionConfig with the running JMRI process.
`abstract void`	`setDisabled(boolean disable)`
`protected abstract void`	`setInstance()`	Load the adapter with an appropriate object unless it's already been set.
`abstract void`	`setManufacturer(String manufacturer)`
`protected abstract void`	`showAdvancedItems()`
`abstract void`	`updateAdapter()`

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

getAdapter, name

Field Details
- NUMOPTIONS
  
  protected int NUMOPTIONS
- showAdvanced
  
  protected JCheckBox showAdvanced
- systemPrefixLabel
  
  protected JLabel systemPrefixLabel
- connectionNameLabel
  
  protected JLabel connectionNameLabel
- systemPrefixField
  
  protected ValidatedTextField systemPrefixField
- connectionNameField
  
  protected JTextField connectionNameField
- _details
  
  protected JPanel _details
- options
  
  protected final Map<String,AbstractConnectionConfig.Option> options
- additionalItems
  
  protected ArrayList<JComponent> additionalItems
- gbLayout
  
  protected GridBagLayout gbLayout
- cL
  
  protected GridBagConstraints cL
- cR
  
  protected GridBagConstraints cR
Constructor Details
- AbstractConnectionConfig
  
  public AbstractConnectionConfig()
  
  Ctor for a functional object with no preexisting adapter. Expect that the subclass setInstance() will fill the adapter member. AbstractConnectionConfigXmlloadCommon
Method Details
- checkInitDone
  
  protected abstract 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
- updateAdapter
  
  public abstract void updateAdapter()
- isDirty
  
  public boolean isDirty()
  
  Determine if configuration needs to be written to disk.
  This default implementation always returns true to maintain the existing behavior.
  
  Specified by:
  
  isDirty in interface ConnectionConfig
  
  Returns:
  
  true if configuration need to be saved, false otherwise
- isRestartRequired
  
  public boolean isRestartRequired()
  
  Determine if application needs to be restarted for configuration changes to be applied.
  The default implementation always returns true to maintain the existing behavior.
  
  Specified by:
  
  isRestartRequired in interface ConnectionConfig
  
  Returns:
  
  true if application needs to restart, false otherwise
- setInstance
  
  protected abstract void setInstance()
  
  Load the adapter with an appropriate object unless it's already been set.
- getInfo
  
  public abstract String getInfo()
  
  Specified by:
  
  getInfo in interface ConnectionConfig
- loadDetails
  
  public abstract 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
  
  Parameters:
  
  details - the specific Swing object to be configured and filled
- showAdvancedItems
  
  protected abstract void showAdvancedItems()
- addStandardDetails
  
  protected int addStandardDetails(PortAdapter adapter, boolean incAdvanced, int i)
- getManufacturer
  
  public abstract String getManufacturer()
  
  Specified by:
  
  getManufacturer in interface ConnectionConfig
- setManufacturer
  
  public abstract void setManufacturer(String manufacturer)
  
  Specified by:
  
  setManufacturer in interface ConnectionConfig
- getConnectionName
  
  public abstract String getConnectionName()
  
  Specified by:
  
  getConnectionName in interface ConnectionConfig
- getDisabled
  
  public abstract boolean getDisabled()
  
  Specified by:
  
  getDisabled in interface ConnectionConfig
- setDisabled
  
  public abstract void setDisabled(boolean disable)
  
  Specified by:
  
  setDisabled in interface ConnectionConfig
- register
  
  public void register()
  Register the ConnectionConfig with the running JMRI process.
  At a minimum, is responsible for:
  
  Registering this object with the ConfigurationManager for persistance, typically at the "Preferences" level
  Adding this object to the default (@link ConnectionConfigManager}
  Specified by:
  
  register in interface ConnectionConfig
- 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
- addNameEntryCheckers
  
  protected void addNameEntryCheckers(@Nonnull PortAdapter adapter)

Class AbstractConnectionConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface jmri.jmrix.ConnectionConfig

Field Details

Constructor Details

Method Details