Package jmri.jmrix.can.adapters

Class ConnectionConfig

java.lang.Object

jmri.jmrix.AbstractConnectionConfig

jmri.jmrix.AbstractSerialConnectionConfig

jmri.jmrix.can.adapters.ConnectionConfig

All Implemented Interfaces:

ConnectionConfig

Direct Known Subclasses:

CanisbConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, ConnectionConfig, PiSprog3ConnectionConfig, PiSprog3PlusConnectionConfig, PiSprog3v2ConnectionConfig, Sprog3PlusConnectionConfig

public abstract class ConnectionConfig
extends AbstractSerialConnectionConfig

Abstract base for objects to handle configuring a layout connection via various types of SerialDriverAdapter object.

Nested Class Summary

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

AbstractConnectionConfig.Option

Field Summary

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)	Create a connection configuration with a preexisting adapter.

Method Summary

Modifier and Type	Method	Description
protected void	checkInitDone()	Complete connection adapter initialization, adding desired options to the Connection Configuration pane.
protected ResourceBundle	getActionModelResourceBundle()	This is purely here for systems that do not implement the SystemConnectionMemo and can be removed once they have been migrated.
void	loadDetails(JPanel details)	Load the Swing widgets needed to configure this connection into a specified JPanel.
abstract String	name()
protected abstract void	setInstance()	Load the adapter with an appropriate object unless it's already been set.
(package private) void	updateUserNameField()

Methods inherited from class jmri.jmrix.AbstractSerialConnectionConfig

addStandardDetails, 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

Constructor Details

ConnectionConfig

public ConnectionConfig(SerialPortAdapter p)

Create a connection configuration with a preexisting adapter. This is used principally when loading a configuration that defines this connection.

Parameters:

p - the adapter to create a connection configuration for

ConnectionConfig

public ConnectionConfig()

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

Method Details

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

Overrides:

checkInitDone in class AbstractSerialConnectionConfig

updateUserNameField

void updateUserNameField()

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

name

public abstract String name()

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 abstract void setInstance()

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

Specified by:

setInstance in class AbstractSerialConnectionConfig