Class com.sekati.log.Out

Description

Out is a multi-tiered trace replacement which uses debug levels and object/instance filters to assist and clarify the debugging process. New level method calls can be created dynamically "overloading" the class via __resolve and proxy. 

 Usage:
 var out:Out = Out.getInstance();
 out.createPanel(640,480); // optionally create an outPanel in the swf
 out.trace(this,"hello world"); // simple hello world
 out.setFilter(this,true); // filters this object from further output
 out.info(this,"hello world"); // wont display due to filter
 out.setFilter(this,false); // unfilter this object
 out.setLevel("trace",false); // disable level trace
 out.trace(this,"hello world"); // wont display due to disabled level
 out.setLevel("debug",true); // creates a new level named "debug" & enable it
 out.debug(this,"hello world"); // displays within the new debug level
 out.object(this,{foo:5, bar:1}); // special object level does basic object recursion

Field Index

$, _status, enabled, error, fatal, info, status, trace, warn

Method Index

benchmark(), createPanel(), getFilters(), getInstance(), getLevels(), isFiltered(), object(), reset(), resetFilters(), setAllLevels(), setFilter(), setLevel()

Field Detail

trace

public trace:Function

info

public info:Function

status

public status:Function

warn

public warn:Function

error

public error:Function

fatal

public fatal:Function

$

static public $:Out [Read Only]
shorthand singleton accessor getter

enabled

public enabled:Boolean
Out enabled getter

_status

public _status:String [Read Only]
level and filter _status getter

Method Detail

getInstance

static public function getInstance():Out

Singleton Accessor

Return

Out

createPanel

public function createPanel(w:Number, h:Number):Void

wrapper to draw a panel to swf for output via OutPanel

Parameters

w(Number) panel width
h(Number) panel height

Return

Void

reset

public function reset():Void

reset Out to default levels and filters

Return

Void

setLevel

public function setLevel(level:String, isEnabled:Boolean):Void

set a levels enabled status or create a new level

Parameters

level(String) level name
isEnabled(Boolean)

Return

Void

setAllLevels

public function setAllLevels(isEnabled:Boolean):Void

set all levels status

Parameters

isEnabled(Boolean)

Return

Void

getLevels

public function getLevels():String

returns a string of all levels for overview/status purposes

Return

String

setFilter

public function setFilter(origin:Object, isFiltered:Boolean):Void

set a filters enabled status or create a new filter

Parameters

origin(Object) object to set filter on
isFiltered(Boolean)

Return

Void

getFilters

public function getFilters():String

return a string of all filters for overview/status purposes

Return

String

resetFilters

public function resetFilters():Void

reset all filters

isFiltered

public function isFiltered(origin:Object):Boolean

object

public function object(origin:Object, obj:Object):Void

object is a special level (method) which handles object recursion via Inspector

Parameters

origin(Object) origin for filtering purposes
obj(Object) object to be recursed thru Out

Return

Void

benchmark

public function benchmark(origin:Object, msg:String, mode:String):Void

benchmark is a special level (method) which handles benchmarking of call execution

Parameters

origin(Object) origin for filtering purposes
msg(String) any extraneous name or message info you wish to output before the benchmark results
mode(String) valid modes are: "start", "stop", "lap"

Return

Void

Throws

Erroron invalid 'mode' argument
as2api