Files
Phraseanet/www/include/jslibs/yui2.8/docs/YAHOO.widget.ProgressBar.html
2011-02-16 16:09:48 +01:00

2340 lines
149 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>API: progressbar YAHOO.widget.ProgressBar (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
<link rel="stylesheet" type="text/css" href="assets/api.css" />
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
<h3>ProgressBar Widget&nbsp; <span class="subtitle">2.8.2r1</span></h3>
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
&gt; <a href="./module_progressbar.html" title="progressbar">progressbar</a>
&gt; YAHOO.widget.ProgressBar
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
&nbsp;
</div>
</div>
</form>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
</fieldset>
</form>
<h2>
Class <b property="yui:name">YAHOO.widget.ProgressBar</b>
<span class="extends">
- extends <a href="YAHOO.util.Element.html" title="YAHOO.util.Element">YAHOO.util.Element</a>
</span>
</h2>
<!-- class tree goes here -->
<div class="summary description" property="yui:description">
The ProgressBar widget provides an easy way to draw a bar depicting progress of an operation,
a level meter, rating or any such simple linear measure.
It allows for highly customized styles including animation, vertical or horizontal and forward or reverse.
</div>
<div class="section constructor details" rel="yui:constructor" resource="#constructor">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong property="yui:name">YAHOO.widget.ProgressBar</strong>
<code>
(
oConfigs
)
</code>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">oConfigs</span>
&lt;<span property="yui:type">object</span>&gt;
</code>
<span property="yui:description"> An object containing any configuration attributes to be set</span>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div rel="yui:properties" resource="#properties">
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private" rel="yui:property" resource="#property__barSizeFunction">
<h4><a name="property__barSizeFunction" property="yui:name">_barSizeFunction</a>
- <code>private <span property="yui:type">{function}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Function to be used to calculate bar size.
It is picked from <a href="#property_barSizeFunctions">_barSizeFunctions</a>
depending on direction and whether animation is active.
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: null
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property__barSizeFunctions">
<h4><a name="property__barSizeFunctions" property="yui:name">_barSizeFunctions</a>
- <code>private <span property="yui:type">{collection of functions}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Collection of functions used by to calculate the size of the bar.
One of this will be used depending on direction and whether animation is active.
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property__barSpace">
<h4><a name="property__barSpace" property="yui:name">_barSpace</a>
- <code>private <span property="yui:type">Number</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The actual space (in pixels) available for the bar within the mask (excludes margins)
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: 100
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property__previousValue">
<h4><a name="property__previousValue" property="yui:name">_previousValue</a>
- <code>private <span property="yui:type">Number</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The previous value setting for the bar. Used mostly as information to event listeners
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: 0
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property__rendered">
<h4><a name="property__rendered" property="yui:name">_rendered</a>
- <code>private <span property="yui:type">boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
A flag to signal that rendering has already happened
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: false
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_ProgressBar.MARKUP">
<h4><a name="property_ProgressBar.MARKUP" property="yui:name">ProgressBar.MARKUP</a>
- <code>static final <span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
String containing the HTML string which is the basis for the Progress Bar.
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: (too long)
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<div class="section field inheritance" rel="yui:superclass" resource="YAHOO.util.Element.html">
<h4>Properties inherited from <a href="YAHOO.util.Element.html" property="yui:name" title="YAHOO.util.Element">YAHOO.util.Element</a>:</h4>
<div class="content" rel="yui:properties">
<code>
<span rel="yui:property" resource="YAHOO.util.Element.html#property_DOM_EVENTS">
<a class="" href="YAHOO.util.Element.html#property_DOM_EVENTS" property="yui:name" title="DOM_EVENTS">DOM_EVENTS</a>
</span>
</code>
</div>
</div>
<div class="section field inheritance" rel="yui:superclass" resource="YAHOO.util.AttributeProvider.html">
<h4>Properties inherited from <a href="YAHOO.util.AttributeProvider.html" property="yui:name" title="YAHOO.util.AttributeProvider">YAHOO.util.AttributeProvider</a>:</h4>
<div class="content" rel="yui:properties">
<code>
<span rel="yui:property" resource="YAHOO.util.AttributeProvider.html#property__configs">
<a class="private" href="YAHOO.util.AttributeProvider.html#property__configs" property="yui:name" title="_configs">_configs</a>
</span>
</code>
</div>
</div>
<div class="section field inheritance" rel="yui:superclass" resource="YAHOO.util.EventProvider.html">
<h4>Properties inherited from <a href="YAHOO.util.EventProvider.html" property="yui:name" title="YAHOO.util.EventProvider">YAHOO.util.EventProvider</a>:</h4>
<div class="content" rel="yui:properties">
<code>
<span rel="yui:property" resource="YAHOO.util.EventProvider.html#property___yui_events">
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_events" property="yui:name" title="__yui_events">__yui_events</a><span class="private">,</span>
</span>
<span rel="yui:property" resource="YAHOO.util.EventProvider.html#property___yui_subscribers">
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_subscribers" property="yui:name" title="__yui_subscribers">__yui_subscribers</a>
</span>
</code>
</div>
</div>
</div>
</div>
<div rel="yui:methods" resource="#methods">
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private" rel="yui:method" resource="#method__animSetter">
<h4>
<a name="method__animSetter">_animSetter</a></h4>
<div class="detail" >
<code>
private
<strong property="yui:name">_animSetter</strong>
(
)
</code>
<div class="description" property="yui:description">
Called in response to a change in the <a href="#config_anim">anim</a> attribute.
It creates and sets up or destroys the instance of the animation utility that will move the bar
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__fixEdges">
<h4>
<a name="method__fixEdges">_fixEdges</a></h4>
<div class="detail" >
<code>
private
<strong property="yui:name">_fixEdges</strong>
(
)
</code>
<div class="description" property="yui:description">
Due to rounding differences, some browsers fail to cover the whole area
with the mask quadrants when the width or height is odd. This method
stretches the lower and/or right quadrants to make the difference.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__heightChange">
<h4>
<a name="method__heightChange">_heightChange</a></h4>
<div class="detail" >
<code>
private
<strong property="yui:name">_heightChange</strong>
(
value
)
</code>
<div class="description" property="yui:description">
Method called when the height attribute is changed
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">value</span>
&lt;<span property="yui:type">int or string</span>&gt;
</code>
<span property="yui:description"> New height, in pixels if int or string including units</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:method" resource="#method__init">
<h4>
<a name="method__init">_init</a></h4>
<div class="detail" >
<code>
protected
void
<strong property="yui:name">_init</strong>
(
oConfigs
)
</code>
<div class="description" property="yui:description">
Initialization code for the widget, separate from the constructor to allow for overriding/patching.
It is called after <a href="#method_initAttributes">initAttributes</a>
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">oConfigs</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> (Optional) Object literal definition of configuration values.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__recalculateConstants">
<h4>
<a name="method__recalculateConstants">_recalculateConstants</a></h4>
<div class="detail" >
<code>
private
<strong property="yui:name">_recalculateConstants</strong>
(
)
</code>
<div class="description" property="yui:description">
Calculates some auxiliary values to make the rendering faster
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__setAriaText">
<h4>
<a name="method__setAriaText">_setAriaText</a></h4>
<div class="detail" >
<code>
private
<strong property="yui:name">_setAriaText</strong>
(
)
</code>
<div class="description" property="yui:description">
Utility method to set the ARIA value attributes
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__valueChange">
<h4>
<a name="method__valueChange">_valueChange</a></h4>
<div class="detail" >
<code>
private
<strong property="yui:name">_valueChange</strong>
(
)
</code>
<div class="description" property="yui:description">
Called in response to a change in the <a href="#config_value">value</a> attribute.
Moves the bar to reflect the new value
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__widthChange">
<h4>
<a name="method__widthChange">_widthChange</a></h4>
<div class="detail" >
<code>
private
<strong property="yui:name">_widthChange</strong>
(
value
)
</code>
<div class="description" property="yui:description">
Method called when the height attribute is changed
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">value</span>
&lt;<span property="yui:type">int or string</span>&gt;
</code>
<span property="yui:description"> New width, in pixels if int or string including units</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_destroy">
<h4>
<a name="method_destroy">destroy</a></h4>
<div class="detail" >
<code>
<strong property="yui:name">destroy</strong>
(
)
</code>
<div class="description" property="yui:description">
Destroys the ProgressBar, related objects and unsubscribes from all events
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method_initAttributes">
<h4>
<a name="method_initAttributes">initAttributes</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">initAttributes</strong>
(
oConfigs
)
</code>
<div class="description" property="yui:description">
Implementation of Element's abstract method. Sets up config values.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">oConfigs</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> (Optional) Object literal definition of configuration values.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_redraw">
<h4>
<a name="method_redraw">redraw</a></h4>
<div class="detail" >
<code>
<strong property="yui:name">redraw</strong>
(
)
</code>
<div class="description" property="yui:description">
Recalculates the bar size and position and redraws it
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_render">
<h4>
<a name="method_render">render</a></h4>
<div class="detail" >
<code>
YAHOO.widget.ProgressBar
<strong property="yui:name">render</strong>
(
el
,
before
)
</code>
<div class="description" property="yui:description">
Renders the ProgressBar into the given container.
If the container has other content, the ProgressBar will be appended to it.
If the second argument is provided, the ProgressBar will be inserted before the given child.
The method is chainable since it returns a reference to this instance.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
&lt;<span property="yui:type">HTML Element</span>&gt;
</code>
<span property="yui:description"> HTML element that will contain the ProgressBar</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">before</span>
&lt;<span property="yui:type">HTML Element</span>&gt;
</code>
<span property="yui:description"> (optional) If present, the ProgressBar will be inserted before this element.</span>
</dd>
</dl>
<div class="chainable">
<strong>Chainable:</strong> This method is chainable.
</div>
</div>
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<div class="section field inheritance" rel="yui:superclass" resource="YAHOO.util.Element.html">
<h4>Methods inherited from <a href="YAHOO.util.Element.html" property="yui:name" title="YAHOO.util.Element">YAHOO.util.Element</a>:</h4>
<div class="content" rel="yui:methods">
<code>
<span rel="yui:method" resource="YAHOO.util.Element.html#method__setHTMLAttrConfig">
<a class="private" href="YAHOO.util.Element.html#method__setHTMLAttrConfig" property="yui:name" title="_setHTMLAttrConfig">_setHTMLAttrConfig</a><span class="private">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_addClass">
<a class="" href="YAHOO.util.Element.html#method_addClass" property="yui:name" title="addClass">addClass</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_addListener">
<a class="" href="YAHOO.util.Element.html#method_addListener" property="yui:name" title="addListener">addListener</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_appendChild">
<a class="" href="YAHOO.util.Element.html#method_appendChild" property="yui:name" title="appendChild">appendChild</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_appendTo">
<a class="" href="YAHOO.util.Element.html#method_appendTo" property="yui:name" title="appendTo">appendTo</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_delegate">
<a class="" href="YAHOO.util.Element.html#method_delegate" property="yui:name" title="delegate">delegate</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_fireQueue">
<a class="" href="YAHOO.util.Element.html#method_fireQueue" property="yui:name" title="fireQueue">fireQueue</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_getElementsByClassName">
<a class="" href="YAHOO.util.Element.html#method_getElementsByClassName" property="yui:name" title="getElementsByClassName">getElementsByClassName</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_getElementsByTagName">
<a class="" href="YAHOO.util.Element.html#method_getElementsByTagName" property="yui:name" title="getElementsByTagName">getElementsByTagName</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_getStyle">
<a class="" href="YAHOO.util.Element.html#method_getStyle" property="yui:name" title="getStyle">getStyle</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_hasChildNodes">
<a class="" href="YAHOO.util.Element.html#method_hasChildNodes" property="yui:name" title="hasChildNodes">hasChildNodes</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_hasClass">
<a class="" href="YAHOO.util.Element.html#method_hasClass" property="yui:name" title="hasClass">hasClass</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_initAttributes">
<a class="" href="YAHOO.util.Element.html#method_initAttributes" property="yui:name" title="initAttributes">initAttributes</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_insertBefore">
<a class="" href="YAHOO.util.Element.html#method_insertBefore" property="yui:name" title="insertBefore">insertBefore</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_on">
<a class="" href="YAHOO.util.Element.html#method_on" property="yui:name" title="on">on</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_removeChild">
<a class="" href="YAHOO.util.Element.html#method_removeChild" property="yui:name" title="removeChild">removeChild</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_removeClass">
<a class="" href="YAHOO.util.Element.html#method_removeClass" property="yui:name" title="removeClass">removeClass</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_removeDelegate">
<a class="" href="YAHOO.util.Element.html#method_removeDelegate" property="yui:name" title="removeDelegate">removeDelegate</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_removeListener">
<a class="" href="YAHOO.util.Element.html#method_removeListener" property="yui:name" title="removeListener">removeListener</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_replaceChild">
<a class="" href="YAHOO.util.Element.html#method_replaceChild" property="yui:name" title="replaceChild">replaceChild</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_replaceClass">
<a class="" href="YAHOO.util.Element.html#method_replaceClass" property="yui:name" title="replaceClass">replaceClass</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_setStyle">
<a class="" href="YAHOO.util.Element.html#method_setStyle" property="yui:name" title="setStyle">setStyle</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_subscribe">
<a class="" href="YAHOO.util.Element.html#method_subscribe" property="yui:name" title="subscribe">subscribe</a>
</span>
</code>
</div>
</div>
<div class="section field inheritance" rel="yui:superclass" resource="YAHOO.util.AttributeProvider.html">
<h4>Methods inherited from <a href="YAHOO.util.AttributeProvider.html" property="yui:name" title="YAHOO.util.AttributeProvider">YAHOO.util.AttributeProvider</a>:</h4>
<div class="content" rel="yui:methods">
<code>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_configureAttribute">
<a class=" deprecated" href="YAHOO.util.AttributeProvider.html#method_configureAttribute" property="yui:name" title="configureAttribute">configureAttribute</a><span class=" deprecated">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_fireBeforeChangeEvent">
<a class="" href="YAHOO.util.AttributeProvider.html#method_fireBeforeChangeEvent" property="yui:name" title="fireBeforeChangeEvent">fireBeforeChangeEvent</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_fireChangeEvent">
<a class="" href="YAHOO.util.AttributeProvider.html#method_fireChangeEvent" property="yui:name" title="fireChangeEvent">fireChangeEvent</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_get">
<a class="" href="YAHOO.util.AttributeProvider.html#method_get" property="yui:name" title="get">get</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_getAttributeConfig">
<a class="private" href="YAHOO.util.AttributeProvider.html#method_getAttributeConfig" property="yui:name" title="getAttributeConfig">getAttributeConfig</a><span class="private">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_getAttributeKeys">
<a class="" href="YAHOO.util.AttributeProvider.html#method_getAttributeKeys" property="yui:name" title="getAttributeKeys">getAttributeKeys</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_refresh">
<a class="" href="YAHOO.util.AttributeProvider.html#method_refresh" property="yui:name" title="refresh">refresh</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_register">
<a class=" deprecated" href="YAHOO.util.AttributeProvider.html#method_register" property="yui:name" title="register">register</a><span class=" deprecated">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_resetAttributeConfig">
<a class="private" href="YAHOO.util.AttributeProvider.html#method_resetAttributeConfig" property="yui:name" title="resetAttributeConfig">resetAttributeConfig</a><span class="private">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_resetValue">
<a class="" href="YAHOO.util.AttributeProvider.html#method_resetValue" property="yui:name" title="resetValue">resetValue</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_set">
<a class="" href="YAHOO.util.AttributeProvider.html#method_set" property="yui:name" title="set">set</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_setAttributeConfig">
<a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributeConfig" property="yui:name" title="setAttributeConfig">setAttributeConfig</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_setAttributes">
<a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributes" property="yui:name" title="setAttributes">setAttributes</a>
</span>
</code>
</div>
</div>
<div class="section field inheritance" rel="yui:superclass" resource="YAHOO.util.EventProvider.html">
<h4>Methods inherited from <a href="YAHOO.util.EventProvider.html" property="yui:name" title="YAHOO.util.EventProvider">YAHOO.util.EventProvider</a>:</h4>
<div class="content" rel="yui:methods">
<code>
<span rel="yui:method" resource="YAHOO.util.EventProvider.html#method_createEvent">
<a class="" href="YAHOO.util.EventProvider.html#method_createEvent" property="yui:name" title="createEvent">createEvent</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.EventProvider.html#method_fireEvent">
<a class="" href="YAHOO.util.EventProvider.html#method_fireEvent" property="yui:name" title="fireEvent">fireEvent</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.EventProvider.html#method_hasEvent">
<a class="" href="YAHOO.util.EventProvider.html#method_hasEvent" property="yui:name" title="hasEvent">hasEvent</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.EventProvider.html#method_subscribe">
<a class="" href="YAHOO.util.EventProvider.html#method_subscribe" property="yui:name" title="subscribe">subscribe</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.EventProvider.html#method_unsubscribe">
<a class="" href="YAHOO.util.EventProvider.html#method_unsubscribe" property="yui:name" title="unsubscribe">unsubscribe</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.EventProvider.html#method_unsubscribeAll">
<a class="" href="YAHOO.util.EventProvider.html#method_unsubscribeAll" property="yui:name" title="unsubscribeAll">unsubscribeAll</a>
</span>
</code>
</div>
</div>
</div>
</div>
<div rel="yui:events" resource="#events">
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="" rel="yui:event" resource="#event_animChange">
<h4>
<a name="event_animChange">animChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">animChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'anim' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_ariaTextTemplateChange">
<h4>
<a name="event_ariaTextTemplateChange">ariaTextTemplateChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">ariaTextTemplateChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'ariaTextTemplate' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_barElChange">
<h4>
<a name="event_barElChange">barElChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">barElChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'barEl' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeAnimChange">
<h4>
<a name="event_beforeAnimChange">beforeAnimChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeAnimChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'anim' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeAriaTextTemplateChange">
<h4>
<a name="event_beforeAriaTextTemplateChange">beforeAriaTextTemplateChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeAriaTextTemplateChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'ariaTextTemplate' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeBarElChange">
<h4>
<a name="event_beforeBarElChange">beforeBarElChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeBarElChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'barEl' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeDirectionChange">
<h4>
<a name="event_beforeDirectionChange">beforeDirectionChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeDirectionChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'direction' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeHeightChange">
<h4>
<a name="event_beforeHeightChange">beforeHeightChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeHeightChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'height' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeMaskElChange">
<h4>
<a name="event_beforeMaskElChange">beforeMaskElChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeMaskElChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'maskEl' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeMaxValueChange">
<h4>
<a name="event_beforeMaxValueChange">beforeMaxValueChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeMaxValueChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'maxValue' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeMinValueChange">
<h4>
<a name="event_beforeMinValueChange">beforeMinValueChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeMinValueChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'minValue' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeValueChange">
<h4>
<a name="event_beforeValueChange">beforeValueChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeValueChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'value' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeWidthChange">
<h4>
<a name="event_beforeWidthChange">beforeWidthChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeWidthChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'width' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_complete">
<h4>
<a name="event_complete">complete</a></h4>
<div class="detail">
<code>
<strong property="yui:name">complete</strong>
(
value
)
</code>
<div class="description" property="yui:description">
Fires at the end of the animation or immediately upon changing values if animation is not loaded
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">value</span>
&lt;<span property="yui:type">Number</span>&gt;
</code>
<span property="yui:description"> the current (final) value</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_directionChange">
<h4>
<a name="event_directionChange">directionChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">directionChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'direction' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_heightChange">
<h4>
<a name="event_heightChange">heightChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">heightChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'height' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_maskElChange">
<h4>
<a name="event_maskElChange">maskElChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">maskElChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'maskEl' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_maxValueChange">
<h4>
<a name="event_maxValueChange">maxValueChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">maxValueChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'maxValue' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_minValueChange">
<h4>
<a name="event_minValueChange">minValueChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">minValueChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'minValue' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_progress">
<h4>
<a name="event_progress">progress</a></h4>
<div class="detail">
<code>
<strong property="yui:name">progress</strong>
(
value
)
</code>
<div class="description" property="yui:description">
If animation is active, it will trigger several times during the animation providing intermediate values
If animation is not active, it will fire only once providing the end value
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">value</span>
&lt;<span property="yui:type">Number</span>&gt;
</code>
<span property="yui:description"> the current, changing value</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_start">
<h4>
<a name="event_start">start</a></h4>
<div class="detail">
<code>
<strong property="yui:name">start</strong>
(
value
)
</code>
<div class="description" property="yui:description">
Fires when the value is about to change. It reports the starting value
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">value</span>
&lt;<span property="yui:type">Number</span>&gt;
</code>
<span property="yui:description"> the current (initial) value</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_valueChange">
<h4>
<a name="event_valueChange">valueChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">valueChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'value' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_widthChange">
<h4>
<a name="event_widthChange">widthChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">widthChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'width' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<div class="section field inheritance" rel="yui:superclass" resource="YAHOO.util.Element.html">
<h4>Events inherited from <a href="YAHOO.util.Element.html" property="yui:name" title="YAHOO.util.Element">YAHOO.util.Element</a>:</h4>
<div class="content" rel="yui:events">
<code>
<span rel="yui:event" resource="YAHOO.util.Element.html#event_appendTo">
<a class="" href="YAHOO.util.Element.html#event_appendTo" property="yui:name" title="appendTo">appendTo</a><span class="">,</span>
</span>
<span rel="yui:event" resource="YAHOO.util.Element.html#event_available">
<a class="" href="YAHOO.util.Element.html#event_available" property="yui:name" title="available">available</a><span class="">,</span>
</span>
<span rel="yui:event" resource="YAHOO.util.Element.html#event_beforeAppendTo">
<a class="" href="YAHOO.util.Element.html#event_beforeAppendTo" property="yui:name" title="beforeAppendTo">beforeAppendTo</a><span class="">,</span>
</span>
<span rel="yui:event" resource="YAHOO.util.Element.html#event_beforeElementChange">
<a class="" href="YAHOO.util.Element.html#event_beforeElementChange" property="yui:name" title="beforeElementChange">beforeElementChange</a><span class="">,</span>
</span>
<span rel="yui:event" resource="YAHOO.util.Element.html#event_contentReady">
<a class="" href="YAHOO.util.Element.html#event_contentReady" property="yui:name" title="contentReady">contentReady</a><span class="">,</span>
</span>
<span rel="yui:event" resource="YAHOO.util.Element.html#event_elementChange">
<a class="" href="YAHOO.util.Element.html#event_elementChange" property="yui:name" title="elementChange">elementChange</a><span class="">,</span>
</span>
</code>
</div>
</div>
</div>
</div>
<div rel="yui:attributes" resource="#configattributes">
<div class="section field details">
<h3 id="configattributes">Configuration Attributes</h3>
<div class="content">
<div class="" rel="yui:attribute" resource="#config_anim">
<h4><a name="config_anim">anim</a>
<code>- <span property="yui:type">{boolean} or {instance of YAHOO.util.Anim}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
it accepts either a boolean (recommended) or an instance of <a href="YAHOO.util.Anim.html">YAHOO.util.Anim</a>.
If a boolean, it will enable/disable animation creating its own instance of the animation utility.
If given an instance of <a href="YAHOO.util.Anim.html">YAHOO.util.Anim</a> it will use that instance.
The <a href="YAHOO.util.Anim.html">animation</a> utility needs to be loaded.
When read, it returns the instance of the animation utility in use or null if none.
It can be used to set the animation parameters such as easing methods or duration.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_ariaTextTemplate">
<h4><a name="config_ariaTextTemplate">ariaTextTemplate</a>
<code>- <span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Text to be voiced by screen readers.
The text is processed by <a href="YAHOO.lang.html#method_substitute">YAHOO.lang.substitute</a>.
It can use the placeholders {value}, {minValue} and {maxValue}
</div>
</div>
<div class="default">
Default Value: "{value}"
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_barEl">
<h4><a name="config_barEl">barEl</a>
<code>- <span property="yui:type">HTMLElement (div)</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Reference to the HTML object that makes the moving bar (read-only)
</div>
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_direction">
<h4><a name="config_direction">direction</a>
<code>- <span property="yui:type">String (any of "ltr", "rtl", "ttb" or "btt")</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Direction of movement of the bar.
It can be any of 'ltr' (left to right), 'rtl' (the reverse) , 'ttb' (top to bottom) or 'btt'.
Can only be set once and only before rendering.
</div>
</div>
<div class="default">
Default Value: 'ltr'
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_height">
<h4><a name="config_height">height</a>
<code>- <span property="yui:type">Number or String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Height of the ProgressBar.
If a number, it will be assumed to be in pixels.
If a string it should be a valid setting for the CSS height attribute.
It will always be returned as a string including units.
</div>
</div>
<div class="default">
Default Value: "20px"
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_maskEl">
<h4><a name="config_maskEl">maskEl</a>
<code>- <span property="yui:type">HTMLElement (table)</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Reference to the HTML object that overlays the bar providing the mask. (read-only)
</div>
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_maxValue">
<h4><a name="config_maxValue">maxValue</a>
<code>- <span property="yui:type">Number</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Represents the top value for the bar.
The bar will be fully extended when reaching this value.
Values higher than this will be ignored.
</div>
</div>
<div class="default">
Default Value: 100
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_minValue">
<h4><a name="config_minValue">minValue</a>
<code>- <span property="yui:type">Number</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Represents the lowest value for the bar.
The bar will be totally collapsed when reaching this value.
Values lower than this will be ignored.
</div>
</div>
<div class="default">
Default Value: 0
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_value">
<h4><a name="config_value">value</a>
<code>- <span property="yui:type">Number</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The value for the bar.
Valid values are in between the minValue and maxValue attributes.
</div>
</div>
<div class="default">
Default Value: 0
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_width">
<h4><a name="config_width">width</a>
<code>- <span property="yui:type">Number or String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Width of the ProgressBar.
If a number, it will be assumed to be in pixels.
If a string it should be a valid setting for the CSS width attribute.
It will always be returned as a string including units.
</div>
</div>
<div class="default">
Default Value: "200px"
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<div class="section field inheritance" rel="yui:superclass" resource="YAHOO.util.Element.html">
<h4>Configuration attributes inherited from <a href="YAHOO.util.Element.html" property="yui:name" title="YAHOO.util.Element">YAHOO.util.Element</a>:</h4>
<div class="content" rel="yui:attributes">
<code>
<span rel="yui:attribute" resource="YAHOO.util.Element.html#config_element">
<a class="" href="YAHOO.util.Element.html#config_element" property="yui:name" title="element">element</a>
</span>
</code>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div id="moduleList" class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html" title="animation">animation</a></li>
<li class=""><a href="module_autocomplete.html" title="autocomplete">autocomplete</a></li>
<li class=""><a href="module_button.html" title="button">button</a></li>
<li class=""><a href="module_calendar.html" title="calendar">calendar</a></li>
<li class=""><a href="module_carousel.html" title="carousel">carousel</a></li>
<li class=""><a href="module_charts.html" title="charts">charts</a></li>
<li class=""><a href="module_colorpicker.html" title="colorpicker">colorpicker</a></li>
<li class=""><a href="module_connection.html" title="connection">connection</a></li>
<li class=""><a href="module_container.html" title="container">container</a></li>
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
<li class=""><a href="module_datatable.html" title="datatable">datatable</a></li>
<li class=""><a href="module_datemath.html" title="datemath">datemath</a></li>
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
<li class=""><a href="module_dragdrop.html" title="dragdrop">dragdrop</a></li>
<li class=""><a href="module_editor.html" title="editor">editor</a></li>
<li class=""><a href="module_element.html" title="element">element</a></li>
<li class=""><a href="module_element-delegate.html" title="element-delegate">element-delegate</a></li>
<li class=""><a href="module_event.html" title="event">event</a></li>
<li class=""><a href="module_event-delegate.html" title="event-delegate">event-delegate</a></li>
<li class=""><a href="module_event-mouseenter.html" title="event-mouseenter">event-mouseenter</a></li>
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
<li class=""><a href="module_get.html" title="get">get</a></li>
<li class=""><a href="module_history.html" title="history">history</a></li>
<li class=""><a href="module_imagecropper.html" title="imagecropper">imagecropper</a></li>
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
<li class=""><a href="module_json.html" title="json">json</a></li>
<li class=""><a href="module_layout.html" title="layout">layout</a></li>
<li class=""><a href="module_logger.html" title="logger">logger</a></li>
<li class=""><a href="module_menu.html" title="menu">menu</a></li>
<li class=""><a href="module_paginator.html" title="paginator">paginator</a></li>
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
<li class=""><a href="module_profilerviewer.html" title="profilerviewer">profilerviewer</a></li>
<li class="selected"><a href="module_progressbar.html" title="progressbar">progressbar</a></li>
<li class=""><a href="module_resize.html" title="resize">resize</a></li>
<li class=""><a href="module_selector.html" title="selector">selector</a></li>
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
<li class=""><a href="module_storage.html" title="Storage">Storage</a></li>
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
<li class=""><a href="module_swf.html" title="swf">swf</a></li>
<li class=""><a href="module_swfdetect.html" title="swfdetect">swfdetect</a></li>
<li class=""><a href="module_swfstore.html" title="swfstore">swfstore</a></li>
<li class=""><a href="module_tabview.html" title="tabview">tabview</a></li>
<li class=""><a href="module_treeview.html" title="treeview">treeview</a></li>
<li class=""><a href="module_uploader.html" title="uploader">uploader</a></li>
<li class=""><a href="module_yahoo.html" title="yahoo">yahoo</a></li>
<li class=""><a href="module_yuiloader.html" title="yuiloader">yuiloader</a></li>
<li class=""><a href="module_yuitest.html" title="yuitest">yuitest</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class="selected"><a href="YAHOO.widget.ProgressBar.html" title="YAHOO.widget.ProgressBar">YAHOO.widget.ProgressBar</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="ProgressBar.js.html" title="ProgressBar.js">ProgressBar.js</a></li>
</ul>
</div>
<div id="propertyList" class="module">
<h4>Properties</h4>
<ul class="content">
<li class="private"><a href="#property__barSizeFunction" title="_barSizeFunction">_barSizeFunction</a></li>
<li class="private"><a href="#property__barSizeFunctions" title="_barSizeFunctions">_barSizeFunctions</a></li>
<li class="private"><a href="#property__barSpace" title="_barSpace">_barSpace</a></li>
<li class="private"><a href="#property__previousValue" title="_previousValue">_previousValue</a></li>
<li class="private"><a href="#property__rendered" title="_rendered">_rendered</a></li>
<li class=""><a href="#property_ProgressBar.MARKUP" title="ProgressBar.MARKUP">ProgressBar.MARKUP</a></li>
</ul>
</div>
<div id="methodsList" class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><a href="#method__animSetter" title="_animSetter">_animSetter</a></li>
<li class="private"><a href="#method__fixEdges" title="_fixEdges">_fixEdges</a></li>
<li class="private"><a href="#method__heightChange" title="_heightChange">_heightChange</a></li>
<li class="protected"><a href="#method__init" title="_init">_init</a></li>
<li class="private"><a href="#method__recalculateConstants" title="_recalculateConstants">_recalculateConstants</a></li>
<li class="private"><a href="#method__setAriaText" title="_setAriaText">_setAriaText</a></li>
<li class="private"><a href="#method__valueChange" title="_valueChange">_valueChange</a></li>
<li class="private"><a href="#method__widthChange" title="_widthChange">_widthChange</a></li>
<li class=""><a href="#method_destroy" title="destroy">destroy</a></li>
<li class="private"><a href="#method_initAttributes" title="initAttributes">initAttributes</a></li>
<li class=""><a href="#method_redraw" title="redraw">redraw</a></li>
<li class=""><a href="#method_render" title="render">render</a></li>
</ul>
</div>
<div id="eventsList" class="module">
<h4>Events</h4>
<ul class="content">
<li class=""><a href="#event_animChange" title="animChange">animChange</a></li>
<li class=""><a href="#event_ariaTextTemplateChange" title="ariaTextTemplateChange">ariaTextTemplateChange</a></li>
<li class=""><a href="#event_barElChange" title="barElChange">barElChange</a></li>
<li class=""><a href="#event_beforeAnimChange" title="beforeAnimChange">beforeAnimChange</a></li>
<li class=""><a href="#event_beforeAriaTextTemplateChange" title="beforeAriaTextTemplateChange">beforeAriaTextTemplateChange</a></li>
<li class=""><a href="#event_beforeBarElChange" title="beforeBarElChange">beforeBarElChange</a></li>
<li class=""><a href="#event_beforeDirectionChange" title="beforeDirectionChange">beforeDirectionChange</a></li>
<li class=""><a href="#event_beforeHeightChange" title="beforeHeightChange">beforeHeightChange</a></li>
<li class=""><a href="#event_beforeMaskElChange" title="beforeMaskElChange">beforeMaskElChange</a></li>
<li class=""><a href="#event_beforeMaxValueChange" title="beforeMaxValueChange">beforeMaxValueChange</a></li>
<li class=""><a href="#event_beforeMinValueChange" title="beforeMinValueChange">beforeMinValueChange</a></li>
<li class=""><a href="#event_beforeValueChange" title="beforeValueChange">beforeValueChange</a></li>
<li class=""><a href="#event_beforeWidthChange" title="beforeWidthChange">beforeWidthChange</a></li>
<li class=""><a href="#event_complete" title="complete">complete</a></li>
<li class=""><a href="#event_directionChange" title="directionChange">directionChange</a></li>
<li class=""><a href="#event_heightChange" title="heightChange">heightChange</a></li>
<li class=""><a href="#event_maskElChange" title="maskElChange">maskElChange</a></li>
<li class=""><a href="#event_maxValueChange" title="maxValueChange">maxValueChange</a></li>
<li class=""><a href="#event_minValueChange" title="minValueChange">minValueChange</a></li>
<li class=""><a href="#event_progress" title="progress">progress</a></li>
<li class=""><a href="#event_start" title="start">start</a></li>
<li class=""><a href="#event_valueChange" title="valueChange">valueChange</a></li>
<li class=""><a href="#event_widthChange" title="widthChange">widthChange</a></li>
</ul>
</div>
<div id="configList" class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li class=""><a href="#config_anim" title="anim">anim</a></li>
<li class=""><a href="#config_ariaTextTemplate" title="ariaTextTemplate">ariaTextTemplate</a></li>
<li class=""><a href="#config_barEl" title="barEl">barEl</a></li>
<li class=""><a href="#config_direction" title="direction">direction</a></li>
<li class=""><a href="#config_height" title="height">height</a></li>
<li class=""><a href="#config_maskEl" title="maskEl">maskEl</a></li>
<li class=""><a href="#config_maxValue" title="maxValue">maxValue</a></li>
<li class=""><a href="#config_minValue" title="minValue">minValue</a></li>
<li class=""><a href="#config_value" title="value">value</a></li>
<li class=""><a href="#config_width" title="width">width</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2010 Yahoo! Inc. All rights reserved.
</div>
</div>
<script type="text/javascript">
var ALL_YUI_PROPS = [{"access": "", "host": "YAHOO.widget.ProgressBar", "name": "anim", "url": "YAHOO.widget.ProgressBar.html#config_anim", "type": "config"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "animChange", "url": "YAHOO.widget.ProgressBar.html#event_animChange", "type": "event"}, {"access": "private", "host": "YAHOO.widget.ProgressBar", "name": "_animSetter", "url": "YAHOO.widget.ProgressBar.html#method__animSetter", "type": "method"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "ariaTextTemplate", "url": "YAHOO.widget.ProgressBar.html#config_ariaTextTemplate", "type": "config"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "ariaTextTemplateChange", "url": "YAHOO.widget.ProgressBar.html#event_ariaTextTemplateChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "barEl", "url": "YAHOO.widget.ProgressBar.html#config_barEl", "type": "config"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "barElChange", "url": "YAHOO.widget.ProgressBar.html#event_barElChange", "type": "event"}, {"access": "private", "host": "YAHOO.widget.ProgressBar", "name": "_barSizeFunction", "url": "YAHOO.widget.ProgressBar.html#property__barSizeFunction", "type": "property"}, {"access": "private", "host": "YAHOO.widget.ProgressBar", "name": "_barSizeFunctions", "url": "YAHOO.widget.ProgressBar.html#property__barSizeFunctions", "type": "property"}, {"access": "private", "host": "YAHOO.widget.ProgressBar", "name": "_barSpace", "url": "YAHOO.widget.ProgressBar.html#property__barSpace", "type": "property"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "beforeAnimChange", "url": "YAHOO.widget.ProgressBar.html#event_beforeAnimChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "beforeAriaTextTemplateChange", "url": "YAHOO.widget.ProgressBar.html#event_beforeAriaTextTemplateChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "beforeBarElChange", "url": "YAHOO.widget.ProgressBar.html#event_beforeBarElChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "beforeDirectionChange", "url": "YAHOO.widget.ProgressBar.html#event_beforeDirectionChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "beforeHeightChange", "url": "YAHOO.widget.ProgressBar.html#event_beforeHeightChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "beforeMaskElChange", "url": "YAHOO.widget.ProgressBar.html#event_beforeMaskElChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "beforeMaxValueChange", "url": "YAHOO.widget.ProgressBar.html#event_beforeMaxValueChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "beforeMinValueChange", "url": "YAHOO.widget.ProgressBar.html#event_beforeMinValueChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "beforeValueChange", "url": "YAHOO.widget.ProgressBar.html#event_beforeValueChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "beforeWidthChange", "url": "YAHOO.widget.ProgressBar.html#event_beforeWidthChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "complete", "url": "YAHOO.widget.ProgressBar.html#event_complete", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "destroy", "url": "YAHOO.widget.ProgressBar.html#method_destroy", "type": "method"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "direction", "url": "YAHOO.widget.ProgressBar.html#config_direction", "type": "config"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "directionChange", "url": "YAHOO.widget.ProgressBar.html#event_directionChange", "type": "event"}, {"access": "private", "host": "YAHOO.widget.ProgressBar", "name": "_fixEdges", "url": "YAHOO.widget.ProgressBar.html#method__fixEdges", "type": "method"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "height", "url": "YAHOO.widget.ProgressBar.html#config_height", "type": "config"}, {"access": "private", "host": "YAHOO.widget.ProgressBar", "name": "_heightChange", "url": "YAHOO.widget.ProgressBar.html#method__heightChange", "type": "method"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "heightChange", "url": "YAHOO.widget.ProgressBar.html#event_heightChange", "type": "event"}, {"access": "protected", "host": "YAHOO.widget.ProgressBar", "name": "_init", "url": "YAHOO.widget.ProgressBar.html#method__init", "type": "method"}, {"access": "private", "host": "YAHOO.widget.ProgressBar", "name": "initAttributes", "url": "YAHOO.widget.ProgressBar.html#method_initAttributes", "type": "method"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "maskEl", "url": "YAHOO.widget.ProgressBar.html#config_maskEl", "type": "config"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "maskElChange", "url": "YAHOO.widget.ProgressBar.html#event_maskElChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "maxValue", "url": "YAHOO.widget.ProgressBar.html#config_maxValue", "type": "config"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "maxValueChange", "url": "YAHOO.widget.ProgressBar.html#event_maxValueChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "minValue", "url": "YAHOO.widget.ProgressBar.html#config_minValue", "type": "config"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "minValueChange", "url": "YAHOO.widget.ProgressBar.html#event_minValueChange", "type": "event"}, {"access": "private", "host": "YAHOO.widget.ProgressBar", "name": "_previousValue", "url": "YAHOO.widget.ProgressBar.html#property__previousValue", "type": "property"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "progress", "url": "YAHOO.widget.ProgressBar.html#event_progress", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "ProgressBar.MARKUP", "url": "YAHOO.widget.ProgressBar.html#property_ProgressBar.MARKUP", "type": "property"}, {"access": "private", "host": "YAHOO.widget.ProgressBar", "name": "_recalculateConstants", "url": "YAHOO.widget.ProgressBar.html#method__recalculateConstants", "type": "method"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "redraw", "url": "YAHOO.widget.ProgressBar.html#method_redraw", "type": "method"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "render", "url": "YAHOO.widget.ProgressBar.html#method_render", "type": "method"}, {"access": "private", "host": "YAHOO.widget.ProgressBar", "name": "_rendered", "url": "YAHOO.widget.ProgressBar.html#property__rendered", "type": "property"}, {"access": "private", "host": "YAHOO.widget.ProgressBar", "name": "_setAriaText", "url": "YAHOO.widget.ProgressBar.html#method__setAriaText", "type": "method"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "start", "url": "YAHOO.widget.ProgressBar.html#event_start", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "value", "url": "YAHOO.widget.ProgressBar.html#config_value", "type": "config"}, {"access": "private", "host": "YAHOO.widget.ProgressBar", "name": "_valueChange", "url": "YAHOO.widget.ProgressBar.html#method__valueChange", "type": "method"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "valueChange", "url": "YAHOO.widget.ProgressBar.html#event_valueChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "width", "url": "YAHOO.widget.ProgressBar.html#config_width", "type": "config"}, {"access": "private", "host": "YAHOO.widget.ProgressBar", "name": "_widthChange", "url": "YAHOO.widget.ProgressBar.html#method__widthChange", "type": "method"}, {"access": "", "host": "YAHOO.widget.ProgressBar", "name": "widthChange", "url": "YAHOO.widget.ProgressBar.html#event_widthChange", "type": "event"}];
</script>
</body>
</html>