Package jmri.jmrix.cmri.serial.serialdriver

Class ConnectionConfig

java.lang.Object

jmri.jmrix.AbstractConnectionConfig

jmri.jmrix.AbstractSerialConnectionConfig

jmri.jmrix.cmri.serial.serialdriver.ConnectionConfig

All Implemented Interfaces:

ConnectionConfig

public class ConnectionConfig
extends AbstractSerialConnectionConfig

Definition of objects to handle configuring a layout connection via a C/MRI SerialDriverAdapter object.

Nested Class Summary

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

AbstractConnectionConfig.Option

Nested classes/interfaces inherited from interface jmri.jmrix.ConnectionConfig

ConnectionConfig.Config

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from class jmri.jmrix.AbstractSerialConnectionConfig

adapter, baudBox, baudBoxLabel, baudList, init, outputIntervalLabel, outputIntervalReset, outputIntervalSpinner, portBox, portBoxLabel

Fields inherited from class jmri.jmrix.AbstractConnectionConfig

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

Constructor Summary

Constructors

Constructor	Description
ConnectionConfig()	Ctor for a connection configuration with no preexisting adapter.
ConnectionConfig(SerialPortAdapter p)	Ctor for an object being created during load process; Swing init is deferred.

Method Summary

Modifier and Type	Method	Description
protected ResourceBundle	getActionModelResourceBundle()	This is purely here for systems that do not implement the SystemConnectionMemo and can be removed once they have been migrated.
ConnectionConfig.Config	getConfig()	Get the configuration for the ConnectionConfig.
void	loadDetails(JPanel details)	Load the Swing widgets needed to configure this connection into a specified JPanel.
String	name()
void	setConfig(ConnectionConfig.Config config)	Set the configuration for the ConnectionConfig.
protected void	setInstance()	Load the adapter with an appropriate object unless it's already been set.

Methods inherited from class jmri.jmrix.AbstractSerialConnectionConfig

addStandardDetails, checkInitDone, dispose, getAdapter, getConnectionName, getDisabled, getInfo, getManufacturer, getPortFriendlyNames, getPortNames, isBaudAdvanced, isPortAdvanced, refreshPortBox, setDisabled, setManufacturer, showAdvancedItems, updateAdapter, updateSerialPortNames

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

Field Details

NAME

public static final String NAME

Constructor Details

ConnectionConfig

public ConnectionConfig(SerialPortAdapter p)

Ctor for an object being created during load process; Swing init is deferred.

Parameters:

p - serial port adapter.

ConnectionConfig

public ConnectionConfig()

Ctor for a connection configuration with no preexisting adapter. setInstance() will fill the adapter member.

Method Details

name

public String name()

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

Overrides:

loadDetails in class AbstractSerialConnectionConfig

Parameters:

details - the specific Swing object to be configured and filled

getActionModelResourceBundle

protected ResourceBundle getActionModelResourceBundle()

Description copied from class: AbstractSerialConnectionConfig

This is purely here for systems that do not implement the SystemConnectionMemo and can be removed once they have been migrated.

Overrides:

getActionModelResourceBundle in class AbstractSerialConnectionConfig

Returns:

Resource bundle for action model

setInstance

protected void setInstance()

Load the adapter with an appropriate object unless it's already been set.

Specified by:

setInstance in class AbstractSerialConnectionConfig

getConfig

public ConnectionConfig.Config getConfig()

Get the configuration for the ConnectionConfig.

Returns:

the configuration or null if not supported

setConfig

public void setConfig(@Nonnull
 ConnectionConfig.Config config)

Set the configuration for the ConnectionConfig. The method MUST check if the configuration is of a supported type and if not, ignore it. An unsupported connection type is not an error.

Parameters:

config - the configuration