/docs/com/google/maps/extras/gradients/Range.html

http://gmaps-utility-library-flash.googlecode.com/ · HTML · 364 lines · 354 code · 1 blank · 9 comment · 0 complexity · 528f4196d21b188e933c9b039d61c0cc 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="Range,com.google.maps.extras.gradients.Range,MAX_PERCENT,MIN_PERCENT,_maxPercent,_minPercent,maxColor,maxValue,minColor,minValue,maxPercent,minPercent,getRgbColorDict,getValueDict,rgbColorDictString,toString" name="keywords">
  8. <title>com.google.maps.extras.gradients.Range</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 = 'Range - 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/gradients/Range.html&amp;com/google/maps/extras/gradients/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;Range</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 Range"); 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.gradients</a></td>
  36. </tr>
  37. <tr>
  38. <td class="classHeaderTableLabel">Class</td><td class="classSignature">public class Range</td>
  39. </tr>
  40. <tr>
  41. <td class="classHeaderTableLabel">Subclasses</td><td><a href="../gradients/GradientRule.html">GradientRule</a>, <a href="../gradients/ValueColorGradient.html">ValueColorGradient</a></td>
  42. </tr>
  43. </table>
  44. <p></p>
  45. A Range is an abstract class that stores three numerical ranges
  46. representing colors, absolute values and percentages.
  47. <p></p>
  48. <br>
  49. <hr>
  50. </div>
  51. <a name="propertySummary"></a>
  52. <div class="summarySection">
  53. <div class="summaryTableTitle">Public Properties</div>
  54. <table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
  55. <tr>
  56. <th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  57. </tr>
  58. <tr class="">
  59. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#maxColor">maxColor</a> : Number = NaN<div class="summaryTableDescription"></div>
  60. </td><td class="summaryTableOwnerCol">Range</td>
  61. </tr>
  62. <tr class="">
  63. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#maxPercent">maxPercent</a> : Number<div class="summaryTableDescription">
  64. End of a percentage range.</div>
  65. </td><td class="summaryTableOwnerCol">Range</td>
  66. </tr>
  67. <tr class="">
  68. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#maxValue">maxValue</a> : Number = NaN<div class="summaryTableDescription"></div>
  69. </td><td class="summaryTableOwnerCol">Range</td>
  70. </tr>
  71. <tr class="">
  72. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#minColor">minColor</a> : Number = NaN<div class="summaryTableDescription"></div>
  73. </td><td class="summaryTableOwnerCol">Range</td>
  74. </tr>
  75. <tr class="">
  76. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#minPercent">minPercent</a> : Number<div class="summaryTableDescription">
  77. Start of a percentage range.</div>
  78. </td><td class="summaryTableOwnerCol">Range</td>
  79. </tr>
  80. <tr class="">
  81. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#minValue">minValue</a> : Number = NaN<div class="summaryTableDescription"></div>
  82. </td><td class="summaryTableOwnerCol">Range</td>
  83. </tr>
  84. </table>
  85. </div>
  86. <a name="protectedPropertySummary"></a>
  87. <div class="summarySection">
  88. <div class="summaryTableTitle">Protected Properties</div>
  89. <table id="summaryTableProtectedProperty" class="summaryTable " cellpadding="3" cellspacing="0">
  90. <tr>
  91. <th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  92. </tr>
  93. <tr class="">
  94. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#_maxPercent">_maxPercent</a> : Number = NaN<div class="summaryTableDescription"> Backing for minPercent.</div>
  95. </td><td class="summaryTableOwnerCol">Range</td>
  96. </tr>
  97. <tr class="">
  98. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#MAX_PERCENT">MAX_PERCENT</a> : Number = 100<div class="summaryTableDescription">[static]</div>
  99. </td><td class="summaryTableOwnerCol">Range</td>
  100. </tr>
  101. <tr class="">
  102. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#_minPercent">_minPercent</a> : Number = NaN<div class="summaryTableDescription"></div>
  103. </td><td class="summaryTableOwnerCol">Range</td>
  104. </tr>
  105. <tr class="">
  106. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#MIN_PERCENT">MIN_PERCENT</a> : Number = 0<div class="summaryTableDescription">[static]</div>
  107. </td><td class="summaryTableOwnerCol">Range</td>
  108. </tr>
  109. </table>
  110. </div>
  111. <a name="methodSummary"></a>
  112. <div class="summarySection">
  113. <div class="summaryTableTitle">Public Methods</div>
  114. <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
  115. <tr>
  116. <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  117. </tr>
  118. <tr class="">
  119. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  120. <div class="summarySignature">
  121. <a class="signatureLink" href="#Range()">Range</a>(self:<a href="Range.html">Range</a>)</div>
  122. <div class="summaryTableDescription"> Backing for maxPercent.</div>
  123. </td><td class="summaryTableOwnerCol">Range</td>
  124. </tr>
  125. <tr class="">
  126. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  127. <div class="summarySignature">
  128. <a class="signatureLink" href="#getRgbColorDict()">getRgbColorDict</a>():Object</div>
  129. <div class="summaryTableDescription"></div>
  130. </td><td class="summaryTableOwnerCol">Range</td>
  131. </tr>
  132. <tr class="">
  133. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  134. <div class="summarySignature">
  135. <a class="signatureLink" href="#getValueDict()">getValueDict</a>():Object</div>
  136. <div class="summaryTableDescription"></div>
  137. </td><td class="summaryTableOwnerCol">Range</td>
  138. </tr>
  139. <tr class="">
  140. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  141. <div class="summarySignature">
  142. <a class="signatureLink" href="#rgbColorDictString()">rgbColorDictString</a>():String</div>
  143. <div class="summaryTableDescription">
  144. String representation of the color ranges of this object
  145. </div>
  146. </td><td class="summaryTableOwnerCol">Range</td>
  147. </tr>
  148. <tr class="">
  149. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  150. <div class="summarySignature">
  151. <a class="signatureLink" href="#toString()">toString</a>():String</div>
  152. <div class="summaryTableDescription">
  153. String representation of this object
  154. </div>
  155. </td><td class="summaryTableOwnerCol">Range</td>
  156. </tr>
  157. </table>
  158. </div>
  159. <script type="text/javascript" language="javascript">
  160. <!--
  161. showHideInherited();
  162. --></script>
  163. <div class="MainContent">
  164. <a name="propertyDetail"></a>
  165. <div class="detailSectionHeader">Property detail</div>
  166. <a name="maxColor"></a>
  167. <table cellspacing="0" cellpadding="0" class="detailHeader">
  168. <tr>
  169. <td class="detailHeaderName">maxColor</td><td class="detailHeaderType">property</td>
  170. </tr>
  171. </table>
  172. <div class="detailBody">
  173. <code>public var maxColor:Number = NaN</code>
  174. </div>
  175. <a name="_maxPercent"></a>
  176. <table cellspacing="0" cellpadding="0" class="detailHeader">
  177. <tr>
  178. <td class="detailHeaderName">_maxPercent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  179. </tr>
  180. </table>
  181. <div class="detailBody">
  182. <code>protected var _maxPercent:Number = NaN</code><p> Backing for minPercent. </p></div>
  183. <a name="maxPercent"></a>
  184. <table cellspacing="0" cellpadding="0" class="detailHeader">
  185. <tr>
  186. <td class="detailHeaderName">maxPercent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  187. </tr>
  188. </table>
  189. <div class="detailBody">
  190. <code>maxPercent:Number</code>&nbsp;&nbsp;[read-write]<p>
  191. End of a percentage range.
  192. </p><span class="label">Implementation</span>
  193. <br>
  194. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get maxPercent():Number</code>
  195. <br>
  196. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function set maxPercent(value:Number):void</code>
  197. <br>
  198. </div>
  199. <a name="MAX_PERCENT"></a>
  200. <table cellspacing="0" cellpadding="0" class="detailHeader">
  201. <tr>
  202. <td class="detailHeaderName">MAX_PERCENT</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  203. </tr>
  204. </table>
  205. <div class="detailBody">
  206. <code>protected static var MAX_PERCENT:Number = 100</code>
  207. </div>
  208. <a name="maxValue"></a>
  209. <table cellspacing="0" cellpadding="0" class="detailHeader">
  210. <tr>
  211. <td class="detailHeaderName">maxValue</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  212. </tr>
  213. </table>
  214. <div class="detailBody">
  215. <code>public var maxValue:Number = NaN</code>
  216. </div>
  217. <a name="minColor"></a>
  218. <table cellspacing="0" cellpadding="0" class="detailHeader">
  219. <tr>
  220. <td class="detailHeaderName">minColor</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  221. </tr>
  222. </table>
  223. <div class="detailBody">
  224. <code>public var minColor:Number = NaN</code>
  225. </div>
  226. <a name="_minPercent"></a>
  227. <table cellspacing="0" cellpadding="0" class="detailHeader">
  228. <tr>
  229. <td class="detailHeaderName">_minPercent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  230. </tr>
  231. </table>
  232. <div class="detailBody">
  233. <code>protected var _minPercent:Number = NaN</code>
  234. </div>
  235. <a name="minPercent"></a>
  236. <table cellspacing="0" cellpadding="0" class="detailHeader">
  237. <tr>
  238. <td class="detailHeaderName">minPercent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  239. </tr>
  240. </table>
  241. <div class="detailBody">
  242. <code>minPercent:Number</code>&nbsp;&nbsp;[read-write]<p>
  243. Start of a percentage range.
  244. </p><span class="label">Implementation</span>
  245. <br>
  246. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get minPercent():Number</code>
  247. <br>
  248. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function set minPercent(value:Number):void</code>
  249. <br>
  250. </div>
  251. <a name="MIN_PERCENT"></a>
  252. <table cellspacing="0" cellpadding="0" class="detailHeader">
  253. <tr>
  254. <td class="detailHeaderName">MIN_PERCENT</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  255. </tr>
  256. </table>
  257. <div class="detailBody">
  258. <code>protected static var MIN_PERCENT:Number = 0</code>
  259. </div>
  260. <a name="minValue"></a>
  261. <table cellspacing="0" cellpadding="0" class="detailHeader">
  262. <tr>
  263. <td class="detailHeaderName">minValue</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  264. </tr>
  265. </table>
  266. <div class="detailBody">
  267. <code>public var minValue:Number = NaN</code>
  268. </div>
  269. <a name="constructorDetail"></a>
  270. <div class="detailSectionHeader">Constructor detail</div>
  271. <a name="Range()"></a>
  272. <table cellspacing="0" cellpadding="0" class="detailHeader">
  273. <tr>
  274. <td class="detailHeaderName">Range</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
  275. </tr>
  276. </table>
  277. <div class="detailBody">
  278. <code>public function Range(self:<a href="Range.html">Range</a>)</code><p> Backing for maxPercent. </p><span class="label">Parameters</span>
  279. <table border="0" cellspacing="0" cellpadding="0">
  280. <tr>
  281. <td width="20px"></td><td><code><span class="label">self</span>:<a href="Range.html">Range</a></code></td>
  282. </tr>
  283. </table>
  284. </div>
  285. <a name="methodDetail"></a>
  286. <div class="detailSectionHeader">Method detail</div>
  287. <a name="getRgbColorDict()"></a>
  288. <table cellspacing="0" cellpadding="0" class="detailHeader">
  289. <tr>
  290. <td class="detailHeaderName">getRgbColorDict</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
  291. </tr>
  292. </table>
  293. <div class="detailBody">
  294. <code>public function getRgbColorDict():Object</code>
  295. <p></p>
  296. <span class="label">Returns</span>
  297. <table border="0" cellspacing="0" cellpadding="0">
  298. <tr>
  299. <td width="20"></td><td><code>Object</code></td>
  300. </tr>
  301. </table>
  302. </div>
  303. <a name="getValueDict()"></a>
  304. <table cellspacing="0" cellpadding="0" class="detailHeader">
  305. <tr>
  306. <td class="detailHeaderName">getValueDict</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  307. </tr>
  308. </table>
  309. <div class="detailBody">
  310. <code>public function getValueDict():Object</code>
  311. <p></p>
  312. <span class="label">Returns</span>
  313. <table border="0" cellspacing="0" cellpadding="0">
  314. <tr>
  315. <td width="20"></td><td><code>Object</code></td>
  316. </tr>
  317. </table>
  318. </div>
  319. <a name="rgbColorDictString()"></a>
  320. <table cellspacing="0" cellpadding="0" class="detailHeader">
  321. <tr>
  322. <td class="detailHeaderName">rgbColorDictString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  323. </tr>
  324. </table>
  325. <div class="detailBody">
  326. <code>public function rgbColorDictString():String</code><p>
  327. String representation of the color ranges of this object
  328. </p><p></p>
  329. <span class="label">Returns</span>
  330. <table border="0" cellspacing="0" cellpadding="0">
  331. <tr>
  332. <td width="20"></td><td><code>String</code></td>
  333. </tr>
  334. </table>
  335. </div>
  336. <a name="toString()"></a>
  337. <table cellspacing="0" cellpadding="0" class="detailHeader">
  338. <tr>
  339. <td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  340. </tr>
  341. </table>
  342. <div class="detailBody">
  343. <code>public function toString():String</code><p>
  344. String representation of this object
  345. </p><p></p>
  346. <span class="label">Returns</span>
  347. <table border="0" cellspacing="0" cellpadding="0">
  348. <tr>
  349. <td width="20"></td><td><code>String</code></td>
  350. </tr>
  351. </table>
  352. </div>
  353. <br>
  354. <br>
  355. <hr>
  356. <br>
  357. <p></p>
  358. <center class="copyright">
  359. </center>
  360. </div>
  361. </body>
  362. </html>
  363. <!-- -->