Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
LineFormattedTarget

Package | mx.logging.targets
Class | public class LineFormattedTarget
Inheritance | LineFormattedTarget AbstractTarget Object
Subclasses | TraceTarget

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

All logger target implementations that have a formatted line style output should extend this class. It provides default behavior for including date, time, category, and level within the output.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | fieldSeparator : String = The separator string to use between fields (the default is " ") | LineFormattedTarget
|  | filters : Array In addition to the level setting, filters are used to provide a psuedo-hierarchical mapping for processing only those events for a given category. | AbstractTarget
|  | id : String [read-only] Provides access to the id of this target. | AbstractTarget
|  | includeCategory : Boolean Indicates if the category for this target should added to the trace. | LineFormattedTarget
|  | includeDate : Boolean Indicates if the date should be added to the trace. | LineFormattedTarget
|  | includeLevel : Boolean Indicates if the level for the event should added to the trace. | LineFormattedTarget
|  | includeTime : Boolean Indicates if the time should be added to the trace. | LineFormattedTarget
|  | level : int Provides access to the level this target is currently set at. | AbstractTarget

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | LineFormattedTarget() Constructor. | LineFormattedTarget
|  | addLogger(logger:ILogger):void Sets up this target with the specified logger. | AbstractTarget
|  | initialized(document:Object, id:String):void Called after the implementing object has been created and all properties specified on the tag have been assigned. | AbstractTarget
|  | logEvent(event:LogEvent):void [override] This method handles a LogEvent from an associated logger. | LineFormattedTarget
|  | removeLogger(logger:ILogger):void Stops this target from receiving events from the specified logger. | AbstractTarget

Property Detail

fieldSeparator | property

`public var fieldSeparator:String =`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The separator string to use between fields (the default is " ")

includeCategory | property |

`public var includeCategory:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

includeDate | property |

`public var includeDate:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Indicates if the date should be added to the trace.

includeLevel | property |

`public var includeLevel:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

includeTime | property |

`public var includeTime:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Indicates if the time should be added to the trace.

Constructor Detail

LineFormattedTarget | () | Constructor

`public function LineFormattedTarget()`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Constructs an instance of a logger target that will format the message data on a single line.

Method Detail

logEvent | () | method

`override public function logEvent(event:LogEvent):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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 is called only if the event's level is in range of the target's level.

Parameters

| `event:LogEvent` — The `LogEvent` handled by this method.

Sun Mar 5 2017, 03:42 PM +11:00