Script logger

The ScriptLogger is an interface which logs informations and errors during the script execution. The logger is accessible by the logger field.

It is possible to set a custom logger by ScriptWrapper.setScriptLogger(ScriptLogger).

Th script logger is available through the logger field in your script. For example:

   public void apply() {
      logger.append("Some text");
   }

Logger API

The logger has the following regular methods:

• Some methods allow to append a message in the logger
• Some methods allow to append an hyperlink in the logger
• Some methods allow to append an error message in the logger
• Some methods allow to manage the tab for the messages

General logger methods

The following methods are general to the logger:

• The ScriptLogger.setLoggerTitle(String) set the title of the logger window
• The ScriptLogger.setStatusMessage(String) set the message on the progress bar of the logger window
• The ScriptLogger.setProgress(float) set the progress value on the progress bar of the logger window (maximu is 100)

Append a message

The following methods allow to append a message in the logger:

• The ScriptLogger.newLine() method appends a new line
• The ScriptLogger.append(String) method appends a line of text, with a default color
• The ScriptLogger.append(String, String) method appends a line of text, with a specified html color

Log content with hyperlinks

The methods allow to append an hyperlink:

• The ScriptLogger.appendLink(String, String) method appends a line of text, with an associated link reference, and a default color
• The ScriptLogger.appendLink(String, String, String) method appends a line of text, with an associated link reference, and a specified html color
• The ScriptLogger.appendLinks(String, List) method appends a line of text, with a list of link references, and a default color
• The ScriptLogger.appendLinks(String, List, String) method appends a line of text, with a list of link references, and a specified html color

Append an error message

The following methods allow to append an error message:

• The ScriptLogger.appendError(String) method appends an error message
• The ScriptLogger.appendError(Throwable) method appends the StackTrace of a Throwable. By default defer to appendError(String) method with the error message
• The ScriptLogger.appendStackTrace(Throwable) method appends the StackTrace of a Throwable

Managing the tabs

The following methods allow to manage the tabs:

• The ScriptLogger.setTab(int) method sets the current value for of the tab for the text. All subsequent lines will be presented with a tab of tabs
• The ScriptLogger.clearTab() method clear the current value of the tab for the text. All subsequent lines will be presented without tab
• The ScriptLogger.getTab() method return the String representing the current String value of the tab

Swing implementation

There is a Swing utility class which implements the Script logger interface.