as3signals 0.7.0 → 0.7.1
Sign up to get free protection for your applications and to get access to all the features.
- data/Gemfile +0 -3
- data/Gemfile.lock +32 -0
- data/README.textile +41 -9
- data/Rakefile +88 -43
- data/as3signals.gemspec +26 -11
- data/bin/as3-signals-v0.7.swc +0 -0
- data/build.properties +1 -0
- data/build.xml +3 -2
- data/docs/AC_OETags.js +129 -0
- data/docs/all-classes.html +55 -0
- data/docs/all-index-A.html +25 -0
- data/docs/all-index-B.html +13 -0
- data/docs/all-index-C.html +13 -0
- data/docs/all-index-D.html +22 -0
- data/docs/all-index-E.html +17 -0
- data/docs/all-index-F.html +13 -0
- data/docs/all-index-G.html +13 -0
- data/docs/all-index-H.html +13 -0
- data/docs/all-index-I.html +15 -0
- data/docs/all-index-J.html +13 -0
- data/docs/all-index-K.html +13 -0
- data/docs/all-index-L.html +13 -0
- data/docs/all-index-M.html +16 -0
- data/docs/all-index-N.html +25 -0
- data/docs/all-index-O.html +14 -0
- data/docs/all-index-P.html +13 -0
- data/docs/all-index-Q.html +13 -0
- data/docs/all-index-R.html +21 -0
- data/docs/all-index-S.html +15 -0
- data/docs/all-index-T.html +15 -0
- data/docs/all-index-U.html +13 -0
- data/docs/all-index-V.html +17 -0
- data/docs/all-index-W.html +13 -0
- data/docs/all-index-X.html +13 -0
- data/docs/all-index-Y.html +13 -0
- data/docs/all-index-Z.html +13 -0
- data/docs/asdoc.js +286 -0
- data/docs/class-summary.html +24 -0
- data/docs/cookies.js +84 -0
- data/docs/help.js +941 -0
- data/docs/images/AirIcon12x12.gif +0 -0
- data/docs/images/P_AlternativeMetadataIndicator_30x28_N.png +0 -0
- data/docs/images/collapsed.gif +0 -0
- data/docs/images/detailHeaderRule.jpg +0 -0
- data/docs/images/detailSectionHeader.jpg +0 -0
- data/docs/images/expanded.gif +0 -0
- data/docs/images/inherit-arrow.gif +0 -0
- data/docs/images/inheritedSummary.gif +0 -0
- data/docs/images/logo.jpg +0 -0
- data/docs/images/titleTableBottom.jpg +0 -0
- data/docs/images/titleTableMiddle.jpg +0 -0
- data/docs/images/titleTableTop.jpg +0 -0
- data/docs/index-list.html +70 -0
- data/docs/index.html +40 -0
- data/docs/org/osflash/signals/DeluxeSignal.html +68 -0
- data/docs/org/osflash/signals/IDeluxeSignal.html +42 -0
- data/docs/org/osflash/signals/IDispatcher.html +21 -0
- data/docs/org/osflash/signals/ISignal.html +39 -0
- data/docs/org/osflash/signals/ISignalOwner.html +24 -0
- data/docs/org/osflash/signals/Signal.html +64 -0
- data/docs/org/osflash/signals/class-list.html +1 -0
- data/docs/org/osflash/signals/events/GenericEvent.html +17 -0
- data/docs/org/osflash/signals/events/IBubbleEventHandler.html +21 -0
- data/docs/org/osflash/signals/events/IEvent.html +16 -0
- data/docs/org/osflash/signals/events/class-list.html +1 -0
- data/docs/org/osflash/signals/events/package-detail.html +14 -0
- data/docs/org/osflash/signals/natives/INativeDispatcher.html +32 -0
- data/docs/org/osflash/signals/natives/NativeMappedSignal.html +106 -0
- data/docs/org/osflash/signals/natives/NativeRelaySignal.html +49 -0
- data/docs/org/osflash/signals/natives/NativeSignal.html +82 -0
- data/docs/org/osflash/signals/natives/class-list.html +1 -0
- data/docs/org/osflash/signals/natives/package-detail.html +21 -0
- data/docs/org/osflash/signals/package-detail.html +19 -0
- data/docs/override.css +12 -0
- data/docs/package-frame.html +18 -0
- data/docs/package-list.html +1 -0
- data/docs/package-summary.html +13 -0
- data/docs/print.css +110 -0
- data/docs/style.css +578 -0
- data/docs/title-bar.html +41 -0
- data/gemfile +3 -0
- data/lib/as3signals.rb +5 -2
- data/lib/as3signals/version.rb +8 -0
- data/libs/asunit4-alpha.swc +0 -0
- metadata +109 -32
- data/as3-signals.as3proj +0 -87
- data/as3-signals.docproj +0 -9
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><!-- saved from url=(0014)about:internet --><html>
|
|
2
|
+
<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
3
|
+
<title>AS3 Signals v0.7</title><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">
|
|
4
|
+
|
|
5
|
+
<base target="classFrame">
|
|
6
|
+
</head>
|
|
7
|
+
|
|
8
|
+
<body class="classFrameContent">
|
|
9
|
+
<h3> Index </h3>
|
|
10
|
+
<table cellpadding="0" cellspacing="5" width="100%">
|
|
11
|
+
<tbody>
|
|
12
|
+
<!--
|
|
13
|
+
<tr>
|
|
14
|
+
<td colspan="2"><a href="all-index-Symbols.html">Symbols</a></td>
|
|
15
|
+
</tr>
|
|
16
|
+
-->
|
|
17
|
+
<tr>
|
|
18
|
+
<td><a href="all-index-A.html">A</a></td>
|
|
19
|
+
<td><a href="all-index-N.html">N</a></td>
|
|
20
|
+
</tr>
|
|
21
|
+
<tr>
|
|
22
|
+
<td><a href="all-index-B.html">B</a></td>
|
|
23
|
+
<td><a href="all-index-O.html">O</a></td>
|
|
24
|
+
</tr>
|
|
25
|
+
<tr>
|
|
26
|
+
<td><a href="all-index-C.html">C</a></td>
|
|
27
|
+
<td><a href="all-index-P.html">P</a></td>
|
|
28
|
+
</tr>
|
|
29
|
+
<tr>
|
|
30
|
+
<td><a href="all-index-D.html">D</a></td>
|
|
31
|
+
<td><a href="all-index-Q.html">Q</a></td>
|
|
32
|
+
</tr>
|
|
33
|
+
<tr>
|
|
34
|
+
<td><a href="all-index-E.html">E</a></td>
|
|
35
|
+
<td><a href="all-index-R.html">R</a></td>
|
|
36
|
+
</tr>
|
|
37
|
+
<tr>
|
|
38
|
+
<td><a href="all-index-F.html">F</a></td>
|
|
39
|
+
<td><a href="all-index-S.html">S</a></td>
|
|
40
|
+
</tr>
|
|
41
|
+
<tr>
|
|
42
|
+
<td><a href="all-index-G.html">G</a></td>
|
|
43
|
+
<td><a href="all-index-T.html">T</a></td>
|
|
44
|
+
</tr>
|
|
45
|
+
<tr>
|
|
46
|
+
<td><a href="all-index-H.html">H</a></td>
|
|
47
|
+
<td><a href="all-index-U.html">U</a></td>
|
|
48
|
+
</tr>
|
|
49
|
+
<tr>
|
|
50
|
+
<td><a href="all-index-I.html">I</a></td>
|
|
51
|
+
<td><a href="all-index-V.html">V</a></td>
|
|
52
|
+
</tr>
|
|
53
|
+
<tr>
|
|
54
|
+
<td><a href="all-index-J.html">J</a></td>
|
|
55
|
+
<td><a href="all-index-W.html">W</a></td>
|
|
56
|
+
</tr>
|
|
57
|
+
<tr>
|
|
58
|
+
<td><a href="all-index-K.html">K</a></td>
|
|
59
|
+
<td><a href="all-index-X.html">X</a></td>
|
|
60
|
+
</tr>
|
|
61
|
+
<tr>
|
|
62
|
+
<td><a href="all-index-L.html">L</a></td>
|
|
63
|
+
<td><a href="all-index-Y.html">Y</a></td>
|
|
64
|
+
</tr>
|
|
65
|
+
<tr>
|
|
66
|
+
<td><a href="all-index-M.html">M</a></td>
|
|
67
|
+
<td><a href="all-index-Z.html">Z</a></td>
|
|
68
|
+
</tr>
|
|
69
|
+
</tbody></table>
|
|
70
|
+
</body><!--AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM<br/>Mon Oct 25 2010, 02:48 PM -07:00 --></html>
|
data/docs/index.html
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd"><!-- saved from url=(0014)about:internet --><html>
|
|
2
|
+
<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
3
|
+
<title>AS3 Signals v0.7</title><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">
|
|
4
|
+
<script language="javascript" type="text/javascript">
|
|
5
|
+
<!--
|
|
6
|
+
window.onload=function(){
|
|
7
|
+
var d=document.location.search;
|
|
8
|
+
var args=d.substring(d.lastIndexOf('?')+1,d.length);
|
|
9
|
+
var classFrameContent=args;
|
|
10
|
+
var classListFrameContent='';
|
|
11
|
+
if (args.indexOf('&') != -1) {
|
|
12
|
+
classFrameContent = args.substring(0,args.indexOf('&'));
|
|
13
|
+
classListFrameContent = args.substring(args.indexOf('&')+1,args.length);
|
|
14
|
+
}
|
|
15
|
+
if(classFrameContent!='')
|
|
16
|
+
top.frames['classFrame'].document.location.href=classFrameContent;
|
|
17
|
+
if(classListFrameContent!='')
|
|
18
|
+
top.frames['packageFrame'].frames['classListFrame'].document.location.href=classListFrameContent;
|
|
19
|
+
}
|
|
20
|
+
-->
|
|
21
|
+
</script>
|
|
22
|
+
</head>
|
|
23
|
+
<frameset cols="175,*" border="2" bordercolor="#AAAAAA" framespacing="1">
|
|
24
|
+
<frame src="package-frame.html" name="packageFrame" scrolling="no">
|
|
25
|
+
<frameset rows="80,*" border="0" bordercolor="#AAAAAA">
|
|
26
|
+
<frame src="title-bar.html" name="titlebar" scrolling="no" frameborder="0">
|
|
27
|
+
<frame src="package-summary.html" name="classFrame" frameborder="0">
|
|
28
|
+
</frameset>
|
|
29
|
+
<noframes>
|
|
30
|
+
<body>
|
|
31
|
+
<h2>Frame Alert</h2>
|
|
32
|
+
<p>
|
|
33
|
+
This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client.
|
|
34
|
+
<br>
|
|
35
|
+
Link to <a href="package-summary.html">Non-frame version.</a>
|
|
36
|
+
</p>
|
|
37
|
+
</body>
|
|
38
|
+
</noframes>
|
|
39
|
+
</frameset>
|
|
40
|
+
<!--AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM<br/>Mon Oct 25 2010, 02:48 PM -07:00 --></html>
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
<!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="DeluxeSignal,org.osflash.signals.DeluxeSignal,_target,_valueClasses,_valueClasses,listenerBoxes,listeners,listenersNeedCloning,listenersNeedCloning,numListeners,numListeners,numListeners,onceListeners,target,valueClasses,valueClasses,valueClasses,add,add,add,addOnce,addOnce,addOnceWithPriority,addOnceWithPriority,addOnce,addWithPriority,addWithPriority,dispatch,dispatch,dispatch,indexOfListener,registerListener,registerListener,remove,remove,remove,removeAll,removeAll,removeAll,setValueClasses,setValueClasses"><title>org.osflash.signals.DeluxeSignal</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"><!--
|
|
2
|
+
asdocTitle = 'DeluxeSignal - AS3 Signals v0.7';
|
|
3
|
+
var baseRef = '../../../';
|
|
4
|
+
window.onload = configPage;
|
|
5
|
+
--></script>
|
|
6
|
+
<script type="text/javascript">
|
|
7
|
+
scrollToNameAnchor();
|
|
8
|
+
</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">AS3 Signals v0.7</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?org/osflash/signals/DeluxeSignal.html&org/osflash/signals/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=" Adobe Logo " title=" Adobe Logo "></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">DeluxeSignal</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">
|
|
9
|
+
<!--
|
|
10
|
+
|
|
11
|
+
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("DeluxeSignal"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);}
|
|
12
|
+
-->
|
|
13
|
+
</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')">org.osflash.signals</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class DeluxeSignal</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">DeluxeSignal <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../../org/osflash/signals/IDeluxeSignal.html">IDeluxeSignal</a>, <a href="../../../org/osflash/signals/ISignalOwner.html">ISignalOwner</a>, <a href="../../../org/osflash/signals/IDispatcher.html">IDispatcher</a></td></tr><tr><td class="classHeaderTableLabel">Subclasses</td><td> <a href="../../../org/osflash/signals/natives/NativeRelaySignal.html">NativeRelaySignal</a></td></tr></table><p></p><p></p><p></p>
|
|
14
|
+
Signal dispatches events to multiple listeners.
|
|
15
|
+
It is inspired by C# events and delegates, and by
|
|
16
|
+
<a href="http://en.wikipedia.org/wiki/Signals_and_slots" target="_top">signals and slots</a>
|
|
17
|
+
in Qt.
|
|
18
|
+
A Signal adds event dispatching functionality through composition and interfaces,
|
|
19
|
+
rather than inheriting from a dispatcher.
|
|
20
|
+
|
|
21
|
+
Project home: <a href="http://github.com/robertpenner/as3-signals/" target="_top">http://github.com/robertpenner/as3-signals/</a>
|
|
22
|
+
<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="#numListeners" class="signatureLink">numListeners</a> : uint<div class="summaryTableDescription">[read-only] The current number of listeners for the signal.</div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#target" class="signatureLink">target</a> : Object<div class="summaryTableDescription"> </div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#valueClasses" class="signatureLink">valueClasses</a> : Array<div class="summaryTableDescription">[read-only]
|
|
23
|
+
An optional array of classes defining the types of parameters sent to listeners.</div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr></table></div><a name="protectedPropertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProtectedProperty"><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="#listenerBoxes" class="signatureLink">listenerBoxes</a> : Array<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#listenersNeedCloning" class="signatureLink">listenersNeedCloning</a> : Boolean = false<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#_target" class="signatureLink">_target</a> : Object<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#_valueClasses" class="signatureLink">_valueClasses</a> : Array<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">DeluxeSignal</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="#DeluxeSignal()" class="signatureLink">DeluxeSignal</a>(target:Object, ... valueClasses)</div><div class="summaryTableDescription">
|
|
24
|
+
Creates a DeluxeSignal instance to dispatch events on behalf of a target object.</div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#add()" class="signatureLink">add</a>(listener:Function):Function</div><div class="summaryTableDescription">
|
|
25
|
+
Subscribes a listener for the signal.</div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addOnce()" class="signatureLink">addOnce</a>(listener:Function):Function</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addOnceWithPriority()" class="signatureLink">addOnceWithPriority</a>(listener:Function, priority:int = 0):Function</div><div class="summaryTableDescription">
|
|
26
|
+
Subscribes a one-time listener for this signal.</div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addWithPriority()" class="signatureLink">addWithPriority</a>(listener:Function, priority:int = 0):Function</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#dispatch()" class="signatureLink">dispatch</a>(... valueObjects):void</div><div class="summaryTableDescription">
|
|
27
|
+
Dispatches an object to listeners.</div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#remove()" class="signatureLink">remove</a>(listener:Function):Function</div><div class="summaryTableDescription">
|
|
28
|
+
Unsubscribes a listener from the signal.</div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeAll()" class="signatureLink">removeAll</a>():void</div><div class="summaryTableDescription">
|
|
29
|
+
Unsubscribes all listeners from the signal.</div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr></table></div><a name="protectedMethodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProtectedMethod"><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="#indexOfListener()" class="signatureLink">indexOfListener</a>(listener:Function):int</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#registerListener()" class="signatureLink">registerListener</a>(listener:Function, once:Boolean = false, priority:int = 0):void</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setValueClasses()" class="signatureLink">setValueClasses</a>(valueClasses:Array):void</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">DeluxeSignal</td></tr></table></div><script language="javascript" type="text/javascript"><!--
|
|
30
|
+
showHideInherited();
|
|
31
|
+
--></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="_target"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">_target</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>protected var _target:Object</code><p></p></div><a name="propertyDetail"></a><a name="_valueClasses"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">_valueClasses</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>protected var _valueClasses:Array</code><p></p></div><a name="propertyDetail"></a><a name="listenerBoxes"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">listenerBoxes</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>protected var listenerBoxes:Array</code><p></p></div><a name="propertyDetail"></a><a name="listenersNeedCloning"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">listenersNeedCloning</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>protected var listenersNeedCloning:Boolean = false</code><p></p></div><a name="propertyDetail"></a><a name="numListeners"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">numListeners</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>numListeners:uint</code> [read-only] <p></p><p></p><p> The current number of listeners for the signal. </p><br/><span class="label"> Implementation </span><br/><code> public function get numListeners():uint</code><br/></div><a name="propertyDetail"></a><a name="target"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">target</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>target:Object</code><p></p><p></p><p> </p><br/><span class="label"> Implementation </span><br/><code> public function get target():Object</code><br/><code> public function set target(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="valueClasses"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">valueClasses</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>valueClasses:Array</code> [read-only] <p></p><p></p><p>
|
|
32
|
+
An optional array of classes defining the types of parameters sent to listeners.
|
|
33
|
+
</p><br/><span class="label"> Implementation </span><br/><code> public function get valueClasses():Array</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="DeluxeSignal()"></a><a name="DeluxeSignal(Object,restParam)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">DeluxeSignal</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function DeluxeSignal(target:Object, ... valueClasses)</code><p></p><p>
|
|
34
|
+
Creates a DeluxeSignal instance to dispatch events on behalf of a target object.
|
|
35
|
+
</p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">target</span>:Object</code> — The object the signal is dispatching events on behalf of.
|
|
36
|
+
</td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code>... <span class="label">valueClasses</span></code> — Any number of class references that enable type checks in dispatch().
|
|
37
|
+
For example, new DeluxeSignal(this, String, uint)
|
|
38
|
+
would allow: signal.dispatch("the Answer", 42)
|
|
39
|
+
but not: signal.dispatch(true, 42.5)
|
|
40
|
+
nor: signal.dispatch()
|
|
41
|
+
NOTE: Subclasses cannot call super.apply(null, valueClasses),
|
|
42
|
+
but this constructor has logic to support super(valueClasses).
|
|
43
|
+
</td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="add()"></a><a name="add(Function)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">add</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function add(listener:Function):Function</code><p></p><p></p><p>
|
|
44
|
+
Subscribes a listener for the signal.
|
|
45
|
+
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code> — A function with arguments
|
|
46
|
+
that matches the value classes dispatched by the signal.
|
|
47
|
+
If value classes are not specified (e.g. via Signal constructor), dispatch() can be called without arguments.
|
|
48
|
+
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Function</code> — the listener Function passed as the parameter
|
|
49
|
+
</td></tr></table></div><a name="addOnce()"></a><a name="addOnce(Function)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addOnce</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function addOnce(listener:Function):Function</code><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">listener</span>:Function</code></td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Function</code></td></tr></table></div><a name="addOnceWithPriority()"></a><a name="addOnceWithPriority(Function,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addOnceWithPriority</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function addOnceWithPriority(listener:Function, priority:int = 0):Function</code><p></p><p></p><p>
|
|
50
|
+
Subscribes a one-time listener for this signal.
|
|
51
|
+
The signal will remove the listener automatically the first time it is called,
|
|
52
|
+
after the dispatch to all listeners is complete.
|
|
53
|
+
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code> — A function with an argument
|
|
54
|
+
that matches the type of event dispatched by the signal.
|
|
55
|
+
If eventClass is not specified, the listener and dispatch() can be called without an argument.
|
|
56
|
+
</td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">priority</span>:int</code> (default = <code>0</code>)<code></code> — The priority level of the event listener.
|
|
57
|
+
The priority is designated by a signed 32-bit integer.
|
|
58
|
+
The higher the number, the higher the priority.
|
|
59
|
+
All listeners with priority n are processed before listeners of priority n-1.
|
|
60
|
+
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Function</code></td></tr></table></div><a name="addWithPriority()"></a><a name="addWithPriority(Function,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addWithPriority</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function addWithPriority(listener:Function, priority:int = 0):Function</code><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">listener</span>:Function</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">priority</span>:int</code> (default = <code>0</code>)<code></code></td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Function</code></td></tr></table></div><a name="dispatch()"></a><a name="dispatch(restParam)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dispatch</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function dispatch(... valueObjects):void</code><p></p><p></p><p>
|
|
61
|
+
Dispatches an object to listeners.
|
|
62
|
+
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code>... <span class="label">valueObjects</span></code> — Any number of parameters to send to listeners. Will be type-checked against valueClasses.
|
|
63
|
+
</td></tr></table></p></div><a name="indexOfListener()"></a><a name="indexOfListener(Function)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">indexOfListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function indexOfListener(listener:Function):int</code><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">listener</span>:Function</code></td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>int</code></td></tr></table></div><a name="registerListener()"></a><a name="registerListener(Function,Boolean,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">registerListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function registerListener(listener:Function, once:Boolean = false, priority:int = 0):void</code><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">listener</span>:Function</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">once</span>:Boolean</code> (default = <code>false</code>)<code></code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">priority</span>:int</code> (default = <code>0</code>)<code></code></td></tr></table></p></div><a name="remove()"></a><a name="remove(Function)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">remove</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function remove(listener:Function):Function</code><p></p><p></p><p>
|
|
64
|
+
Unsubscribes a listener from the signal.
|
|
65
|
+
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code></td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Function</code> — the listener Function passed as the parameter
|
|
66
|
+
</td></tr></table></div><a name="removeAll()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeAll</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function removeAll():void</code><p></p><p></p><p>
|
|
67
|
+
Unsubscribes all listeners from the signal.
|
|
68
|
+
</p></div><a name="setValueClasses()"></a><a name="setValueClasses(Array)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setValueClasses</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function setValueClasses(valueClasses:Array):void</code><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">valueClasses</span>:Array</code></td></tr></table></p></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM</footer><br/>Mon Oct 25 2010, 02:48 PM -07:00 </center></div></body></html><!--AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM<br/>Mon Oct 25 2010, 02:48 PM -07:00 -->
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
<!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="IDeluxeSignal,org.osflash.signals.IDeluxeSignal,add,add,add,addOnce,addOnce,addOnceWithPriority,addOnceWithPriority,addOnce,addWithPriority,addWithPriority,dispatch,dispatch,dispatch,indexOfListener,registerListener,registerListener,remove,remove,remove,removeAll,removeAll,removeAll,setValueClasses,setValueClasses"><title>org.osflash.signals.IDeluxeSignal</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"><!--
|
|
2
|
+
asdocTitle = 'IDeluxeSignal - AS3 Signals v0.7';
|
|
3
|
+
var baseRef = '../../../';
|
|
4
|
+
window.onload = configPage;
|
|
5
|
+
--></script>
|
|
6
|
+
<script type="text/javascript">
|
|
7
|
+
scrollToNameAnchor();
|
|
8
|
+
</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">AS3 Signals v0.7</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?org/osflash/signals/IDeluxeSignal.html&org/osflash/signals/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=" Adobe Logo " title=" Adobe Logo "></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">IDeluxeSignal</td><td class="titleTableSubNav" id="subNav" align="right"><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">
|
|
9
|
+
<!--
|
|
10
|
+
|
|
11
|
+
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("IDeluxeSignal"); titleBar_setSubNav(false,false,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);}
|
|
12
|
+
-->
|
|
13
|
+
</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')">org.osflash.signals</a></td></tr><tr><td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IDeluxeSignal extends <a href="../../../org/osflash/signals/ISignal.html">ISignal</a></td></tr><tr><td class="classHeaderTableLabel">Implementors</td><td> <a href="../../../org/osflash/signals/DeluxeSignal.html">DeluxeSignal</a>, <a href="../../../org/osflash/signals/natives/NativeSignal.html">NativeSignal</a></td></tr></table><p></p><p></p><p></p>
|
|
14
|
+
<p></p><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><div class="showHideLinks"><div id="hideInheritedProperty" class="hideInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(false,'Property');"><img class="showHideLinkImage" src="../../../images/expanded.gif"> Hide Inherited Public Properties</a></div><div id="showInheritedProperty" class="showInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(true,'Property');"><img class="showHideLinkImage" src="../../../images/collapsed.gif"> Show Inherited Public Properties</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable hideInheritedProperty" id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../org/osflash/signals/ISignal.html#numListeners" class="signatureLink">numListeners</a> : uint<div class="summaryTableDescription">[read-only] The current number of listeners for the signal.</div></td><td class="summaryTableOwnerCol"><a href="../../../org/osflash/signals/ISignal.html">ISignal</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../org/osflash/signals/ISignal.html#valueClasses" class="signatureLink">valueClasses</a> : Array<div class="summaryTableDescription">[read-only]
|
|
15
|
+
An optional array of classes defining the types of parameters sent to listeners.</div></td><td class="summaryTableOwnerCol"><a href="../../../org/osflash/signals/ISignal.html">ISignal</a></td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><div class="showHideLinks"><div id="hideInheritedMethod" class="hideInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(false,'Method');"><img class="showHideLinkImage" src="../../../images/expanded.gif"> Hide Inherited Public Methods</a></div><div id="showInheritedMethod" class="showInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(true,'Method');"><img class="showHideLinkImage" src="../../../images/collapsed.gif"> Show Inherited Public Methods</a></div></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="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../org/osflash/signals/ISignal.html#add()" class="signatureLink">add</a>(listener:Function):Function</div><div class="summaryTableDescription">
|
|
16
|
+
Subscribes a listener for the signal.</div></td><td class="summaryTableOwnerCol"><a href="../../../org/osflash/signals/ISignal.html">ISignal</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../org/osflash/signals/ISignal.html#addOnce()" class="signatureLink">addOnce</a>(listener:Function):Function</div><div class="summaryTableDescription">
|
|
17
|
+
Subscribes a one-time listener for this signal.</div></td><td class="summaryTableOwnerCol"><a href="../../../org/osflash/signals/ISignal.html">ISignal</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addOnceWithPriority()" class="signatureLink">addOnceWithPriority</a>(listener:Function, priority:int = 0):Function</div><div class="summaryTableDescription">
|
|
18
|
+
Subscribes a one-time listener for this signal.</div></td><td class="summaryTableOwnerCol">IDeluxeSignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addWithPriority()" class="signatureLink">addWithPriority</a>(listener:Function, priority:int = 0):Function</div><div class="summaryTableDescription">
|
|
19
|
+
Subscribes a listener for the signal.</div></td><td class="summaryTableOwnerCol">IDeluxeSignal</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../org/osflash/signals/ISignal.html#remove()" class="signatureLink">remove</a>(listener:Function):Function</div><div class="summaryTableDescription">
|
|
20
|
+
Unsubscribes a listener from the signal.</div></td><td class="summaryTableOwnerCol"><a href="../../../org/osflash/signals/ISignal.html">ISignal</a></td></tr></table></div><script language="javascript" type="text/javascript"><!--
|
|
21
|
+
showHideInherited();
|
|
22
|
+
--></script><div class="MainContent"><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="addOnceWithPriority()"></a><a name="addOnceWithPriority(Function,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addOnceWithPriority</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function addOnceWithPriority(listener:Function, priority:int = 0):Function</code><p></p><p></p><p>
|
|
23
|
+
Subscribes a one-time listener for this signal.
|
|
24
|
+
The signal will remove the listener automatically the first time it is called,
|
|
25
|
+
after the dispatch to all listeners is complete.
|
|
26
|
+
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code> — A function with an argument
|
|
27
|
+
that matches the type of event dispatched by the signal.
|
|
28
|
+
If eventClass is not specified, the listener and dispatch() can be called without an argument.
|
|
29
|
+
</td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">priority</span>:int</code> (default = <code>0</code>)<code></code> — The priority level of the event listener.
|
|
30
|
+
The priority is designated by a signed 32-bit integer.
|
|
31
|
+
The higher the number, the higher the priority.
|
|
32
|
+
All listeners with priority n are processed before listeners of priority n-1.
|
|
33
|
+
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Function</code></td></tr></table></div><a name="addWithPriority()"></a><a name="addWithPriority(Function,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addWithPriority</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function addWithPriority(listener:Function, priority:int = 0):Function</code><p></p><p></p><p>
|
|
34
|
+
Subscribes a listener for the signal.
|
|
35
|
+
After you successfully register an event listener,
|
|
36
|
+
you cannot change its priority through additional calls to add().
|
|
37
|
+
To change a listener's priority, you must first call remove().
|
|
38
|
+
Then you can register the listener again with the new priority level.
|
|
39
|
+
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code> — A function with an argument
|
|
40
|
+
that matches the type of event dispatched by the signal.
|
|
41
|
+
If eventClass is not specified, the listener and dispatch() can be called without an argument.
|
|
42
|
+
</td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">priority</span>:int</code> (default = <code>0</code>)<code></code></td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Function</code></td></tr></table></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM</footer><br/>Mon Oct 25 2010, 02:48 PM -07:00 </center></div></body></html><!--AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM<br/>Mon Oct 25 2010, 02:48 PM -07:00 -->
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<!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="IDispatcher,org.osflash.signals.IDispatcher,add,add,add,addOnce,addOnce,addOnceWithPriority,addOnceWithPriority,addOnce,addWithPriority,addWithPriority,dispatch,dispatch,dispatch,indexOfListener,registerListener,registerListener,remove,remove,remove,removeAll,removeAll,removeAll,setValueClasses,setValueClasses"><title>org.osflash.signals.IDispatcher</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"><!--
|
|
2
|
+
asdocTitle = 'IDispatcher - AS3 Signals v0.7';
|
|
3
|
+
var baseRef = '../../../';
|
|
4
|
+
window.onload = configPage;
|
|
5
|
+
--></script>
|
|
6
|
+
<script type="text/javascript">
|
|
7
|
+
scrollToNameAnchor();
|
|
8
|
+
</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">AS3 Signals v0.7</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?org/osflash/signals/IDispatcher.html&org/osflash/signals/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=" Adobe Logo " title=" Adobe Logo "></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">IDispatcher</td><td class="titleTableSubNav" id="subNav" align="right"><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">
|
|
9
|
+
<!--
|
|
10
|
+
|
|
11
|
+
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("IDispatcher"); titleBar_setSubNav(false,false,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);}
|
|
12
|
+
-->
|
|
13
|
+
</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')">org.osflash.signals</a></td></tr><tr><td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IDispatcher</td></tr><tr><td class="classHeaderTableLabel">Implementors</td><td> <a href="../../../org/osflash/signals/DeluxeSignal.html">DeluxeSignal</a>, <a href="../../../org/osflash/signals/Signal.html">Signal</a></td></tr></table><p></p><p></p><p></p>
|
|
14
|
+
<p></p><br/><hr></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="#dispatch()" class="signatureLink">dispatch</a>(... valueObjects):void</div><div class="summaryTableDescription">
|
|
15
|
+
Dispatches an object to listeners.</div></td><td class="summaryTableOwnerCol">IDispatcher</td></tr></table></div><script language="javascript" type="text/javascript"><!--
|
|
16
|
+
showHideInherited();
|
|
17
|
+
--></script><div class="MainContent"><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="dispatch()"></a><a name="dispatch(restParam)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dispatch</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function dispatch(... valueObjects):void</code><p></p><p></p><p>
|
|
18
|
+
Dispatches an object to listeners.
|
|
19
|
+
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code>... <span class="label">valueObjects</span></code> — Any number of parameters to send to listeners. Will be type-checked against valueClasses.
|
|
20
|
+
</td></tr></table></p><br/><span class="label">Throws</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>ArgumentError <code>ArgumentError</code>: valueObjects </code> — are not compatible with valueClasses.
|
|
21
|
+
</td></tr></table></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM</footer><br/>Mon Oct 25 2010, 02:48 PM -07:00 </center></div></body></html><!--AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM<br/>Mon Oct 25 2010, 02:48 PM -07:00 -->
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
<!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="ISignal,org.osflash.signals.ISignal,_target,_valueClasses,_valueClasses,listenerBoxes,listeners,listenersNeedCloning,listenersNeedCloning,numListeners,numListeners,numListeners,onceListeners,target,valueClasses,valueClasses,valueClasses,add,add,add,addOnce,addOnce,addOnceWithPriority,addOnceWithPriority,addOnce,addWithPriority,addWithPriority,dispatch,dispatch,dispatch,indexOfListener,registerListener,registerListener,remove,remove,remove,removeAll,removeAll,removeAll,setValueClasses,setValueClasses"><title>org.osflash.signals.ISignal</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"><!--
|
|
2
|
+
asdocTitle = 'ISignal - AS3 Signals v0.7';
|
|
3
|
+
var baseRef = '../../../';
|
|
4
|
+
window.onload = configPage;
|
|
5
|
+
--></script>
|
|
6
|
+
<script type="text/javascript">
|
|
7
|
+
scrollToNameAnchor();
|
|
8
|
+
</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">AS3 Signals v0.7</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?org/osflash/signals/ISignal.html&org/osflash/signals/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=" Adobe Logo " title=" Adobe Logo "></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">ISignal</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">
|
|
9
|
+
<!--
|
|
10
|
+
|
|
11
|
+
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("ISignal"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);}
|
|
12
|
+
-->
|
|
13
|
+
</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')">org.osflash.signals</a></td></tr><tr><td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface ISignal</td></tr></table><p></p><p></p><p></p>
|
|
14
|
+
<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="#numListeners" class="signatureLink">numListeners</a> : uint<div class="summaryTableDescription">[read-only] The current number of listeners for the signal.</div></td><td class="summaryTableOwnerCol">ISignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#valueClasses" class="signatureLink">valueClasses</a> : Array<div class="summaryTableDescription">[read-only]
|
|
15
|
+
An optional array of classes defining the types of parameters sent to listeners.</div></td><td class="summaryTableOwnerCol">ISignal</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="#add()" class="signatureLink">add</a>(listener:Function):Function</div><div class="summaryTableDescription">
|
|
16
|
+
Subscribes a listener for the signal.</div></td><td class="summaryTableOwnerCol">ISignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addOnce()" class="signatureLink">addOnce</a>(listener:Function):Function</div><div class="summaryTableDescription">
|
|
17
|
+
Subscribes a one-time listener for this signal.</div></td><td class="summaryTableOwnerCol">ISignal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#remove()" class="signatureLink">remove</a>(listener:Function):Function</div><div class="summaryTableDescription">
|
|
18
|
+
Unsubscribes a listener from the signal.</div></td><td class="summaryTableOwnerCol">ISignal</td></tr></table></div><script language="javascript" type="text/javascript"><!--
|
|
19
|
+
showHideInherited();
|
|
20
|
+
--></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="numListeners"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">numListeners</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>numListeners:uint</code> [read-only] <p></p><p></p><p> The current number of listeners for the signal. </p><br/><span class="label"> Implementation </span><br/><code> public function get numListeners():uint</code><br/></div><a name="propertyDetail"></a><a name="valueClasses"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">valueClasses</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>valueClasses:Array</code> [read-only] <p></p><p></p><p>
|
|
21
|
+
An optional array of classes defining the types of parameters sent to listeners.
|
|
22
|
+
</p><br/><span class="label"> Implementation </span><br/><code> public function get valueClasses():Array</code><br/></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="add()"></a><a name="add(Function)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">add</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function add(listener:Function):Function</code><p></p><p></p><p>
|
|
23
|
+
Subscribes a listener for the signal.
|
|
24
|
+
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code> — A function with arguments
|
|
25
|
+
that matches the value classes dispatched by the signal.
|
|
26
|
+
If value classes are not specified (e.g. via Signal constructor), dispatch() can be called without arguments.
|
|
27
|
+
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Function</code> — the listener Function passed as the parameter
|
|
28
|
+
</td></tr></table></div><a name="addOnce()"></a><a name="addOnce(Function)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addOnce</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function addOnce(listener:Function):Function</code><p></p><p></p><p>
|
|
29
|
+
Subscribes a one-time listener for this signal.
|
|
30
|
+
The signal will remove the listener automatically the first time it is called,
|
|
31
|
+
after the dispatch to all listeners is complete.
|
|
32
|
+
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code> — A function with arguments
|
|
33
|
+
that matches the value classes dispatched by the signal.
|
|
34
|
+
If value classes are not specified (e.g. via Signal constructor), dispatch() can be called without arguments.
|
|
35
|
+
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Function</code> — the listener Function passed as the parameter
|
|
36
|
+
</td></tr></table></div><a name="remove()"></a><a name="remove(Function)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">remove</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function remove(listener:Function):Function</code><p></p><p></p><p>
|
|
37
|
+
Unsubscribes a listener from the signal.
|
|
38
|
+
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code></td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Function</code> — the listener Function passed as the parameter
|
|
39
|
+
</td></tr></table></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM</footer><br/>Mon Oct 25 2010, 02:48 PM -07:00 </center></div></body></html><!--AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM<br/>Mon Oct 25 2010, 02:48 PM -07:00 -->
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
<!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="ISignalOwner,org.osflash.signals.ISignalOwner,add,add,add,addOnce,addOnce,addOnceWithPriority,addOnceWithPriority,addOnce,addWithPriority,addWithPriority,dispatch,dispatch,dispatch,indexOfListener,registerListener,registerListener,remove,remove,remove,removeAll,removeAll,removeAll,setValueClasses,setValueClasses"><title>org.osflash.signals.ISignalOwner</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"><!--
|
|
2
|
+
asdocTitle = 'ISignalOwner - AS3 Signals v0.7';
|
|
3
|
+
var baseRef = '../../../';
|
|
4
|
+
window.onload = configPage;
|
|
5
|
+
--></script>
|
|
6
|
+
<script type="text/javascript">
|
|
7
|
+
scrollToNameAnchor();
|
|
8
|
+
</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">AS3 Signals v0.7</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?org/osflash/signals/ISignalOwner.html&org/osflash/signals/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=" Adobe Logo " title=" Adobe Logo "></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">ISignalOwner</td><td class="titleTableSubNav" id="subNav" align="right"><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">
|
|
9
|
+
<!--
|
|
10
|
+
|
|
11
|
+
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("ISignalOwner"); titleBar_setSubNav(false,false,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);}
|
|
12
|
+
-->
|
|
13
|
+
</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')">org.osflash.signals</a></td></tr><tr><td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface ISignalOwner extends <a href="../../../org/osflash/signals/ISignal.html">ISignal</a></td></tr><tr><td class="classHeaderTableLabel">Implementors</td><td> <a href="../../../org/osflash/signals/DeluxeSignal.html">DeluxeSignal</a>, <a href="../../../org/osflash/signals/Signal.html">Signal</a></td></tr></table><p></p><p></p><p></p>
|
|
14
|
+
ISignalOwner gives access to the powerful function, removeAll. This should only be called by trusted classes.
|
|
15
|
+
<p></p><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><div class="showHideLinks"><div id="hideInheritedProperty" class="hideInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(false,'Property');"><img class="showHideLinkImage" src="../../../images/expanded.gif"> Hide Inherited Public Properties</a></div><div id="showInheritedProperty" class="showInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(true,'Property');"><img class="showHideLinkImage" src="../../../images/collapsed.gif"> Show Inherited Public Properties</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable hideInheritedProperty" id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../org/osflash/signals/ISignal.html#numListeners" class="signatureLink">numListeners</a> : uint<div class="summaryTableDescription">[read-only] The current number of listeners for the signal.</div></td><td class="summaryTableOwnerCol"><a href="../../../org/osflash/signals/ISignal.html">ISignal</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../org/osflash/signals/ISignal.html#valueClasses" class="signatureLink">valueClasses</a> : Array<div class="summaryTableDescription">[read-only]
|
|
16
|
+
An optional array of classes defining the types of parameters sent to listeners.</div></td><td class="summaryTableOwnerCol"><a href="../../../org/osflash/signals/ISignal.html">ISignal</a></td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><div class="showHideLinks"><div id="hideInheritedMethod" class="hideInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(false,'Method');"><img class="showHideLinkImage" src="../../../images/expanded.gif"> Hide Inherited Public Methods</a></div><div id="showInheritedMethod" class="showInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(true,'Method');"><img class="showHideLinkImage" src="../../../images/collapsed.gif"> Show Inherited Public Methods</a></div></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="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../org/osflash/signals/ISignal.html#add()" class="signatureLink">add</a>(listener:Function):Function</div><div class="summaryTableDescription">
|
|
17
|
+
Subscribes a listener for the signal.</div></td><td class="summaryTableOwnerCol"><a href="../../../org/osflash/signals/ISignal.html">ISignal</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../org/osflash/signals/ISignal.html#addOnce()" class="signatureLink">addOnce</a>(listener:Function):Function</div><div class="summaryTableDescription">
|
|
18
|
+
Subscribes a one-time listener for this signal.</div></td><td class="summaryTableOwnerCol"><a href="../../../org/osflash/signals/ISignal.html">ISignal</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../org/osflash/signals/ISignal.html#remove()" class="signatureLink">remove</a>(listener:Function):Function</div><div class="summaryTableDescription">
|
|
19
|
+
Unsubscribes a listener from the signal.</div></td><td class="summaryTableOwnerCol"><a href="../../../org/osflash/signals/ISignal.html">ISignal</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeAll()" class="signatureLink">removeAll</a>():void</div><div class="summaryTableDescription">
|
|
20
|
+
Unsubscribes all listeners from the signal.</div></td><td class="summaryTableOwnerCol">ISignalOwner</td></tr></table></div><script language="javascript" type="text/javascript"><!--
|
|
21
|
+
showHideInherited();
|
|
22
|
+
--></script><div class="MainContent"><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="removeAll()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeAll</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function removeAll():void</code><p></p><p></p><p>
|
|
23
|
+
Unsubscribes all listeners from the signal.
|
|
24
|
+
</p></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM</footer><br/>Mon Oct 25 2010, 02:48 PM -07:00 </center></div></body></html><!--AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM<br/>Mon Oct 25 2010, 02:48 PM -07:00 -->
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
<!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="Signal,org.osflash.signals.Signal,_target,_valueClasses,_valueClasses,listenerBoxes,listeners,listenersNeedCloning,listenersNeedCloning,numListeners,numListeners,numListeners,onceListeners,target,valueClasses,valueClasses,valueClasses,add,add,add,addOnce,addOnce,addOnceWithPriority,addOnceWithPriority,addOnce,addWithPriority,addWithPriority,dispatch,dispatch,dispatch,indexOfListener,registerListener,registerListener,remove,remove,remove,removeAll,removeAll,removeAll,setValueClasses,setValueClasses"><title>org.osflash.signals.Signal</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"><!--
|
|
2
|
+
asdocTitle = 'Signal - AS3 Signals v0.7';
|
|
3
|
+
var baseRef = '../../../';
|
|
4
|
+
window.onload = configPage;
|
|
5
|
+
--></script>
|
|
6
|
+
<script type="text/javascript">
|
|
7
|
+
scrollToNameAnchor();
|
|
8
|
+
</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">AS3 Signals v0.7</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?org/osflash/signals/Signal.html&org/osflash/signals/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=" Adobe Logo " title=" Adobe Logo "></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">Signal</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">
|
|
9
|
+
<!--
|
|
10
|
+
|
|
11
|
+
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Signal"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);}
|
|
12
|
+
-->
|
|
13
|
+
</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')">org.osflash.signals</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class Signal</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">Signal <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../../org/osflash/signals/ISignalOwner.html">ISignalOwner</a>, <a href="../../../org/osflash/signals/IDispatcher.html">IDispatcher</a></td></tr></table><p></p><p></p><p></p>
|
|
14
|
+
Signal dispatches events to multiple listeners.
|
|
15
|
+
It is inspired by C# events and delegates, and by
|
|
16
|
+
<a href="http://en.wikipedia.org/wiki/Signals_and_slots" target="_top">signals and slots</a>
|
|
17
|
+
in Qt.
|
|
18
|
+
A Signal adds event dispatching functionality through composition and interfaces,
|
|
19
|
+
rather than inheriting from a dispatcher.
|
|
20
|
+
|
|
21
|
+
Project home: <a href="http://github.com/robertpenner/as3-signals/" target="_top">http://github.com/robertpenner/as3-signals/</a>
|
|
22
|
+
<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="#numListeners" class="signatureLink">numListeners</a> : uint<div class="summaryTableDescription">[read-only] The current number of listeners for the signal.</div></td><td class="summaryTableOwnerCol">Signal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#valueClasses" class="signatureLink">valueClasses</a> : Array<div class="summaryTableDescription">[read-only]
|
|
23
|
+
An optional array of classes defining the types of parameters sent to listeners.</div></td><td class="summaryTableOwnerCol">Signal</td></tr></table></div><a name="protectedPropertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProtectedProperty"><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="#listeners" class="signatureLink">listeners</a> : Array<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">Signal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#listenersNeedCloning" class="signatureLink">listenersNeedCloning</a> : Boolean = false<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">Signal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#onceListeners" class="signatureLink">onceListeners</a> : Dictionary<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">Signal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#_valueClasses" class="signatureLink">_valueClasses</a> : Array<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">Signal</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="#Signal()" class="signatureLink">Signal</a>(... valueClasses)</div><div class="summaryTableDescription">
|
|
24
|
+
Creates a Signal instance to dispatch value objects.</div></td><td class="summaryTableOwnerCol">Signal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#add()" class="signatureLink">add</a>(listener:Function):Function</div><div class="summaryTableDescription">
|
|
25
|
+
Subscribes a listener for the signal.</div></td><td class="summaryTableOwnerCol">Signal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addOnce()" class="signatureLink">addOnce</a>(listener:Function):Function</div><div class="summaryTableDescription">
|
|
26
|
+
Subscribes a one-time listener for this signal.</div></td><td class="summaryTableOwnerCol">Signal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#dispatch()" class="signatureLink">dispatch</a>(... valueObjects):void</div><div class="summaryTableDescription">
|
|
27
|
+
Dispatches an object to listeners.</div></td><td class="summaryTableOwnerCol">Signal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#remove()" class="signatureLink">remove</a>(listener:Function):Function</div><div class="summaryTableDescription">
|
|
28
|
+
Unsubscribes a listener from the signal.</div></td><td class="summaryTableOwnerCol">Signal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeAll()" class="signatureLink">removeAll</a>():void</div><div class="summaryTableDescription">
|
|
29
|
+
Unsubscribes all listeners from the signal.</div></td><td class="summaryTableOwnerCol">Signal</td></tr></table></div><a name="protectedMethodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProtectedMethod"><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="#registerListener()" class="signatureLink">registerListener</a>(listener:Function, once:Boolean = false):void</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">Signal</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setValueClasses()" class="signatureLink">setValueClasses</a>(valueClasses:Array):void</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">Signal</td></tr></table></div><script language="javascript" type="text/javascript"><!--
|
|
30
|
+
showHideInherited();
|
|
31
|
+
--></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="_valueClasses"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">_valueClasses</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>protected var _valueClasses:Array</code><p></p></div><a name="propertyDetail"></a><a name="listeners"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">listeners</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>protected var listeners:Array</code><p></p></div><a name="propertyDetail"></a><a name="listenersNeedCloning"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">listenersNeedCloning</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>protected var listenersNeedCloning:Boolean = false</code><p></p></div><a name="propertyDetail"></a><a name="numListeners"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">numListeners</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>numListeners:uint</code> [read-only] <p></p><p></p><p> The current number of listeners for the signal. </p><br/><span class="label"> Implementation </span><br/><code> public function get numListeners():uint</code><br/></div><a name="propertyDetail"></a><a name="onceListeners"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">onceListeners</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>protected var onceListeners:Dictionary</code><p></p></div><a name="propertyDetail"></a><a name="valueClasses"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">valueClasses</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>valueClasses:Array</code> [read-only] <p></p><p></p><p>
|
|
32
|
+
An optional array of classes defining the types of parameters sent to listeners.
|
|
33
|
+
</p><br/><span class="label"> Implementation </span><br/><code> public function get valueClasses():Array</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="Signal()"></a><a name="Signal(restParam)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">Signal</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function Signal(... valueClasses)</code><p></p><p>
|
|
34
|
+
Creates a Signal instance to dispatch value objects.
|
|
35
|
+
</p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code>... <span class="label">valueClasses</span></code> — Any number of class references that enable type checks in dispatch().
|
|
36
|
+
For example, new Signal(String, uint)
|
|
37
|
+
would allow: signal.dispatch("the Answer", 42)
|
|
38
|
+
but not: signal.dispatch(true, 42.5)
|
|
39
|
+
nor: signal.dispatch()
|
|
40
|
+
NOTE: Subclasses cannot call super.apply(null, valueClasses),
|
|
41
|
+
but this constructor has logic to support super(valueClasses).
|
|
42
|
+
</td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="add()"></a><a name="add(Function)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">add</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function add(listener:Function):Function</code><p></p><p></p><p>
|
|
43
|
+
Subscribes a listener for the signal.
|
|
44
|
+
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code> — A function with arguments
|
|
45
|
+
that matches the value classes dispatched by the signal.
|
|
46
|
+
If value classes are not specified (e.g. via Signal constructor), dispatch() can be called without arguments.
|
|
47
|
+
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Function</code> — the listener Function passed as the parameter
|
|
48
|
+
</td></tr></table></div><a name="addOnce()"></a><a name="addOnce(Function)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addOnce</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function addOnce(listener:Function):Function</code><p></p><p></p><p>
|
|
49
|
+
Subscribes a one-time listener for this signal.
|
|
50
|
+
The signal will remove the listener automatically the first time it is called,
|
|
51
|
+
after the dispatch to all listeners is complete.
|
|
52
|
+
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code> — A function with arguments
|
|
53
|
+
that matches the value classes dispatched by the signal.
|
|
54
|
+
If value classes are not specified (e.g. via Signal constructor), dispatch() can be called without arguments.
|
|
55
|
+
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Function</code> — the listener Function passed as the parameter
|
|
56
|
+
</td></tr></table></div><a name="dispatch()"></a><a name="dispatch(restParam)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dispatch</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function dispatch(... valueObjects):void</code><p></p><p></p><p>
|
|
57
|
+
Dispatches an object to listeners.
|
|
58
|
+
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code>... <span class="label">valueObjects</span></code> — Any number of parameters to send to listeners. Will be type-checked against valueClasses.
|
|
59
|
+
</td></tr></table></p></div><a name="registerListener()"></a><a name="registerListener(Function,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">registerListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function registerListener(listener:Function, once:Boolean = false):void</code><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">listener</span>:Function</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">once</span>:Boolean</code> (default = <code>false</code>)<code></code></td></tr></table></p></div><a name="remove()"></a><a name="remove(Function)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">remove</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function remove(listener:Function):Function</code><p></p><p></p><p>
|
|
60
|
+
Unsubscribes a listener from the signal.
|
|
61
|
+
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code></td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Function</code> — the listener Function passed as the parameter
|
|
62
|
+
</td></tr></table></div><a name="removeAll()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeAll</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function removeAll():void</code><p></p><p></p><p>
|
|
63
|
+
Unsubscribes all listeners from the signal.
|
|
64
|
+
</p></div><a name="setValueClasses()"></a><a name="setValueClasses(Array)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setValueClasses</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function setValueClasses(valueClasses:Array):void</code><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">valueClasses</span>:Array</code></td></tr></table></p></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM</footer><br/>Mon Oct 25 2010, 02:48 PM -07:00 </center></div></body></html><!--AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM<br/>Mon Oct 25 2010, 02:48 PM -07:00 -->
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<!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"><title>org.osflash.signals - AS3 Signals v0.7</title><base target="classFrame"><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"></head><body class="classFrameContent"><h3><a href="package-detail.html" target="classFrame" style="color:black">Package org.osflash.signals</a></h3><table cellpadding="0" cellspacing="0"><tr><td><a href="package-detail.html#interfaceSummary" style="color:black"><b>Interfaces</b></a></td></tr><tr><td><a href="IDeluxeSignal.html"><i>IDeluxeSignal</i></a></td></tr><tr><td><a href="IDispatcher.html"><i>IDispatcher</i></a></td></tr><tr><td><a href="ISignal.html"><i>ISignal</i></a></td></tr><tr><td><a href="ISignalOwner.html"><i>ISignalOwner</i></a></td></tr><tr><td width="10px"> </td></tr><tr><td><a href="package-detail.html#classSummary" style="color:black"><b>Classes</b></a></td></tr><tr><td><a href="DeluxeSignal.html">DeluxeSignal</a></td></tr><tr><td><a href="Signal.html">Signal</a></td></tr></table></body></html><!--AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM<br/>Mon Oct 25 2010, 02:48 PM -07:00 -->
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
<!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="GenericEvent,org.osflash.signals.events.GenericEvent,_bubbles,_currentTarget,_signal,_target,bubbles,bubbles,currentTarget,currentTarget,signal,signal,target,target,clone,clone,onEventBubbled"><title>org.osflash.signals.events.GenericEvent</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"><!--
|
|
2
|
+
asdocTitle = 'GenericEvent - AS3 Signals v0.7';
|
|
3
|
+
var baseRef = '../../../../';
|
|
4
|
+
window.onload = configPage;
|
|
5
|
+
--></script>
|
|
6
|
+
<script type="text/javascript">
|
|
7
|
+
scrollToNameAnchor();
|
|
8
|
+
</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">AS3 Signals v0.7</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?org/osflash/signals/events/GenericEvent.html&org/osflash/signals/events/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=" Adobe Logo " title=" Adobe Logo "></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">GenericEvent</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">
|
|
9
|
+
<!--
|
|
10
|
+
|
|
11
|
+
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("GenericEvent"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);}
|
|
12
|
+
-->
|
|
13
|
+
</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')">org.osflash.signals.events</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class GenericEvent</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">GenericEvent <img src="../../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../../../org/osflash/signals/events/IEvent.html">IEvent</a></td></tr></table><p></p><p></p><p></p>
|
|
14
|
+
<p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="IEvent.html" target="">Documentation for the event interface being maintained in IEvent to avoid duplication for now.</a></div><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="#bubbles" class="signatureLink">bubbles</a> : Boolean<div class="summaryTableDescription"> Indicates whether the event is a bubbling event.</div></td><td class="summaryTableOwnerCol">GenericEvent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#currentTarget" class="signatureLink">currentTarget</a> : Object<div class="summaryTableDescription"> The object that added the listener for the event.</div></td><td class="summaryTableOwnerCol">GenericEvent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#signal" class="signatureLink">signal</a> : <a href="../../../../org/osflash/signals/IDeluxeSignal.html">IDeluxeSignal</a><div class="summaryTableDescription"> The signal that dispatched the event.</div></td><td class="summaryTableOwnerCol">GenericEvent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#target" class="signatureLink">target</a> : Object<div class="summaryTableDescription"> The object that originally dispatched the event.</div></td><td class="summaryTableOwnerCol">GenericEvent</td></tr></table></div><a name="protectedPropertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProtectedProperty"><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="#_bubbles" class="signatureLink">_bubbles</a> : Boolean<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">GenericEvent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#_currentTarget" class="signatureLink">_currentTarget</a> : Object<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">GenericEvent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#_signal" class="signatureLink">_signal</a> : <a href="../../../../org/osflash/signals/IDeluxeSignal.html">IDeluxeSignal</a><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">GenericEvent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#_target" class="signatureLink">_target</a> : Object<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">GenericEvent</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="#GenericEvent()" class="signatureLink">GenericEvent</a>(bubbles:Boolean = false)</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">GenericEvent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#clone()" class="signatureLink">clone</a>():<a href="../../../../org/osflash/signals/events/IEvent.html">IEvent</a></div><div class="summaryTableDescription"> Returns a new copy of the instance.</div></td><td class="summaryTableOwnerCol">GenericEvent</td></tr></table></div><script language="javascript" type="text/javascript"><!--
|
|
15
|
+
showHideInherited();
|
|
16
|
+
--></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="_bubbles"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">_bubbles</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>protected var _bubbles:Boolean</code><p></p></div><a name="propertyDetail"></a><a name="_currentTarget"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">_currentTarget</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>protected var _currentTarget:Object</code><p></p></div><a name="propertyDetail"></a><a name="_signal"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">_signal</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>protected var _signal:<a href="../../../../org/osflash/signals/IDeluxeSignal.html">IDeluxeSignal</a></code><p></p></div><a name="propertyDetail"></a><a name="_target"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">_target</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>protected var _target:Object</code><p></p></div><a name="propertyDetail"></a><a name="bubbles"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">bubbles</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>bubbles:Boolean</code><p></p><p></p><p> Indicates whether the event is a bubbling event. </p><br/><span class="label"> Implementation </span><br/><code> public function get bubbles():Boolean</code><br/><code> public function set bubbles(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="currentTarget"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">currentTarget</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>currentTarget:Object</code><p></p><p></p><p> The object that added the listener for the event. </p><br/><span class="label"> Implementation </span><br/><code> public function get currentTarget():Object</code><br/><code> public function set currentTarget(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="signal"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">signal</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>signal:<a href="../../../../org/osflash/signals/IDeluxeSignal.html">IDeluxeSignal</a></code><p></p><p></p><p> The signal that dispatched the event. </p><br/><span class="label"> Implementation </span><br/><code> public function get signal():<a href="../../../../org/osflash/signals/IDeluxeSignal.html">IDeluxeSignal</a></code><br/><code> public function set signal(value:<a href="../../../../org/osflash/signals/IDeluxeSignal.html">IDeluxeSignal</a>):void</code><br/></div><a name="propertyDetail"></a><a name="target"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">target</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>target:Object</code><p></p><p></p><p> The object that originally dispatched the event.
|
|
17
|
+
When dispatched from an signal, the target is the object containing the signal. </p><br/><span class="label"> Implementation </span><br/><code> public function get target():Object</code><br/><code> public function set target(value:Object):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="GenericEvent()"></a><a name="GenericEvent(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">GenericEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function GenericEvent(bubbles:Boolean = false)</code><p></p><br/><br/><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">bubbles</span>:Boolean</code> (default = <code>false</code>)<code></code></td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="clone()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">clone</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function clone():<a href="../../../../org/osflash/signals/events/IEvent.html">IEvent</a></code><p></p><p></p><p> Returns a new copy of the instance. </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../../../org/osflash/signals/events/IEvent.html">IEvent</a></code></td></tr></table></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM</footer><br/>Mon Oct 25 2010, 02:48 PM -07:00 </center></div></body></html><!--AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM<br/>Mon Oct 25 2010, 02:48 PM -07:00 -->
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<!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="IBubbleEventHandler,org.osflash.signals.events.IBubbleEventHandler,clone,clone,onEventBubbled"><title>org.osflash.signals.events.IBubbleEventHandler</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"><!--
|
|
2
|
+
asdocTitle = 'IBubbleEventHandler - AS3 Signals v0.7';
|
|
3
|
+
var baseRef = '../../../../';
|
|
4
|
+
window.onload = configPage;
|
|
5
|
+
--></script>
|
|
6
|
+
<script type="text/javascript">
|
|
7
|
+
scrollToNameAnchor();
|
|
8
|
+
</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">AS3 Signals v0.7</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?org/osflash/signals/events/IBubbleEventHandler.html&org/osflash/signals/events/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=" Adobe Logo " title=" Adobe Logo "></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">IBubbleEventHandler</td><td class="titleTableSubNav" id="subNav" align="right"><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">
|
|
9
|
+
<!--
|
|
10
|
+
|
|
11
|
+
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("IBubbleEventHandler"); titleBar_setSubNav(false,false,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);}
|
|
12
|
+
-->
|
|
13
|
+
</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')">org.osflash.signals.events</a></td></tr><tr><td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IBubbleEventHandler</td></tr></table><p></p><p></p><p></p><br/><hr></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="#onEventBubbled()" class="signatureLink">onEventBubbled</a>(event:<a href="../../../../org/osflash/signals/events/IEvent.html">IEvent</a>):Boolean</div><div class="summaryTableDescription">
|
|
14
|
+
Handler for event bubbling.</div></td><td class="summaryTableOwnerCol">IBubbleEventHandler</td></tr></table></div><script language="javascript" type="text/javascript"><!--
|
|
15
|
+
showHideInherited();
|
|
16
|
+
--></script><div class="MainContent"><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="onEventBubbled()"></a><a name="onEventBubbled(org.osflash.signals.events.IEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">onEventBubbled</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function onEventBubbled(event:<a href="../../../../org/osflash/signals/events/IEvent.html">IEvent</a>):Boolean</code><p></p><p></p><p>
|
|
17
|
+
Handler for event bubbling.
|
|
18
|
+
It's left to the IBubbleEventHandler to decide what to do with the event.
|
|
19
|
+
</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="../../../../org/osflash/signals/events/IEvent.html">IEvent</a></code> — The event that bubbled up.
|
|
20
|
+
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — whether to continue bubbling this event
|
|
21
|
+
</td></tr></table></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM</footer><br/>Mon Oct 25 2010, 02:48 PM -07:00 </center></div></body></html><!--AS3 Signals - Documentation generated at: 10/25/2010 02:48 PM<br/>Mon Oct 25 2010, 02:48 PM -07:00 -->
|