vegas.logging.targets.LineFormattedTarget

	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
		separator : String = " " The separator string.	LineFormattedTarget

Public Methods

	Method		Defined by
		LineFormattedTarget(bGlobal:Boolean = false, sChannel:String = null) Creates a new LineFormattedTarget instance.	LineFormattedTarget
		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.	LineFormattedTarget
		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.	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

Property detail

includeCategory

property

public var includeCategory:Boolean = false

Indicates if the category for this target should added to the trace.

includeDate

property

public var includeDate:Boolean = false

Indicates if the date should be added to the trace.

includeLevel

property

public var includeLevel:Boolean = false

Indicates if the level for the event should added to the trace.

includeLines

property

public var includeLines:Boolean = false

Indicates if the line for the event should added to the trace.

includeMilliseconds

property

public var includeMilliseconds:Boolean = false

Indicates if the milliseconds should be added to the trace. Only relevant when includeTime is true.

includeTime

property

public var includeTime:Boolean = false

Indicates if the time should be added to the trace.

separator

property

public var separator:String = " "

The separator string.

Constructor detail

LineFormattedTarget

()

constructor

public function LineFormattedTarget(bGlobal:Boolean = false, sChannel:String = null)

Creates a new LineFormattedTarget instance.

Parameters

	`bGlobal:Boolean` (default = `false`) — the flag to use a global event flow or a local event flow.

	`sChannel:String` (default = `null`) — the name of the global event flow if the `bGlobal` argument is `true`.

Method detail

formatDate

()

method

protected function formatDate(d:Date):String

This method format the passed Date in arguments.

Parameters

d:Date

Returns

String

formatLevel

()

method

protected function formatLevel(level:String):String

This method format the passed level in arguments.

Parameters

level:String

Returns

String

formatLines

()

method

protected function formatLines():String

This method format the current line value.

Returns

String

formatMessage

()

method

protected 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

formatTime

()

method

protected function formatTime(d:Date):String

This method format the current Date passed in argument.

Parameters

d:Date

Returns

String

getDigit

()

method

protected function getDigit(n:Number):String

Returns the string representation of a number and use digit conversion.

Parameters

n:Number

Returns

String

internalLog

()

method

public 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`

logEvent

()

method

public override function logEvent(event:LogEvent):void

This method handles a LogEvent from an associated logger. A target uses this method to translate the event into the appropriate format for transmission, storage, or display. This method will be called only if the event's level is in range of the target's level.

Parameters

event:LogEvent

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

Package	vegas.logging.targets
Class	public class LineFormattedTarget
Inheritance	LineFormattedTarget AbstractTarget CoreEventDispatcher CoreObject
Subclasses	AirLoggerTarget, FireBugTarget, LuminicTarget, SOSTarget, TextFieldTarget, TraceTarget, XPanelTarget