<html> <head> <title>HTML_Progress_UI::setCellCoordinates</title> <link rel="stylesheet" type="text/css" href="../media/style.css"> </head> <body> <table border="0" cellspacing="0" cellpadding="0" height="48" width="100%"> <tr> <td class="header_top">HTML_Progress</td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> <tr> <td class="header_menu"> [ <a href="../classtrees_HTML_Progress.html" class="menu">class tree: HTML_Progress</a> ] [ <a href="../elementindex_HTML_Progress.html" class="menu">index: HTML_Progress</a> ] [ <a href="../elementindex.html" class="menu">all elements</a> ] </td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> </table> <table width="100%" border="0" cellpadding="0" cellspacing="0"> <tr valign="top"> <td> <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top"> <table width="100%" border="0" cellpadding="0" cellspacing="0"> <tr> <td width="10%" align="left" valign="bottom"><a href= "../HTML_Progress/tutorial_ui.getcellcoordinates.pkg.html">Prev</a></td> <td width="80%" align="center" valign="bottom"></td> <td width="10%" align="right" valign="bottom"><a href= "../HTML_Progress/tutorial_ui.getborderattributes.pkg.html">Next</a></td> </tr> </table> <div><a name=""></a><div class="ref-title-box"><div class="ref-title"><span class="function">HTML_Progress_UI::setCellCoordinates</span></div> <div class="ref-purpose">sets the coordinates of each cell for a polygonal shape</div></div> <span><a name="synopsis"></a><h2 class="title">Synopsis</h2><div class="ref-synopsis"><p class="func-synopsis">require_once 'HTML/Progress/UI.php';</p> mixed <span class="function">HTML_Progress_UI::setCellCoordinates</span>( int <i>$xgrid</i> int <i>$ygrid</i> array <i>$coord = NULL</i>)</div></span> <span><a name="description"></a><h2 class="title">Description</h2><p>This method is used to define all cell coordinates of any progress meter polygonal shape (square, rectangle ...)</p></span> <span><a name="parameter"></a><h2 class="title">Parameter</h2><p><ul class="parameter"><dl><dt>integer <i>$xgrid</i><dd> <li><p>the grid width in cell size.</p></li></dl></ul> <ul class="parameter"><dl><dt>integer <i>$ygrid</i><dd> <li><p>the grid height in cell size.</p></li></dl></ul> <ul class="parameter"><dl><dt>array <i>$coord</i><dd> <li><p>the coordinates (x,y) in the grid, of each cell.</p></li></dl></ul></p></span> <span><a name="throws"></a><h2 class="title">Throws</h2><p><table frame = "border"><p><strong>Possible PEAR_Error values</strong></p><colgroup span = "4"/><thead><tr><td>Error level</td> <td>Error code</td> <td>Error message</td> <td>Solution</td></tr></thead> <tbody><tr><td>exception</td> <td><b>HTML_PROGRESS_ERROR_INVALID_INPUT</b></td> <td>invalid input, parameter #1 "<i>$xgrid</i>" was expecting "integer"</td> <td>Fixed the cast of parameter</td></tr> <tr><td>error</td> <td><b>HTML_PROGRESS_ERROR_INVALID_INPUT</b></td> <td>invalid input, parameter #1 "<i>$xgrid</i>" was expecting "greater than 2"</td> <td>Give an integer greater than two</td></tr> <tr><td>exception</td> <td><b>HTML_PROGRESS_ERROR_INVALID_INPUT</b></td> <td>invalid input, parameter #2 "<i>$ygrid</i>" was expecting "integer"</td> <td>Fixed the cast of parameter</td></tr> <tr><td>error</td> <td><b>HTML_PROGRESS_ERROR_INVALID_INPUT</b></td> <td>invalid input, parameter #2 "<i>$ygrid</i>" was expecting "greater than 2"</td> <td>Give an integer greater than two</td></tr> <tr><td>exception</td> <td><b>HTML_PROGRESS_ERROR_INVALID_INPUT</b></td> <td>invalid input, parameter #3 "<i>$coord</i>" was expecting "array"</td> <td>Fixed the cast of parameter</td></tr> <tr><td>error</td> <td><b>HTML_PROGRESS_ERROR_INVALID_INPUT</b></td> <td>invalid input, parameter #3 "<i>$coord</i>" was expecting "coordinate less than grid width"</td> <td>Fixed the cell x-coordinate or the parameter #1 (grid width)</td></tr> <tr><td>error</td> <td><b>HTML_PROGRESS_ERROR_INVALID_INPUT</b></td> <td>invalid input, parameter #3 "<i>$coord</i>" was expecting "coordinate less than grid height"</td> <td>Fixed the cell y-coordinate or the parameter #2 (grid height)</td></tr></tbody></table></p></span> <span><a name="note"></a><h2 class="title">Note</h2>( HTML_Progress >= 1.2.0RC1 )<br /> <p><table class="note"><tr><td class="note_img"><img src="../media/important.png"></td><td class="note_text">This function can not be called statically.</td></tr></table></p> <p><table class="note"><tr><td class="note_img"><img src="../media/tip.png"></td><td class="note_text">For basic shapes (square, rectangle), you don't have to give all cell coordinates. HTML_Progress will compute it for you. You should have to give the cell coordinates list only for free polygonal shape.</td></tr></table></p></span> <span><a name="see"></a><h2 class="title">See</h2><p><a href="../HTML_Progress/tutorial_ui.getcellcoordinates.pkg.html">HTML_Progress_UI::getCellCoordinates</a></p></span> <span><a name="example"></a><h2 class="title">Example</h2><p>Example below will create a rectangle 6x4 (see line 18).<br /> <p><table class="note"><tr><td><img src="../media/example.png"></td><td><img src = "../media/screenshots/rect64.png"/></td></tr></table></p> <p><div class="listing"><pre><ol><li><span class="src-php"><?php</span></li> <li><span class="src-inc">require_once </span><span class="src-str">'HTML/Progress.php'</span><span class="src-sym">;</span></li> <li> </li> <li><span class="src-var">$bar </span>= <span class="src-key">new </span><span class="src-id"><a href="../HTML_Progress/HTML_Progress.html">HTML_Progress</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">setAnimSpeed</span><span class="src-sym">(</span><span class="src-num">250</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">setIncrement</span><span class="src-sym">(</span><span class="src-num">10</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li> </li> <li><span class="src-var">$ui </span>=<span class="src-sym">& </span><span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">getUI</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$ui</span><span class="src-sym">-></span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetStringAttributes">setStringAttributes</a><span class="src-sym">(</span><span class="src-str">'valign=bottom align=center width=90 height=30'</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$ui</span><span class="src-sym">-></span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetOrientation">setOrientation</a><span class="src-sym">(</span><span class="src-id"><a href="../HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_POLYGONAL">HTML_PROGRESS_POLYGONAL</a></span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$ui</span><span class="src-sym">-></span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetCellAttributes">setCellAttributes</a><span class="src-sym">(</span><span class="src-key">array</span><span class="src-sym">(</span></li> <li> <span class="src-str">'width' </span>=> <span class="src-num">15</span><span class="src-sym">,</span></li> <li> <span class="src-str">'height' </span>=> <span class="src-num">15</span><span class="src-sym">,</span></li> <li> <span class="src-str">'active-color' </span>=> <span class="src-str">'red'</span><span class="src-sym">,</span></li> <li> <span class="src-str">'inactive-color' </span>=> <span class="src-str">'orange'</span><span class="src-sym">,</span></li> <li> <span class="src-sym">)</span></li> <li><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$ui</span><span class="src-sym">-></span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetCellCoordinates">setCellCoordinates</a><span class="src-sym">(</span><span class="src-num">6</span><span class="src-sym">,</span><span class="src-num">4</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm">// Rectangle 6x4</span></li> <li><span class="src-php">?></span></li> <li><html></li> <li><head></li> <li><title>setCellCoordinates example</title></li> <li><style type="text/css"></li> <li><!--</li> <li><span class="src-php"><?php </span>echo <span class="src-var">$bar</span><span class="src-sym">-></span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetStyle">getStyle</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-php">?></span></li> <li>// --></li> <li></style></li> <li><script type="text/javascript"></li> <li><!--</li> <li><span class="src-php"><?php </span>echo <span class="src-var">$ui</span><span class="src-sym">-></span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetScript">getScript</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-php">?></span></li> <li>//--></li> <li></script></li> <li></head></li> <li><body></li> <li> </li> <li><span class="src-php"><?php </span></li> <li>echo <span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">toHtml</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span></li> <li><span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-php">?></span></li> <li> </li> <li></body></li> <li></html></li> </ol></pre></div></p></p></span></div> <table width="100%" border="0" cellpadding="0" cellspacing="0"> <tr> <td width="33%" align="left" valign="top"><a href="../HTML_Progress/tutorial_ui.getcellcoordinates.pkg.html">Prev</a></td> <td width="34%" align="center" valign="top"><a href= "../HTML_Progress/tutorial_part3-reference.pkg.html">Up</a></td> <td width="33%" align="right" valign="top"><a href= "../HTML_Progress/tutorial_ui.getborderattributes.pkg.html">Next</a></td> </tr> <tr> <td width="33%" align="left" valign="top"><span class="function">HTML_Progress_UI::getCellCoordinates</span></td> <td width="34%" align="center" valign="top">Reference Guide</td> <td width="33%" align="right" valign="top"><span class="function">HTML_Progress_UI::getBorderAttributes</span></td> </tr> </table> <div class="credit"> <hr /> Documentation generated on Sun, 12 Sep 2004 20:23:24 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a> </div> </td></tr></table> </td> </tr> </table> </body> </html>