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:
Comparable<SwingConfiguratorInterface>, SwingConfiguratorInterface
Direct Known Subclasses:
DebuggerMaleAnalogActionSocketSwing, DebuggerMaleAnalogExpressionSocketSwing, DebuggerMaleDigitalActionSocketSwing, DebuggerMaleDigitalBooleanActionSocketSwing, DebuggerMaleDigitalExpressionSocketSwing, DebuggerMaleStringActionSocketSwing, DebuggerMaleStringExpressionSocketSwing
public abstract class AbstractDebuggerMaleSocketSwing extends AbstractSwingConfigurator
Abstract class for SwingConfiguratorInterface

  • Constructor Details

  • Method Details

    • 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 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 final 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

    • createPanel

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

    • validate

      public final 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

    • createSubPanel

      protected JPanel createSubPanel(@CheckForNull Base object, @Nonnull 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 List<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 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 final void updateObject(@Nonnull Base object)
      Updates the object with the data in the form.
      Parameters:
      object - the object to update

    • 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

    • 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 final void dispose()
      Description copied from interface: SwingConfiguratorInterface
      Dispose the panel and remove all the listeners that this class may have registered.