Package jmri.jmrix
Class AbstractUsbConnectionConfig
- java.lang.Object
-
- jmri.jmrix.AbstractConnectionConfig
-
- jmri.jmrix.AbstractUsbConnectionConfig
-
- All Implemented Interfaces:
ConnectionConfig
- Direct Known Subclasses:
AnymaDMX_ConnectionConfig
public abstract class AbstractUsbConnectionConfig extends AbstractConnectionConfig
Abstract base class for common implementation of the ConnectionConfig
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) class
AbstractUsbConnectionConfig.ComboBoxRenderer
-
Nested classes/interfaces inherited from class jmri.jmrix.AbstractConnectionConfig
AbstractConnectionConfig.Option
-
-
Field Summary
Fields Modifier and Type Field Description protected UsbPortAdapter
adapter
protected boolean
init
(package private) java.lang.String
invalidPort
(package private) java.util.List<java.lang.String>
newList
(package private) java.util.List<java.lang.String>
originalList
protected UserPreferencesManager
p
protected javax.swing.JComboBox<java.lang.String>
portBox
protected javax.swing.JLabel
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 AbstractUsbConnectionConfig()
Ctor for a functional object with no preexisting adapter.AbstractUsbConnectionConfig(UsbPortAdapter p)
Create a connection configuration with a preexisting adapter.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected int
addStandardDetails(boolean incAdvanced, int i)
protected void
checkInitDone()
Complete connection adapter initialization, adding desired options to the Connection Configuration pane.void
dispose()
Done with this ConnectionConfig object.UsbPortAdapter
getAdapter()
java.lang.String
getConnectionName()
boolean
getDisabled()
java.lang.String
getInfo()
java.lang.String
getManufacturer()
protected java.util.List<java.lang.String>
getPortNames()
boolean
isPortAdvanced()
void
loadDetails(javax.swing.JPanel details)
Load the Swing widgets needed to configure this connection into a specified JPanel.void
refreshPortBox()
void
setDisabled(boolean disabled)
void
setManufacturer(java.lang.String manufacturer)
protected void
showAdvancedItems()
void
updateAdapter()
protected static void
updateUsbPortNames(java.lang.String portName, javax.swing.JComboBox<java.lang.String> portCombo, java.util.List<java.lang.String> portList)
Handle friendly port names.-
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
name
-
-
-
-
Field Detail
-
adapter
protected UsbPortAdapter adapter
-
init
protected boolean init
-
p
protected UserPreferencesManager p
-
portBox
protected javax.swing.JComboBox<java.lang.String> portBox
-
portBoxLabel
protected javax.swing.JLabel portBoxLabel
-
newList
java.util.List<java.lang.String> newList
-
originalList
java.util.List<java.lang.String> originalList
-
invalidPort
java.lang.String invalidPort
-
-
Constructor Detail
-
AbstractUsbConnectionConfig
public AbstractUsbConnectionConfig(UsbPortAdapter 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
-
AbstractUsbConnectionConfig
public AbstractUsbConnectionConfig()
Ctor for a functional object with no preexisting adapter. Expect that the subclass setInstance() will fill the adapter member.
-
-
Method Detail
-
getAdapter
public UsbPortAdapter getAdapter()
-
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 classAbstractConnectionConfig
-
updateAdapter
public void updateAdapter()
- Specified by:
updateAdapter
in classAbstractConnectionConfig
-
getInfo
public java.lang.String getInfo()
- Specified by:
getInfo
in interfaceConnectionConfig
- Specified by:
getInfo
in classAbstractConnectionConfig
-
refreshPortBox
public void refreshPortBox()
-
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 interfaceConnectionConfig
- Specified by:
loadDetails
in classAbstractConnectionConfig
- Parameters:
details
- the specific Swing object to be configured and filled
-
showAdvancedItems
protected void showAdvancedItems()
- Specified by:
showAdvancedItems
in classAbstractConnectionConfig
-
addStandardDetails
protected int addStandardDetails(boolean incAdvanced, int i)
-
isPortAdvanced
public boolean isPortAdvanced()
-
getManufacturer
public java.lang.String getManufacturer()
- Specified by:
getManufacturer
in interfaceConnectionConfig
- Specified by:
getManufacturer
in classAbstractConnectionConfig
-
setManufacturer
public void setManufacturer(java.lang.String manufacturer)
- Specified by:
setManufacturer
in interfaceConnectionConfig
- Specified by:
setManufacturer
in classAbstractConnectionConfig
-
getDisabled
public boolean getDisabled()
- Specified by:
getDisabled
in interfaceConnectionConfig
- Specified by:
getDisabled
in classAbstractConnectionConfig
-
setDisabled
public void setDisabled(boolean disabled)
- Specified by:
setDisabled
in interfaceConnectionConfig
- Specified by:
setDisabled
in classAbstractConnectionConfig
-
getConnectionName
public java.lang.String getConnectionName()
- Specified by:
getConnectionName
in interfaceConnectionConfig
- Specified by:
getConnectionName
in classAbstractConnectionConfig
-
dispose
public void dispose()
Description copied from interface:ConnectionConfig
Done with this ConnectionConfig object. Invoked inJmrixConfigPane
when switching away from this particular mode.- Specified by:
dispose
in interfaceConnectionConfig
- Overrides:
dispose
in classAbstractConnectionConfig
-
updateUsbPortNames
protected static void updateUsbPortNames(java.lang.String portName, javax.swing.JComboBox<java.lang.String> portCombo, java.util.List<java.lang.String> portList)
Handle friendly port names. Note that this changes the selection in portCombo, so that should be tracked after this returns.- Parameters:
portName
- The currently-selected port nameportCombo
- The combo box that's displaying the available portsportList
- The list of valid (unfriendly) port names
-
getPortNames
@Nonnull protected java.util.List<java.lang.String> getPortNames()
-
-