Swing Script logger

The DefaultSwingScriptLogger class is a swing implementation of the ScriptLogger.

Overview

There are two Swing utility classes which implement the Script logger interface:

• The DefaultSwingScriptLogger is a JFrame
• The DefaultSwingScriptLoggerArea is a JComponent

To show the logs in a Swing window, just use the following after creating the ScriptWrapper:

   ScriptWrapper<Script> wrapper = new GroovyScriptWrapper() {
   }
   ...
   DefaultSwingScriptLogger() logger = new DefaultSwingScriptLogger();
   wrapper.setScriptLogger(logger);

Swing logger methods

General logger methods

The following methods have an implementation in the Swing 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 (maximum is 100)

Log content with hyperlinks

The Swing implementation of the Script logger has methods which allow to show hyperlinked content.

Hyperlinks can show only one lilnk for a message. For example:

   int i = 0;
   public void process(TreeElement element) {
      i++;
      String linkID = >the link ID generated from the element>
      logger.appendLink("the element " + i, linkID);
   }      

It is also possible to show more than one link for one message. For example:

   public void process(TreeElement element1, TreeElement element2) {
      HyperlinkElement linkElt1 = new HyperlinkElement(element1.name, element1);
      HyperlinkElement linkElt2 = new HyperlinkElement(element2.name, element2);      
      logger.appendObjectLinks("The elements are %1 and %2", linkElt1, linkElt2);
   }     

Managing the tabs

The Swing implementation of the Script logger will automatically append tabulation characters (  ) for the logger area before the messages. You don't need to use the ScriptLogger.getTab() method to use the tabs. For example in the following code the tabs will be

   ScriptWrapper<Script> wrapper = new GroovyScriptWrapper() {
   }
   ...
   DefaultSwingScriptLogger() logger = new DefaultSwingScriptLogger();
   wrapper.setScriptLogger(logger); // set the Swing script logger
   wrapper.installScript(file); // install the script
      
   logger.append("Parent");
   logger.setTab(1);
   logger.append("Child 1");
   logger.append("Child 2");
   logger.setTab(2);
   logger.append("Grandchild");