D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
opt
/
lampp
/
lib
/
php
/
doc
/
HTML_Progress
/
docs
/
TDG
/
HTML_Progress
/
Filename :
tutorial_ui.setorientation.pkg.html
back
Copy
<html> <head> <title>HTML_Progress_UI::setOrientation</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.getorientation.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.getfillway.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::setOrientation</span></div> <div class="ref-purpose">sets the orientation of the progress meter</div></div> <span><a name="synopsis"></a><h2 class="title">Synopsis</h2><div class="ref-synopsis"><p><p class="func-synopsis">require_once 'HTML/Progress/UI.php';</p> void <span class="function">HTML_Progress_UI::setOrientation</span>( integer <i>$orient</i>)</p></div></span> <span><a name="description"></a><h2 class="title">Description</h2><p>This method is used to change orientation of the progress meter in one step.</p> <p><table frame = "border"><p><strong>It could be:</strong></p><colgroup span = "2"/><thead align = "center"><tr><td><strong>Orientation</strong></td> <td><strong>Use constant</strong></td></tr></thead> <tbody><tr><td>horizontal</td> <td><b>HTML_PROGRESS_BAR_HORIZONTAL</b></td></tr> <tr><td>vertical</td> <td><b>HTML_PROGRESS_BAR_VERTICAL</b></td></tr> <tr><td>polygonal (square, rectangle)</td> <td><b>HTML_PROGRESS_POLYGONAL</b></td></tr> <tr><td>circle, ellipse</td> <td><b>HTML_PROGRESS_CIRCLE</b></td></tr></tbody></table></p></span> <span><a name="parameter"></a><h2 class="title">Parameter</h2><p><ul class="parameter"><dl><dt>integer <i>$orient</i><dd> <li><p>the new progress meter orientation.</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>$orient</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>$orient</i>" was expecting "1|2|3|4"</td> <td>Expected one of these constants: <p><ol><li><b>HTML_PROGRESS_BAR_HORIZONTAL</b></li> <li><b>HTML_PROGRESS_BAR_VERTICAL</b></li> <li><b>HTML_PROGRESS_POLYGONAL</b></li> <li><b>HTML_PROGRESS_CIRCLE</b></li></ol></p></td></tr></tbody></table></p></span> <span><a name="note"></a><h2 class="title">Note</h2>( HTML_Progress >= 1.0 )<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/caution.png"></td><td class="note_text">Parameter <strong>$orient</strong> is an integer which identify only 2 shapes (in version 1.0): Horizontal and Vertical progress bars. Polygonal and Circle shapes are available only since version 1.2.0RC1.</td></tr></table></p></span> <span><a name="see"></a><h2 class="title">See</h2><p><a href="../HTML_Progress/tutorial_ui.getorientation.pkg.html">HTML_Progress_UI::getOrientation</a></p></span> <span><a name="example"></a><h2 class="title">Example</h2><p>Example below (that requires HTML_Progress >= 1.2.0RC3) will produced a vertical progress bar (see line 11) with only 6 cells. It's a dynamic example, the progress bar will run.<br /> <p><table class="note"><tr><td><img src="../media/example.png"></td><td><img src = "../media/screenshots/vertical1.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">100</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">setIdent</span><span class="src-sym">(</span><span class="src-str">'PB1'</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><span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">setBorderPainted</span><span class="src-sym">(</span><span class="src-id">true</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#methodsetOrientation">setOrientation</a><span class="src-sym">(</span><span class="src-id"><a href="../HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_BAR_VERTICAL">HTML_PROGRESS_BAR_VERTICAL</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#methodsetFillWay">setFillWay</a><span class="src-sym">(</span><span class="src-str">'natural'</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#methodsetCellCount">setCellCount</a><span class="src-sym">(</span><span class="src-num">6</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">'active-color' </span>=> <span class="src-str">'#970038'</span><span class="src-sym">,</span></li> <li> <span class="src-str">'inactive-color' </span>=> <span class="src-str">'#FFDDAA'</span><span class="src-sym">,</span></li> <li> <span class="src-str">'width' </span>=> <span class="src-num">50</span><span class="src-sym">,</span></li> <li> <span class="src-str">'height' </span>=> <span class="src-num">13</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#methodsetBorderAttributes">setBorderAttributes</a><span class="src-sym">(</span><span class="src-str">'width=1'</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-key">array</span><span class="src-sym">(</span></li> <li> <span class="src-str">'font-size' </span>=> <span class="src-num">8</span><span class="src-sym">,</span></li> <li> <span class="src-str">'color' </span>=> <span class="src-str">'#FF0000'</span><span class="src-sym">,</span></li> <li> <span class="src-str">'background-color' </span>=> <span class="src-str">'#C3C6C3'</span><span class="src-sym">,</span></li> <li> <span class="src-str">'align' </span>=> <span class="src-str">'center'</span><span class="src-sym">, </span></li> <li> <span class="src-str">'valign' </span>=> <span class="src-str">'bottom'</span></li> <li><span class="src-sym">))</span><span class="src-sym">;</span></li> <li> </li> <li><span class="src-php">?></span></li> <li><!DOCTYPE html</li> <li> PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"</li> <li> "http://www.w3c.org/TR/xhtml1/DTD/xhtml1-strict.dtd"></li> <li> </li> <li><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"></li> <li><head></li> <li><title>setOrientation 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>body {</li> <li> background-color: #C3C6C3;</li> <li> color: #000000;</li> <li> font-family: Verdana, Arial;</li> <li>}</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">$bar</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.getorientation.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.getfillway.pkg.html">Next</a></td> </tr> <tr> <td width="33%" align="left" valign="top"><span class="function">HTML_Progress_UI::getOrientation</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::getFillWay</span></td> </tr> </table> <div class="credit"> <hr /> Documentation generated on Sun, 12 Sep 2004 20:23:19 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a> </div> </td></tr></table> </td> </tr> </table> </body> </html>