org.scripthelper.swing.debug

Class SwingDebugScriptWindow

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.scripthelper.swing.AbstractSwingScriptLogger

org.scripthelper.swing.debug.SwingDebugScriptWindow

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.TreeExpansionListener, javax.swing.RootPaneContainer, javax.swing.WindowConstants, ScriptLogger, DebugListener, ScriptExceptionListener, SwingScriptLogger

public class SwingDebugScriptWindow
extends AbstractSwingScriptLogger
implements ScriptExceptionListener, DebugListener, javax.swing.event.TreeExpansionListener

A Swing debug script window.

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
static java.lang.String	CONTINUE_TOOLTIP The key for the continue tooltip.
static java.lang.String	END_TOOLTIP The key for the end tooltip.
static java.lang.String	STEP_TOOLTIP The key for the step tooltip.

Fields inherited from class org.scripthelper.swing.AbstractSwingScriptLogger

area, progressBar

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.exceptions.ScriptExceptionListener

STATE_ABORTED, STATE_ERROR, STATE_OK

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
SwingDebugScriptWindow() Constructor with a default title and size.
SwingDebugScriptWindow(int editorRows, int areaRows) Constructor with a default title.
SwingDebugScriptWindow(java.lang.String title, int editorRows, int areaRows) Constructor.

Method Summary

Modifier and Type	Method and Description
void	aborted(java.lang.String message) Fired when an abort is encountered.
boolean	addBreakpoint(int lineNumber) Add a breakpoint for a line number, or change the breakpoint to a step.
void	addDebugSession(DebugSession<?> session) Set the debug session.
void	editBreakpoint(Breakpoint breakpoint, java.lang.String expressionAsString) Edit a breakpoint for a line number.
void	endSession() Called when the session has ended.
java.util.Map<java.lang.Integer,Breakpoint>	getBreakpoints() Return the breakpoints.
java.util.Set<java.lang.Integer>	getBrokens() Return the line numbers for broken breakpoints.
int	getCurrentStep() Return the current line.
short	getScriptState() Return the state of the listener since the last execution.
protected java.lang.String	getTooltip(java.lang.String key) Return the tooltip for the button defined by a specified key.
protected void	init() Initialize the window.
protected void	initializeHTMLContent() Initialize the HTML content.
void	installScript(ScriptSource source, ScriptWrapper wrapper) Called when a script is installed.
boolean	isScriptInstalled(ScriptSource source) Return true if the script associated with a specified source has already been installed.
void	notified(java.lang.String message, char errorType, java.lang.Throwable th) Fired when any exception is encountered.
void	notifiedFirst(ScriptRuntimeException exception, char errorType, java.lang.String extension) Fired when the first exception is encountered while executing a script.
void	resetState() Reset the state of the script listener.
void	setScriptLogger(ScriptLogger logger) Set the script logger.
void	step(DebugSession<?> session, Step step) Apply a step.
void	treeCollapsed(javax.swing.event.TreeExpansionEvent event)
void	treeExpanded(javax.swing.event.TreeExpansionEvent event)
protected void	visitHyperLink(java.lang.String linkDesc) Visit an hyperlink.

Methods inherited from class org.scripthelper.swing.AbstractSwingScriptLogger

acceptNullObjectLinks, append, append, appendArrayLinks, appendColorArrayLinks, appendError, appendLink, appendLink, appendLinks, appendObjectLink, appendObjectLink, appendObjectLinks, appendObjectLinks, appendObjectLinks, clear, clearTab, createYesNoPanel, doPrint, doPrintImpl, getHyperLinkListener, getLines, getLinkIndexConverter, getPrintDirectory, getTab, getTabImpl, initializeTextArea, newLine, registerHyperLinkListener, registerLinkIndexConverter, setLoggerTitle, setProgress, setStatusMessage, setTab

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.exceptions.ScriptExceptionListener

resetWrapperOnDispose

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

STEP_TOOLTIP

public static final java.lang.String STEP_TOOLTIP

The key for the step tooltip.

See Also:

Constant Field Values

CONTINUE_TOOLTIP

public static final java.lang.String CONTINUE_TOOLTIP

The key for the continue tooltip.

See Also:

Constant Field Values

END_TOOLTIP

public static final java.lang.String END_TOOLTIP

The key for the end tooltip.

See Also:

Constant Field Values

Constructor Detail

SwingDebugScriptWindow

public SwingDebugScriptWindow()

Constructor with a default title and size.

SwingDebugScriptWindow

public SwingDebugScriptWindow(int editorRows,
                              int areaRows)

Constructor with a default title.

Parameters:

editorRows - the number of rows for the editor

areaRows - the number of rows for the output and variables area

SwingDebugScriptWindow

public SwingDebugScriptWindow(java.lang.String title,
                              int editorRows,
                              int areaRows)

Constructor.

Parameters:

title - the window title

editorRows - the number of rows for the editor

areaRows - the number of rows for the output and variables area

Method Detail

getCurrentStep

public int getCurrentStep()

Return the current line.

Returns:

the current line

getBreakpoints

public java.util.Map<java.lang.Integer,Breakpoint> getBreakpoints()

Return the breakpoints.

Returns:

the breakpoints

getBrokens

public java.util.Set<java.lang.Integer> getBrokens()

Return the line numbers for broken breakpoints.

Returns:

the line numbers

editBreakpoint

public void editBreakpoint(Breakpoint breakpoint,
                           java.lang.String expressionAsString)

Edit a breakpoint for a line number.

Parameters:

breakpoint - the breakpoint

expressionAsString - the expression to use for the breakpoint

addBreakpoint

public boolean addBreakpoint(int lineNumber)

Add a breakpoint for a line number, or change the breakpoint to a step.

Parameters:

lineNumber - the line number

Returns:

true if the breakpoint could be added

setScriptLogger

public void setScriptLogger(ScriptLogger logger)

Set the script logger. Do nothing.

Specified by:

setScriptLogger in interface ScriptExceptionListener

Parameters:

logger - the script logger

installScript

public void installScript(ScriptSource source,
                          ScriptWrapper wrapper)

Called when a script is installed.

Specified by:

installScript in interface DebugListener

Parameters:

source - the script source

wrapper - the ScriptWrapper

isScriptInstalled

public boolean isScriptInstalled(ScriptSource source)

Return true if the script associated with a specified source has already been installed.

Specified by:

isScriptInstalled in interface DebugListener

Parameters:

source - the source

Returns:

true if the script associated with a specified source has already been installed

getScriptState

public short getScriptState()

Return the state of the listener since the last execution.

Specified by:

getScriptState in interface ScriptExceptionListener

Returns:

the state of the listener since the last execution

aborted

public void aborted(java.lang.String message)

Fired when an abort is encountered.

Specified by:

aborted in interface ScriptExceptionListener

Parameters:

message - the abort message

notified

public void notified(java.lang.String message,
                     char errorType,
                     java.lang.Throwable th)

Fired when any exception is encountered.

Specified by:

notified in interface ScriptExceptionListener

Parameters:

message - the message

th - the Throwable

errorType - the error type

See Also:

ErrorType

notifiedFirst

public void notifiedFirst(ScriptRuntimeException exception,
                          char errorType,
                          java.lang.String extension)

Fired when the first exception is encountered while executing a script.

Specified by:

notifiedFirst in interface ScriptExceptionListener

Parameters:

exception - the ScriptException

extension - the language extension

errorType - the error type

See Also:

ErrorType

resetState

public void resetState()

Reset the state of the script listener.

Specified by:

resetState in interface ScriptExceptionListener

endSession

public void endSession()

Called when the session has ended.

Specified by:

endSession in interface DebugListener

addDebugSession

public void addDebugSession(DebugSession<?> session)

Set the debug session.

Specified by:

addDebugSession in interface DebugListener

Parameters:

session - the debug session

step

public void step(DebugSession<?> session,
                 Step step)

Apply a step.

Specified by:

step in interface DebugListener

Parameters:

session - the Debug session

step - the step

treeExpanded

public void treeExpanded(javax.swing.event.TreeExpansionEvent event)

Specified by:

treeExpanded in interface javax.swing.event.TreeExpansionListener

treeCollapsed

public void treeCollapsed(javax.swing.event.TreeExpansionEvent event)

Specified by:

treeCollapsed in interface javax.swing.event.TreeExpansionListener

getTooltip

protected java.lang.String getTooltip(java.lang.String key)

Return the tooltip for the button defined by a specified key. Return null by default, which means that a default tooltip text will be provided.

Parameters:

key - the key

Returns:

the tooltip

initializeHTMLContent

protected void initializeHTMLContent()

Initialize the HTML content.

Overrides:

initializeHTMLContent in class AbstractSwingScriptLogger

visitHyperLink

protected void visitHyperLink(java.lang.String linkDesc)

Visit an hyperlink.

Overrides:

visitHyperLink in class AbstractSwingScriptLogger

Parameters:

linkDesc - the hyperlink description

init

protected void init()

Initialize the window.

Specified by:

init in class AbstractSwingScriptLogger