<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<title>Control.ScrollBar : Pure JavaScript/CSS scroll bars for Prototype</title>
<link href="/styles.css" media="screen" rel="stylesheet" type="text/css" />
<script src="all.js" type="text/javascript"></script>
<script>
document.observe('dom:loaded',function(){
var scrollbar = new Control.ScrollBar('scrollbar_content','scrollbar_track');
$('scroll_down_50').observe('click',function(event){
scrollbar.scrollBy(-50);
event.stop();
});
$('scroll_up_50').observe('click',function(event){
scrollbar.scrollBy(50);
event.stop();
});
$('scroll_top').observe('click',function(event){
scrollbar.scrollTo('top');
event.stop();
});
$('scroll_bottom').observe('click',function(event){
//to animate a scroll operation you can pass true
//or a callback that will be called when scrolling is complete
scrollbar.scrollTo('bottom',function(){
if(typeof(console) != "undefined")
console.log('Finished scrolling to bottom.');
});
event.stop();
});
$('scroll_second').observe('click',function(event){
//you can pass a number or element to scroll to
//if you pass an element, it will be centered, unless it is
//near the bottom of the container
scrollbar.scrollTo($('second_subhead'));
event.stop();
});
$('scroll_third').observe('click',function(event){
//passing true will animate the scroll
scrollbar.scrollTo($('third_subhead'),true);
event.stop();
});
$('scroll_insert').observe('click',function(event){
$('scrollbar_content').insert('<p><b>Inserted: ' + $('repeat').innerHTML + '</b></p>');
//you only need to call this if ajax or dom operations modify the layout
//this is automatically called when the window resizes
scrollbar.recalculateLayout();
event.stop();
});
});
</script>
<style>
#scrollbar_container {
position:relative;
width:500px;
}
#scrollbar_track {
position:absolute;
top:0;
right:0;
height:100%;
width:10px;
background-color:transparent;
cursor:move;
}
#scrollbar_handle {
width:10px;
background-color:#5c92e7;
cursor:move;
-moz-border-radius: 5px;
-webkit-border-radius: 5px;
opacity:0.9;
-moz-opacity:0.9;
}
#scrollbar_content {
overflow:hidden;
width:485px;
height:250px;
}
</style>
</head>
<body class="control">
<div id="outer_container">
<div id="container">
<div id="header">
<h2><a href="[URL unfurl="true"]http://livepipe.net/"><span>LivePipe™[/URL] : User Interface Components for Prototype</span></a></h2>
<ul id="navigation">
<li><a href="[URL unfurl="true"]http://livepipe.net/">Home</a></li>[/URL]
<li><a href="[URL unfurl="true"]http://livepipe.net/core">Core</a></li>[/URL]
<li class="active"><a href="[URL unfurl="true"]http://livepipe.net/control">Controls</a></li>[/URL]
<li><a href="[URL unfurl="true"]http://livepipe.net/extra">Extras</a></li>[/URL]
<li><a href="[URL unfurl="true"]http://livepipe.net/download">Download[/URL] & Contribute</a></li>
</ul>
</div>
<div id="main">
<div id="main_container">
<a href="[URL unfurl="true"]http://personalgrid.com/"[/URL] id="personal_grid"><span>Get 2GB of free storage at PersonalGrid</span></a>
<ul id="subnavigation">
<li class="first"><a href="[URL unfurl="true"]http://livepipe.net/control/contextmenu">ContextMenu</a></li>[/URL]
<!--<li><a href="[URL unfurl="true"]http://livepipe.net/control/pagination">Pagination</a></li>-->[/URL]
<li><a href="[URL unfurl="true"]http://livepipe.net/control/progressbar">ProgressBar</a></li>[/URL]
<li><a href="[URL unfurl="true"]http://livepipe.net/control/rating">Rating</a></li>[/URL]
<li class="active"><a href="[URL unfurl="true"]http://livepipe.net/control/scrollbar">ScrollBar</a></li>[/URL]
<li><a href="[URL unfurl="true"]http://livepipe.net/control/selectmultiple">SelectMultiple</a></li>[/URL]
<li><a href="[URL unfurl="true"]http://livepipe.net/control/selection">Selection</a></li>[/URL]
<li><a href="[URL unfurl="true"]http://livepipe.net/control/tabs">Tabs</a></li>[/URL]
<li><a href="[URL unfurl="true"]http://livepipe.net/control/textarea">TextArea</a></li>[/URL]
<li><a href="[URL unfurl="true"]http://livepipe.net/control/window">Window</a></li>[/URL]
</ul>
<h1>Control.ScrollBar</h1>
<p class="introduction">Pure JavaScript/CSS scroll bars for Prototype.</p>
<ul class="subsection_tabs" id="main_tabs" style="clear:none;">
<li class="source_code"><a href="[URL unfurl="true"]http://github.com/syntacticx/livepipe-ui/tree/master/src/scrollbar.js">scrollbar.js[/URL] source</a></li>
<li class="tab"><a href="#tutorial">Tutorial</a></li>
<li class="tab"><a href="#api">API</a></li>
</ul>
<script>
document.observe('dom:loaded',function(){
new Control.Tabs('main_tabs',{
linkSelector: 'li.tab a'
});
});
</script>
<div id="tutorial">
<div style="float:right;">
<h3>Scroll To...</h3>
<ul>
<li><a href="#" id="scroll_down_50">Up 50 Pixels</a></li>
<li><a href="#" id="scroll_up_50">Down 50 Pixels</a></li>
<li><a href="#" id="scroll_top">Top</a></li>
<li><a href="#" id="scroll_bottom">Bottom (Animated)</a></li>
<li><a href="#" id="scroll_second">Second Subhead</a></li>
<li><a href="#" id="scroll_third">Third Subhead (Animated)</a></li>
</ul>
</div>
<div id="scrollbar_container">
<div id="scrollbar_track">
<div id="scrollbar_handle">
</div>
</div>
<div id="scrollbar_content">
<h3>Use the Mouse Wheel or Handle to Scroll</h3>
<p>Nulla facilisi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Fusce consectetuer. Phasellus molestie, sem vel laoreet pretium, arcu arcu rutrum eros, ac mattis felis ante at orci. Vivamus vel mauris. Ut porttitor, nunc eu tincidunt gravida, orci odio luctus mi, id venenatis dui nunc sit amet turpis. Mauris urna nisl, feugiat a, ultrices id, ultrices et, est. Nam eu felis non tortor luctus congue. Mauris consequat malesuada augue. Donec eu nibh in libero tempor aliquet. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Pellentesque sapien erat, imperdiet tincidunt, vestibulum eget, fringilla vel, odio. Ut risus. Ut pretium neque ac velit. Vivamus diam. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. In hac habitasse platea dictumst. Nunc luctus fringilla mi. Nunc ultrices nisi ac urna.</p>
<h3 id="second_subhead">Convallis Felis ac Massa Accumsan</h3>
<p id="repeat">Phasellus faucibus adipiscing quam. Maecenas gravida, diam sit amet mollis accumsan, risus diam ornare leo, non sollicitudin lorem mi vitae ante. In at mi. In vestibulum nunc eleifend justo. Nullam semper. Nulla venenatis ornare ipsum. Phasellus pharetra. Suspendisse molestie. Fusce porta vulputate quam. Etiam vitae tortor. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Maecenas vulputate magna nec diam. Aliquam sagittis lectus a pede. Sed fermentum, risus non sollicitudin posuere, erat arcu iaculis nibh, eu faucibus sapien velit dapibus ipsum. Proin fringilla sapien sed dui.</p>
<h3 id="third_subhead">Eleifend Justo Nullam Semper</h3>
<p>Cras eros tellus, posuere at, condimentum eget, fringilla nec, lectus. Mauris ut enim. Quisque imperdiet rutrum elit. Curabitur in nunc. Sed pretium. Aliquam convallis. Proin venenatis. Proin sed magna. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nunc tincidunt. Nam vitae leo at urna dictum venenatis.</p>
<p>Cras iaculis. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut nisl. Duis quis enim at justo euismod accumsan. Duis mollis. Curabitur sed ante. Morbi bibendum iaculis ligula. Suspendisse aliquet est. Sed velit orci, sagittis non, posuere vitae, aliquet in, massa. Vestibulum egestas.</p>
</div>
</div>
</div>
<div id="api">
<h3>Instance</h3><table cellpadding="0" cellspacing="0" width="100%" class="api_table">
<thead>
<tr><td>Return</td><td>Name</td><td class="description">Description</td></tr>
</thead>
<tbody>
<tr class="even"><td class="type first">Control.ScrollBar</td><td class="signature"><b>initialize(Element container, Element track [,Hash options])</b></td><td class="last">Automatically calls recalculateLayout(). The handle will be obtained via track.firstDescendant()</td></tr>
<tr class="odd"><td class="type first">null</td><td class="signature"><b>destroy()</b></td><td class="last"></td></tr>
<tr class="even"><td class="type first">null</td><td class="signature"><b>disable()</b></td><td class="last"></td></tr>
<tr class="odd"><td class="type first">null</td><td class="signature"><b>enable()</b></td><td class="last"></td></tr>
<tr class="even"><td class="type first">null</td><td class="signature"><b>recalculateLayout()</b></td><td class="last">Call this if the page layout changes from dynamic content. Recalculates track length, handle length and wether or not the scrollbar should be hidden or visible.</td></tr>
<tr class="odd"><td class="type first">null</td><td class="signature"><b>reset()</b></td><td class="last"></td></tr>
<tr class="even"><td class="type first">null</td><td class="signature"><b>scrollBy(number y)</b></td><td class="last"><b>y</b> can be a positive or negative integer.</td></tr>
<tr class="odd"><td class="type first">null</td><td class="signature"><b>scrollTo(mixed y [,mixed animate])</b></td><td class="last"><b>y</b> can be an Element, a number (offsetTop), or the string 'top' or 'bottom'. <b>animate</b> (smooth scrolling) can be a boolean, or can be a callback to execute when the scroll is complete. If a callback is passed the it is always called, even if scrolling is not necessary.</td></tr>
<tr class="even"><td class="type first">Element</td><td class="signature"><b>container</b></td><td class="last"></td></tr>
<tr class="odd"><td class="type first">Element</td><td class="signature"><b>handle</b></td><td class="last"></td></tr>
<tr class="even"><td class="type first">Element</td><td class="signature"><b>track</b></td><td class="last"></td></tr>
</tbody>
</table>
<h3>Options</h3><table cellpadding="0" cellspacing="0" width="100%" class="api_table">
<thead>
<tr><td>Type</td><td>Name</td><td>Default</td><td class="description">Description</td></tr>
</thead>
<tbody>
<tr class="even"><td class="type first">string</td><td><b>active_class_name</b></td><td class="default">'scrolling'</td><td class="last"></td></tr>
<tr class="odd"><td class="type first">Element</td><td><b>apply_active_class_name_to</b></td><td class="default">this.container</td><td class="last"></td></tr>
<tr class="even"><td class="type first">number</td><td><b>handle_minimum_height</b></td><td class="default">25</td><td class="last">If <b>proportional</b> is true, this is the minimum height in pixels. </td></tr>
<tr class="odd"><td class="type first">number</td><td><b>notification_timeout_length</b></td><td class="default">125</td><td class="last">Milliseconds between change() events when scrolling.</td></tr>
<tr class="even"><td class="type first">bool</td><td><b>proportional</b></td><td class="default">true</td><td class="last">Draw the handle proportional to (container height / length of track).</td></tr>
<tr class="odd"><td class="type first">number</td><td><b>scroll_to_smoothing</b></td><td class="default">0.01</td><td class="last"></td></tr>
<tr class="even"><td class="type first">number</td><td><b>scroll_to_steps</b></td><td class="default">15</td><td class="last"></td></tr>
<tr class="odd"><td class="type first">Hash</td><td><b>slider_options</b></td><td class="default">{}</td><td class="last">Will be passed to Control.Slider</td></tr>
</tbody>
</table>
<h3>Events</h3><table cellpadding="0" cellspacing="0" width="100%" class="api_table">
<thead>
<tr><td>Name</td><td class="description">Description</td></tr>
</thead>
<tbody>
<tr class="even"><td class="first"><b>change(number delta)</b></td><td class="last">Forwarded from slider.onSlide and slider.onChange, but will fire at a maximum interval of options.notification_timeout_length for performance.</td></tr>
<tr class="odd"><td class="first"><b>disabled()</b></td><td class="last"></td></tr>
<tr class="even"><td class="first"><b>enabled()</b></td><td class="last"></td></tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</body>
</html>