%PDF- %PDF-
Direktori : /home/alliance/domains/sedl.alnetis.fr/public_html/js/libs/development-bundle/docs/ |
Current File : /home/alliance/domains/sedl.alnetis.fr/public_html/js/libs/development-bundle/docs/progressbar.html |
<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>jQuery UI progressbar documentation</title> <style> body { font-family: "Trebuchet MS", "Arial", "Helvetica", "Verdana", "sans-serif" } .gutter { display: none; } </style> </head> <body> <script>{ "title": "Progressbar Widget", "excerpt": "Display status of a determinate process.", "termSlugs": { "category": [ "widgets" ] } }</script><section class="quick-nav"><header><h2>QuickNav</h2></header><div class="quick-nav-section"> <h3>Options</h3> <div><a href="#option-disabled">disabled</a></div> <div><a href="#option-value">value</a></div> </div> <div class="quick-nav-section"> <h3>Methods</h3> <div><a href="#method-destroy">destroy</a></div> <div><a href="#method-disable">disable</a></div> <div><a href="#method-enable">enable</a></div> <div><a href="#method-option">option</a></div> <div><a href="#method-value">value</a></div> <div><a href="#method-widget">widget</a></div> </div> <div class="quick-nav-section"> <h3>Events</h3> <div><a href="#event-change">change</a></div> <div><a href="#event-create">create</a></div> <div><a href="#event-complete">complete</a></div> </div></section><article id="progressbar1" class="entry widget"><h2 class="section-title"> <span>Progressbar Widget</span><span class="version-details">version added: 1.6</span> </h2> <div class="entry-wrapper"> <p class="desc"><strong>Description: </strong>Display status of a determinate process.</p> <section id="options"><header><h2 class="underline">Options</h2></header><div id="option-disabled" class="api-item first-item"> <h3>disabled<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Boolean">Boolean</a></span> </h3> <div class="default"> <strong>Default: </strong><code>false</code> </div> <div>Disables the progressbar if set to <code>true</code>.</div> </div> <div id="option-value" class="api-item"> <h3>value<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Number">Number</a></span> </h3> <div class="default"> <strong>Default: </strong><code>0</code> </div> <div>The value of the progressbar.</div> </div></section><section id="methods"><header><h2 class="underline">Methods</h2></header><div id="method-destroy"><div class="api-item first-item"> <h3>destroy()</h3> <div> Removes the progressbar functionality completely. This will return the element back to its pre-init state. </div> </div></div> <div id="method-disable"><div class="api-item"> <h3>disable()</h3> <div> Disables the progressbar. </div> </div></div> <div id="method-enable"><div class="api-item"> <h3>enable()</h3> <div> Enables the progressbar. </div> </div></div> <div id="method-option"> <div class="api-item"> <h3>option( optionName ) <span class="returns">Returns: <a class="return" href="http://api.jquery.com/Types/#Object">Object</a></span> </h3> <div>Gets the value currently associated with the specified <code>optionName</code>.</div> <ul><li> <div><strong>optionName</strong></div> <div>Type: <a href="http://api.jquery.com/Types#String">String</a> </div> <div>The name of the option to get.</div> </li></ul> </div> <div class="api-item"> <h3>option() <span class="returns">Returns: <a class="return" href="http://api.jquery.com/Types/#PlainObject">PlainObject</a></span> </h3> <div>Gets an object containing key/value pairs representing the current progressbar options hash.</div> </div> <div class="api-item"> <h3>option( optionName, value )</h3> <div>Sets the value of the progressbar option associated with the specified <code>optionName</code>.</div> <ul> <li> <div><strong>optionName</strong></div> <div>Type: <a href="http://api.jquery.com/Types#String">String</a> </div> <div>The name of the option to set.</div> </li> <li> <div><strong>value</strong></div> <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a> </div> <div>A value to set for the option.</div> </li> </ul> </div> <div class="api-item"> <h3>option( options )</h3> <div>Sets one or more options for the progressbar.</div> <ul><li> <div><strong>options</strong></div> <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a> </div> <div>A map of option-value pairs to set.</div> </li></ul> </div> </div> <div id="method-value"> <div class="api-item"> <h3>value() <span class="returns">Returns: <a class="return" href="http://api.jquery.com/Types/#Number">Number</a></span> </h3> <div>Gets the current value of the progressbar.</div> </div> <div class="api-item"> <h3>value( value )</h3> <div>Sets the current value of the progressbar.</div> <ul><li> <div><strong>value</strong></div> <div>Type: <a href="http://api.jquery.com/Types#Number">Number</a> </div> <div>The value to set.</div> </li></ul> </div> </div> <div id="method-widget"><div class="api-item"> <h3>widget() <span class="returns">Returns: <a class="return" href="http://api.jquery.com/Types/#jQuery">jQuery</a></span> </h3> <div> Returns a <code>jQuery</code> object containing the progressbar. </div> </div></div></section><section id="events"><header><h2 class="underline">Events</h2></header><div id="event-change" class="api-item first-item"> <h3>change( event, ui )</h3> <div>Triggered when the value of the progressbar changes.</div> <ul> <li> <div><strong>event</strong></div> <div>Type: <a href="http://api.jquery.com/Types#Event">Event</a> </div> <div></div> </li> <li> <div><strong>ui</strong></div> <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a> </div> <div></div> </li> </ul> </div> <div id="event-complete" class="api-item"> <h3>complete( event, ui )</h3> <div>Triggered when the value of the progressbar reaches the maximum value.</div> <ul> <li> <div><strong>event</strong></div> <div>Type: <a href="http://api.jquery.com/Types#Event">Event</a> </div> <div></div> </li> <li> <div><strong>ui</strong></div> <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a> </div> <div></div> </li> </ul> </div> <div id="event-create" class="api-item"> <h3>create( event, ui )</h3> <div> Triggered when the progressbar is created. </div> <ul> <li> <div><strong>event</strong></div> <div>Type: <a href="http://api.jquery.com/Types#Event">Event</a> </div> <div></div> </li> <li> <div><strong>ui</strong></div> <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a> </div> <div></div> </li> </ul> </div></section><div class="longdesc"> <p> The progress bar is designed to display the current percent complete for a process. The bar is coded to be flexibly sized through CSS and will scale to fit inside its parent container by default. </p> <p> This is a determinate progress bar, meaning that it should only be used in situations where the system can accurately update the current status. A determinate progress bar should never fill from left to right, then loop back to empty for a single process — if the actual status cannot be calculated, an indeterminate progress bar or spinner animation is a better way to provide user feedback. </p> </div> <h3>Additional Notes:</h3> <div class="longdesc"><ul><li> This widget requires some functional CSS, otherwise it won't work. If you build a custom theme, use the widget's specific CSS file as a starting point. </li></ul></div> <section class="entry-examples" id="entry-examples"><header><h2 class="underline">Example:</h2></header><div class="entry-example" id="example-0"> <h4><span class="desc">A simple jQuery UI Progressbar</span></h4> <div class="syntaxhighlighter "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="gutter"><div class="line number1 index0 alt2">1</div><div class="line number2 index1 alt1">2</div><div class="line number3 index2 alt2">3</div><div class="line number4 index3 alt1">4</div><div class="line number5 index4 alt2">5</div><div class="line number6 index5 alt1">6</div><div class="line number7 index6 alt2">7</div><div class="line number8 index7 alt1">8</div><div class="line number9 index8 alt2">9</div><div class="line number10 index9 alt1">10</div><div class="line number11 index10 alt2">11</div><div class="line number12 index11 alt1">12</div><div class="line number13 index12 alt2">13</div><div class="line number14 index13 alt1">14</div><div class="line number15 index14 alt2">15</div><div class="line number16 index15 alt1">16</div><div class="line number17 index16 alt2">17</div><div class="line number18 index17 alt1">18</div><div class="line number19 index18 alt2">19</div><div class="line number20 index19 alt1">20</div><div class="line number21 index20 alt2">21</div></td><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain"><!doctype html></code></div><div class="line number2 index1 alt1"><code class="plain"><</code><code class="keyword">html</code> <code class="color1">lang</code><code class="plain">=</code><code class="string">"en"</code><code class="plain">></code></div><div class="line number3 index2 alt2"><code class="plain"><</code><code class="keyword">head</code><code class="plain">></code></div><div class="line number4 index3 alt1"><code class="undefined spaces"> </code><code class="plain"><</code><code class="keyword">meta</code> <code class="color1">charset</code><code class="plain">=</code><code class="string">"utf-8"</code><code class="plain">></code></div><div class="line number5 index4 alt2"><code class="undefined spaces"> </code><code class="plain"><</code><code class="keyword">title</code><code class="plain">>progressbar demo</</code><code class="keyword">title</code><code class="plain">></code></div><div class="line number6 index5 alt1"><code class="undefined spaces"> </code><code class="plain"><</code><code class="keyword">link</code> <code class="color1">rel</code><code class="plain">=</code><code class="string">"stylesheet"</code> <code class="color1">href</code><code class="plain">=</code><code class="string">"<a href="http://code.jquery.com/ui/1.9.0-rc.1/themes/base/jquery-ui.css">http://code.jquery.com/ui/1.9.0-rc.1/themes/base/jquery-ui.css</a>"</code><code class="plain">></code></div><div class="line number7 index6 alt2"><code class="undefined spaces"> </code><code class="plain"><</code><code class="keyword">script</code> <code class="color1">src</code><code class="plain">=</code><code class="string">"<a href="http://code.jquery.com/jquery-1.8.2.js">http://code.jquery.com/jquery-1.8.2.js</a>"</code><code class="plain">></</code><code class="keyword">script</code><code class="plain">></code></div><div class="line number8 index7 alt1"><code class="undefined spaces"> </code><code class="plain"><</code><code class="keyword">script</code> <code class="color1">src</code><code class="plain">=</code><code class="string">"<a href="http://code.jquery.com/ui/1.9.0-rc.1/jquery-ui.js">http://code.jquery.com/ui/1.9.0-rc.1/jquery-ui.js</a>"</code><code class="plain">></</code><code class="keyword">script</code><code class="plain">></code></div><div class="line number9 index8 alt2"><code class="plain"></</code><code class="keyword">head</code><code class="plain">></code></div><div class="line number10 index9 alt1"><code class="plain"><</code><code class="keyword">body</code><code class="plain">></code></div><div class="line number11 index10 alt2"> </div><div class="line number12 index11 alt1"><code class="plain"><</code><code class="keyword">div</code> <code class="color1">id</code><code class="plain">=</code><code class="string">"progressbar"</code><code class="plain">></</code><code class="keyword">div</code><code class="plain">></code></div><div class="line number13 index12 alt2"> </div><div class="line number14 index13 alt1"><code class="plain"><</code><code class="keyword">script</code><code class="plain">></code></div><div class="line number15 index14 alt2"><code class="plain">$( "#progressbar" ).progressbar({</code></div><div class="line number16 index15 alt1"><code class="undefined spaces"> </code><code class="plain">value: 37</code></div><div class="line number17 index16 alt2"><code class="plain">});</code></div><div class="line number18 index17 alt1"><code class="plain"></</code><code class="keyword">script</code><code class="plain">></code></div><div class="line number19 index18 alt2"> </div><div class="line number20 index19 alt1"><code class="plain"></</code><code class="keyword">body</code><code class="plain">></code></div><div class="line number21 index20 alt2"><code class="plain"></</code><code class="keyword">html</code><code class="plain">></code></div></div></td></tr></tbody></table></div> <h4>Demo:</h4> <div class="demo code-demo" data-height="50"></div> </div></section> </div></article> </body> </html>