PageRenderTime 74ms CodeModel.GetById 45ms app.highlight 22ms RepoModel.GetById 2ms app.codeStats 0ms

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