/docs/com/google/maps/extras/xmlparsers/kml/Overlay.html

http://gmaps-utility-library-flash.googlecode.com/ · HTML · 300 lines · 289 code · 2 blank · 9 comment · 0 complexity · ed37aac3f58e2c5b9a457a8031f64340 MD5 · raw file

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <head>
  4. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  5. <link rel="stylesheet" href="../../../../../../style.css" type="text/css" media="screen">
  6. <link rel="stylesheet" href="../../../../../../print.css" type="text/css" media="print">
  7. <meta content="Overlay,com.google.maps.extras.xmlparsers.kml.Overlay,color,drawOrder,icon,toString" name="keywords">
  8. <title>com.google.maps.extras.xmlparsers.kml.Overlay</title>
  9. </head>
  10. <body>
  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. <!--
  13. asdocTitle = 'Overlay - API Documentation';
  14. var baseRef = '../../../../../../';
  15. window.onload = configPage;
  16. --></script>
  17. <table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
  18. <tr>
  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?com/google/maps/extras/xmlparsers/kml/Overlay.html&amp;com/google/maps/extras/xmlparsers/kml/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. </tr>
  21. <tr class="titleTableRow2">
  22. <td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;Overlay</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
  23. </tr>
  24. <tr class="titleTableRow3">
  25. <td colspan="2">&nbsp;</td>
  26. </tr>
  27. </table>
  28. <script type="text/javascript" language="javascript">
  29. <!--
  30. if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class Overlay"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
  31. --></script>
  32. <div class="MainContent">
  33. <table cellspacing="0" cellpadding="0" class="classHeaderTable">
  34. <tr>
  35. <td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.google.maps.extras.xmlparsers.kml</a></td>
  36. </tr>
  37. <tr>
  38. <td class="classHeaderTableLabel">Class</td><td class="classSignature">public class Overlay</td>
  39. </tr>
  40. <tr>
  41. <td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">Overlay <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../../../images/inherit-arrow.gif"> <a href="Feature.html">Feature</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../../../images/inherit-arrow.gif"> <a href="KmlObject.html">KmlObject</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../../../images/inherit-arrow.gif"> <a href="../XmlElement.html">XmlElement</a></td>
  42. </tr>
  43. <tr>
  44. <td class="classHeaderTableLabel">Subclasses</td><td><a href="../kml/KmlGroundOverlay.html">KmlGroundOverlay</a></td>
  45. </tr>
  46. </table>
  47. <p></p>
  48. Base class extended by GroundOverlay, ScreenOverlay (not implemented), and PhotoOverlay (not implemented).
  49. <p></p>
  50. <p>
  51. <span class="classHeaderTableLabel">See also</span>
  52. </p>
  53. <div class="seeAlso">
  54. <a href="http://code.google.com/apis/kml/documentation/kmlreference.html#overlay" target="mm_external">http://code.google.com/apis/kml/documentation/kmlreference.html#overlay</a>
  55. </div>
  56. <br>
  57. <hr>
  58. </div>
  59. <a name="propertySummary"></a>
  60. <div class="summarySection">
  61. <div class="summaryTableTitle">Public Properties</div>
  62. <div class="showHideLinks">
  63. <div class="hideInheritedProperty" id="hideInheritedProperty">
  64. <a onclick="javascript:setInheritedVisible(false,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Properties</a>
  65. </div>
  66. <div class="showInheritedProperty" id="showInheritedProperty">
  67. <a onclick="javascript:setInheritedVisible(true,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Properties</a>
  68. </div>
  69. </div>
  70. <table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
  71. <tr>
  72. <th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  73. </tr>
  74. <tr class="hideInheritedProperty">
  75. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Feature.html#author">author</a> : <a href="../atom/Author.html">Author</a>
  76. <div class="summaryTableDescription">
  77. Represents the &lt;atom:author&gt; child element.</div>
  78. </td><td class="summaryTableOwnerCol"><a href="Feature.html">Feature</a></td>
  79. </tr>
  80. <tr class="">
  81. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#color">color</a> : String<div class="summaryTableDescription">[read-only]
  82. Represents the &lt;color&gt; child element.</div>
  83. </td><td class="summaryTableOwnerCol">Overlay</td>
  84. </tr>
  85. <tr class="hideInheritedProperty">
  86. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Feature.html#description">description</a> : String<div class="summaryTableDescription">
  87. Represents the &lt;description&gt; child element.</div>
  88. </td><td class="summaryTableOwnerCol"><a href="Feature.html">Feature</a></td>
  89. </tr>
  90. <tr class="">
  91. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#drawOrder">drawOrder</a> : Number<div class="summaryTableDescription">[read-only]
  92. Represents the &lt;drawOrder&gt; child element.</div>
  93. </td><td class="summaryTableOwnerCol">Overlay</td>
  94. </tr>
  95. <tr class="">
  96. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#icon">icon</a> : <a href="../kml/Icon.html">Icon</a>
  97. <div class="summaryTableDescription">[read-only]
  98. Represents the &lt;href&gt; child element.</div>
  99. </td><td class="summaryTableOwnerCol">Overlay</td>
  100. </tr>
  101. <tr class="hideInheritedProperty">
  102. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="KmlObject.html#_id">_id</a> : String<div class="summaryTableDescription"></div>
  103. </td><td class="summaryTableOwnerCol"><a href="KmlObject.html">KmlObject</a></td>
  104. </tr>
  105. <tr class="hideInheritedProperty">
  106. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="KmlObject.html#id">id</a> : String<div class="summaryTableDescription">
  107. Represents the id attribute of the element.</div>
  108. </td><td class="summaryTableOwnerCol"><a href="KmlObject.html">KmlObject</a></td>
  109. </tr>
  110. <tr class="hideInheritedProperty">
  111. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="KmlObject.html#kml">kml</a> : Namespace<div class="summaryTableDescription"></div>
  112. </td><td class="summaryTableOwnerCol"><a href="KmlObject.html">KmlObject</a></td>
  113. </tr>
  114. <tr class="hideInheritedProperty">
  115. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Feature.html#link">link</a> : <a href="../atom/Link.html">Link</a>
  116. <div class="summaryTableDescription">
  117. Represents the &lt;atom:link&gt; child element.</div>
  118. </td><td class="summaryTableOwnerCol"><a href="Feature.html">Feature</a></td>
  119. </tr>
  120. <tr class="hideInheritedProperty">
  121. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Feature.html#name">name</a> : String<div class="summaryTableDescription">
  122. Represents the &lt;name&gt; child element.</div>
  123. </td><td class="summaryTableOwnerCol"><a href="Feature.html">Feature</a></td>
  124. </tr>
  125. <tr class="hideInheritedProperty">
  126. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Feature.html#open">open</a> : Boolean<div class="summaryTableDescription">
  127. Represents the &lt;open&gt; child element.</div>
  128. </td><td class="summaryTableOwnerCol"><a href="Feature.html">Feature</a></td>
  129. </tr>
  130. <tr class="hideInheritedProperty">
  131. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Feature.html#snippet">snippet</a> : String<div class="summaryTableDescription">
  132. Represents the &lt;snippet&gt; child element.</div>
  133. </td><td class="summaryTableOwnerCol"><a href="Feature.html">Feature</a></td>
  134. </tr>
  135. <tr class="hideInheritedProperty">
  136. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Feature.html#style">style</a> : <a href="../kml/Style.html">Style</a>
  137. <div class="summaryTableDescription">
  138. Represents the &lt;Style&gt; child element.</div>
  139. </td><td class="summaryTableOwnerCol"><a href="Feature.html">Feature</a></td>
  140. </tr>
  141. <tr class="hideInheritedProperty">
  142. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Feature.html#styleUrl">styleUrl</a> : String<div class="summaryTableDescription">
  143. Represents the &lt;styleUrl&gt; child element.</div>
  144. </td><td class="summaryTableOwnerCol"><a href="Feature.html">Feature</a></td>
  145. </tr>
  146. <tr class="hideInheritedProperty">
  147. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Feature.html#visibility">visibility</a> : Boolean<div class="summaryTableDescription">
  148. Represents the &lt;visibility&gt; child element.</div>
  149. </td><td class="summaryTableOwnerCol"><a href="Feature.html">Feature</a></td>
  150. </tr>
  151. <tr class="hideInheritedProperty">
  152. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../XmlElement.html#xml">xml</a> : XMLList<div class="summaryTableDescription">
  153. Get the XML used to populate the NewsFeedElement.</div>
  154. </td><td class="summaryTableOwnerCol"><a href="../XmlElement.html">XmlElement</a></td>
  155. </tr>
  156. </table>
  157. </div>
  158. <a name="protectedPropertySummary"></a>
  159. <div class="summarySection">
  160. <div class="summaryTableTitle">Protected Properties</div>
  161. <div class="showHideLinks">
  162. <div class="hideInheritedProtectedProperty" id="hideInheritedProtectedProperty">
  163. <a onclick="javascript:setInheritedVisible(false,'ProtectedProperty');" href="#protectedPropertySummary" class="showHideLink"><img src="../../../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Protected Properties</a>
  164. </div>
  165. <div class="showInheritedProtectedProperty" id="showInheritedProtectedProperty">
  166. <a onclick="javascript:setInheritedVisible(true,'ProtectedProperty');" href="#protectedPropertySummary" class="showHideLink"><img src="../../../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Protected Properties</a>
  167. </div>
  168. </div>
  169. <table id="summaryTableProtectedProperty" class="summaryTable hideInheritedProtectedProperty" cellpadding="3" cellspacing="0">
  170. <tr>
  171. <th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  172. </tr>
  173. <tr class="hideInheritedProtectedProperty">
  174. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../XmlElement.html#x">x</a> : XMLList<div class="summaryTableDescription"></div>
  175. </td><td class="summaryTableOwnerCol"><a href="../XmlElement.html">XmlElement</a></td>
  176. </tr>
  177. </table>
  178. </div>
  179. <a name="methodSummary"></a>
  180. <div class="summarySection">
  181. <div class="summaryTableTitle">Public Methods</div>
  182. <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
  183. <tr>
  184. <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  185. </tr>
  186. <tr class="">
  187. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  188. <div class="summarySignature">
  189. <a class="signatureLink" href="#Overlay()">Overlay</a>(x:XMLList)</div>
  190. <div class="summaryTableDescription">
  191. Constructor for class.</div>
  192. </td><td class="summaryTableOwnerCol">Overlay</td>
  193. </tr>
  194. <tr class="">
  195. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  196. <div class="summarySignature">
  197. <a class="signatureLink" href="#toString()">toString</a>():String</div>
  198. <div class="summaryTableDescription"></div>
  199. </td><td class="summaryTableOwnerCol">Overlay</td>
  200. </tr>
  201. </table>
  202. </div>
  203. <script type="text/javascript" language="javascript">
  204. <!--
  205. showHideInherited();
  206. --></script>
  207. <div class="MainContent">
  208. <a name="propertyDetail"></a>
  209. <div class="detailSectionHeader">Property detail</div>
  210. <a name="color"></a>
  211. <table cellspacing="0" cellpadding="0" class="detailHeader">
  212. <tr>
  213. <td class="detailHeaderName">color</td><td class="detailHeaderType">property</td>
  214. </tr>
  215. </table>
  216. <div class="detailBody">
  217. <code>color:String</code>&nbsp;&nbsp;[read-only]<p>
  218. Represents the &lt;color&gt; child element.
  219. </p><span class="label">Implementation</span>
  220. <br>
  221. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get color():String</code>
  222. <br>
  223. </div>
  224. <a name="drawOrder"></a>
  225. <table cellspacing="0" cellpadding="0" class="detailHeader">
  226. <tr>
  227. <td class="detailHeaderName">drawOrder</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  228. </tr>
  229. </table>
  230. <div class="detailBody">
  231. <code>drawOrder:Number</code>&nbsp;&nbsp;[read-only]<p>
  232. Represents the &lt;drawOrder&gt; child element.
  233. </p><span class="label">Implementation</span>
  234. <br>
  235. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get drawOrder():Number</code>
  236. <br>
  237. </div>
  238. <a name="icon"></a>
  239. <table cellspacing="0" cellpadding="0" class="detailHeader">
  240. <tr>
  241. <td class="detailHeaderName">icon</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  242. </tr>
  243. </table>
  244. <div class="detailBody">
  245. <code>icon:<a href="../kml/Icon.html">Icon</a></code>&nbsp;&nbsp;[read-only]<p>
  246. Represents the &lt;href&gt; child element.
  247. </p><span class="label">Implementation</span>
  248. <br>
  249. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get icon():<a href="../kml/Icon.html">Icon</a></code>
  250. <br>
  251. </div>
  252. <a name="constructorDetail"></a>
  253. <div class="detailSectionHeader">Constructor detail</div>
  254. <a name="Overlay()"></a>
  255. <table cellspacing="0" cellpadding="0" class="detailHeader">
  256. <tr>
  257. <td class="detailHeaderName">Overlay</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
  258. </tr>
  259. </table>
  260. <div class="detailBody">
  261. <code>public function Overlay(x:XMLList)</code><p>
  262. Constructor for class.
  263. </p><span class="label">Parameters</span>
  264. <table border="0" cellspacing="0" cellpadding="0">
  265. <tr>
  266. <td width="20px"></td><td><code><span class="label">x</span>:XMLList</code></td>
  267. </tr>
  268. </table>
  269. </div>
  270. <a name="methodDetail"></a>
  271. <div class="detailSectionHeader">Method detail</div>
  272. <a name="toString()"></a>
  273. <table cellspacing="0" cellpadding="0" class="detailHeader">
  274. <tr>
  275. <td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
  276. </tr>
  277. </table>
  278. <div class="detailBody">
  279. <code>public override function toString():String</code>
  280. <p></p>
  281. <span class="label">Returns</span>
  282. <table border="0" cellspacing="0" cellpadding="0">
  283. <tr>
  284. <td width="20"></td><td><code>String</code></td>
  285. </tr>
  286. </table>
  287. </div>
  288. <br>
  289. <br>
  290. <hr>
  291. <br>
  292. <p></p>
  293. <center class="copyright">
  294. </center>
  295. </div>
  296. </body>
  297. </html>
  298. <!-- -->