Package jmri.jmrit.logixng.tools.debugger.swing

Class AbstractDebuggerMaleSocketSwing

java.lang.Object

jmri.jmrit.logixng.swing.AbstractSwingConfigurator

jmri.jmrit.logixng.tools.debugger.swing.AbstractDebuggerMaleSocketSwing

All Implemented Interfaces:

java.lang.Comparable<SwingConfiguratorInterface>, SwingConfiguratorInterface

Direct Known Subclasses:

DebuggerMaleAnalogActionSocketSwing, DebuggerMaleAnalogExpressionSocketSwing, DebuggerMaleDigitalActionSocketSwing, DebuggerMaleDigitalBooleanActionSocketSwing, DebuggerMaleDigitalExpressionSocketSwing, DebuggerMaleStringActionSocketSwing, DebuggerMaleStringExpressionSocketSwing

public abstract class AbstractDebuggerMaleSocketSwing
extends AbstractSwingConfigurator

Abstract class for SwingConfiguratorInterface

Constructor Summary

Constructors

Constructor	Description
AbstractDebuggerMaleSocketSwing()

Method Summary

Modifier and Type	Method	Description
MaleSocket	createNewObject(java.lang.String systemName, java.lang.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, javax.swing.JPanel buttonPanel)
protected javax.swing.JPanel	createSubPanel(Base object, javax.swing.JPanel buttonPanel)	The sub class may override this method to add more detail to the panel.
void	dispose()	Dispose the panel and remove all the listeners that this class may have registered.
java.lang.String	getAutoSystemName()	Create a new system name.
javax.swing.JPanel	getConfigPanel(javax.swing.JPanel buttonPanel)	Get a configuration panel when a new object is to be created and we don't have it yet.
javax.swing.JPanel	getConfigPanel(Base object, javax.swing.JPanel buttonPanel)	Get a configuration panel for an object.
java.lang.String	getExampleSystemName()	Get an example of a system name
BaseManager<? extends NamedBean>	getManager()	Get the manager that handles the beans for the new object.
java.lang.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(java.util.List<java.lang.String> errorMessages)	Validate the form.
boolean	validateSubPanel(java.util.List<java.lang.String> errorMessages)	If the sub class overrides createSubPanel(), it may use this method to validate the sub panel.

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

executeEvaluate, getAllSymbols, getExecuteEvaluateMenuText, 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

Constructor Detail

AbstractDebuggerMaleSocketSwing

public AbstractDebuggerMaleSocketSwing()

Method Detail

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 final javax.swing.JPanel getConfigPanel(@Nonnull
                                               javax.swing.JPanel buttonPanel)
                                        throws java.lang.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:

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

getConfigPanel

public final javax.swing.JPanel getConfigPanel(@Nonnull
                                               Base object,
                                               @Nonnull
                                               javax.swing.JPanel buttonPanel)
                                        throws java.lang.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:

java.lang.IllegalArgumentException - when needed

createPanel

protected final void createPanel(@CheckForNull
                                 Base object,
                                 @Nonnull
                                 javax.swing.JPanel buttonPanel)

validate

public final boolean validate(@Nonnull
                              java.util.List<java.lang.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

createSubPanel

protected javax.swing.JPanel createSubPanel(@CheckForNull
                                            Base object,
                                            @Nonnull
                                            javax.swing.JPanel buttonPanel)

The sub class may override this method to add more detail to the panel.

Parameters:

object - the object for which to return a configuration panel

buttonPanel - panel with the buttons

Returns:

a panel that configures this object

validateSubPanel

public boolean validateSubPanel(@Nonnull
                                java.util.List<java.lang.String> errorMessages)

If the sub class overrides createSubPanel(), it may use this method to validate the sub panel.

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
                                  java.lang.String systemName,
                                  @CheckForNull
                                  java.lang.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 final void updateObject(@Nonnull
                               Base object)

Updates the object with the data in the form.

Parameters:

object - the object to update

getExampleSystemName

public java.lang.String getExampleSystemName()

Get an example of a system name

Returns:

the system name

getAutoSystemName

public java.lang.String getAutoSystemName()

Create a new system name.

Returns:

a new system name

toString

public java.lang.String toString()

Returns the name of the class that this class configures.

Specified by:

toString in interface SwingConfiguratorInterface

Overrides:

toString in class java.lang.Object

Returns:

the name of the class this class configures.

dispose

public final void dispose()

Description copied from interface: SwingConfiguratorInterface

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