Package jmri.jmrix
Interface ConnectionConfig
-
- All Known Subinterfaces:
StreamConnectionConfig
- All Known Implementing Classes:
AbstractConnectionConfig
,AbstractDCCppSerialConnectionConfig
,AbstractNetworkConnectionConfig
,AbstractSerialConnectionConfig
,AbstractSimulatorConnectionConfig
,AbstractStreamConnectionConfig
,AbstractUsbConnectionConfig
,AbstractXNetSerialConnectionConfig
,AnymaDMX_ConnectionConfig
,CanisbConnectionConfig
,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
,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
,ConnectionConfig
,ConnectionConfig
,ConnectionConfig
,ConnectionConfig
,ConnectionConfig
,ConnectionConfig
,ConnectionConfig
,ConnectionConfig
,ConnectionConfig
,DCCppStreamConnectionConfig
,IpocsConnectionConfig
,LnStreamConnectionConfig
,MergConnectionConfig
,MqttConnectionConfig
,PiSprog3ConnectionConfig
,PiSprog3PlusConnectionConfig
,PiSprog3v2ConnectionConfig
,RaspberryPiConnectionConfig
,RaspberryPiSimulatorConnectionConfig
,RfidStreamConnectionConfig
,Sprog3PlusConnectionConfig
,SprogCSStreamConnectionConfig
,XNetStreamConnectionConfig
,Z21SimulatorConnectionConfig
,Z21XNetConnectionConfig
public interface ConnectionConfig
Interface for objects that handle configuring a layout connection.General design documentation is available on the Structure of External System Connections page.
- See Also:
JmrixConfigPane
,PortAdapter
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
dispose()
Done with this ConnectionConfig object.PortAdapter
getAdapter()
java.lang.String
getConnectionName()
boolean
getDisabled()
java.lang.String
getInfo()
java.lang.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.void
loadDetails(javax.swing.JPanel details)
Load the Swing widgets needed to configure this connection into a specified JPanel.java.lang.String
name()
void
register()
Register the ConnectionConfig with the running JMRI process.void
setDisabled(boolean disabled)
void
setManufacturer(java.lang.String Manufacturer)
-
-
-
Method Detail
-
name
java.lang.String name()
-
getInfo
java.lang.String getInfo()
-
getAdapter
PortAdapter getAdapter()
-
getConnectionName
java.lang.String getConnectionName()
-
getManufacturer
java.lang.String getManufacturer()
-
setManufacturer
void setManufacturer(java.lang.String Manufacturer)
-
loadDetails
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.- Parameters:
details
- the specific Swing object to be configured and filled
-
register
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}
-
dispose
void dispose()
Done with this ConnectionConfig object. Invoked inJmrixConfigPane
when switching away from this particular mode.
-
getDisabled
boolean getDisabled()
-
setDisabled
void setDisabled(boolean disabled)
-
isDirty
boolean isDirty()
Determine if configuration needs to be written to disk.- Returns:
- true if configuration needs to be saved, false otherwise
-
isRestartRequired
boolean isRestartRequired()
Determine if application needs to be restarted for configuration changes to be applied.- Returns:
- true if application needs to restart, false otherwise
-
-