Plugin.ScrollViewPaginatorPlugin.html revision 73459f1f0c0488aac383015649d830bddbdb934a
<head>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h3>scrollview-paginator <span class="subtitle">3.2.0pr1</span></h3>
> <a href="/module_scrollview-paginator.html" title="scrollview-paginator">scrollview-paginator</a>
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
</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>
<span class="extends">
</span>
</h2>
<!-- class tree goes here -->
<div class="summary description" property="yui:description">
Scrollview plugin that adds support for paging
</div>
<div class="section constructor details" rel="yui:constructor" resource="#constructor">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<code>
(
)
</code>
<div class="description">
</div>
</div>
</div>
</div>
<div rel="yui:properties" resource="#properties">
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
- <code>static <span property="yui:type">Object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The default attribute configuration for the plugin
</div>
</div>
<hr />
</div>
- <code>static <span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The identity of the plugin
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: 'paginatorPlugin'
</div>
<hr />
</div>
- <code>static <span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The namespace on which the plugin will reside
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: 'pages'
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<h4>Properties inherited from <a href="Attribute.html" property="yui:name" title="Attribute">Attribute</a>:</h4>
<div class="content" rel="yui:properties">
<code>
</code>
</div>
</div>
<div class="content" rel="yui:properties">
<code>
</span>
</code>
</div>
</div>
<h4>Properties inherited from <a href="Plugin.Base.html" property="yui:name" title="Plugin.Base">Plugin.Base</a>:</h4>
<div class="content" rel="yui:properties">
<code>
<a class="private" href="Plugin.Base.html#property__handles" property="yui:name" title="_handles">_handles</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="protected" rel="yui:method" resource="#method__afterIndexChange">
<h4>
<a name="method__afterIndexChange">_afterIndexChange</a></h4>
<div class="detail" >
<code>
protected
void
<strong property="yui:name">_afterIndexChange</strong>
(
)
</code>
<div class="description" property="yui:description">
index attr change handler
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:method" resource="#method__calculatePageOffsets">
<h4>
<a name="method__calculatePageOffsets">_calculatePageOffsets</a></h4>
<div class="detail" >
<code>
protected
void
<strong property="yui:name">_calculatePageOffsets</strong>
(
)
</code>
<div class="description" property="yui:description">
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:method" resource="#method__flickFrame">
<h4>
<a name="method__flickFrame">_flickFrame</a></h4>
<div class="detail" >
<code>
protected
void
<strong property="yui:name">_flickFrame</strong>
(
)
</code>
<div class="description" property="yui:description">
Executed to respond to the flick event, by over-riding the default flickFrame animation.
This is needed to determine if the next or prev page should be activated.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:method" resource="#method__scrollEnded">
<h4>
<a name="method__scrollEnded">_scrollEnded</a></h4>
<div class="detail" >
<code>
protected
void
<strong property="yui:name">_scrollEnded</strong>
(
)
</code>
<div class="description" property="yui:description">
scrollEnd handler detects if a page needs to change
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:method" resource="#method__uiIndex">
<h4>
<a name="method__uiIndex">_uiIndex</a></h4>
<div class="detail" >
<code>
protected
void
<strong property="yui:name">_uiIndex</strong>
(
)
</code>
<div class="description" property="yui:description">
Update the UI based on the current page index
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_destructor">
<h4>
<a name="method_destructor">destructor</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">destructor</strong>
(
)
</code>
<div class="description" property="yui:description">
Destructor removes anything added by the plugin
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_initializer">
<h4>
<a name="method_initializer">initializer</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">initializer</strong>
(
)
</code>
<div class="description" property="yui:description">
Designated initializer
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_next">
<h4>
<a name="method_next">next</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">next</strong>
(
disableAnim
)
</code>
<div class="description" property="yui:description">
Scroll to the next page in the scrollview, with animation
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">disableAnim</span>
<<span property="yui:type">Boolean</span>>
</code>
<span property="yui:description"> If true, no animation is used</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_prev">
<h4>
<a name="method_prev">prev</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">prev</strong>
(
disableAnim
)
</code>
<div class="description" property="yui:description">
Scroll to the previous page in the scrollview, with animation
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">disableAnim</span>
<<span property="yui:type">Boolean</span>>
</code>
<span property="yui:description"> If true, no animation is used</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_scrollTo">
<h4>
<a name="method_scrollTo">scrollTo</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">scrollTo</strong>
(
index
,
duration
,
easing
)
</code>
<div class="description" property="yui:description">
Scroll to a given page in the scrollview, with animation.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">index</span>
<<span property="yui:type">Number</span>>
</code>
<span property="yui:description"> The index of the page to scroll to</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">duration</span>
<<span property="yui:type">Number</span>>
</code>
<span property="yui:description"> The number of ms the animation should last</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">easing</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> The timing function to use in the animation</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_snapToCurrent">
<h4>
<a name="method_snapToCurrent">snapToCurrent</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">snapToCurrent</strong>
(
)
</code>
<div class="description" property="yui:description">
Snaps the scrollview to the currently selected page
</div>
<div class="description">
</div>
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<h4>Methods inherited from <a href="EventTarget.html" property="yui:name" title="EventTarget">EventTarget</a>:</h4>
<div class="content" rel="yui:methods">
<code>
<a class="private" href="EventTarget.html#method__getType" property="yui:name" title="_getType">_getType</a><span class="private">,</span>
</span>
<a class="private" href="EventTarget.html#method__monitor" property="yui:name" title="_monitor">_monitor</a><span class="private">,</span>
</span>
<a class="private" href="EventTarget.html#method__parseType" property="yui:name" title="_parseType">_parseType</a><span class="private">,</span>
</span>
<a class="" href="EventTarget.html#method_addTarget" property="yui:name" title="addTarget">addTarget</a><span class="">,</span>
</span>
<a class="" href="EventTarget.html#method_after" property="yui:name" title="after">after</a><span class="">,</span>
</span>
<a class="" href="EventTarget.html#method_before" property="yui:name" title="before">before</a><span class="">,</span>
</span>
<a class="" href="EventTarget.html#method_bubble" property="yui:name" title="bubble">bubble</a><span class="">,</span>
</span>
<a class="" href="EventTarget.html#method_detach" property="yui:name" title="detach">detach</a><span class="">,</span>
</span>
<a class="" href="EventTarget.html#method_detachAll" property="yui:name" title="detachAll">detachAll</a><span class="">,</span>
</span>
<a class="" href="EventTarget.html#method_fire" property="yui:name" title="fire">fire</a><span class="">,</span>
</span>
<a class="" href="EventTarget.html#method_getEvent" property="yui:name" title="getEvent">getEvent</a><span class="">,</span>
</span>
<a class="" href="EventTarget.html#method_getTargets" property="yui:name" title="getTargets">getTargets</a><span class="">,</span>
</span>
<a class="" href="EventTarget.html#method_on" property="yui:name" title="on">on</a><span class="">,</span>
</span>
<a class="" href="EventTarget.html#method_once" property="yui:name" title="once">once</a><span class="">,</span>
</span>
<a class="" href="EventTarget.html#method_publish" property="yui:name" title="publish">publish</a><span class="">,</span>
</span>
<a class="" href="EventTarget.html#method_removeTarget" property="yui:name" title="removeTarget">removeTarget</a><span class="">,</span>
</span>
<a class=" deprecated" href="EventTarget.html#method_subscribe" property="yui:name" title="subscribe">subscribe</a><span class=" deprecated">,</span>
</span>
<a class=" deprecated" href="EventTarget.html#method_unsubscribe" property="yui:name" title="unsubscribe">unsubscribe</a><span class=" deprecated">,</span>
</span>
<a class=" deprecated" href="EventTarget.html#method_unsubscribeAll" property="yui:name" title="unsubscribeAll">unsubscribeAll</a>
</span>
</code>
</div>
</div>
<h4>Methods inherited from <a href="Attribute.html" property="yui:name" title="Attribute">Attribute</a>:</h4>
<div class="content" rel="yui:methods">
<code>
<a class="private" href="Attribute.html#method__addAttrs" property="yui:name" title="_addAttrs">_addAttrs</a><span class="private">,</span>
</span>
<a class="private" href="Attribute.html#method__addLazyAttr" property="yui:name" title="_addLazyAttr">_addLazyAttr</a><span class="private">,</span>
</span>
<a class="private" href="Attribute.html#method__defAttrChangeFn" property="yui:name" title="_defAttrChangeFn">_defAttrChangeFn</a><span class="private">,</span>
</span>
<a class="private" href="Attribute.html#method__fireAttrChange" property="yui:name" title="_fireAttrChange">_fireAttrChange</a><span class="private">,</span>
</span>
<a class="protected" href="Attribute.html#method__getAttr" property="yui:name" title="_getAttr">_getAttr</a><span class="protected">,</span>
</span>
<a class="protected" href="Attribute.html#method__getAttrCfg" property="yui:name" title="_getAttrCfg">_getAttrCfg</a><span class="protected">,</span>
</span>
<a class="private" href="Attribute.html#method__getAttrInitVal" property="yui:name" title="_getAttrInitVal">_getAttrInitVal</a><span class="private">,</span>
</span>
<a class="protected" href="Attribute.html#method__getAttrs" property="yui:name" title="_getAttrs">_getAttrs</a><span class="protected">,</span>
</span>
<a class="private" href="Attribute.html#method__getStateVal" property="yui:name" title="_getStateVal">_getStateVal</a><span class="private">,</span>
</span>
<a class="private" href="Attribute.html#method__isLazyAttr" property="yui:name" title="_isLazyAttr">_isLazyAttr</a><span class="private">,</span>
</span>
<a class="private" href="Attribute.html#method__normAttrVals" property="yui:name" title="_normAttrVals">_normAttrVals</a><span class="private">,</span>
</span>
<a class="protected" href="Attribute.html#method__protectAttrs" property="yui:name" title="_protectAttrs">_protectAttrs</a><span class="protected">,</span>
</span>
<a class="protected" href="Attribute.html#method__set" property="yui:name" title="_set">_set</a><span class="protected">,</span>
</span>
<a class="protected" href="Attribute.html#method__setAttr" property="yui:name" title="_setAttr">_setAttr</a><span class="protected">,</span>
</span>
<a class="protected" href="Attribute.html#method__setAttrs" property="yui:name" title="_setAttrs">_setAttrs</a><span class="protected">,</span>
</span>
<a class="private" href="Attribute.html#method__setAttrVal" property="yui:name" title="_setAttrVal">_setAttrVal</a><span class="private">,</span>
</span>
<a class="private" href="Attribute.html#method__setStateVal" property="yui:name" title="_setStateVal">_setStateVal</a><span class="private">,</span>
</span>
<a class="" href="Attribute.html#method_addAttr" property="yui:name" title="addAttr">addAttr</a><span class="">,</span>
</span>
<a class="" href="Attribute.html#method_addAttrs" property="yui:name" title="addAttrs">addAttrs</a><span class="">,</span>
</span>
<a class="" href="Attribute.html#method_attrAdded" property="yui:name" title="attrAdded">attrAdded</a><span class="">,</span>
</span>
<a class="" href="Attribute.html#method_get" property="yui:name" title="get">get</a><span class="">,</span>
</span>
<a class="" href="Attribute.html#method_getAttrs" property="yui:name" title="getAttrs">getAttrs</a><span class="">,</span>
</span>
<a class="" href="Attribute.html#method_modifyAttr" property="yui:name" title="modifyAttr">modifyAttr</a><span class="">,</span>
</span>
<a class="" href="Attribute.html#method_removeAttr" property="yui:name" title="removeAttr">removeAttr</a><span class="">,</span>
</span>
<a class="" href="Attribute.html#method_reset" property="yui:name" title="reset">reset</a><span class="">,</span>
</span>
<a class="" href="Attribute.html#method_set" property="yui:name" title="set">set</a><span class="">,</span>
</span>
</span>
</code>
</div>
</div>
<h4>Methods inherited from <a href="Plugin.Host.html" property="yui:name" title="Plugin.Host">Plugin.Host</a>:</h4>
<div class="content" rel="yui:methods">
<code>
<a class="private" href="Plugin.Host.html#method__destroyPlugins" property="yui:name" title="_destroyPlugins">_destroyPlugins</a><span class="private">,</span>
</span>
<a class="private" href="Plugin.Host.html#method__initPlugins" property="yui:name" title="_initPlugins">_initPlugins</a><span class="private">,</span>
</span>
<a class="private" href="Plugin.Host.html#method__plug" property="yui:name" title="_plug">_plug</a><span class="private">,</span>
</span>
<a class="private" href="Plugin.Host.html#method__unplug" property="yui:name" title="_unplug">_unplug</a><span class="private">,</span>
</span>
<a class="" href="Plugin.Host.html#method_hasPlugin" property="yui:name" title="hasPlugin">hasPlugin</a><span class="">,</span>
</span>
<a class="" href="Plugin.Host.html#method_plug" property="yui:name" title="plug">plug</a><span class="">,</span>
</span>
</span>
</code>
</div>
</div>
<div class="content" rel="yui:methods">
<code>
<a class="private" href="Base.html#method__aggregateAttrs" property="yui:name" title="_aggregateAttrs">_aggregateAttrs</a><span class="private">,</span>
</span>
<a class="protected" href="Base.html#method__defDestroyFn" property="yui:name" title="_defDestroyFn">_defDestroyFn</a><span class="protected">,</span>
</span>
<a class="protected" href="Base.html#method__defInitFn" property="yui:name" title="_defInitFn">_defInitFn</a><span class="protected">,</span>
</span>
<a class="private" href="Base.html#method__destroyHierarchy" property="yui:name" title="_destroyHierarchy">_destroyHierarchy</a><span class="private">,</span>
</span>
<a class="private" href="Base.html#method__filterAttrCfs" property="yui:name" title="_filterAttrCfs">_filterAttrCfs</a><span class="private">,</span>
</span>
<a class="protected" href="Base.html#method__getAttrCfgs" property="yui:name" title="_getAttrCfgs">_getAttrCfgs</a><span class="protected">,</span>
</span>
<a class="protected" href="Base.html#method__getClasses" property="yui:name" title="_getClasses">_getClasses</a><span class="protected">,</span>
</span>
<a class="private" href="Base.html#method__initHierarchy" property="yui:name" title="_initHierarchy">_initHierarchy</a><span class="private">,</span>
</span>
<a class="private" href="Base.html#method__initHierarchyData" property="yui:name" title="_initHierarchyData">_initHierarchyData</a><span class="private">,</span>
</span>
<a class="private" href="Base.html#method__preInitEventCfg" property="yui:name" title="_preInitEventCfg">_preInitEventCfg</a><span class="private">,</span>
</span>
<a class="" href="Base.html#method_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span>
</span>
<a class="" href="Base.html#method_init" property="yui:name" title="init">init</a><span class="">,</span>
</span>
</span>
</code>
</div>
</div>
<h4>Methods inherited from <a href="Plugin.Base.html" property="yui:name" title="Plugin.Base">Plugin.Base</a>:</h4>
<div class="content" rel="yui:methods">
<code>
<a class="" href="Plugin.Base.html#method_afterHostEvent" property="yui:name" title="afterHostEvent">afterHostEvent</a><span class="">,</span>
</span>
<a class="" href="Plugin.Base.html#method_afterHostMethod" property="yui:name" title="afterHostMethod">afterHostMethod</a><span class="">,</span>
</span>
<a class="" href="Plugin.Base.html#method_beforeHostMethod" property="yui:name" title="beforeHostMethod">beforeHostMethod</a><span class="">,</span>
</span>
<a class="" href="Plugin.Base.html#method_destructor" property="yui:name" title="destructor">destructor</a><span class="">,</span>
</span>
<a class="" href="Plugin.Base.html#method_doAfter" property="yui:name" title="doAfter">doAfter</a><span class="">,</span>
</span>
<a class="" href="Plugin.Base.html#method_doBefore" property="yui:name" title="doBefore">doBefore</a><span class="">,</span>
</span>
<a class="" href="Plugin.Base.html#method_initializer" property="yui:name" title="initializer">initializer</a><span class="">,</span>
</span>
<a class="" href="Plugin.Base.html#method_onHostEvent" property="yui:name" title="onHostEvent">onHostEvent</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_indexChange">
<h4>
<a name="event_indexChange">indexChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">indexChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'index' is changed. You can listen for the event using the <a href="Attribute.html#method_on">on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after">after</a> method if you wish to be notified after the attribute's value has changed.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
</code>
<span property="yui:description">An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl></span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_selectorChange">
<h4>
<a name="event_selectorChange">selectorChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">selectorChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'selector' is changed. You can listen for the event using the <a href="Attribute.html#method_on">on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after">after</a> method if you wish to be notified after the attribute's value has changed.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
</code>
<span property="yui:description">An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl></span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_totalChange">
<h4>
<a name="event_totalChange">totalChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">totalChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'total' is changed. You can listen for the event using the <a href="Attribute.html#method_on">on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after">after</a> method if you wish to be notified after the attribute's value has changed.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
</code>
<span property="yui:description">An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl></span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<div class="content" rel="yui:events">
<code>
<a class="" href="Base.html#event_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span>
</span>
<a class="" href="Base.html#event_destroyedChange" property="yui:name" title="destroyedChange">destroyedChange</a><span class="">,</span>
</span>
<a class="" href="Base.html#event_init" property="yui:name" title="init">init</a><span class="">,</span>
</span>
<a class="" href="Base.html#event_initializedChange" property="yui:name" title="initializedChange">initializedChange</a><span class="">,</span>
</span>
</code>
</div>
</div>
<h4>Events inherited from <a href="Plugin.Base.html" property="yui:name" title="Plugin.Base">Plugin.Base</a>:</h4>
<div class="content" rel="yui:events">
<code>
<a class="" href="Plugin.Base.html#event_hostChange" property="yui:name" title="hostChange">hostChange</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_index">
<h4><a name="config_index">index</a>
<code>- <span property="yui:type">{Number}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The active page number for a paged scrollview
</div>
</div>
<div class="default">
Default Value: 0
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_selector">
<h4><a name="config_selector">selector</a>
<code>- <span property="yui:type">{String}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
CSS selector for a page inside the scrollview. The scrollview
will snap to the closest page.
</div>
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_total">
<h4><a name="config_total">total</a>
<code>- <span property="yui:type">{Number}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The total number of pages
</div>
</div>
<div class="default">
Default Value: 0
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<h4>Configuration attributes inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4>
<div class="content" rel="yui:attributes">
<code>
</span>
<a class="" href="Base.html#config_initialized" property="yui:name" title="initialized">initialized</a>
</span>
</code>
</div>
</div>
<h4>Configuration attributes inherited from <a href="Plugin.Base.html" property="yui:name" title="Plugin.Base">Plugin.Base</a>:</h4>
<div class="content" rel="yui:attributes">
<code>
</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_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
<li class=""><a href="module_event-valuechange.html" title="event-valuechange">event-valuechange</a></li>
<li class=""><a href="module_history-deprecated.html" title="history-deprecated">history-deprecated</a></li>
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li>
<li class="selected"><a href="module_scrollview-paginator.html" title="scrollview-paginator">scrollview-paginator</a></li>
<li class=""><a href="module_scrollview-scrollbars.html" title="scrollview-scrollbars">scrollview-scrollbars</a></li>
<li class=""><a href="module_widget-position-align.html" title="widget-position-align">widget-position-align</a></li>
<li class=""><a href="module_widget-position-constrain.html" title="widget-position-constrain">widget-position-constrain</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class="selected"><a href="Plugin.ScrollViewPaginatorPlugin.html" title="Plugin.ScrollViewPaginatorPlugin">Plugin.ScrollViewPaginatorPlugin</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="paginator-plugin.js.html" title="paginator-plugin.js">paginator-plugin.js</a></li>
<li class=""><a href="scrollbars-plugin.js.html" title="scrollbars-plugin.js">scrollbars-plugin.js</a></li>
</ul>
</div>
<div id="propertyList" class="module">
<h4>Properties</h4>
<ul class="content">
<li class=""><a href="#property_ScrollViewPaginator.ATTRS" title="ScrollViewPaginator.ATTRS">ScrollViewPaginator.ATTRS</a></li>
<li class=""><a href="#property_ScrollViewPaginator.NAME" title="ScrollViewPaginator.NAME">ScrollViewPaginator.NAME</a></li>
<li class=""><a href="#property_ScrollViewPaginator.NS" title="ScrollViewPaginator.NS">ScrollViewPaginator.NS</a></li>
</ul>
</div>
<div id="methodsList" class="module">
<h4>Methods</h4>
<ul class="content">
<li class="protected"><a href="#method__afterIndexChange" title="_afterIndexChange">_afterIndexChange</a></li>
<li class="protected"><a href="#method__calculatePageOffsets" title="_calculatePageOffsets">_calculatePageOffsets</a></li>
<li class="protected"><a href="#method__flickFrame" title="_flickFrame">_flickFrame</a></li>
<li class="protected"><a href="#method__scrollEnded" title="_scrollEnded">_scrollEnded</a></li>
<li class="protected"><a href="#method__uiIndex" title="_uiIndex">_uiIndex</a></li>
<li class=""><a href="#method_destructor" title="destructor">destructor</a></li>
<li class=""><a href="#method_initializer" title="initializer">initializer</a></li>
<li class=""><a href="#method_next" title="next">next</a></li>
<li class=""><a href="#method_prev" title="prev">prev</a></li>
<li class=""><a href="#method_scrollTo" title="scrollTo">scrollTo</a></li>
<li class=""><a href="#method_snapToCurrent" title="snapToCurrent">snapToCurrent</a></li>
</ul>
</div>
<div id="eventsList" class="module">
<h4>Events</h4>
<ul class="content">
<li class=""><a href="#event_indexChange" title="indexChange">indexChange</a></li>
<li class=""><a href="#event_selectorChange" title="selectorChange">selectorChange</a></li>
<li class=""><a href="#event_totalChange" title="totalChange">totalChange</a></li>
</ul>
</div>
<div id="configList" class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li class=""><a href="#config_index" title="index">index</a></li>
<li class=""><a href="#config_selector" title="selector">selector</a></li>
<li class=""><a href="#config_total" title="total">total</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright © 2010 Yahoo! Inc. All rights reserved.
</div>
</div>
<script type="text/javascript">
var ALL_YUI_PROPS = [{"access": "protected", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "_afterIndexChange", "url": "Plugin.ScrollViewPaginatorPlugin.html#method__afterIndexChange", "type": "method"}, {"access": "protected", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "_calculatePageOffsets", "url": "Plugin.ScrollViewPaginatorPlugin.html#method__calculatePageOffsets", "type": "method"}, {"access": "", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "destructor", "url": "Plugin.ScrollViewPaginatorPlugin.html#method_destructor", "type": "method"}, {"access": "protected", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "_flickFrame", "url": "Plugin.ScrollViewPaginatorPlugin.html#method__flickFrame", "type": "method"}, {"access": "", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "index", "url": "Plugin.ScrollViewPaginatorPlugin.html#config_index", "type": "config"}, {"access": "", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "indexChange", "url": "Plugin.ScrollViewPaginatorPlugin.html#event_indexChange", "type": "event"}, {"access": "", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "initializer", "url": "Plugin.ScrollViewPaginatorPlugin.html#method_initializer", "type": "method"}, {"access": "", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "next", "url": "Plugin.ScrollViewPaginatorPlugin.html#method_next", "type": "method"}, {"access": "", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "prev", "url": "Plugin.ScrollViewPaginatorPlugin.html#method_prev", "type": "method"}, {"access": "protected", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "_scrollEnded", "url": "Plugin.ScrollViewPaginatorPlugin.html#method__scrollEnded", "type": "method"}, {"access": "", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "scrollTo", "url": "Plugin.ScrollViewPaginatorPlugin.html#method_scrollTo", "type": "method"}, {"access": "", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "ScrollViewPaginator.ATTRS", "url": "Plugin.ScrollViewPaginatorPlugin.html#property_ScrollViewPaginator.ATTRS", "type": "property"}, {"access": "", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "ScrollViewPaginator.NAME", "url": "Plugin.ScrollViewPaginatorPlugin.html#property_ScrollViewPaginator.NAME", "type": "property"}, {"access": "", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "ScrollViewPaginator.NS", "url": "Plugin.ScrollViewPaginatorPlugin.html#property_ScrollViewPaginator.NS", "type": "property"}, {"access": "", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "selector", "url": "Plugin.ScrollViewPaginatorPlugin.html#config_selector", "type": "config"}, {"access": "", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "selectorChange", "url": "Plugin.ScrollViewPaginatorPlugin.html#event_selectorChange", "type": "event"}, {"access": "", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "snapToCurrent", "url": "Plugin.ScrollViewPaginatorPlugin.html#method_snapToCurrent", "type": "method"}, {"access": "", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "total", "url": "Plugin.ScrollViewPaginatorPlugin.html#config_total", "type": "config"}, {"access": "", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "totalChange", "url": "Plugin.ScrollViewPaginatorPlugin.html#event_totalChange", "type": "event"}, {"access": "protected", "host": "Plugin.ScrollViewPaginatorPlugin", "name": "_uiIndex", "url": "Plugin.ScrollViewPaginatorPlugin.html#method__uiIndex", "type": "method"}];
</script>
</body>
</html>