Package jmri.jmrit.logixng.actions.swing

Class ActionSetReporterSwing

java.lang.Object

jmri.jmrit.logixng.swing.AbstractSwingConfigurator

jmri.jmrit.logixng.actions.swing.AbstractDigitalActionSwing

jmri.jmrit.logixng.actions.swing.ActionSetReporterSwing

All Implemented Interfaces:

Comparable<SwingConfiguratorInterface>, SwingConfiguratorInterface

public class ActionSetReporterSwing
extends AbstractDigitalActionSwing

Configures an ActionSetReporter object with a Swing JPanel.

Field Summary

Fields inherited from class jmri.jmrit.logixng.actions.swing.AbstractDigitalActionSwing

panel

Constructor Summary

Constructors

Constructor	Description
ActionSetReporterSwing()

Method Summary

Modifier and Type	Method	Description
boolean	canClose()	Is the SWI ready to be closed?
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.
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.
void	validateDataSection(ActionSetReporter action, List<String> errorMessages)

Methods inherited from class jmri.jmrit.logixng.actions.swing.AbstractDigitalActionSwing

executeEvaluate, getAutoSystemName, getConfigPanel, getConfigPanel, getExampleSystemName, getExecuteEvaluateMenuText, getManager

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

compareTo, setDefaultValues

Constructor Details

ActionSetReporterSwing

public ActionSetReporterSwing()

Method Details

createPanel

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

Specified by:

createPanel in class AbstractDigitalActionSwing

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

validateDataSection

public void validateDataSection(@Nonnull
 ActionSetReporter action,
 @Nonnull
 List<String> errorMessages)

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.

canClose

public boolean canClose()

Is the SWI ready to be closed?

Returns:

true if the SWI is ready to be closed, false otherwise.

dispose

public void dispose()

Description copied from interface: SwingConfiguratorInterface

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