| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../override.css" type="text/css"><meta name="keywords" content="AbstractTarget,mx.logging.AbstractTarget,ALL,DEBUG,ERROR,FATAL,INFO,LOG,WARN,category,category,filters,filters,id,level,level,level,message,addLogger,addLogger,addTarget,debug,debug,error,error,fatal,fatal,flush,getLevelString,getLogger,hasIllegalCharacters,info,info,initialized,isDebug,isError,isFatal,isInfo,isWarn,log,log,logEvent,removeLogger,removeLogger,removeTarget,warn,warn"><title>mx.logging.AbstractTarget</title></head><body><script language="javascript" type="text/javascript" src="../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../help.js"></script><script language="javascript" type="text/javascript" src="../../cookies.js"></script><script language="javascript" type="text/javascript"><!-- |
| asdocTitle = 'AbstractTarget - ApacheFlex API Reference'; |
| var baseRef = '../../'; |
| window.onload = configPage; |
| --></script> |
| <script type="text/javascript"> |
| scrollToNameAnchor(); |
| </script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../package-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Packages</a> | <a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a> | <a href="../../all-index-A.html" onclick="loadClassListFrame('../../index-list.html')">Index</a> | <a id="framesLink1" href="../../index.html?mx/logging/AbstractTarget.html&mx/logging/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">AbstractTarget</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("AbstractTarget"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">mx.logging</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class AbstractTarget</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">AbstractTarget <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../mx/logging/ILoggingTarget.html">ILoggingTarget</a>, <a href="../../mx/core/IMXMLObject.html">IMXMLObject</a></td></tr><tr><td class="classHeaderTableLabel">Subclasses</td><td> <a href="../../mx/logging/targets/LineFormattedTarget.html">LineFormattedTarget</a></td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p> |
| 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 <code>logEvent()</code> method is provided. |
| |
| <p></p><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#filters" class="signatureLink">filters</a> : Array<div class="summaryTableDescription"> |
| In addition to the level setting, filters are used to |
| provide a psuedo-hierarchical mapping for processing only those events |
| for a given category.</div></td><td class="summaryTableOwnerCol">AbstractTarget</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#id" class="signatureLink">id</a> : String<div class="summaryTableDescription">[read-only] |
| Provides access to the id of this target.</div></td><td class="summaryTableOwnerCol">AbstractTarget</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#level" class="signatureLink">level</a> : int<div class="summaryTableDescription"> |
| Provides access to the level this target is currently set at.</div></td><td class="summaryTableOwnerCol">AbstractTarget</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#AbstractTarget()" class="signatureLink">AbstractTarget</a>()</div><div class="summaryTableDescription"> |
| Constructor.</div></td><td class="summaryTableOwnerCol">AbstractTarget</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addLogger()" class="signatureLink">addLogger</a>(logger:<a href="../../mx/logging/ILogger.html">ILogger</a>):void</div><div class="summaryTableDescription"> |
| Sets up this target with the specified logger.</div></td><td class="summaryTableOwnerCol">AbstractTarget</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#initialized()" class="signatureLink">initialized</a>(document:Object, id:String):void</div><div class="summaryTableDescription"> |
| Called after the implementing object has been created |
| and all properties specified on the tag have been assigned.</div></td><td class="summaryTableOwnerCol">AbstractTarget</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logEvent()" class="signatureLink">logEvent</a>(event:<a href="../../mx/logging/LogEvent.html">LogEvent</a>):void</div><div class="summaryTableDescription"> |
| This method handles a LogEvent from an associated logger.</div></td><td class="summaryTableOwnerCol">AbstractTarget</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeLogger()" class="signatureLink">removeLogger</a>(logger:<a href="../../mx/logging/ILogger.html">ILogger</a>):void</div><div class="summaryTableDescription"> |
| Stops this target from receiving events from the specified logger.</div></td><td class="summaryTableOwnerCol">AbstractTarget</td></tr></table></div><script language="javascript" type="text/javascript"><!-- |
| showHideInherited(); |
| --></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="filters"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">filters</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>filters:Array</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| In addition to the <code>level</code> setting, filters are used to |
| provide a psuedo-hierarchical mapping for processing only those events |
| for a given category. |
| <p> |
| 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 |
| <code>mx.rpc.soap.WebService</code> class, uses |
| "mx.rpc.soap.WebService" as the parameter to the |
| <code>Log.getLogger()</code> 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 <code>InvalidFilterError</code> |
| is thrown. |
| If <code>null</code> or [] is specified, the filters are set to the |
| default of ["*"]. |
| </p> |
| <p>For example: |
| <pre> |
| var traceLogger:ILoggingTarget = new TraceTarget(); |
| traceLogger.filters = ["mx.rpc.*", "mx.messaging.*"]; |
| Log.addTarget(traceLogger); |
| </pre> |
| </p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get filters():Array</code><br/><code> public function set filters(value:Array):void</code><br/></div><a name="propertyDetail"></a><a name="id"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">id</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>id:String</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| 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 |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get id():String</code><br/></div><a name="propertyDetail"></a><a name="level"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">level</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>level:int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Provides access to the level this target is currently set at. |
| Value values are: |
| <ul> |
| <li><code>LogEventLevel.FATAL (1000)</code> designates events that are very |
| harmful and will eventually lead to application failure</li> |
| <li><code>LogEventLevel.ERROR (8)</code> designates error events that might |
| still allow the application to continue running.</li> |
| <li><code>LogEventLevel.WARN (6)</code> designates events that could be |
| harmful to the application operation</li> |
| <li><code>LogEventLevel.INFO (4)</code> designates informational messages |
| that highlight the progress of the application at |
| coarse-grained level.</li> |
| <li><code>LogEventLevel.DEBUG (2)</code> designates informational |
| level messages that are fine grained and most helpful when |
| debugging an application.</li> |
| <li><code>LogEventLevel.ALL (0)</code> intended to force a target to |
| process all messages.</li> |
| </ul> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get level():int</code><br/><code> public function set level(value:int):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="AbstractTarget()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">AbstractTarget</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function AbstractTarget()</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p> |
| Constructor. |
| |
| </p></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="addLogger()"></a><a name="addLogger(mx.logging.ILogger)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addLogger</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function addLogger(logger:<a href="../../mx/logging/ILogger.html">ILogger</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Sets up this target with the specified logger. |
| This allows this target to receive log events from the specified logger. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">logger</span>:<a href="../../mx/logging/ILogger.html">ILogger</a></code> — The ILogger that this target should listen to. |
| |
| </td></tr></table></p></div><a name="initialized()"></a><a name="initialized(Object,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initialized</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function initialized(document:Object, id:String):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Called after the implementing object has been created |
| and all properties specified on the tag have been assigned. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">document</span>:Object</code> — MXML document that created this object. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">id</span>:String</code> — Used by the document to refer to this object. |
| If the object is a deep property on the document, id is null. |
| |
| </td></tr></table></p></div><a name="logEvent()"></a><a name="logEvent(mx.logging.LogEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">logEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function logEvent(event:<a href="../../mx/logging/LogEvent.html">LogEvent</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| This method handles a <code>LogEvent</code> 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. |
| <p><b><i>NOTE: Descendants must override this method to make it useful.</i></b></p> |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:<a href="../../mx/logging/LogEvent.html">LogEvent</a></code> — An event from an associated logger. |
| |
| </td></tr></table></p></div><a name="removeLogger()"></a><a name="removeLogger(mx.logging.ILogger)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeLogger</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function removeLogger(logger:<a href="../../mx/logging/ILogger.html">ILogger</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Stops this target from receiving events from the specified logger. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">logger</span>:<a href="../../mx/logging/ILogger.html">ILogger</a></code> — The ILogger that this target should ignore. |
| |
| </td></tr></table></p></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 --> |
