PageRenderTime 592ms CodeModel.GetById 21ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/asdoc/en/aw/external/jsinterface/JSSimple.html

http://jsinterface.googlecode.com/
HTML | 264 lines | 225 code | 30 blank | 9 comment | 0 complexity | 866b2c466c6d37104b960102bafe1f3c MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

    2. 

  2. <html>

    3. 

  3. <head>

    4. 

  4. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">

    5. 

  5. <link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">

    6. 

  6. <link rel="stylesheet" href="../../../print.css" type="text/css" media="print">

    7. 

  7. <meta content="JSSimple,aw.external.jsinterface.JSSimple,addSimpleType,getSimpleData,isSimpleType,removeSimpleType" name="keywords">

    8. 

  8. <title>aw.external.jsinterface.JSSimple</title>

    9. 

  9. </head>

    10. 

  10. <body>

    11. 

  11. <script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">

    12. 

  12. <!--

    13. 

  13. 				asdocTitle = 'JSSimple - API Documentation';

    14. 

  14. 				var baseRef = '../../../';

    15. 

  15. 				window.onload = configPage;

    16. 

  16. 			--></script>

    17. 

  17. <table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">

    18. 

  18. <tr>

    19. 

  19. <td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?aw/external/jsinterface/JSSimple.html&amp;aw/external/jsinterface/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>

    20. 

  20. </tr>

    21. 

  21. <tr class="titleTableRow2">

    22. 

  22. <td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;JSSimple</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>

    23. 

  23. </tr>

    24. 

  24. <tr class="titleTableRow3">

    25. 

  25. <td colspan="2">&nbsp;</td>

    26. 

  26. </tr>

    27. 

  27. </table>

    28. 

  28. <script type="text/javascript" language="javascript">

    29. 

  29. <!--

    30. 

  30. if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class JSSimple"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}

    31. 

  31. --></script>

    32. 

  32. <div class="MainContent">

    33. 

  33. <table cellspacing="0" cellpadding="0" class="classHeaderTable">

    34. 

  34. <tr>

    35. 

  35. <td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">aw.external.jsinterface</a></td>

    36. 

  36. </tr>

    37. 

  37. <tr>

    38. 

  38. <td class="classHeaderTableLabel">Class</td><td class="classSignature">public class JSSimple</td>

    39. 

  39. </tr>

    40. 

  40. <tr>

    41. 

  41. <td class="classHeaderTableLabel">Implements</td><td><a href="IJSSimple.html">IJSSimple</a></td>

    42. 

  42. </tr>

    43. 

  43. </table>

    44. 

  44. <p></p> 
    45. 

  45.  It’s a ready wrapper object for objects, transferred to JavaScript directly. 
    46. 

  46.  It allows transferring objects “as is”, without links or saving in the stack. 
    47. 

  47.  If you need to transfer an object from Flash Player environment directly to 
    48. 

  48.  JavaScript without any transformations then you should wrap it in this object. 
    49. 

  49.  
    50. 

  50.  <p></p>

    51. 

  51. <br>

    52. 

  52. <span class="label">Example</span>

    53. 

  53. <br><div class='listing'><pre>
    54. 

  54. package {
    55. 

  55.  import aw.external.JSInterface;
    56. 

  56.  import aw.external.jsinterface.JSSimple;
    57. 

  57.  
    58. 

  58.  import flash.display.Sprite;
    59. 

  59.  
    60. 

  60.  public class Test extends Sprite{
    61. 

  61.   public var initData:Object = {color:0xff00ff, size:[100, 300], thickness:2};
    62. 

  62.   public function Test():void{
    63. 

  63.    super();
    64. 

  64.    JSInterface.initialize(this, true);
    65. 

  65.    JSInterface.window.definedJavaScriptDrawFunction(this.graphics, new JSSimple(this.initData));
    66. 

  66.   }
    67. 

  67.  }
    68. 

  68. }
    69. 

  69. </pre></div>
    70. 

  70.  
    71. 

  71.  <p></p>

    72. 

  72. <p>

    73. 

  73. <span class="classHeaderTableLabel">See also</span>

    74. 

  74. </p>

    75. 

  75. <div class="seeAlso">

    76. 

  76. <a href="../jsinterface/IJSSimple.html" target="">aw.external.jsinterface.IJSSimple</a>

    77. 

  77. </div>

    78. 

  78. <br>

    79. 

  79. <hr>

    80. 

  80. </div>

    81. 

  81. <a name="methodSummary"></a>

    82. 

  82. <div class="summarySection">

    83. 

  83. <div class="summaryTableTitle">Public Methods</div>

    84. 

  84. <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">

    85. 

  85. <tr>

    86. 

  86. <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>

    87. 

  87. </tr>

    88. 

  88. <tr class="">

    89. 

  89. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">

    90. 

  90. <div class="summarySignature">

    91. 

  91. <a class="signatureLink" href="#JSSimple()">JSSimple</a>(d:Object)</div>

    92. 

  92. <div class="summaryTableDescription"> 
    93. 

  93.   
    94. 

  94.   
    95. 

  95.   
    96. 

  96.   </div>

    97. 

  97. </td><td class="summaryTableOwnerCol">JSSimple</td>

    98. 

  98. </tr>

    99. 

  99. <tr class="">

    100. 

  100. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">

    101. 

  101. <div class="summarySignature">

    102. 

  102. <a class="signatureLink" href="#addSimpleType()">addSimpleType</a>(obj:Object):void</div>

    103. 

  103. <div class="summaryTableDescription">[static] 
    104. 

  104.   
    105. 

  105.   
    106. 

  106.   
    107. 

  107.   </div>

    108. 

  108. </td><td class="summaryTableOwnerCol">JSSimple</td>

    109. 

  109. </tr>

    110. 

  110. <tr class="">

    111. 

  111. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">

    112. 

  112. <div class="summarySignature">

    113. 

  113. <a class="signatureLink" href="#getSimpleData()">getSimpleData</a>():*</div>

    114. 

  114. <div class="summaryTableDescription"> 
    115. 

  115.   It’s a method that retrieves an object transferred to the constructor as a set of simple data.</div>

    116. 

  116. </td><td class="summaryTableOwnerCol">JSSimple</td>

    117. 

  117. </tr>

    118. 

  118. <tr class="">

    119. 

  119. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">

    120. 

  120. <div class="summarySignature">

    121. 

  121. <a class="signatureLink" href="#isSimpleType()">isSimpleType</a>(obj:Object):Boolean</div>

    122. 

  122. <div class="summaryTableDescription">[static] 
    123. 

  123.   
    124. 

  124.   
    125. 

  125.   
    126. 

  126.   </div>

    127. 

  127. </td><td class="summaryTableOwnerCol">JSSimple</td>

    128. 

  128. </tr>

    129. 

  129. <tr class="">

    130. 

  130. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">

    131. 

  131. <div class="summarySignature">

    132. 

  132. <a class="signatureLink" href="#removeSimpleType()">removeSimpleType</a>(obj:Object):void</div>

    133. 

  133. <div class="summaryTableDescription">[static] 
    134. 

  134.   
    135. 

  135.   
    136. 

  136.   
    137. 

  137.   </div>

    138. 

  138. </td><td class="summaryTableOwnerCol">JSSimple</td>

    139. 

  139. </tr>

    140. 

  140. </table>

    141. 

  141. </div>

    142. 

  142. <script type="text/javascript" language="javascript">

    143. 

  143. <!--

    144. 

  144. showHideInherited();

    145. 

  145. --></script>

    146. 

  146. <div class="MainContent">

    147. 

  147. <a name="constructorDetail"></a>

    148. 

  148. <div class="detailSectionHeader">Constructor detail</div>

    149. 

  149. <a name="JSSimple()"></a>

    150. 

  150. <table cellspacing="0" cellpadding="0" class="detailHeader">

    151. 

  151. <tr>

    152. 

  152. <td class="detailHeaderName">JSSimple</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>

    153. 

  153. </tr>

    154. 

  154. </table>

    155. 

  155. <div class="detailBody">

    156. 

  156. <code>public function JSSimple(d:Object)</code><p> 
    157. 

  157.   
    158. 

  158.   
    159. 

  159.   
    160. 

  160.   </p><span class="label">Parameters</span>

    161. 

  161. <table border="0" cellspacing="0" cellpadding="0">

    162. 

  162. <tr>

    163. 

  163. <td width="20px"></td><td><code><span class="label">d</span>:Object</code></td>

    164. 

  164. </tr>

    165. 

  165. </table>

    166. 

  166. </div>

    167. 

  167. <a name="methodDetail"></a>

    168. 

  168. <div class="detailSectionHeader">Method detail</div>

    169. 

  169. <a name="addSimpleType()"></a>

    170. 

  170. <table cellspacing="0" cellpadding="0" class="detailHeader">

    171. 

  171. <tr>

    172. 

  172. <td class="detailHeaderName">addSimpleType</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>

    173. 

  173. </tr>

    174. 

  174. </table>

    175. 

  175. <div class="detailBody">

    176. 

  176. <code>public static function addSimpleType(obj:Object):void</code><p> 
    177. 

  177.   
    178. 

  178.   
    179. 

  179.   
    180. 

  180.   </p><span class="label">Parameters</span>

    181. 

  181. <table border="0" cellspacing="0" cellpadding="0">

    182. 

  182. <tr>

    183. 

  183. <td width="20px"></td><td><code><span class="label">obj</span>:Object</code></td>

    184. 

  184. </tr>

    185. 

  185. </table>

    186. 

  186. </div>

    187. 

  187. <a name="getSimpleData()"></a>

    188. 

  188. <table cellspacing="0" cellpadding="0" class="detailHeader">

    189. 

  189. <tr>

    190. 

  190. <td class="detailHeaderName">getSimpleData</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>

    191. 

  191. </tr>

    192. 

  192. </table>

    193. 

  193. <div class="detailBody">

    194. 

  194. <code>public function getSimpleData():*</code><p> 
    195. 

  195.   It’s a method that retrieves an object transferred to the constructor as a set of simple data. 
    196. 

  196.   It is used when forming a request to JavaScript environment and service information is generated 
    197. 

  197.   for all complex objects. This information will be transferred. This object used as wrapper 
    198. 

  198.   guarantees transfer of the original object to JavaScript environment directly, without writing 
    199. 

  199.   it to stack and transferring additional information.  
    200. 

  200.   
    201. 

  201.   
    202. 

  202.   </p><p></p>

    203. 

  203. <span class="label">Returns</span>

    204. 

  204. <table border="0" cellspacing="0" cellpadding="0">

    205. 

  205. <tr>

    206. 

  206. <td width="20"></td><td><code>*</code></td>

    207. 

  207. </tr>

    208. 

  208. </table>

    209. 

  209. </div>

    210. 

  210. <a name="isSimpleType()"></a>

    211. 

  211. <table cellspacing="0" cellpadding="0" class="detailHeader">

    212. 

  212. <tr>

    213. 

  213. <td class="detailHeaderName">isSimpleType</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>

    214. 

  214. </tr>

    215. 

  215. </table>

    216. 

  216. <div class="detailBody">

    217. 

  217. <code>public static function isSimpleType(obj:Object):Boolean</code><p> 
    218. 

  218.   
    219. 

  219.   
    220. 

  220.   
    221. 

  221.   </p><span class="label">Parameters</span>

    222. 

  222. <table border="0" cellspacing="0" cellpadding="0">

    223. 

  223. <tr>

    224. 

  224. <td width="20px"></td><td><code><span class="label">obj</span>:Object</code></td>

    225. 

  225. </tr>

    226. 

  226. </table>

    227. 

  227. <p></p>

    228. 

  228. <span class="label">Returns</span>

    229. 

  229. <table border="0" cellspacing="0" cellpadding="0">

    230. 

  230. <tr>

    231. 

  231. <td width="20"></td><td><code>Boolean</code> &mdash; Boolean 
    232. 

  232.   </td>

    233. 

  233. </tr>

    234. 

  234. </table>

    235. 

  235. </div>

    236. 

  236. <a name="removeSimpleType()"></a>

    237. 

  237. <table cellspacing="0" cellpadding="0" class="detailHeader">

    238. 

  238. <tr>

    239. 

  239. <td class="detailHeaderName">removeSimpleType</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>

    240. 

  240. </tr>

    241. 

  241. </table>

    242. 

  242. <div class="detailBody">

    243. 

  243. <code>public static function removeSimpleType(obj:Object):void</code><p> 
    244. 

  244.   
    245. 

  245.   
    246. 

  246.   
    247. 

  247.   </p><span class="label">Parameters</span>

    248. 

  248. <table border="0" cellspacing="0" cellpadding="0">

    249. 

  249. <tr>

    250. 

  250. <td width="20px"></td><td><code><span class="label">obj</span>:Object</code></td>

    251. 

  251. </tr>

    252. 

  252. </table>

    253. 

  253. </div>

    254. 

  254. <br>

    255. 

  255. <br>

    256. 

  256. <hr>

    257. 

  257. <br>

    258. 

  258. <p></p>

    259. 

  259. <center class="copyright"> 

    260. 

  260. </center>

    261. 

  261. </div>

    262. 

  262. </body>

    263. 

  263. </html>

    264. 

  264. <!-- -->

    265. 

  265.