XrayTrace Class

Class com.blitzagency.xray.XrayTrace

Inheritance > XrayTrace

Singleton

XrayTrace is the main logger class for Xray (AdminTool). You can send as many arguments as you like and all objects will be recursed (if necessary) and traced not only in the interface, but in Flash's output panel if you're debugging in the IDE.

Example


 // to create your own instance
 import com.blitzagency.xray.XrayTrace;
 var xrayTrace:XrayTrace = XrayTrace.getInstance();
 xrayTrace.trace("what's my array?", myArray);

 // to use Xray's static property
 import com.blitzagency.xray.Xray;
 Xray.tt("what's my array?", myArray);

Constructor Summary
private	XrayTrace()

Property Summary
static XrayTrace	_instance
Number	_queInterval interval speed to send output back to localConnection
private Number	_recursionCount recursion controller number to keep it from going into a 256 loops error
String	_separator the separator to be used in the trace output. Currently it's "::". IE: (3486) my vars: john :: sally :: joe
private String	_sViewInfo the full output that is broken up and sent back to the interface
private String	_sViewInfoClean clean formatted for Flash IDE/non HTML textboxes \|\| this is actually not being used. currently, all output is passed back without formatting. I'm keeping it here for future use incase there's a breakthrough with displaying large amounts of trace output.
Function	addEventListener
Function	dispatchEvent
private Number	iViewColCount when recursing objects, I indent the nested objects/properties. This is the counter for each time an object is recursed
Number	queInterval
Function	removeEventListener
private Array	sendAry array of broken up trace output to send back to the interface via localConnection
private Number	sendSI sendSI is the interval id for sending data back to the interface
String	separator
String	sViewInfo
String	sViewInfoClean

Method Summary
private Boolean	examine(obj:Object) examine actually does the recursion of objects and builds upon the string to be sent back
static XrayTrace	getInstance()
private	sendData() sends the data chunks back to the interface by dispatching an event "onSendData". LoggerConnection is the only listener right now.
String	trace() loops the arguments sent in. If it finds an object, it sends it off to be examined. If not, it adds it to the string to be returned

Event Summary
	onTrace An event that is triggered when trace information is complete and sent back.

Constructor Detail

XrayTrace

private function XrayTrace()

Property Detail

_instance

public static var _instance:XrayTrace;

_queInterval

public var _queInterval:Number;

_recursionCount

private var _recursionCount:Number;

_separator

public var _separator:String;

_sViewInfo

private var _sViewInfo:String;

_sViewInfoClean

private var _sViewInfoClean:String;

addEventListener

var addEventListener:Function;

dispatchEvent

var dispatchEvent:Function;

iViewColCount

private var iViewColCount:Number;

queInterval

public function get/set queInterval():Number

removeEventListener

var removeEventListener:Function;

sendAry

private var sendAry:Array;

sendSI

private var sendSI:Number;

separator

public function get/set separator():String

sViewInfo

public function get/set sViewInfo():String

sViewInfoClean

public function get/set sViewInfoClean():String

Method Detail

examine

private function examine(obj:Object):Boolean

Parameters:

obj:Object: what to be recursed

Returns:

Boolean when completed, it returns true

getInstance

public static function getInstance():XrayTrace

sendData

private function sendData()

Returns:

trace

public function trace():String

Parameters:

mulitple: arguments can be passed

Returns:

String

Event Detail

onTrace

function onTrace(eventObj)

Returns:

Object with one property: sInfo

Documentation generated by BLDoc Community Edition from B-Line Express.