home *** CD-ROM | disk | FTP | other *** search
/ Mobiclic 164 / MOBICLIC164.ISO / mac / DATA / DSS164 / DSS164_04 / lib / as3-signals-v0.9-BETA.swc / docs / org.osflash.signals.natives.xml < prev    next >
Extensible Markup Language  |  2011-08-31  |  38KB  |  268 lines
  1. <?xml version="1.0" encoding="UTF-8"?><apiPackage id="org.osflash.signals.natives"><apiName>org.osflash.signals.natives</apiName><apiDetail/><apiClassifier id="org.osflash.signals.natives:NativeRelaySignal"><apiName>NativeRelaySignal</apiName><shortdesc>
  2.      The NativeRelaySignal class is used to relay events from an IEventDispatcher
  3.      to listeners.</shortdesc><prolog><asMetadata><DefaultProperty name="valueClasses"/></asMetadata></prolog><apiClassifierDetail><apiClassifierDef><apiAccess value="public"/><apiStatic/><apiBaseInterface>org.osflash.signals.natives:INativeDispatcher</apiBaseInterface><apiBaseClassifier>org.osflash.signals:Signal</apiBaseClassifier></apiClassifierDef><apiDesc>
  4.      The NativeRelaySignal class is used to relay events from an IEventDispatcher
  5.      to listeners.
  6.      The difference as compared to NativeSignal is that
  7.      NativeRelaySignal has its own dispatching code,
  8.      whereas NativeSignal uses the IEventDispatcher to dispatch.
  9.      </apiDesc></apiClassifierDetail><apiConstructor id="org.osflash.signals.natives:NativeRelaySignal:NativeRelaySignal"><apiName>NativeRelaySignal</apiName><shortdesc>
  10.          Creates a new NativeRelaySignal instance to relay events from an IEventDispatcher.</shortdesc><prolog/><apiConstructorDetail><apiConstructorDef><apiAccess value="public"/><apiParam><apiItemName>target</apiItemName><apiType value="flash.events:IEventDispatcher"/><apiDesc>An object that implements the flash.events.IEventDispatcher interface.
  11.          </apiDesc></apiParam><apiParam><apiItemName>eventType</apiItemName><apiType value="String"/><apiDesc>The event string name that would normally be passed to IEventDispatcher.addEventListener().
  12.          </apiDesc></apiParam><apiParam><apiItemName>eventClass</apiItemName><apiType value="Class"/><apiData>null</apiData><apiDesc>An optional class reference that enables an event type check in dispatch().
  13.          Because the target is an IEventDispatcher,
  14.          eventClass needs to be flash.events.Event or a subclass of it.
  15.          </apiDesc></apiParam></apiConstructorDef><apiDesc>
  16.          Creates a new NativeRelaySignal instance to relay events from an IEventDispatcher.
  17.          </apiDesc></apiConstructorDetail></apiConstructor><apiOperation id="org.osflash.signals.natives:NativeRelaySignal:addOnceWithPriority"><apiName>addOnceWithPriority</apiName><shortdesc> 
  18.          Subscribes a one-time listener for this signal.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiDesc>a ISlot, which contains the Function passed as the parameter
  19.          </apiDesc><apiOperationClassifier>org.osflash.signals:ISlot</apiOperationClassifier></apiReturn><apiParam><apiItemName>listener</apiItemName><apiType value="Function"/><apiDesc>A function with an argument
  20.          that matches the type of event dispatched by the signal.
  21.          If eventClass is not specified, the listener and dispatch() can be called without an argument.
  22.          </apiDesc></apiParam><apiParam><apiItemName>priority</apiItemName><apiType value="int"/><apiData>0</apiData><apiDesc>The priority level of the event listener.
  23.          The priority is designated by a signed 32-bit integer.
  24.          The higher the number, the higher the priority.
  25.          All listeners with priority n are processed before listeners of priority n-1.
  26.          </apiDesc></apiParam></apiOperationDef><apiDesc> 
  27.          Subscribes a one-time listener for this signal.
  28.          The signal will remove the listener automatically the first time it is called,
  29.          after the dispatch to all listeners is complete.
  30.          </apiDesc></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeRelaySignal:addOnce"><apiName>addOnce</apiName><shortdesc/><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiIsOverride/><apiReturn><apiOperationClassifier>org.osflash.signals:ISlot</apiOperationClassifier></apiReturn><apiParam><apiItemName>listener</apiItemName><apiType value="Function"/></apiParam></apiOperationDef></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeRelaySignal:addWithPriority"><apiName>addWithPriority</apiName><shortdesc> 
  31.          Subscribes a listener for the signal.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiDesc>a ISlot, which contains the Function passed as the parameter
  32.          </apiDesc><apiOperationClassifier>org.osflash.signals:ISlot</apiOperationClassifier></apiReturn><apiParam><apiItemName>listener</apiItemName><apiType value="Function"/><apiDesc>A function with an argument
  33.          that matches the type of event dispatched by the signal.
  34.          If eventClass is not specified, the listener and dispatch() can be called without an argument.
  35.          </apiDesc></apiParam><apiParam><apiItemName>priority</apiItemName><apiType value="int"/><apiData>0</apiData></apiParam></apiOperationDef><apiDesc> 
  36.          Subscribes a listener for the signal.
  37.          After you successfully register an event listener,
  38.          you cannot change its priority through additional calls to add().
  39.          To change a listener's priority, you must first call remove().
  40.          Then you can register the listener again with the new priority level.
  41.          </apiDesc></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeRelaySignal:add"><apiName>add</apiName><shortdesc/><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiIsOverride/><apiReturn><apiOperationClassifier>org.osflash.signals:ISlot</apiOperationClassifier></apiReturn><apiParam><apiItemName>listener</apiItemName><apiType value="Function"/></apiParam></apiOperationDef></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeRelaySignal:dispatchEvent"><apiName>dispatchEvent</apiName><shortdesc>
  42.          Unlike other signals, NativeRelaySignal does not dispatch null
  43.          because it causes an exception in EventDispatcher.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="Boolean"/></apiReturn><apiParam><apiItemName>event</apiItemName><apiType value="flash.events:Event"/><apiDesc>        An instance of a class that is or extends flash.events.Event.
  44.          </apiDesc></apiParam></apiOperationDef><apiDesc>
  45.          Unlike other signals, NativeRelaySignal does not dispatch null
  46.          because it causes an exception in EventDispatcher.
  47.          
  48.          Dispatches an event to listeners.
  49.          </apiDesc></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeRelaySignal:dispatch"><apiName>dispatch</apiName><shortdesc>
  50.          
  51.          Dispatches an object to listeners.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiIsOverride/><apiReturn><apiType value="void"/></apiReturn><apiParam><apiItemName>valueObjects</apiItemName><apiType value="restParam"/><apiDesc>Any number of parameters to send to listeners. Will be type-checked against valueClasses.
  52.          </apiDesc></apiParam></apiOperationDef><apiDesc>
  53.          
  54.          Dispatches an object to listeners.
  55.          </apiDesc></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeRelaySignal:protected:onNativeEvent"><apiName>onNativeEvent</apiName><shortdesc/><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="protected"/><apiReturn><apiType value="void"/></apiReturn><apiParam><apiItemName>event</apiItemName><apiType value="flash.events:Event"/></apiParam></apiOperationDef></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeRelaySignal:protected:registerListenerWithPriority"><apiName>registerListenerWithPriority</apiName><shortdesc/><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="protected"/><apiReturn><apiOperationClassifier>org.osflash.signals:ISlot</apiOperationClassifier></apiReturn><apiParam><apiItemName>listener</apiItemName><apiType value="Function"/></apiParam><apiParam><apiItemName>once</apiItemName><apiType value="Boolean"/><apiData>false</apiData></apiParam><apiParam><apiItemName>priority</apiItemName><apiType value="int"/><apiData>0</apiData></apiParam></apiOperationDef></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeRelaySignal:removeAll"><apiName>removeAll</apiName><shortdesc>
  56.          
  57.          Unsubscribes all listeners from the signal.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiIsOverride/><apiReturn><apiType value="void"/></apiReturn></apiOperationDef><apiDesc>
  58.          
  59.          Unsubscribes all listeners from the signal.
  60.          </apiDesc></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeRelaySignal:remove"><apiName>remove</apiName><shortdesc> 
  61.          Unsubscribes a listener from the signal.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiIsOverride/><apiReturn><apiDesc>a ISlot, which contains the Function passed as the parameter
  62.          </apiDesc><apiOperationClassifier>org.osflash.signals:ISlot</apiOperationClassifier></apiReturn><apiParam><apiItemName>listener</apiItemName><apiType value="Function"/><apiDesc>     </apiDesc></apiParam></apiOperationDef><apiDesc> 
  63.          Unsubscribes a listener from the signal.
  64.          </apiDesc></apiOperationDetail></apiOperation><apiValue id="org.osflash.signals.natives:NativeRelaySignal:protected:_eventClass"><apiName>_eventClass</apiName><shortdesc/><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="protected"/><apiDynamic/><apiType value="Class"/></apiValueDef></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeRelaySignal:protected:_eventType"><apiName>_eventType</apiName><shortdesc/><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="protected"/><apiDynamic/><apiType value="String"/></apiValueDef></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeRelaySignal:protected:_target"><apiName>_target</apiName><shortdesc/><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="protected"/><apiDynamic/><apiType value="flash.events:IEventDispatcher"/></apiValueDef></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeRelaySignal:eventClass:get"><apiName>eventClass</apiName><shortdesc> 
  65.          The class of event permitted to be dispatched.</shortdesc><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="readwrite"/><apiType value="Class"/></apiValueDef><apiDesc> 
  66.          The class of event permitted to be dispatched. Will be flash.events.Event or a subclass.
  67.          </apiDesc></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeRelaySignal:eventType:get"><apiName>eventType</apiName><shortdesc> 
  68.          The type of event permitted to be dispatched.</shortdesc><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="readwrite"/><apiType value="String"/></apiValueDef><apiDesc> 
  69.          The type of event permitted to be dispatched. Corresponds to flash.events.Event.type.
  70.          </apiDesc></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeRelaySignal:target:get"><apiName>target</apiName><shortdesc> 
  71.          The object considered the source of the dispatched events.</shortdesc><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="readwrite"/><apiType value="flash.events:IEventDispatcher"/></apiValueDef><apiDesc> 
  72.          The object considered the source of the dispatched events.
  73.          </apiDesc></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeRelaySignal:valueClasses:set"><apiName>valueClasses</apiName><shortdesc/><prolog/><apiValueDetail><apiValueDef><apiIsOverride/><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="readwrite"/><apiType value="Array"/></apiValueDef></apiValueDetail></apiValue></apiClassifier><apiClassifier id="org.osflash.signals.natives:NativeMappedSignal"><apiName>NativeMappedSignal</apiName><shortdesc>
  74.      
  75.      The NativeMappedSignal class is used to map/transform a native Event, 
  76.      relayed from an IEventDispatcher, into other forms of data, 
  77.      which are dispatched to all listeners.</shortdesc><prolog><asMetadata><DefaultProperty name="valueClasses"/></asMetadata></prolog><apiClassifierDetail><apiClassifierDef><apiAccess value="public"/><apiStatic/><apiBaseClassifier>org.osflash.signals.natives:NativeRelaySignal</apiBaseClassifier></apiClassifierDef><apiDesc>
  78.      <p>
  79.      The NativeMappedSignal class is used to map/transform a native Event, 
  80.      relayed from an IEventDispatcher, into other forms of data, 
  81.      which are dispatched to all listeners.
  82.      </p>
  83.      <p>This can be used to form a border where native flash Events do not cross.</p>
  84.      </apiDesc></apiClassifierDetail><apiConstructor id="org.osflash.signals.natives:NativeMappedSignal:NativeMappedSignal"><apiName>NativeMappedSignal</apiName><shortdesc>
  85.          Creates a new NativeMappedSignal instance to map/transform a native Event, 
  86.           relayed from an IEventDispatcher, into other forms of data, 
  87.           which are dispatched to all listeners.</shortdesc><prolog/><apiConstructorDetail><apiConstructorDef><apiAccess value="public"/><apiParam><apiItemName>target</apiItemName><apiType value="flash.events:IEventDispatcher"/><apiDesc>An object that implements the flash.events.IEventDispatcher interface.
  88.          </apiDesc></apiParam><apiParam><apiItemName>eventType</apiItemName><apiType value="String"/><apiDesc>The event string name that would normally be passed to IEventDispatcher.addEventListener().
  89.          </apiDesc></apiParam><apiParam><apiItemName>eventClass</apiItemName><apiType value="Class"/><apiData>null</apiData><apiDesc>An optional class reference that enables an event type check in dispatch().
  90.          </apiDesc></apiParam><apiParam><apiItemName>mappedTypes</apiItemName><apiType value="restParam"/><apiDesc>an optional list of types that enables the checking of the types mapped from an Event. 
  91.          </apiDesc></apiParam></apiConstructorDef><apiDesc>
  92.          Creates a new NativeMappedSignal instance to map/transform a native Event, 
  93.           relayed from an IEventDispatcher, into other forms of data, 
  94.           which are dispatched to all listeners.
  95.          
  96.          </apiDesc></apiConstructorDetail></apiConstructor><apiOperation id="org.osflash.signals.natives:NativeMappedSignal:dispatchEvent"><apiName>dispatchEvent</apiName><shortdesc/><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiIsOverride/><apiReturn><apiType value="Boolean"/></apiReturn><apiParam><apiItemName>event</apiItemName><apiType value="flash.events:Event"/></apiParam></apiOperationDef></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeMappedSignal:protected:mapEvent"><apiName>mapEvent</apiName><shortdesc>
  97.          For usage without extension, instances of NativeMappedSignal that are dispatching any values ( valueClasses.length > 0 ),
  98.          needs to be provided with a either a mapping function or a list of object literals.</shortdesc><prolog><asCustoms><parameter>eventFromTarget the event that was dispatched from target.
  99.          </parameter></asCustoms></prolog><apiOperationDetail><apiOperationDef><apiAccess value="protected"/><apiReturn><apiDesc>An object or Array of objects mapped from an Event. The mapping of Event to data will be performed by the mapping function
  100.          if it is set. A list of object literals can also be supplied in place of the mapping function.
  101.          If no mapping function or object literals are supplied then an empty Array is returned or
  102.          if <codeph>valueClasses.length > 0</codeph> an ArgumentError is thrown.
  103.          
  104.          </apiDesc><apiType value="Object"/></apiReturn><apiParam><apiItemName>eventFromTarget</apiItemName><apiType value="flash.events:Event"/></apiParam></apiOperationDef><apiDesc>
  105.          For usage without extension, instances of <codeph>NativeMappedSignal</codeph> that are dispatching any values ( <codeph>valueClasses.length > 0</codeph> ),
  106.          needs to be provided with a either a mapping function or a list of object literals.
  107.          See <codeph>mapTo</codeph> for more info.
  108.          
  109.          Subclasses could override this one instead of letting the environment set the mapTo,
  110.          MAKE SURE to also override <codeph>mapTo(...)</codeph> if it should not be allowed.
  111.          
  112.          </apiDesc></apiOperationDetail><related-links><link href="org.osflash.signals.natives.xml#NativeMappedSignal/mapTo()"><linktext>mapTo()</linktext></link></related-links></apiOperation><apiOperation id="org.osflash.signals.natives:NativeMappedSignal:mapTo"><apiName>mapTo</apiName><shortdesc>
  113.          Sets the mapping function or literal object list.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiDesc>The NativeMappedSignal object this method was called on. This allows the Signal to be defined and mapped in one statement.
  114.          </apiDesc><apiOperationClassifier>org.osflash.signals.natives:NativeMappedSignal</apiOperationClassifier></apiReturn><apiParam><apiItemName>objectListOrFunction</apiItemName><apiType value="restParam"/><apiDesc>This can either be a list of object literals or a function that returns list of objects. 
  115.          </apiDesc></apiParam></apiOperationDef><apiDesc>
  116.          Sets the mapping function or literal object list.
  117.          If the argument is a list of object literals then this list is dispatched to listeners.
  118.          
  119.          <codeblock rev="3.0">
  120.           signal = new NativeMappedSignal(button, MouseEvent.CLICK, MouseEvent, String).mapTo("ping")
  121.           signal.add(function(arg:String):void { trace(arg) }) // prints "ping"
  122.          </codeblock>
  123.          
  124.          And an example passing a list of literals:
  125.          
  126.          <codeblock rev="3.0">
  127.           signal = new NativeMappedSignal(button, MouseEvent.CLICK, MouseEvent, String, int, Number).mapTo("ping", 3, 3.1415)
  128.           signal.add(function(arg1:String, arg2:int, arg3:Number):void { trace(arg1, arg2, arg3) }) // prints "ping", 3, 3.1415
  129.          </codeblock>
  130.          
  131.          If the argument is a function then it is called when the event this NativeMappedSignal is listening for is dispatched.
  132.          The function should return an Array or a single object. The data returned from the function is passed along as arguments in the Signal dispatch.
  133.          Lets look at some examples of mapping functions and the function that is called back:
  134.          
  135.          <codeblock rev="3.0">
  136.           signal = new NativeMappedSignal(button, MouseEvent.CLICK, MouseEvent, String).mapTo(function():void { 
  137.             return "ping"
  138.           })
  139.           signal.add(function(arg:String):void { trace(arg) }) // prints "ping"
  140.          </codeblock>
  141.          
  142.          and here's an example using a list of arguments:
  143.          
  144.          <codeblock rev="3.0">
  145.           signal = new NativeMappedSignal(button, MouseEvent.CLICK, MouseEvent, String, int, Number).mapTo(function():void { 
  146.             return ["ping", 3, 3.1415] 
  147.           })
  148.              signal.add(function(arg1:String, arg2:int, arg3:Number):void { trace(arg1, arg2, arg3) }) // prints "ping", 3, 3.1415
  149.          </codeblock>
  150.          
  151.          You can also state your wish to receive the native Event in th mapping function by simply including an argument of type Event:
  152.          
  153.          <codeblock rev="3.0">
  154.           signal = new NativeMappedSignal(button, MouseEvent.CLICK, MouseEvent, Point).mapTo(function(event:MouseEvent):void { 
  155.             return new Point(event.localX, event.localY)
  156.           })
  157.           signal.add(function(arg:Point):void { trace(arg) }) // prints "(x=128, y=256)"
  158.          </codeblock> 
  159.          
  160.          </apiDesc></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeMappedSignal:protected:onNativeEvent"><apiName>onNativeEvent</apiName><shortdesc/><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="protected"/><apiIsOverride/><apiReturn><apiType value="void"/></apiReturn><apiParam><apiItemName>event</apiItemName><apiType value="flash.events:Event"/></apiParam></apiOperationDef></apiOperationDetail></apiOperation><apiValue id="org.osflash.signals.natives:NativeMappedSignal:eventClass:get"><apiName>eventClass</apiName><shortdesc>
  161.           
  162.          The class of event permitted to be dispatched.</shortdesc><prolog/><apiValueDetail><apiValueDef><apiIsOverride/><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="readwrite"/><apiType value="Class"/></apiValueDef><apiDesc>
  163.           
  164.          The class of event permitted to be dispatched. Will be flash.events.Event or a subclass.
  165.          </apiDesc></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeMappedSignal:protected:mappingFunction:get"><apiName>mappingFunction</apiName><shortdesc/><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="protected"/><apiDynamic/><apiValueAccess value="read"/><apiType value="Function"/></apiValueDef></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeMappedSignal:valueClasses:set"><apiName>valueClasses</apiName><shortdesc>
  166.          </shortdesc><prolog/><apiValueDetail><apiValueDef><apiIsOverride/><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="readwrite"/><apiType value="Array"/></apiValueDef><apiDesc>
  167.          </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier id="org.osflash.signals.natives:NativeSignal"><apiName>NativeSignal</apiName><shortdesc>
  168.      The NativeSignal class provides a strongly-typed facade for an IEventDispatcher.</shortdesc><prolog><asMetadata><DefaultProperty name="eventClass"/></asMetadata></prolog><apiClassifierDetail><apiClassifierDef><apiAccess value="public"/><apiStatic/><apiBaseInterface>org.osflash.signals.natives:INativeDispatcher</apiBaseInterface><apiBaseClassifier>Object</apiBaseClassifier></apiClassifierDef><apiDesc>
  169.      The NativeSignal class provides a strongly-typed facade for an IEventDispatcher.
  170.      A NativeSignal is essentially a mini-dispatcher locked to a specific event type and class.
  171.      It can become part of an interface.
  172.      </apiDesc></apiClassifierDetail><apiConstructor id="org.osflash.signals.natives:NativeSignal:NativeSignal"><apiName>NativeSignal</apiName><shortdesc>
  173.          Creates a NativeSignal instance to dispatch events on behalf of a target object.</shortdesc><prolog/><apiConstructorDetail><apiConstructorDef><apiAccess value="public"/><apiParam><apiItemName>target</apiItemName><apiType value="flash.events:IEventDispatcher"/><apiData>null</apiData><apiDesc>The object on whose behalf the signal is dispatching events.
  174.          </apiDesc></apiParam><apiParam><apiItemName>eventType</apiItemName><apiType value="String"/><apiData/><apiDesc>The type of Event permitted to be dispatched from this signal. Corresponds to Event.type.
  175.          </apiDesc></apiParam><apiParam><apiItemName>eventClass</apiItemName><apiType value="Class"/><apiData>null</apiData><apiDesc>An optional class reference that enables an event type check in dispatch(). Defaults to flash.events.Event if omitted.
  176.          </apiDesc></apiParam></apiConstructorDef><apiDesc>
  177.          Creates a NativeSignal instance to dispatch events on behalf of a target object.
  178.          </apiDesc></apiConstructorDetail></apiConstructor><apiOperation id="org.osflash.signals.natives:NativeSignal:addOnceWithPriority"><apiName>addOnceWithPriority</apiName><shortdesc> 
  179.          Subscribes a one-time listener for this signal.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiDesc>a ISlot, which contains the Function passed as the parameter
  180.          </apiDesc><apiOperationClassifier>org.osflash.signals:ISlot</apiOperationClassifier></apiReturn><apiParam><apiItemName>listener</apiItemName><apiType value="Function"/><apiDesc>A function with an argument
  181.          that matches the type of event dispatched by the signal.
  182.          If eventClass is not specified, the listener and dispatch() can be called without an argument.
  183.          </apiDesc></apiParam><apiParam><apiItemName>priority</apiItemName><apiType value="int"/><apiData>0</apiData><apiDesc>The priority level of the event listener.
  184.          The priority is designated by a signed 32-bit integer.
  185.          The higher the number, the higher the priority.
  186.          All listeners with priority n are processed before listeners of priority n-1.
  187.          </apiDesc></apiParam></apiOperationDef><apiDesc> 
  188.          Subscribes a one-time listener for this signal.
  189.          The signal will remove the listener automatically the first time it is called,
  190.          after the dispatch to all listeners is complete.
  191.          </apiDesc></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeSignal:addOnce"><apiName>addOnce</apiName><shortdesc> 
  192.          Subscribes a one-time listener for this signal.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiDesc>a ISlot, which contains the Function passed as the parameter
  193.          </apiDesc><apiOperationClassifier>org.osflash.signals:ISlot</apiOperationClassifier></apiReturn><apiParam><apiItemName>listener</apiItemName><apiType value="Function"/><apiDesc>A function with arguments
  194.          that matches the value classes dispatched by the signal.
  195.          If value classes are not specified (e.g. via Signal constructor), dispatch() can be called without arguments.
  196.          </apiDesc></apiParam></apiOperationDef><apiDesc> 
  197.          Subscribes a one-time listener for this signal.
  198.          The signal will remove the listener automatically the first time it is called,
  199.          after the dispatch to all listeners is complete.
  200.          </apiDesc></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeSignal:addWithPriority"><apiName>addWithPriority</apiName><shortdesc> 
  201.          Subscribes a listener for the signal.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiDesc>a ISlot, which contains the Function passed as the parameter
  202.          </apiDesc><apiOperationClassifier>org.osflash.signals:ISlot</apiOperationClassifier></apiReturn><apiParam><apiItemName>listener</apiItemName><apiType value="Function"/><apiDesc>A function with an argument
  203.          that matches the type of event dispatched by the signal.
  204.          If eventClass is not specified, the listener and dispatch() can be called without an argument.
  205.          </apiDesc></apiParam><apiParam><apiItemName>priority</apiItemName><apiType value="int"/><apiData>0</apiData></apiParam></apiOperationDef><apiDesc> 
  206.          Subscribes a listener for the signal.
  207.          After you successfully register an event listener,
  208.          you cannot change its priority through additional calls to add().
  209.          To change a listener's priority, you must first call remove().
  210.          Then you can register the listener again with the new priority level.
  211.          </apiDesc></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeSignal:add"><apiName>add</apiName><shortdesc> 
  212.          Subscribes a listener for the signal.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiDesc>a ISlot, which contains the Function passed as the parameter
  213.          </apiDesc><apiOperationClassifier>org.osflash.signals:ISlot</apiOperationClassifier></apiReturn><apiParam><apiItemName>listener</apiItemName><apiType value="Function"/><apiDesc>A function with arguments
  214.          that matches the value classes dispatched by the signal.
  215.          If value classes are not specified (e.g. via Signal constructor), dispatch() can be called without arguments.
  216.          </apiDesc></apiParam></apiOperationDef><apiDesc> 
  217.          Subscribes a listener for the signal.
  218.          </apiDesc></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeSignal:dispatchEvent"><apiName>dispatchEvent</apiName><shortdesc>
  219.          Unlike other signals, NativeSignal does not dispatch null
  220.          because it causes an exception in EventDispatcher.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="Boolean"/></apiReturn><apiParam><apiItemName>event</apiItemName><apiType value="flash.events:Event"/><apiDesc>        An instance of a class that is or extends flash.events.Event.
  221.          </apiDesc></apiParam></apiOperationDef><apiDesc>
  222.          Unlike other signals, NativeSignal does not dispatch null
  223.          because it causes an exception in EventDispatcher.
  224.          
  225.          Dispatches an event to listeners.
  226.          </apiDesc></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeSignal:dispatch"><apiName>dispatch</apiName><shortdesc> 
  227.          Dispatches an object to listeners.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="void"/></apiReturn><apiParam><apiItemName>valueObjects</apiItemName><apiType value="restParam"/><apiDesc>Any number of parameters to send to listeners. Will be type-checked against valueClasses.
  228.          </apiDesc></apiParam></apiOperationDef><apiDesc> 
  229.          Dispatches an object to listeners.
  230.          </apiDesc></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeSignal:protected:registerListenerWithPriority"><apiName>registerListenerWithPriority</apiName><shortdesc/><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="protected"/><apiReturn><apiOperationClassifier>org.osflash.signals:ISlot</apiOperationClassifier></apiReturn><apiParam><apiItemName>listener</apiItemName><apiType value="Function"/></apiParam><apiParam><apiItemName>once</apiItemName><apiType value="Boolean"/><apiData>false</apiData></apiParam><apiParam><apiItemName>priority</apiItemName><apiType value="int"/><apiData>0</apiData></apiParam></apiOperationDef></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeSignal:protected:registrationPossible"><apiName>registrationPossible</apiName><shortdesc/><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="protected"/><apiReturn><apiType value="Boolean"/></apiReturn><apiParam><apiItemName>listener</apiItemName><apiType value="Function"/></apiParam><apiParam><apiItemName>once</apiItemName><apiType value="Boolean"/></apiParam></apiOperationDef></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeSignal:removeAll"><apiName>removeAll</apiName><shortdesc> 
  231.          Unsubscribes all listeners from the signal.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="void"/></apiReturn></apiOperationDef><apiDesc> 
  232.          Unsubscribes all listeners from the signal.
  233.          </apiDesc></apiOperationDetail></apiOperation><apiOperation id="org.osflash.signals.natives:NativeSignal:remove"><apiName>remove</apiName><shortdesc> 
  234.          Unsubscribes a listener from the signal.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiDesc>a ISlot, which contains the Function passed as the parameter
  235.          </apiDesc><apiOperationClassifier>org.osflash.signals:ISlot</apiOperationClassifier></apiReturn><apiParam><apiItemName>listener</apiItemName><apiType value="Function"/><apiDesc>     </apiDesc></apiParam></apiOperationDef><apiDesc> 
  236.          Unsubscribes a listener from the signal.
  237.          </apiDesc></apiOperationDetail></apiOperation><apiValue id="org.osflash.signals.natives:NativeSignal:protected:_eventClass"><apiName>_eventClass</apiName><shortdesc/><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="protected"/><apiDynamic/><apiType value="Class"/></apiValueDef></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeSignal:protected:_eventType"><apiName>_eventType</apiName><shortdesc/><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="protected"/><apiDynamic/><apiType value="String"/></apiValueDef></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeSignal:protected:_target"><apiName>_target</apiName><shortdesc/><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="protected"/><apiDynamic/><apiType value="flash.events:IEventDispatcher"/></apiValueDef></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeSignal:protected:_valueClasses"><apiName>_valueClasses</apiName><shortdesc/><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="protected"/><apiDynamic/><apiType value="Array"/></apiValueDef></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeSignal:protected:slots"><apiName>slots</apiName><shortdesc/><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="protected"/><apiDynamic/><apiValueClassifier>org.osflash.signals:SlotList</apiValueClassifier></apiValueDef></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeSignal:eventClass:get"><apiName>eventClass</apiName><shortdesc> 
  238.          The class of event permitted to be dispatched.</shortdesc><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="readwrite"/><apiType value="Class"/></apiValueDef><apiDesc> 
  239.          The class of event permitted to be dispatched. Will be flash.events.Event or a subclass.
  240.          </apiDesc></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeSignal:eventType:get"><apiName>eventType</apiName><shortdesc> 
  241.          The type of event permitted to be dispatched.</shortdesc><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="readwrite"/><apiType value="String"/></apiValueDef><apiDesc> 
  242.          The type of event permitted to be dispatched. Corresponds to flash.events.Event.type.
  243.          </apiDesc></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeSignal:numListeners:get"><apiName>numListeners</apiName><shortdesc>  The current number of listeners for the signal.</shortdesc><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="read"/><apiType value="uint"/></apiValueDef><apiDesc>  The current number of listeners for the signal. </apiDesc></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeSignal:target:get"><apiName>target</apiName><shortdesc> 
  244.          The object considered the source of the dispatched events.</shortdesc><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="readwrite"/><apiType value="flash.events:IEventDispatcher"/></apiValueDef><apiDesc> 
  245.          The object considered the source of the dispatched events.
  246.          </apiDesc></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:NativeSignal:valueClasses:get"><apiName>valueClasses</apiName><shortdesc> 
  247.          An optional array of classes defining the types of parameters sent to listeners.</shortdesc><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="readwrite"/><apiType value="Array"/></apiValueDef><apiDesc> 
  248.          An optional array of classes defining the types of parameters sent to listeners.
  249.          </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier id="org.osflash.signals.natives:INativeDispatcher"><apiName>INativeDispatcher</apiName><shortdesc>
  250.      Similar to IDispatcher but using strong types specific to Flash's native event system.</shortdesc><prolog><asMetadata/></prolog><apiClassifierDetail><apiClassifierDef><apiInterface/><apiAccess value="public"/><apiStatic/><apiBaseInterface>org.osflash.signals:IPrioritySignal</apiBaseInterface><apiBaseClassifier/></apiClassifierDef><apiDesc>
  251.      Similar to IDispatcher but using strong types specific to Flash's native event system.
  252.      </apiDesc></apiClassifierDetail><apiOperation id="org.osflash.signals.natives:INativeDispatcher:org.osflash.signals.natives:INativeDispatcher:dispatchEvent"><apiName>dispatchEvent</apiName><shortdesc>
  253.          Dispatches an event to listeners.</shortdesc><prolog/><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiException><apiDesc>Event object is <codeph>null</codeph>.
  254.          </apiDesc><apiItemName>ArgumentError    <code>ArgumentError</code>:</apiItemName><apiOperationClassifier>ArgumentError    <code>ArgumentError</code>:</apiOperationClassifier></apiException><apiException><apiDesc>object [event] is not an instance of [eventClass].
  255.          </apiDesc><apiItemName>ArgumentError    <code>ArgumentError</code>:    Event</apiItemName><apiOperationClassifier>ArgumentError    <code>ArgumentError</code>:    Event</apiOperationClassifier></apiException><apiException><apiDesc>object has incorrect type. Expected [eventType] but was [event.type].
  256.          </apiDesc><apiItemName>ArgumentError    <code>ArgumentError</code>:    Event</apiItemName><apiOperationClassifier>ArgumentError    <code>ArgumentError</code>:    Event</apiOperationClassifier></apiException><apiReturn><apiType value="Boolean"/></apiReturn><apiParam><apiItemName>event</apiItemName><apiType value="flash.events:Event"/><apiDesc>        An instance of a class that is or extends flash.events.Event.
  257.          </apiDesc></apiParam></apiOperationDef><apiDesc>
  258.          Dispatches an event to listeners.
  259.          </apiDesc></apiOperationDetail></apiOperation><apiValue id="org.osflash.signals.natives:INativeDispatcher:org.osflash.signals.natives:INativeDispatcher:eventClass:get"><apiName>eventClass</apiName><shortdesc>
  260.          The class of event permitted to be dispatched.</shortdesc><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="read"/><apiType value="Class"/></apiValueDef><apiDesc>
  261.          The class of event permitted to be dispatched. Will be flash.events.Event or a subclass.
  262.          </apiDesc></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:INativeDispatcher:org.osflash.signals.natives:INativeDispatcher:eventType:get"><apiName>eventType</apiName><shortdesc>
  263.          The type of event permitted to be dispatched.</shortdesc><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="read"/><apiType value="String"/></apiValueDef><apiDesc>
  264.          The type of event permitted to be dispatched. Corresponds to flash.events.Event.type.
  265.          </apiDesc></apiValueDetail></apiValue><apiValue id="org.osflash.signals.natives:INativeDispatcher:org.osflash.signals.natives:INativeDispatcher:target:get"><apiName>target</apiName><shortdesc>
  266.          The object considered the source of the dispatched events.</shortdesc><prolog/><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="readwrite"/><apiType value="flash.events:IEventDispatcher"/></apiValueDef><apiDesc>
  267.          The object considered the source of the dispatched events.
  268.          </apiDesc></apiValueDetail></apiValue></apiClassifier></apiPackage>