Package jmri.jmrix

Class AbstractStreamConnectionConfig

java.lang.Object

jmri.jmrix.AbstractConnectionConfig

jmri.jmrix.AbstractStreamConnectionConfig

All Implemented Interfaces:

ConnectionConfig, StreamConnectionConfig

Direct Known Subclasses:

DCCppStreamConnectionConfig, LnStreamConnectionConfig, RfidStreamConnectionConfig, SprogCSStreamConnectionConfig, XNetStreamConnectionConfig, Z21XNetConnectionConfig

public abstract class AbstractStreamConnectionConfig
extends AbstractConnectionConfig
implements StreamConnectionConfig

Abstract base class for common implementation of the Stream Port ConnectionConfig

Nested Class Summary

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

AbstractConnectionConfig.Option

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractStreamPortController	adapter
protected boolean	init

Fields inherited from class jmri.jmrix.AbstractConnectionConfig

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

Constructor Summary

Constructors

Constructor	Description
AbstractStreamConnectionConfig()	Ctor for a functional object with no preexisting adapter.
AbstractStreamConnectionConfig(AbstractStreamPortController 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.
void	dispose()	Done with this ConnectionConfig object.
AbstractStreamPortController	getAdapter()
java.lang.String	getConnectionName()
boolean	getDisabled()
java.lang.String	getInfo()
java.lang.String	getManufacturer()
void	loadDetails(javax.swing.JPanel details)	Load the Swing widgets needed to configure this connection into a specified JPanel.
void	setDisabled(boolean disabled)
void	setManufacturer(java.lang.String manufacturer)
protected void	showAdvancedItems()
void	updateAdapter()

Methods inherited from class jmri.jmrix.AbstractConnectionConfig

addNameEntryCheckers, addStandardDetails, isDirty, isRestartRequired, register, setInstance

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

isDirty, isRestartRequired, name, register

Field Detail

init

protected boolean init

adapter

protected AbstractStreamPortController adapter

Constructor Detail

AbstractStreamConnectionConfig

public AbstractStreamConnectionConfig(AbstractStreamPortController 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

AbstractStreamConnectionConfig

public AbstractStreamConnectionConfig()

Ctor for a functional object with no preexisting adapter. Expect that the subclass setInstance() will fill the adapter member.

Method Detail

getAdapter

public AbstractStreamPortController getAdapter()

Specified by:

getAdapter in interface ConnectionConfig

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

getInfo

public java.lang.String getInfo()

This implementation always returns the localized value for "none".

Specified by:

getInfo in interface ConnectionConfig

Specified by:

getInfo in class AbstractConnectionConfig

Returns:

the localized value for "none"

loadDetails

public void loadDetails(javax.swing.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

getManufacturer

public java.lang.String getManufacturer()

Specified by:

getManufacturer in interface ConnectionConfig

Specified by:

getManufacturer in class AbstractConnectionConfig

setManufacturer

public void setManufacturer(java.lang.String manufacturer)

Specified by:

setManufacturer in interface ConnectionConfig

Specified by:

setManufacturer in class AbstractConnectionConfig

getConnectionName

public java.lang.String getConnectionName()

Specified by:

getConnectionName in interface ConnectionConfig

Specified by:

getConnectionName 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

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