Package jmri.jmrit.logixng.implementation.swing

Class DefaultModuleSwing

java.lang.Object

jmri.jmrit.logixng.swing.AbstractSwingConfigurator

jmri.jmrit.logixng.implementation.swing.DefaultModuleSwing

All Implemented Interfaces:

Comparable<SwingConfiguratorInterface>, SwingConfiguratorInterface

public class DefaultModuleSwing
extends AbstractSwingConfigurator

Configures an DefaultModule object with a Swing JPanel.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) ModuleParametersTableModel	_moduleParametersTableModel
protected JPanel	panel
(package private) static final ResourceBundle	rbx

Constructor Summary

Constructors

Constructor	Description
DefaultModuleSwing()

Method Summary

Modifier and Type	Method	Description
MaleSocket	createNewObject(String systemName, String userName)	Create a new object with the data entered.This method must also register the object in its manager.
protected void	createPanel(Base object, JPanel buttonPanel)
void	dispose()	Dispose the panel and remove all the listeners that this class may have registered.
void	executeEvaluate(Base object)	Execute or evaluate an item that this object configures.
String	getAutoSystemName()	Create a new system name.
JPanel	getConfigPanel(JPanel buttonPanel)	Get a configuration panel when a new object is to be created and we don't have it yet.
JPanel	getConfigPanel(Base object, JPanel buttonPanel)	Get a configuration panel for an object.
String	getExampleSystemName()	Get an example of a system name
String	getExecuteEvaluateMenuText()	Get the menu text for execute/evaluate.
BaseManager<? extends NamedBean>	getManager()	Get the manager that handles the beans for the new object.
String	toString()	Returns the name of the class that this class configures.
void	updateObject(Base object)	Updates the object with the data in the form.
boolean	validate(List<String> errorMessages)	Validate the form.

Methods inherited from class jmri.jmrit.logixng.swing.AbstractSwingConfigurator

getAllSymbols, getJDialog, setJDialog

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jmri.jmrit.logixng.swing.SwingConfiguratorInterface

canClose, compareTo, setDefaultValues

Field Details

rbx

static final ResourceBundle rbx

panel

protected JPanel panel

_moduleParametersTableModel

ModuleParametersTableModel _moduleParametersTableModel

Constructor Details

DefaultModuleSwing

public DefaultModuleSwing()

Method Details

getExecuteEvaluateMenuText

public String getExecuteEvaluateMenuText()

Get the menu text for execute/evaluate.

Specified by:

getExecuteEvaluateMenuText in interface SwingConfiguratorInterface

Overrides:

getExecuteEvaluateMenuText in class AbstractSwingConfigurator

Returns:

the menu text

executeEvaluate

public void executeEvaluate(@Nonnull
 Base object)

Execute or evaluate an item that this object configures.

Specified by:

executeEvaluate in interface SwingConfiguratorInterface

Overrides:

executeEvaluate in class AbstractSwingConfigurator

Parameters:

object - the object to execute or evaluate

getManager

public BaseManager<? extends NamedBean> getManager()

Get the manager that handles the beans for the new object. This is used for validation of the system name for the bean that this class creates.

Returns:

the manager

getConfigPanel

public JPanel getConfigPanel(@Nonnull
 JPanel buttonPanel)
                      throws IllegalArgumentException

Get a configuration panel when a new object is to be created and we don't have it yet. This method initializes the panel with an empty configuration.

Parameters:

buttonPanel - panel with the buttons

Returns:

a panel that configures this object

Throws:

IllegalArgumentException - if this class does not support the class with the name given in parameter 'className'

getConfigPanel

public JPanel getConfigPanel(@Nonnull
 Base object,
 @Nonnull
 JPanel buttonPanel)
                      throws IllegalArgumentException

Get a configuration panel for an object. This method initializes the panel with the configuration of the object.

Parameters:

object - the object for which to return a configuration panel

buttonPanel - panel with the buttons

Returns:

a panel that configures this object

Throws:

IllegalArgumentException - when needed

getExampleSystemName

public String getExampleSystemName()

Get an example of a system name

Returns:

the system name

getAutoSystemName

public String getAutoSystemName()

Create a new system name.

Returns:

a new system name

createPanel

protected void createPanel(@CheckForNull
 Base object,
 @Nonnull
 JPanel buttonPanel)

validate

public boolean validate(@Nonnull
 List<String> errorMessages)

Validate the form.

The parameter errorMessage is used to give the error message in case of an error. If there are errors, the error messages is added to the list errorMessage.

Parameters:

errorMessages - the error messages in case of an error

Returns:

true if data in the form is valid, false otherwise

createNewObject

public MaleSocket createNewObject(@Nonnull
 String systemName,
 @CheckForNull
 String userName)

Create a new object with the data entered.This method must also register the object in its manager.

Parameters:

systemName - system name

userName - user name

Returns:

a male socket for the new object

updateObject

public void updateObject(@Nonnull
 Base object)

Updates the object with the data in the form.

Parameters:

object - the object to update

toString

public String toString()

Returns the name of the class that this class configures.

Specified by:

toString in interface SwingConfiguratorInterface

Overrides:

toString in class Object

Returns:

the name of the class this class configures.

dispose

public void dispose()

Description copied from interface: SwingConfiguratorInterface

Dispose the panel and remove all the listeners that this class may have registered.