vegas.logging.targets.XPanelTarget

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
		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
		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
		name : String The name of the connection	XPanelTarget
		separator : String = " " The separator string.	LineFormattedTarget

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		XPanelTarget(name:String = "unknow") Creates a new XPanelTarget instance.	XPanelTarget
		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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	CoreEventDispatcher
		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.	XPanelTarget
		isLocked():Boolean Returns `true` if the object is locked.	CoreEventDispatcher
		lock():void Locks the object.	CoreEventDispatcher
		logEvent(event:LogEvent):void This method handles a `LogEvent` from an associated logger.	LineFormattedTarget
		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
		setLogger(log:ILogger = null):void Sets the internal `ILogger` reference of this `ILogable` object.	CoreObject
		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.	XPanelTarget
		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
		CONNECTION_ID : String = "_xpanel1" [static] The id of the LocalConnection.	XPanelTarget
		DISPATCH_MESSAGE : String = "dispatchMessage" [static] The dispatch message label.	XPanelTarget
		LEVEL_ALL : uint = 0x00 [static] The 'all' level value of the XPanel console.	XPanelTarget
		LEVEL_DEBUG : uint = 0x0001 [static] The 'debug' level value of the XPanel console.	XPanelTarget
		LEVEL_ERROR : uint = 0x0008 [static] The 'error' level value of the XPanel console.	XPanelTarget
		LEVEL_FATAL : uint = 0x0010 [static] The 'fatal' level value of the XPanel console.	XPanelTarget
		LEVEL_INFORMATION : uint = 0x0002 [static] The 'information' level value of the XPanel console.	XPanelTarget
		LEVEL_NONE : Number = 0xFF [static] The 'none' level value of the XPanel console.	XPanelTarget
		LEVEL_START : uint = 0x0100 [static] The 'start' level value of the XPanel console.	XPanelTarget
		LEVEL_WARNING : uint = 0x0004 [static] The 'warning' level value of the XPanel console.	XPanelTarget
		START : String = "Started" [static] The started value.	XPanelTarget

Property detail

name

property

public var name:String

The name of the connection

Constructor detail

XPanelTarget

()

constructor

public function XPanelTarget(name:String = "unknow")

Creates a new XPanelTarget instance.

Parameters

name:String (default = "unknow")

Method detail

formatMessage

()

method

protected override function formatMessage(message:*, level:String, category:String, date:Date):String

This method format the log message.

Parameters

	`message:*`

	`level:String`

	`category:String`

	`date:Date`

Returns

String

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`

Constant detail

CONNECTION_ID

constant

public static const CONNECTION_ID:String = "_xpanel1"

The id of the LocalConnection.

DISPATCH_MESSAGE

constant

public static const DISPATCH_MESSAGE:String = "dispatchMessage"

The dispatch message label.

LEVEL_ALL

constant

public static const LEVEL_ALL:uint = 0x00

The 'all' level value of the XPanel console.

LEVEL_DEBUG

constant

public static const LEVEL_DEBUG:uint = 0x0001

The 'debug' level value of the XPanel console.

LEVEL_ERROR

constant

public static const LEVEL_ERROR:uint = 0x0008

The 'error' level value of the XPanel console.

LEVEL_FATAL

constant

public static const LEVEL_FATAL:uint = 0x0010

The 'fatal' level value of the XPanel console.

LEVEL_INFORMATION

constant

public static const LEVEL_INFORMATION:uint = 0x0002

The 'information' level value of the XPanel console.

LEVEL_NONE

constant

public static const LEVEL_NONE:Number = 0xFF

The 'none' level value of the XPanel console.

LEVEL_START

constant

public static const LEVEL_START:uint = 0x0100

The 'start' level value of the XPanel console.

LEVEL_WARNING

constant

public static const LEVEL_WARNING:uint = 0x0004

The 'warning' level value of the XPanel console.

START

constant

public static const START:String = "Started"

The started value.

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

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