org.scripthelper.context

Interface ScriptLogger

All Known Subinterfaces:

SwingScriptLogger

All Known Implementing Classes:

AbstractSwingScriptLogger, DefaultScriptLogger, DefaultSwingScriptLogger, DefaultSwingScriptLoggerArea, SwingDebugScriptWindow

public interface ScriptLogger

The Script logger interface.

Method Summary

Modifier and Type	Method and Description
default void	acceptNullObjectLinks(boolean accept) Specifies if the logger must accept objects which generate null links from LinkIndexConverter.getLinkFromObject(java.lang.Object).
void	append(java.lang.String txt) Append a line of text, with a default color.
void	append(java.lang.String txt, java.lang.String htmlColor) Append a line of text, with a specific color.
default void	appendArrayLinks(java.lang.String txt, java.lang.String... linkIDs) Append a hyperlinked line of text in the message area, with a default color.
default void	appendColorArrayLinks(java.lang.String txt, java.lang.String htmlColor, java.lang.String... linkIDs) Append a hyperlinked line of text in the message area, with a default color.
void	appendError(java.lang.String message) Append an error.
default void	appendError(java.lang.Throwable th) Append an error.
default void	appendLink(java.lang.String txt, java.lang.String linkID) Append a hyperlinked line of text in the message area, with a default color.
default void	appendLink(java.lang.String txt, java.lang.String linkID, java.lang.String htmlColor) Append a hyperlinked line of text in the message area, with a specific color.
default void	appendLinks(java.lang.String txt, java.util.List<java.lang.String> linkIDs) Append a hyperlinked line of text in the message area, with a default color.
default void	appendLinks(java.lang.String txt, java.util.List<java.lang.String> linkIDs, java.lang.String htmlColor) Append a hyperlinked line of text in the message area, with a specified color.
default void	appendObjectLink(HyperlinkElement element) Append a hyperlinked line of text in the message area, with a default color.
default void	appendObjectLink(HyperlinkElement element, java.lang.String htmlColor) Append a hyperlinked line of text in the message area, with a specific color.
default void	appendObjectLinks(java.lang.String txt, HyperlinkElement... links) Append a hyperlinked line of text in the message area, with a default color.
default void	appendObjectLinks(java.lang.String txt, java.util.List<HyperlinkElement> links) Append a hyperlinked line of text in the message area, with a default color.
default void	appendObjectLinks(java.lang.String txt, java.util.List<HyperlinkElement> links, java.lang.String htmlColor) Append a hyperlinked line of text in the message area, with a specified color.
default void	appendObjectLinks(java.lang.String txt, java.lang.String htmlColor, HyperlinkElement... links) Append a hyperlinked line of text in the message area, with a specified color.
default void	appendStackTrace(java.lang.Throwable th) Append a StackTrace.
default void	clear() Clear the content of the logger.
default void	clearTab() Clear the current value of the tab for the text.
default void	finishedScript() Called at the end of the script.
default java.lang.String	getTab() Return the tab as a text content.
default void	newLine() Append a new line.
default void	registerHyperLinkListener(ScriptLoggerHyperLinkListener hyperlinkListener) Register the listener which will be fired when an hyperlink is visited.
default void	registerLinkIndexConverter(LinkIndexConverter converter) Register the class which will convert Objects to and from link indexes.
default void	setLoggerTitle(java.lang.String title) Set the title of the logger area.
default void	setProgress(float value) Set the value of the script progression.
default void	setStatusMessage(java.lang.String message) Set the message of the logger status bar.
default void	setTab(int tabs) Set the current value for of the tab for the text.

Method Detail

setLoggerTitle

default void setLoggerTitle(java.lang.String title)

Set the title of the logger area. Do nothing by default.

Parameters:

title - the title

setStatusMessage

default void setStatusMessage(java.lang.String message)

Set the message of the logger status bar. Do nothing by default.

Parameters:

message - the message

newLine

default void newLine()

Append a new line.

append

void append(java.lang.String txt)

Append a line of text, with a default color.

Parameters:

txt - the text

append

void append(java.lang.String txt,
            java.lang.String htmlColor)

Append a line of text, with a specific color.

Parameters:

txt - the text

htmlColor - the HTML color to use for the text

appendLink

default void appendLink(java.lang.String txt,
                        java.lang.String linkID)

Append a hyperlinked line of text in the message area, with a default color.

Parameters:

txt - the text

linkID - the hyperlink ID

appendObjectLink

default void appendObjectLink(HyperlinkElement element)

Append a hyperlinked line of text in the message area, with a default color.

Parameters:

element - the hyperlink associated element

appendLinks

default void appendLinks(java.lang.String txt,
                         java.util.List<java.lang.String> linkIDs)

Append a hyperlinked line of text in the message area, with a default color.

Parameters:

txt - the text

linkIDs - the hyperlinks IDs

appendArrayLinks

default void appendArrayLinks(java.lang.String txt,
                              java.lang.String... linkIDs)

Append a hyperlinked line of text in the message area, with a default color.

Parameters:

txt - the text

linkIDs - the hyperlinks IDs

appendObjectLinks

default void appendObjectLinks(java.lang.String txt,
                               java.util.List<HyperlinkElement> links)

Append a hyperlinked line of text in the message area, with a default color.

Parameters:

txt - the text

links - the hyperlinks elements

appendObjectLinks

default void appendObjectLinks(java.lang.String txt,
                               HyperlinkElement... links)

Append a hyperlinked line of text in the message area, with a default color.

Parameters:

txt - the text

links - the hyperlinks elements

appendLinks

default void appendLinks(java.lang.String txt,
                         java.util.List<java.lang.String> linkIDs,
                         java.lang.String htmlColor)

Append a hyperlinked line of text in the message area, with a specified color.

Parameters:

txt - the text

linkIDs - the hyperlinks IDs

htmlColor - the color

appendColorArrayLinks

default void appendColorArrayLinks(java.lang.String txt,
                                   java.lang.String htmlColor,
                                   java.lang.String... linkIDs)

Append a hyperlinked line of text in the message area, with a default color.

Parameters:

txt - the text

htmlColor - the html color

linkIDs - the hyperlinks IDs

appendObjectLinks

default void appendObjectLinks(java.lang.String txt,
                               java.util.List<HyperlinkElement> links,
                               java.lang.String htmlColor)

Append a hyperlinked line of text in the message area, with a specified color.

Parameters:

txt - the text

links - the hyperlinks

htmlColor - the html color

appendObjectLinks

default void appendObjectLinks(java.lang.String txt,
                               java.lang.String htmlColor,
                               HyperlinkElement... links)

Append a hyperlinked line of text in the message area, with a specified color.

Parameters:

txt - the text

links - the hyperlinks

htmlColor - the color

appendLink

default void appendLink(java.lang.String txt,
                        java.lang.String linkID,
                        java.lang.String htmlColor)

Append a hyperlinked line of text in the message area, with a specific color.

Parameters:

txt - the text

linkID - the hyperlink ID

htmlColor - the HTML color to use for the text

appendObjectLink

default void appendObjectLink(HyperlinkElement element,
                              java.lang.String htmlColor)

Append a hyperlinked line of text in the message area, with a specific color.

Parameters:

element - the hyperlink element

htmlColor - the HTML color to use for the text

appendError

void appendError(java.lang.String message)

Append an error.

Parameters:

message - the error message

appendError

default void appendError(java.lang.Throwable th)

Append an error.

Parameters:

th - the Throwable

appendStackTrace

default void appendStackTrace(java.lang.Throwable th)

Append a StackTrace.

Parameters:

th - the Throwable

acceptNullObjectLinks

default void acceptNullObjectLinks(boolean accept)

Specifies if the logger must accept objects which generate null links from LinkIndexConverter.getLinkFromObject(java.lang.Object).

Parameters:

accept - true if the logger must accept objects which generate null links

registerLinkIndexConverter

default void registerLinkIndexConverter(LinkIndexConverter converter)

Register the class which will convert Objects to and from link indexes. Do nothing by default.

Parameters:

converter - the link index converter

registerHyperLinkListener

default void registerHyperLinkListener(ScriptLoggerHyperLinkListener hyperlinkListener)

Register the listener which will be fired when an hyperlink is visited. No nothing by default.

Parameters:

hyperlinkListener - the listener

clearTab

default void clearTab()

Clear the current value of the tab for the text. All subsequent lines will be presented without tab. Do nothing by default.

getTab

default java.lang.String getTab()

Return the tab as a text content. Return an empty String by default.

Returns:

the tab

setTab

default void setTab(int tabs)

Set the current value for of the tab for the text. All subsequent lines will be presented with a tab of tabs. Do nothing by default.

Parameters:

tabs - the current value for of the tab for the text

clear

default void clear()

Clear the content of the logger. Do nothing by default.

setProgress

default void setProgress(float value)

Set the value of the script progression. Do nothing by default.

Parameters:

value - the value

finishedScript

default void finishedScript()

Called at the end of the script. Do nothing by default.