org.scripthelper.swing

Class AbstractSwingScriptLogger

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.scripthelper.swing.AbstractSwingScriptLogger

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, ScriptLogger, SwingScriptLogger

Direct Known Subclasses:

DefaultSwingScriptLogger, SwingDebugScriptWindow

public abstract class AbstractSwingScriptLogger
extends javax.swing.JFrame
implements SwingScriptLogger

Presents a scrollable logging text area for Script messages.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFrame

javax.swing.JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

java.awt.Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected StylableSizableArea	area The area.
protected javax.swing.JProgressBar	progressBar The progress bar. it is null by default.

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface org.scripthelper.swing.SwingScriptLogger

CLEAR_KEY, OK_KEY, PRINT_KEY, SEARCH_KEY

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
AbstractSwingScriptLogger() Constructor.
AbstractSwingScriptLogger(boolean hasProgressBar) Constructor.
AbstractSwingScriptLogger(java.lang.String title) Constructor.
AbstractSwingScriptLogger(java.lang.String title, boolean hasProgressBar) Constructor.

Method Summary

Modifier and Type	Method and Description
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 text) Append a line of text in the message area, with a default color.
void	append(java.lang.String txt, java.lang.String htmlColor) Append a line of text in the message area, with a specific color.
void	appendArrayLinks(java.lang.String txt, java.lang.String... linkIDs) Append a hyperlinked line of text in the message area, with a default color.
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 txt) Append a line of text in the message area, colored in red (for errors).
void	appendLink(java.lang.String txt, java.lang.String linkID) Append a hyperlinked line of text in the message area, with a default color.
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.
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.
void	appendObjectLink(HyperlinkElement element) Append a hyperlinked line of text in the message area, with a default color.
void	appendObjectLink(HyperlinkElement element, java.lang.String htmlColor) Append a hyperlinked line of text in the message area, with a specific color.
void	appendObjectLinks(java.lang.String txt, HyperlinkElement... links) Append a hyperlinked line of text in the message area, with a specified color.
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.
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.
void	clear() Clear the content of the logger
void	clearTab() Clear the current value of the tab for the text.
protected javax.swing.JPanel	createYesNoPanel() Create a Panel with a OK and a print buttons.
protected void	doPrint() Print the content of the panel as html.
protected void	doPrintImpl(java.io.File file) Perform the html printing.
ScriptLoggerHyperLinkListener	getHyperLinkListener() Return the listener which will be fired when an hyperlink is visited.
java.util.List<java.lang.String>	getLines() Return the list of currently logger lines.
LinkIndexConverter	getLinkIndexConverter() Return class which will convert Objects to and from link indexes.
protected java.io.File	getPrintDirectory() Return the default directory to use for printing the area content.
java.lang.String	getTab() Return the tab that can be usage for a text content.
protected java.lang.String	getTabImpl() Return the tab.
protected abstract void	init() Initialize the logger.
protected void	initializeHTMLContent() Initialize the HTML content.
protected void	initializeTextArea() Initialize the text area.
void	newLine() Append a new line.
void	registerHyperLinkListener(ScriptLoggerHyperLinkListener hyperlinkListener) Register the listener which will be fired when an hyperlink is visited.
void	registerLinkIndexConverter(LinkIndexConverter converter) Register the class which will convert Objects to and from link indexes.
void	setLoggerTitle(java.lang.String title) Set the title of the logger area.
void	setProgress(float value) Set the value of the progress bar.
void	setStatusMessage(java.lang.String message) Set the message of the logger status bar.
void	setTab(int tabs) Set the current value for of the tab for the text.
protected void	visitHyperLink(java.lang.String linkDesc) Visit an hyperlink.

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.scripthelper.swing.SwingScriptLogger

doGetLabel, getLabel

Methods inherited from interface org.scripthelper.context.ScriptLogger

appendError, appendLinks, appendObjectLinks, appendStackTrace, finishedScript

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

area

protected StylableSizableArea area

The area.

progressBar

protected javax.swing.JProgressBar progressBar

The progress bar. it is null by default.

Constructor Detail

AbstractSwingScriptLogger

public AbstractSwingScriptLogger()

Constructor.

AbstractSwingScriptLogger

public AbstractSwingScriptLogger(java.lang.String title)

Constructor.

Parameters:

title - the window title

AbstractSwingScriptLogger

public AbstractSwingScriptLogger(boolean hasProgressBar)

Constructor.

Parameters:

hasProgressBar - true if there must be a progress bar

AbstractSwingScriptLogger

public AbstractSwingScriptLogger(java.lang.String title,
                                 boolean hasProgressBar)

Constructor.

Parameters:

title - the window title

hasProgressBar - true if there must be a progress bar

Method Detail

init

protected abstract void init()

Initialize the logger.

setLoggerTitle

public void setLoggerTitle(java.lang.String title)

Set the title of the logger area.

Specified by:

setLoggerTitle in interface ScriptLogger

Parameters:

title - the title

setStatusMessage

public void setStatusMessage(java.lang.String message)

Set the message of the logger status bar.

Specified by:

setStatusMessage in interface ScriptLogger

Parameters:

message - the message

registerLinkIndexConverter

public void registerLinkIndexConverter(LinkIndexConverter converter)

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

Specified by:

registerLinkIndexConverter in interface ScriptLogger

Parameters:

converter - the link index converter

getLinkIndexConverter

public LinkIndexConverter getLinkIndexConverter()

Return class which will convert Objects to and from link indexes.

Returns:

the link index converter

acceptNullObjectLinks

public void acceptNullObjectLinks(boolean accept)

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

Specified by:

acceptNullObjectLinks in interface ScriptLogger

Parameters:

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

registerHyperLinkListener

public void registerHyperLinkListener(ScriptLoggerHyperLinkListener hyperlinkListener)

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

Specified by:

registerHyperLinkListener in interface ScriptLogger

Parameters:

hyperlinkListener - the listener

getHyperLinkListener

public ScriptLoggerHyperLinkListener getHyperLinkListener()

Return the listener which will be fired when an hyperlink is visited.

Returns:

the listener

initializeTextArea

protected void initializeTextArea()

Initialize the text area.

visitHyperLink

protected void visitHyperLink(java.lang.String linkDesc)

Visit an hyperlink.

Parameters:

linkDesc - the hyperlink description

getLines

public java.util.List<java.lang.String> getLines()

Return the list of currently logger lines.

Returns:

the list of currently logger lines

initializeHTMLContent

protected void initializeHTMLContent()

Initialize the HTML content.

clear

public void clear()

Clear the content of the logger

Specified by:

clear in interface ScriptLogger

newLine

public void newLine()

Append a new line.

Specified by:

newLine in interface ScriptLogger

append

public void append(java.lang.String text)

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

Specified by:

append in interface ScriptLogger

Parameters:

text - the text

append

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

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

Specified by:

append in interface ScriptLogger

Parameters:

txt - the text

htmlColor - the HTML color to use for the text

appendLink

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

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

Specified by:

appendLink in interface ScriptLogger

Parameters:

txt - the text

linkID - the hyperlink ID

appendObjectLink

public void appendObjectLink(HyperlinkElement element)

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

Specified by:

appendObjectLink in interface ScriptLogger

Parameters:

element - the hyperlink element

appendLink

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

Specified by:

appendLink in interface ScriptLogger

Parameters:

txt - the text

linkID - the hyperlink ID

htmlColor - the HTML color to use for the text

appendObjectLink

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

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

Specified by:

appendObjectLink in interface ScriptLogger

Parameters:

element - the hyperlink element

htmlColor - the HTML color to use for the text

appendArrayLinks

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

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

Specified by:

appendArrayLinks in interface ScriptLogger

Parameters:

txt - the text

linkIDs - the hyperlinks IDs

appendLinks

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

Specified by:

appendLinks in interface ScriptLogger

Parameters:

txt - the text

linkIDs - the hyperlinks IDs

htmlColor - the color

appendColorArrayLinks

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

Specified by:

appendColorArrayLinks in interface ScriptLogger

Parameters:

txt - the text

htmlColor - the html color

linkIDs - the hyperlinks IDs

appendObjectLinks

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

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

Specified by:

appendObjectLinks in interface ScriptLogger

Parameters:

txt - the text

links - the hyperlinks Objects

appendObjectLinks

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

Specified by:

appendObjectLinks in interface ScriptLogger

Parameters:

txt - the text

links - the hyperlinks Objects

htmlColor - the color

appendObjectLinks

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

Specified by:

appendObjectLinks in interface ScriptLogger

Parameters:

txt - the text

links - the hyperlinks Objects

htmlColor - the color

appendError

public void appendError(java.lang.String txt)

Append a line of text in the message area, colored in red (for errors).

Specified by:

appendError in interface ScriptLogger

Parameters:

txt - the text

getTabImpl

protected java.lang.String getTabImpl()

Return the tab.

Returns:

the tab

getTab

public java.lang.String getTab()

Return the tab that can be usage for a text content. Return an empty String by default.

Specified by:

getTab in interface ScriptLogger

Returns:

the tab

clearTab

public void clearTab()

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

Specified by:

clearTab in interface ScriptLogger

setTab

public 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

Specified by:

setTab in interface ScriptLogger

Parameters:

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

setProgress

public void setProgress(float value)

Set the value of the progress bar.

Specified by:

setProgress in interface ScriptLogger

Parameters:

value - the value

createYesNoPanel

protected javax.swing.JPanel createYesNoPanel()

Create a Panel with a OK and a print buttons.

Returns:

the panel

getPrintDirectory

protected java.io.File getPrintDirectory()

Return the default directory to use for printing the area content.

Returns:

the directory

doPrint

protected void doPrint()

Print the content of the panel as html.

doPrintImpl

protected void doPrintImpl(java.io.File file)
                    throws java.io.IOException

Perform the html printing.

Parameters:

file - the file where to put the html content

Throws:

java.io.IOException - if an IOException is thrown