Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.logging 
AbstractTarget 
Packagemx.logging
Classpublic class AbstractTarget
InheritanceAbstractTarget Inheritance Object
Implements ILoggingTarget, IMXMLObject
Subclasses LineFormattedTarget

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

This class provides the basic functionality required by the logging framework for a target implementation. It handles the validation of filter expressions and provides a default level property. No implementation of the logEvent() method is provided.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  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
  level : int
Provides access to the level this target is currently set at.
AbstractTarget
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
Public Methods
 MethodDefined By
  
Constructor.
AbstractTarget
  
Sets up this target with the specified logger.
AbstractTarget
 Inherited
Indicates whether an object has a specified property defined.
Object
  
Called after the implementing object has been created and all properties specified on the tag have been assigned.
AbstractTarget
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
This method handles a LogEvent from an associated logger.
AbstractTarget
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
Stops this target from receiving events from the specified logger.
AbstractTarget
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

filters

property
filters:Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

In addition to the level setting, filters are used to provide a psuedo-hierarchical mapping for processing only those events for a given category.

Each logger belongs to a category. By convention these categories map to the fully-qualified class name in which the logger is used. For example, a logger that is logging messages for the mx.rpc.soap.WebService class, uses "mx.rpc.soap.WebService" as the parameter to the Log.getLogger() method call. When messages are sent under this category only those targets that have a filter which matches that category receive notification of those events. Filter expressions can include a wildcard match, indicated with an asterisk. The wildcard must be the right-most character in the expression. For example: rpc*, mx.*, or *. If an invalid expression is specified, a InvalidFilterError is thrown. If null or [] is specified, the filters are set to the default of ["*"].

For example:

               var traceLogger:ILoggingTarget = new TraceTarget();
               traceLogger.filters = ["mx.rpc.*", "mx.messaging.*"];
               Log.addTarget(traceLogger);
         



Implementation
    public function get filters():Array
    public function set filters(value:Array):void

id

property 
id:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Provides access to the id of this target. The id is assigned at runtime by the mxml compiler if used as an mxml tag, or internally if used within a script block



Implementation
    public function get id():String

level

property 
level:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Provides access to the level this target is currently set at. Value values are:

  • LogEventLevel.FATAL (1000) designates events that are very harmful and will eventually lead to application failure
  • LogEventLevel.ERROR (8) designates error events that might still allow the application to continue running.
  • LogEventLevel.WARN (6) designates events that could be harmful to the application operation
  • LogEventLevel.INFO (4) designates informational messages that highlight the progress of the application at coarse-grained level.
  • LogEventLevel.DEBUG (2) designates informational level messages that are fine grained and most helpful when debugging an application.
  • LogEventLevel.ALL (0) intended to force a target to process all messages.



Implementation
    public function get level():int
    public function set level(value:int):void
Constructor Detail

AbstractTarget

()Constructor
public function AbstractTarget()

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Method Detail

addLogger

()method
public function addLogger(logger:ILogger):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Sets up this target with the specified logger. This allows this target to receive log events from the specified logger.

Parameters

logger:ILogger — The ILogger that this target should listen to.

initialized

()method 
public function initialized(document:Object, id:String):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Called after the implementing object has been created and all properties specified on the tag have been assigned.

Parameters

document:Object — MXML document that created this object.
 
id:String — Used by the document to refer to this object. If the object is a deep property on the document, id is null.

logEvent

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

NOTE: Descendants must override this method to make it useful.

Parameters

event:LogEvent — An event from an associated logger.

removeLogger

()method 
public function removeLogger(logger:ILogger):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Stops this target from receiving events from the specified logger.

Parameters

logger:ILogger — The ILogger that this target should ignore.