vegas.logging.targets.AirLoggerTarget

Public Properties

	Property		Defined by
		channel : String Indicates the channel of this dispatcher if this instance is global.	CoreEventDispatcher
		charPlacement : String = "'*' must be the right most character." [static] The static field used when throws an Error when the character placement failed.	AbstractTarget
		charsInvalid : String = "The following characters are not valid: []~$^&/(){}<>+=_-`!@#%?,:;'\" [static] The static field used when throws an Error when a character is invalid.	AbstractTarget
		DEFAULT_ID_IN : String = "" [static] The default id in value.	AirLoggerTarget
		errorFilter : String = "Error for filter ''{0}'" [static] The static field used when throws an Error when filter failed.	AbstractTarget
		filters : Array (read-write) Returns the filters array representation of this target.	AbstractTarget
		includeCategory : Boolean = false Indicates if the category for this target should added to the trace.	LineFormattedTarget
		includeDate : Boolean = false Indicates if the date should be added to the trace.	LineFormattedTarget
		includeLevel : Boolean = false Indicates if the level for the event should added to the trace.	LineFormattedTarget
		includeLines : Boolean = false Indicates if the line for the event should added to the trace.	LineFormattedTarget
		includeMilliseconds : Boolean = false Indicates if the milliseconds should be added to the trace.	LineFormattedTarget
		includeTime : Boolean = false Indicates if the time should be added to the trace.	LineFormattedTarget
		INFO : Number = 20000 [static] Designates informational messages that highlight the progress of the application at coarse-grained level with the AirLogger console (20000).	AirLoggerTarget
		IN_SUFFIX : String = "_OUT" [static] The 'out' connection suffix.	AirLoggerTarget
		isGlobal : Boolean (read-only) Returns the value of the isGlobal flag of this model.	CoreEventDispatcher
		level : LogEventLevel (read-write) Returns the level of this target.	AbstractTarget
		OUT_SUFFIX : String = "_IN" [static] The 'in' connection suffix.	AirLoggerTarget
		separator : String = " " The separator string.	LineFormattedTarget
		SET_TAB_NAME : String = "setTabName" [static] The id who indicates if the tab name of the current application must change this name.	AirLoggerTarget
		WARN : Number = 30000 [static] Designates events that could be harmful to the application operation with the AirLogger console (30000).	AirLoggerTarget

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		AirLoggerTarget(name:String = "", autoClear:Boolean = false, bGlobal:Boolean = false, sChannel:String = null) Creates a new AirLoggerTarget instance.	AirLoggerTarget
		addCategory(category:String):Boolean Insert a category in the fllters if this category don't exist.	AbstractTarget
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0.0, useWeakReference:Boolean = false):void Allows the registration of event listeners on the event target.	CoreEventDispatcher
		addLogger(logger:ILogger):void Sets up this target with the specified logger.	AbstractTarget
		addNamespace(nameSpace:String):Boolean Add a new namespace in the filters array.	AbstractTarget
		clear():void Clear the console.	AirLoggerTarget
		close():void Close the connection with the console.	AirLoggerTarget
		connect():void Connect the target with the console.	AirLoggerTarget
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	CoreEventDispatcher
		focus():void Focus in the console.	AirLoggerTarget
		getAirLoggerMessage(type:String, message:LogEventLevel = null, level:Date = null, date:String = null, sMessageType:* = null):Object Returns the generic object who contains all attributes who defines the AirLogger message to send.	AirLoggerTarget
		getEventDispatcher():EventDispatcher Returns the internal `EventDispatcher` reference.	CoreEventDispatcher
		getIsGlobal():Boolean Returns the value of the isGlobal flag of this model.	CoreEventDispatcher
		getLogger():ILogger Returns the internal `ILogger` reference of this `ILogable` object.	CoreObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	CoreEventDispatcher
		hashCode():uint Returns a hashcode value for the object.	CoreObject
		initEventDispatcher():EventDispatcher Creates and returns the internal `EventDispatcher` reference (this method is invoked in the constructor).	CoreEventDispatcher
		internalLog(message:*, level:LogEventLevel):void Descendants of this class should override this method to direct the specified message to the desired output.	AirLoggerTarget
		isIdentified():Boolean Indicates if the target is isIdentified.	AirLoggerTarget
		isLocked():Boolean Returns `true` if the object is locked.	CoreEventDispatcher
		isRequesting():Boolean Indicates if the target is requesting.	AirLoggerTarget
		lock():void Locks the object.	CoreEventDispatcher
		logEvent(event:LogEvent):void This method handles a `LogEvent` from an associated logger.	LineFormattedTarget
		pingRequest():void Launch the ping request process of the console with this target.	AirLoggerTarget
		registerEventListener(type:String, listener:Boolean, useCapture:int = false, priority:Boolean = 0, useWeakReference:* = false):void Allows the registration of event listeners on the event target (Function or EventListener).	CoreEventDispatcher
		removeCategory(category:String):Boolean Remove a category in the fllters if this category exist.	AbstractTarget
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	CoreEventDispatcher
		removeLogger(logger:ILogger):void Stops this target from receiving events from the specified logger.	AbstractTarget
		removeNamespace(nameSpace:String):Boolean Removes an existing namespace in the filters array.	AbstractTarget
		setEventDispatcher(e:EventDispatcher):void Sets the internal `EventDispatcher` reference.	CoreEventDispatcher
		setGlobal(flag:Boolean = false, channel:String = null):void Sets if the instance use a global `EventDispatcher` to dispatch this events, if the `flag` value is `false` the instance use a local EventDispatcher.	CoreEventDispatcher
		setID(id:String):void Sets the unique id of the target in the console.	AirLoggerTarget
		setLogger(log:ILogger = null):void Sets the internal `ILogger` reference of this `ILogable` object.	CoreObject
		setName(s:String):void Sets the name of the target.	AirLoggerTarget
		toSource(indent:int = 0):String Returns the string representation the source code of the object.	CoreEventDispatcher
		toString():String Returns the string representation of this instance.	CoreObject
		unlock():void Unlocks the display.	CoreEventDispatcher
		unregisterEventListener(type:String, listener:Boolean, useCapture:* = false):void Removes a listener (Function or EventListener object) from the EventDispatcher object.	CoreEventDispatcher
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	CoreEventDispatcher

	Method	Defined by
		formatDate(d:Date):String This method format the passed Date in arguments.	LineFormattedTarget
		formatLevel(level:String):String This method format the passed level in arguments.	LineFormattedTarget
		formatLines():String This method format the current line value.	LineFormattedTarget
		formatMessage(message:*, level:String, category:String, date:Date):String This method format the log message.	LineFormattedTarget
		formatTime(d:Date):String This method format the current Date passed in argument.	LineFormattedTarget
		getDigit(n:Number):String Returns the string representation of a number and use digit conversion.	LineFormattedTarget

	Constant	Defined by
		CLEAR : String = "clear" [static] The id message to clear the console.	AirLoggerTarget
		DEBUG : Number = 10000 [static] Designates informational level messages that are fine grained and most helpful when debugging an application with the AirLogger console (10000).	AirLoggerTarget
		ERROR : Number = 40000 [static] Designates error events that might still allow the application to continue running with the AirLogger console (40000).	AirLoggerTarget
		FATAL : Number = 50000 [static] Designates events that are very harmful and will eventually lead to application failure with the AirLogger console (50000).	AirLoggerTarget
		FOCUS : String = "focus" [static] The 'focus' string representation.	AirLoggerTarget
		ID_ALREADY_USED : String = "idAlreadyUsed" [static] The id who indicates if the id is already used.	AirLoggerTarget
		LOCAL_CONNECTION_ID : String = "_AIRLOGGER_CONSOLE" [static] The local connection id.	AirLoggerTarget
		MAIN_CONNECTION_ALREADY_USED : String = "mainConnectionAlreadyUsed" [static] The 'mainConnectionAlreadyUsed' string representation.	AirLoggerTarget

Property detail

DEFAULT_ID_IN

property

public static var DEFAULT_ID_IN:String = ""

The default id in value.

INFO

property

public static var INFO:Number = 20000

Designates informational messages that highlight the progress of the application at coarse-grained level with the AirLogger console (20000).

IN_SUFFIX

property

public static var IN_SUFFIX:String = "_OUT"

The 'out' connection suffix.

OUT_SUFFIX

property

public static var OUT_SUFFIX:String = "_IN"

The 'in' connection suffix.

SET_TAB_NAME

property

public static var SET_TAB_NAME:String = "setTabName"

The id who indicates if the tab name of the current application must change this name.

WARN

property

public static var WARN:Number = 30000

Designates events that could be harmful to the application operation with the AirLogger console (30000).

Constructor detail

AirLoggerTarget

()

constructor

public function AirLoggerTarget(name:String = "", autoClear:Boolean = false, bGlobal:Boolean = false, sChannel:String = null)

Creates a new AirLoggerTarget instance.

Parameters

	`name:String` (default = "") — the flag to use a global event flow or a local event flow.

	`autoClear:Boolean` (default = `false`) — the name of the global event flow if the `bGlobal` argument is `true`.

	`bGlobal:Boolean` (default = `false`)

	`sChannel:String` (default = `null`)

Method detail

clear

()

method

public function clear():void

Clear the console.

()

method

public function close():void

Close the connection with the console.

connect

()

method

public function connect():void

Connect the target with the console.

focus

()

method

public function focus():void

Focus in the console.

getAirLoggerMessage

()

method

public function getAirLoggerMessage(type:String, message:LogEventLevel = null, level:Date = null, date:String = null, sMessageType:* = null):Object

Returns the generic object who contains all attributes who defines the AirLogger message to send.

Parameters

	`type:String`

	`message:LogEventLevel` (default = `null`)

	`level:Date` (default = `null`)

	`date:String` (default = `null`)

	`sMessageType:*` (default = `null`)

Returns

Object — the generic object who contains all attributes who defines the AirLogger message to send.

internalLog

()

method

public override function internalLog(message:*, level:LogEventLevel):void

Descendants of this class should override this method to direct the specified message to the desired output.

Parameters

	`message:*` — String containing preprocessed log message which may include time, date, category, etc. based on property settings, such as `includeDate`, `includeCategory`, etc.

	`level:LogEventLevel`

isIdentified

()

method

public function isIdentified():Boolean

Indicates if the target is isIdentified.

Returns

Boolean

isRequesting

()

method

public function isRequesting():Boolean

Indicates if the target is requesting.

Returns

Boolean

pingRequest

()

method

public function pingRequest():void

Launch the ping request process of the console with this target.

setID

()

method

public function setID(id:String):void

Sets the unique id of the target in the console.

Parameters

id:String

setName

()

method

public function setName(s:String):void

Sets the name of the target.

Parameters

s:String

Constant detail

CLEAR

constant

public static const CLEAR:String = "clear"

The id message to clear the console.

DEBUG

constant

public static const DEBUG:Number = 10000

Designates informational level messages that are fine grained and most helpful when debugging an application with the AirLogger console (10000).

ERROR

constant

public static const ERROR:Number = 40000

Designates error events that might still allow the application to continue running with the AirLogger console (40000).

FATAL

constant

public static const FATAL:Number = 50000

Designates events that are very harmful and will eventually lead to application failure with the AirLogger console (50000).

FOCUS

constant

public static const FOCUS:String = "focus"

The 'focus' string representation.

ID_ALREADY_USED

constant

public static const ID_ALREADY_USED:String = "idAlreadyUsed"

The id who indicates if the id is already used.

LOCAL_CONNECTION_ID

constant

public static const LOCAL_CONNECTION_ID:String = "_AIRLOGGER_CONSOLE"

The local connection id.

MAIN_CONNECTION_ALREADY_USED

constant

public static const MAIN_CONNECTION_ALREADY_USED:String = "mainConnectionAlreadyUsed"

The 'mainConnectionAlreadyUsed' string representation.

VEGAS AS3 Reference	All Packages \| All Classes \| Index \| Frames No Frames
Class AirLoggerTarget	Properties \| Methods \| Constants

Package	vegas.logging.targets
Class	public class AirLoggerTarget
Inheritance	AirLoggerTarget LineFormattedTarget AbstractTarget CoreEventDispatcher CoreObject