Package adams.scripting.responsehandler

Class LogTextBoxResponseHandler

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.scripting.responsehandler.ResponseHandler, Serializable
    public class LogTextBoxResponseHandler
extends adams.scripting.responsehandler.AbstractResponseHandler
    For logging responses.
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected LogTextBox m_Log
      the log to use.

      • Fields inherited from class adams.scripting.responsehandler.AbstractResponseHandler

        m_Enabled, m_Owner

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void displayErrorMessage​(adams.scripting.command.RemoteCommandWithErrorMessage cmd)
      Displays the error message.
      LogTextBox getLog()
      Returns the log in use.
      String globalInfo()
      Returns a string describing the object.
      void responseFailed​(adams.scripting.command.RemoteCommand cmd, String msg)
      Handles failed responses.
      void responseSuccessful​(adams.scripting.command.RemoteCommand cmd)
      Handles successful responses.
      void setLog​(LogTextBox value)
      Sets the log to use.

      • Methods inherited from class adams.scripting.responsehandler.AbstractResponseHandler

        defineOptions, enabledTipText, getEnabled, getOwner, insertHandler, setEnabled, setOwner

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_Log

        protected LogTextBox m_Log
        the log to use.

    • Constructor Detail

      • LogTextBoxResponseHandler

        public LogTextBoxResponseHandler()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • setLog

        public void setLog​(LogTextBox value)
        Sets the log to use.
        Parameters:
        value - the log

      • getLog

        public LogTextBox getLog()
        Returns the log in use.
        Returns:
        the log

      • displayErrorMessage

        protected void displayErrorMessage​(adams.scripting.command.RemoteCommandWithErrorMessage cmd)
        Displays the error message.
        Parameters:
        cmd - the command

      • responseSuccessful

        public void responseSuccessful​(adams.scripting.command.RemoteCommand cmd)
        Handles successful responses.
        Parameters:
        cmd - the command with the response

      • responseFailed

        public void responseFailed​(adams.scripting.command.RemoteCommand cmd,
                           String msg)
        Handles failed responses.
        Parameters:
        cmd - the command with the response
        msg - message, can be null