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

http://gmaps-utility-library-flash.googlecode.com/ · HTML · 535 lines · 519 code · 7 blank · 9 comment · 0 complexity · 1e5749a47aaed1fb41d4588d5a59102f 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="GradientRuleList,com.google.maps.extras.gradients.GradientRuleList,createValueColorGradients,fillValueColorFromChildren,fillValueColorFromParent,fillValueColorFromSiblings,fromXML,threeColorGradientControl,toString,twoColorGradientControl" name="keywords">
  8. <title>com.google.maps.extras.gradients.GradientRuleList</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 = 'GradientRuleList - 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/GradientRuleList.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;GradientRuleList</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 GradientRuleList"); 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 GradientRuleList</td>
  39. </tr>
  40. <tr>
  41. <td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">GradientRuleList <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../../images/inherit-arrow.gif"> <a href="GradientRule.html">GradientRule</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../../images/inherit-arrow.gif"> <a href="Range.html">Range</a></td>
  42. </tr>
  43. </table>
  44. <p></p>
  45. GradientRuleList is the top class for creating gradient configs.
  46. It can be constructed from a list of GradientRule objects
  47. or from an XML spec. When combined with a list of Numbers,
  48. GradientRuleList produces a GradientControl for subsequent use.
  49. <p></p>
  50. <br>
  51. <hr>
  52. </div>
  53. <a name="propertySummary"></a>
  54. <div class="summarySection">
  55. <div class="summaryTableTitle">Public Properties</div>
  56. <div class="showHideLinks">
  57. <div class="hideInheritedProperty" id="hideInheritedProperty">
  58. <a onclick="javascript:setInheritedVisible(false,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Properties</a>
  59. </div>
  60. <div class="showInheritedProperty" id="showInheritedProperty">
  61. <a onclick="javascript:setInheritedVisible(true,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Properties</a>
  62. </div>
  63. </div>
  64. <table id="summaryTableProperty" class="summaryTable hideInheritedProperty" cellpadding="3" cellspacing="0">
  65. <tr>
  66. <th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  67. </tr>
  68. <tr class="hideInheritedProperty">
  69. <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="Range.html#maxColor">maxColor</a> : Number = NaN<div class="summaryTableDescription"></div>
  70. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  71. </tr>
  72. <tr class="hideInheritedProperty">
  73. <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="GradientRule.html#maxPercent">maxPercent</a> : Number<div class="summaryTableDescription">
  74. End of a percentage range.</div>
  75. </td><td class="summaryTableOwnerCol"><a href="GradientRule.html">GradientRule</a></td>
  76. </tr>
  77. <tr class="hideInheritedProperty">
  78. <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="Range.html#maxValue">maxValue</a> : Number = NaN<div class="summaryTableDescription"></div>
  79. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  80. </tr>
  81. <tr class="hideInheritedProperty">
  82. <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="Range.html#minColor">minColor</a> : Number = NaN<div class="summaryTableDescription"></div>
  83. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></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="GradientRule.html#minPercent">minPercent</a> : Number<div class="summaryTableDescription">
  87. Start of a percentage range.</div>
  88. </td><td class="summaryTableOwnerCol"><a href="GradientRule.html">GradientRule</a></td>
  89. </tr>
  90. <tr class="hideInheritedProperty">
  91. <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="Range.html#minValue">minValue</a> : Number = NaN<div class="summaryTableDescription"></div>
  92. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  93. </tr>
  94. </table>
  95. </div>
  96. <a name="protectedPropertySummary"></a>
  97. <div class="summarySection">
  98. <div class="summaryTableTitle">Protected Properties</div>
  99. <div class="showHideLinks">
  100. <div class="hideInheritedProtectedProperty" id="hideInheritedProtectedProperty">
  101. <a onclick="javascript:setInheritedVisible(false,'ProtectedProperty');" href="#protectedPropertySummary" class="showHideLink"><img src="../../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Protected Properties</a>
  102. </div>
  103. <div class="showInheritedProtectedProperty" id="showInheritedProtectedProperty">
  104. <a onclick="javascript:setInheritedVisible(true,'ProtectedProperty');" href="#protectedPropertySummary" class="showHideLink"><img src="../../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Protected Properties</a>
  105. </div>
  106. </div>
  107. <table id="summaryTableProtectedProperty" class="summaryTable hideInheritedProtectedProperty" cellpadding="3" cellspacing="0">
  108. <tr>
  109. <th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  110. </tr>
  111. <tr class="hideInheritedProtectedProperty">
  112. <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="Range.html#_maxPercent">_maxPercent</a> : Number = NaN<div class="summaryTableDescription"> Backing for minPercent.</div>
  113. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  114. </tr>
  115. <tr class="hideInheritedProtectedProperty">
  116. <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="Range.html#MAX_PERCENT">MAX_PERCENT</a> : Number = 100<div class="summaryTableDescription">[static]</div>
  117. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  118. </tr>
  119. <tr class="hideInheritedProtectedProperty">
  120. <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="Range.html#_minPercent">_minPercent</a> : Number = NaN<div class="summaryTableDescription"></div>
  121. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  122. </tr>
  123. <tr class="hideInheritedProtectedProperty">
  124. <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="Range.html#MIN_PERCENT">MIN_PERCENT</a> : Number = 0<div class="summaryTableDescription">[static]</div>
  125. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  126. </tr>
  127. </table>
  128. </div>
  129. <a name="methodSummary"></a>
  130. <div class="summarySection">
  131. <div class="summaryTableTitle">Public Methods</div>
  132. <div class="showHideLinks">
  133. <div class="hideInheritedMethod" id="hideInheritedMethod">
  134. <a onclick="javascript:setInheritedVisible(false,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Methods</a>
  135. </div>
  136. <div class="showInheritedMethod" id="showInheritedMethod">
  137. <a onclick="javascript:setInheritedVisible(true,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Methods</a>
  138. </div>
  139. </div>
  140. <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
  141. <tr>
  142. <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  143. </tr>
  144. <tr class="">
  145. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  146. <div class="summarySignature">
  147. <a class="signatureLink" href="#GradientRuleList()">GradientRuleList</a>(ruleList:Array)</div>
  148. <div class="summaryTableDescription">
  149. Class constructor
  150. </div>
  151. </td><td class="summaryTableOwnerCol">GradientRuleList</td>
  152. </tr>
  153. <tr class="hideInheritedMethod">
  154. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
  155. <div class="summarySignature">
  156. <a class="signatureLink" href="GradientRule.html#applyGradientToValueList()">applyGradientToValueList</a>(dataValues:Array):<a href="../gradients/GradientControl.html">GradientControl</a>
  157. </div>
  158. <div class="summaryTableDescription">
  159. Create a new instance of this class from an XML config
  160. </div>
  161. </td><td class="summaryTableOwnerCol"><a href="GradientRule.html">GradientRule</a></td>
  162. </tr>
  163. <tr class="">
  164. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  165. <div class="summarySignature">
  166. <a class="signatureLink" href="#createValueColorGradients()">createValueColorGradients</a>(parent:<a href="Range.html">Range</a>):Array</div>
  167. <div class="summaryTableDescription"></div>
  168. </td><td class="summaryTableOwnerCol">GradientRuleList</td>
  169. </tr>
  170. <tr class="hideInheritedMethod">
  171. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
  172. <div class="summarySignature">
  173. <a class="signatureLink" href="GradientRule.html#fillFromNext()">fillFromNext</a>(next:<a href="../gradients/GradientRule.html">GradientRule</a>, fillPercent:Boolean = true):void</div>
  174. <div class="summaryTableDescription"></div>
  175. </td><td class="summaryTableOwnerCol"><a href="GradientRule.html">GradientRule</a></td>
  176. </tr>
  177. <tr class="hideInheritedMethod">
  178. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
  179. <div class="summarySignature">
  180. <a class="signatureLink" href="GradientRule.html#fillFromPrev()">fillFromPrev</a>(prev:<a href="../gradients/GradientRule.html">GradientRule</a>, fillPercent:Boolean = true):void</div>
  181. <div class="summaryTableDescription"></div>
  182. </td><td class="summaryTableOwnerCol"><a href="GradientRule.html">GradientRule</a></td>
  183. </tr>
  184. <tr class="hideInheritedMethod">
  185. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
  186. <div class="summarySignature">
  187. <a class="signatureLink" href="GradientRule.html#fillMax()">fillMax</a>(other:<a href="../gradients/GradientRule.html">GradientRule</a>):void</div>
  188. <div class="summaryTableDescription"></div>
  189. </td><td class="summaryTableOwnerCol"><a href="GradientRule.html">GradientRule</a></td>
  190. </tr>
  191. <tr class="hideInheritedMethod">
  192. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
  193. <div class="summarySignature">
  194. <a class="signatureLink" href="GradientRule.html#fillMin()">fillMin</a>(other:<a href="../gradients/GradientRule.html">GradientRule</a>):void</div>
  195. <div class="summaryTableDescription"></div>
  196. </td><td class="summaryTableOwnerCol"><a href="GradientRule.html">GradientRule</a></td>
  197. </tr>
  198. <tr class="">
  199. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  200. <div class="summarySignature">
  201. <a class="signatureLink" href="#fillValueColorFromChildren()">fillValueColorFromChildren</a>():void</div>
  202. <div class="summaryTableDescription"></div>
  203. </td><td class="summaryTableOwnerCol">GradientRuleList</td>
  204. </tr>
  205. <tr class="">
  206. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  207. <div class="summarySignature">
  208. <a class="signatureLink" href="#fillValueColorFromParent()">fillValueColorFromParent</a>(parent:<a href="GradientRule.html">GradientRule</a>):void</div>
  209. <div class="summaryTableDescription"></div>
  210. </td><td class="summaryTableOwnerCol">GradientRuleList</td>
  211. </tr>
  212. <tr class="">
  213. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  214. <div class="summarySignature">
  215. <a class="signatureLink" href="#fillValueColorFromSiblings()">fillValueColorFromSiblings</a>():void</div>
  216. <div class="summaryTableDescription"></div>
  217. </td><td class="summaryTableOwnerCol">GradientRuleList</td>
  218. </tr>
  219. <tr class="">
  220. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  221. <div class="summarySignature">
  222. <a class="signatureLink" href="#fromXML()">fromXML</a>(xml:XML):<a href="../gradients/GradientRuleList.html">GradientRuleList</a>
  223. </div>
  224. <div class="summaryTableDescription">[static]
  225. Create a new instance of this class from an XML config
  226. </div>
  227. </td><td class="summaryTableOwnerCol">GradientRuleList</td>
  228. </tr>
  229. <tr class="hideInheritedMethod">
  230. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
  231. <div class="summarySignature">
  232. <a class="signatureLink" href="Range.html#getRgbColorDict()">getRgbColorDict</a>():Object</div>
  233. <div class="summaryTableDescription"></div>
  234. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  235. </tr>
  236. <tr class="hideInheritedMethod">
  237. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
  238. <div class="summarySignature">
  239. <a class="signatureLink" href="Range.html#getValueDict()">getValueDict</a>():Object</div>
  240. <div class="summaryTableDescription"></div>
  241. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  242. </tr>
  243. <tr class="hideInheritedMethod">
  244. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
  245. <div class="summarySignature">
  246. <a class="signatureLink" href="Range.html#rgbColorDictString()">rgbColorDictString</a>():String</div>
  247. <div class="summaryTableDescription">
  248. String representation of the color ranges of this object
  249. </div>
  250. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  251. </tr>
  252. <tr class="">
  253. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  254. <div class="summarySignature">
  255. <a class="signatureLink" href="#threeColorGradientControl()">threeColorGradientControl</a>(minColor:Number, midColor:Number, maxColor:Number, values:Array):<a href="../gradients/GradientControl.html">GradientControl</a>
  256. </div>
  257. <div class="summaryTableDescription">[static]
  258. Quickly create a three-color GradientControl for the specified values
  259. </div>
  260. </td><td class="summaryTableOwnerCol">GradientRuleList</td>
  261. </tr>
  262. <tr class="">
  263. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  264. <div class="summarySignature">
  265. <a class="signatureLink" href="#toString()">toString</a>():String</div>
  266. <div class="summaryTableDescription">
  267. Return a string representation of this object
  268. </div>
  269. </td><td class="summaryTableOwnerCol">GradientRuleList</td>
  270. </tr>
  271. <tr class="">
  272. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  273. <div class="summarySignature">
  274. <a class="signatureLink" href="#twoColorGradientControl()">twoColorGradientControl</a>(minColor:Number, maxColor:Number, values:Array):<a href="../gradients/GradientControl.html">GradientControl</a>
  275. </div>
  276. <div class="summaryTableDescription">[static]
  277. Quickly create a two-color GradientControl for the specified values
  278. </div>
  279. </td><td class="summaryTableOwnerCol">GradientRuleList</td>
  280. </tr>
  281. </table>
  282. </div>
  283. <a name="protectedMethodSummary"></a>
  284. <div class="summarySection">
  285. <div class="summaryTableTitle">Protected Methods</div>
  286. <div class="showHideLinks">
  287. <div class="hideInheritedProtectedMethod" id="hideInheritedProtectedMethod">
  288. <a onclick="javascript:setInheritedVisible(false,'ProtectedMethod');" href="#protectedMethodSummary" class="showHideLink"><img src="../../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Protected Methods</a>
  289. </div>
  290. <div class="showInheritedProtectedMethod" id="showInheritedProtectedMethod">
  291. <a onclick="javascript:setInheritedVisible(true,'ProtectedMethod');" href="#protectedMethodSummary" class="showHideLink"><img src="../../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Protected Methods</a>
  292. </div>
  293. </div>
  294. <table id="summaryTableProtectedMethod" class="summaryTable hideInheritedProtectedMethod" cellpadding="3" cellspacing="0">
  295. <tr>
  296. <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  297. </tr>
  298. <tr class="hideInheritedProtectedMethod">
  299. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
  300. <div class="summarySignature">
  301. <a class="signatureLink" href="GradientRule.html#createFlatGradient()">createFlatGradient</a>():<a href="../gradients/ValueColorGradient.html">ValueColorGradient</a>
  302. </div>
  303. <div class="summaryTableDescription"></div>
  304. </td><td class="summaryTableOwnerCol"><a href="GradientRule.html">GradientRule</a></td>
  305. </tr>
  306. </table>
  307. </div>
  308. <script type="text/javascript" language="javascript">
  309. <!--
  310. showHideInherited();
  311. --></script>
  312. <div class="MainContent">
  313. <a name="constructorDetail"></a>
  314. <div class="detailSectionHeader">Constructor detail</div>
  315. <a name="GradientRuleList()"></a>
  316. <table cellspacing="0" cellpadding="0" class="detailHeader">
  317. <tr>
  318. <td class="detailHeaderName">GradientRuleList</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
  319. </tr>
  320. </table>
  321. <div class="detailBody">
  322. <code>public function GradientRuleList(ruleList:Array)</code><p>
  323. Class constructor
  324. </p><span class="label">Parameters</span>
  325. <table border="0" cellspacing="0" cellpadding="0">
  326. <tr>
  327. <td width="20px"></td><td><code><span class="label">ruleList</span>:Array</code> &mdash; The list of child gradient rules
  328. </td>
  329. </tr>
  330. </table>
  331. </div>
  332. <a name="methodDetail"></a>
  333. <div class="detailSectionHeader">Method detail</div>
  334. <a name="createValueColorGradients()"></a>
  335. <table cellspacing="0" cellpadding="0" class="detailHeader">
  336. <tr>
  337. <td class="detailHeaderName">createValueColorGradients</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
  338. </tr>
  339. </table>
  340. <div class="detailBody">
  341. <code>public override function createValueColorGradients(parent:<a href="Range.html">Range</a>):Array</code><span class="label">Parameters</span>
  342. <table border="0" cellspacing="0" cellpadding="0">
  343. <tr>
  344. <td width="20px"></td><td><code><span class="label">parent</span>:<a href="Range.html">Range</a></code></td>
  345. </tr>
  346. </table>
  347. <p></p>
  348. <span class="label">Returns</span>
  349. <table border="0" cellspacing="0" cellpadding="0">
  350. <tr>
  351. <td width="20"></td><td><code>Array</code></td>
  352. </tr>
  353. </table>
  354. </div>
  355. <a name="fillValueColorFromChildren()"></a>
  356. <table cellspacing="0" cellpadding="0" class="detailHeader">
  357. <tr>
  358. <td class="detailHeaderName">fillValueColorFromChildren</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  359. </tr>
  360. </table>
  361. <div class="detailBody">
  362. <code>public override function fillValueColorFromChildren():void</code>
  363. </div>
  364. <a name="fillValueColorFromParent()"></a>
  365. <table cellspacing="0" cellpadding="0" class="detailHeader">
  366. <tr>
  367. <td class="detailHeaderName">fillValueColorFromParent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  368. </tr>
  369. </table>
  370. <div class="detailBody">
  371. <code>public override function fillValueColorFromParent(parent:<a href="GradientRule.html">GradientRule</a>):void</code><span class="label">Parameters</span>
  372. <table border="0" cellspacing="0" cellpadding="0">
  373. <tr>
  374. <td width="20px"></td><td><code><span class="label">parent</span>:<a href="GradientRule.html">GradientRule</a></code></td>
  375. </tr>
  376. </table>
  377. </div>
  378. <a name="fillValueColorFromSiblings()"></a>
  379. <table cellspacing="0" cellpadding="0" class="detailHeader">
  380. <tr>
  381. <td class="detailHeaderName">fillValueColorFromSiblings</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  382. </tr>
  383. </table>
  384. <div class="detailBody">
  385. <code>public override function fillValueColorFromSiblings():void</code>
  386. </div>
  387. <a name="fromXML()"></a>
  388. <table cellspacing="0" cellpadding="0" class="detailHeader">
  389. <tr>
  390. <td class="detailHeaderName">fromXML</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  391. </tr>
  392. </table>
  393. <div class="detailBody">
  394. <code>public static function fromXML(xml:XML):<a href="../gradients/GradientRuleList.html">GradientRuleList</a></code><p>
  395. Create a new instance of this class from an XML config
  396. </p><span class="label">Parameters</span>
  397. <table border="0" cellspacing="0" cellpadding="0">
  398. <tr>
  399. <td width="20px"></td><td><code><span class="label">xml</span>:XML</code> &mdash; An XML configuration specifying gradient config
  400. </td>
  401. </tr>
  402. </table>
  403. <p></p>
  404. <span class="label">Returns</span>
  405. <table border="0" cellspacing="0" cellpadding="0">
  406. <tr>
  407. <td width="20"></td><td><code><a href="../gradients/GradientRuleList.html">GradientRuleList</a></code></td>
  408. </tr>
  409. </table>
  410. </div>
  411. <a name="threeColorGradientControl()"></a>
  412. <table cellspacing="0" cellpadding="0" class="detailHeader">
  413. <tr>
  414. <td class="detailHeaderName">threeColorGradientControl</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  415. </tr>
  416. </table>
  417. <div class="detailBody">
  418. <code>public static function threeColorGradientControl(minColor:Number, midColor:Number, maxColor:Number, values:Array):<a href="../gradients/GradientControl.html">GradientControl</a></code><p>
  419. Quickly create a three-color GradientControl for the specified values
  420. </p><span class="label">Parameters</span>
  421. <table border="0" cellspacing="0" cellpadding="0">
  422. <tr>
  423. <td width="20px"></td><td><code><span class="label">minColor</span>:Number</code> &mdash; The start of the color range
  424. </td>
  425. </tr>
  426. <tr>
  427. <td class="paramSpacer">&nbsp;</td>
  428. </tr>
  429. <tr>
  430. <td width="20px"></td><td><code><span class="label">midColor</span>:Number</code> &mdash; The middle of the color range
  431. </td>
  432. </tr>
  433. <tr>
  434. <td class="paramSpacer">&nbsp;</td>
  435. </tr>
  436. <tr>
  437. <td width="20px"></td><td><code><span class="label">maxColor</span>:Number</code> &mdash; The end of the color range
  438. </td>
  439. </tr>
  440. <tr>
  441. <td class="paramSpacer">&nbsp;</td>
  442. </tr>
  443. <tr>
  444. <td width="20px"></td><td><code><span class="label">values</span>:Array</code> &mdash; The list of Numbers whose min and max values define
  445. the numerical range.
  446. </td>
  447. </tr>
  448. </table>
  449. <p></p>
  450. <span class="label">Returns</span>
  451. <table border="0" cellspacing="0" cellpadding="0">
  452. <tr>
  453. <td width="20"></td><td><code><a href="../gradients/GradientControl.html">GradientControl</a></code> &mdash;
  454. A GradientControl
  455. </td>
  456. </tr>
  457. </table>
  458. </div>
  459. <a name="toString()"></a>
  460. <table cellspacing="0" cellpadding="0" class="detailHeader">
  461. <tr>
  462. <td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  463. </tr>
  464. </table>
  465. <div class="detailBody">
  466. <code>public override function toString():String</code><p>
  467. Return a string representation of this object
  468. </p><p></p>
  469. <span class="label">Returns</span>
  470. <table border="0" cellspacing="0" cellpadding="0">
  471. <tr>
  472. <td width="20"></td><td><code>String</code> &mdash; A string
  473. </td>
  474. </tr>
  475. </table>
  476. </div>
  477. <a name="twoColorGradientControl()"></a>
  478. <table cellspacing="0" cellpadding="0" class="detailHeader">
  479. <tr>
  480. <td class="detailHeaderName">twoColorGradientControl</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  481. </tr>
  482. </table>
  483. <div class="detailBody">
  484. <code>public static function twoColorGradientControl(minColor:Number, maxColor:Number, values:Array):<a href="../gradients/GradientControl.html">GradientControl</a></code><p>
  485. Quickly create a two-color GradientControl for the specified values
  486. </p><span class="label">Parameters</span>
  487. <table border="0" cellspacing="0" cellpadding="0">
  488. <tr>
  489. <td width="20px"></td><td><code><span class="label">minColor</span>:Number</code> &mdash; The start of the color range
  490. </td>
  491. </tr>
  492. <tr>
  493. <td class="paramSpacer">&nbsp;</td>
  494. </tr>
  495. <tr>
  496. <td width="20px"></td><td><code><span class="label">maxColor</span>:Number</code> &mdash; The end of the color range
  497. </td>
  498. </tr>
  499. <tr>
  500. <td class="paramSpacer">&nbsp;</td>
  501. </tr>
  502. <tr>
  503. <td width="20px"></td><td><code><span class="label">values</span>:Array</code> &mdash; The list of Numbers whose min and max values define
  504. the numerical range.
  505. </td>
  506. </tr>
  507. </table>
  508. <p></p>
  509. <span class="label">Returns</span>
  510. <table border="0" cellspacing="0" cellpadding="0">
  511. <tr>
  512. <td width="20"></td><td><code><a href="../gradients/GradientControl.html">GradientControl</a></code> &mdash;
  513. A GradientControl
  514. </td>
  515. </tr>
  516. </table>
  517. </div>
  518. <br>
  519. <br>
  520. <hr>
  521. <br>
  522. <p></p>
  523. <center class="copyright">
  524. </center>
  525. </div>
  526. </body>
  527. </html>
  528. <!-- -->