Class jsTracer

Object
   |
   +--jsTracer

class jsTracer


jsTracer serves as a simple but powerful JavaScript logging, tracing and debugging tool. When used in conjunction with JavaScript debuggers such as Venkman or even Microsoft's Visual Studio, jsTracer will improve your JavaScript authoring and debugging experience. It is especially helpful with cross browser JavaScript development as it allows you to trace or log messages and then compare method calls and sequencing. I've found it to be very helpful with those elusive and hard to find cross browser JavaScript discrepancies.
Defined in jsTracer.js


Field Summary
<private>  jsTracer _master
          The master or top most jsTracer object.
<private>  Array _queue
          An array of messages that have been queued for tracing prior to jsTracer fully initializing (which happens on load).
<private>  Boolean _stackTraceEnabled
          Indicates if stack collection is enabled.
 Integer. count
          The number of messages written.
 Boolean defined
          Indicates if the jsTracer object has been prototyped or defined.
 Boolean enabled
          Indicates if jsTracer is enabled.
 Integer maxSize
          The maximum number of messages to keep in the tracer array.
 Object MessageType
          An enum listing the available message types.
 
Constructor Summary
jsTracer ()
            The jsTracer object constructor.
 
Method Summary
 <private>  String _getFunctionHTML(<Function> func)
           Builds an HTML string for function definitions.
 <private>  String _getRandomRGB()
           Returns a random RGB color string for use in CSS.
 <private>  void _updateStackTraceOption(checked)
           Supporting GUI function for checking the stack option checkbox.
 <private>  void _write(<String> message, <jsTracer.MessageType> messageType, <String> css, <Array> stack)
           This is kind of a go between write function.
 <private>  void _writeReal(<String> message, <jsTracer.MessageType> messageType, <String> css, <Array> stack)
           Writes a message to the trace log.
 void addEventListener(obj, eventName, listener)
           Cross browser way of adding an event listener.
 void changeView(<jsTracer.MessageType> messageType)
           This is the filter that controls which messages are visible in the trace window.
 void clear()
           Clears the log and the trace window if tracing is turned on.
 void close(<Event> event)
           Closes the trace window.
 void disableStackTrace()
           Disables stack trace collection.
 void enableStackTrace()
           Enables stack trace collection.
 void filterChanged(<Event> event)
           Changes the message filter.
 Element getHeader()
           Gets the header element in the trace window.
 Element getMessageContainer()
           Gets the message container element in the trace window.
 jsTracer getTopTracer()
           Gets the top most tracer object, the one that belongs to the top frame inserted by jsTracer.
 CSSStyleSheet getTracerStyleSheet()
           Returns the CSS style sheet used to style the trace window.
 Window getWindow()
           Returns the window that owns the jsTracer object.
 void hideContextMenu(<Event> event)
           Hides the context menu after a brief pause.
 void hideContextMenuImmediate(<Event> event)
           Hides the context menu.
 void highlightMessage(<Element> message, <String> color)
           Highlights a message in the trace viewer.
 void highlightMessageClicked(<Event> event)
           Event handler wired to the click event that highlights messages in the trace viewer.
 void init()
           Initializes jsTracer.
 void messageClicked(<Event> event)
           Handler for the click event on messages
 Object prepMessage(<String> message)
           Prepares a message for tracing.
 void removeContextMenu()
          
 void removeEventListener(obj, eventName, listener)
           Cross browser way of removing event listeners.
 void removeHighlight(<Element> message)
           Removes highlighting from a message.
 void removeHighlightClicked(<Event> event)
           Event handler wired to the click that removes highlights from messages.
 void setViewerOpacity(<Integer> opacity)
           Sets the opacity level of the view window.
 Object showContextMenu(<Event> event)
           Shows the context menu.
 void showStackTrace(<Event> event)
           Pops up a window that shows the stack trace for the current trace message.
 void toggleEnable(<Event> event)
           Toggles the enable/disable feature.
 void toggleStackTrace(<Element> el)
           Toggles the stack trace option.
 void write(<String> message, <jsTracer.MessageType> messageType, <String> css)
           Writes a message to the trace log.

Field Detail

_master

<private> jsTracer _master

_queue

<private> Array _queue

_stackTraceEnabled

<private> Boolean _stackTraceEnabled

count

Integer. count

defined

Boolean defined

enabled

Boolean enabled

maxSize

Integer maxSize

MessageType

Object MessageType

Constructor Detail

jsTracer

jsTracer()

Method Detail

_getFunctionHTML

 <private> String _getFunctionHTML(<Function> func)

_getRandomRGB

 <private> String _getRandomRGB()

_updateStackTraceOption

 <private> void _updateStackTraceOption(checked)

_write

 <private> void _write(<String> message, <jsTracer.MessageType> messageType, <String> css, <Array> stack)

_writeReal

 <private> void _writeReal(<String> message, <jsTracer.MessageType> messageType, <String> css, <Array> stack)

addEventListener

void addEventListener(obj, eventName, listener)

changeView

void changeView(<jsTracer.MessageType> messageType)

clear

void clear()

close

void close(<Event> event)

disableStackTrace

void disableStackTrace()

enableStackTrace

void enableStackTrace()

filterChanged

void filterChanged(<Event> event)

getHeader

Element getHeader()

getMessageContainer

Element getMessageContainer()

getTopTracer

jsTracer getTopTracer()

getTracerStyleSheet

CSSStyleSheet getTracerStyleSheet()

getWindow

Window getWindow()

hideContextMenu

void hideContextMenu(<Event> event)

hideContextMenuImmediate

void hideContextMenuImmediate(<Event> event)

highlightMessage

void highlightMessage(<Element> message, <String> color)

highlightMessageClicked

void highlightMessageClicked(<Event> event)

init

void init()

messageClicked

void messageClicked(<Event> event)

prepMessage

Object prepMessage(<String> message)

removeContextMenu

void removeContextMenu()

removeEventListener

void removeEventListener(obj, eventName, listener)

removeHighlight

void removeHighlight(<Element> message)

removeHighlightClicked

void removeHighlightClicked(<Event> event)

setViewerOpacity

void setViewerOpacity(<Integer> opacity)

showContextMenu

Object showContextMenu(<Event> event)

showStackTrace

void showStackTrace(<Event> event)

toggleEnable

void toggleEnable(<Event> event)

toggleStackTrace

void toggleStackTrace(<Element> el)

write

void write(<String> message, <jsTracer.MessageType> messageType, <String> css)


Documentation generated by JSDoc on Fri Jun 23 00:24:30 2006