webgui/www/extras/yui/examples/carousel/csl_selection.html
JT Smith 20f8df1291 upgrading to YUI 2.6
data tables are going to need some work yet, but the other stuff seems to be working 100%
2008-10-22 23:53:29 +00:00

408 lines
22 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>YUI Library Examples: Carousel Control: Spotlight example</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../assets/yui.css" >
<style>
/*Supplemental CSS for the YUI distribution*/
#custom-doc { width: 95%; min-width: 950px; }
#pagetitle {background-image: url(../../assets/bg_hd.gif);}
#pagetitle h1 {background-image: url(../../assets/title_h_bg.gif);}
</style>
<link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css">
<!--Script and CSS includes for YUI dependencies on this page-->
<link rel="stylesheet" type="text/css" href="../../build/carousel/assets/skins/sam/carousel.css" />
<link rel="stylesheet" type="text/css" href="../../build/button/assets/skins/sam/button.css" />
<script type="text/javascript" src="../../build/yuiloader/yuiloader-min.js"></script>
<script type="text/javascript" src="../../build/dom/dom-min.js"></script>
<script type="text/javascript" src="../../build/event/event-min.js"></script>
<script type="text/javascript" src="../../build/element/element-beta-min.js"></script>
<script type="text/javascript" src="../../build/carousel/carousel-beta-min.js"></script>
<script type="text/javascript" src="../../build/button/button-min.js"></script>
<!--begin custom header content for this example-->
<style type="text/css">
/* Style the spotlight container */
#spotlight {
border: 1px solid #ccc;
height: 180px;
margin: 10px auto;
padding: 1px;
width: 240px;
}
#container {
margin: 0 auto;
}
.yui-carousel-element li {
height: 75px;
opacity: 0.6;
width: 75px;
}
.yui-carousel-element .yui-carousel-item-selected {
opacity: 1;
}
.yui-skin-sam .yui-carousel-nav ul li {
margin: 0;
}
</style>
<!--end custom header content for this example-->
<script type="text/javascript">
//enable passthrough of errors from YUI Event:
if ((typeof YAHOO !== "undefined") && (YAHOO.util) && (YAHOO.util.Event)) {
YAHOO.util.Event.throwErrors = true;
}
</script>
</head>
<body id="yahoo-com" class=" yui-skin-sam">
<div id="custom-doc" class="yui-t2">
<div id="hd">
<div id="ygunav">
<p><em><a href="http://developer.yahoo.com/yui/">YUI Library Home</a></em></p>
<form action="http://search.yahoo.com/search" id="sitesearchform">
<input name="vs" type="hidden" value="developer.yahoo.com">
<input name="vs" type="hidden" value="yuiblog.com">
<div id="sitesearch">
<label for="searchinput">Site Search (YDN &amp; YUIBlog): </label>
<input type="text" id="searchinput" name="p">
<input type="submit" value="Search" id="searchsubmit" class="ygbt">
</div>
</form> </div>
<div id="ygma"><a href="../../"><img src="../../assets/yui.gif" border="0" height="38"></a></div>
<div id="pagetitle"><h1>YUI Library Examples: Carousel Control: Spotlight example</h1></div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-ge">
<div class="yui-u first example">
<div class="promo">
<h1>Carousel Control: Spotlight example</h1>
<div class="exampleIntro">
<p>
This example uses the <a href="http://developer.yahoo.com/yui/carousel/">YUI Carousel Control</a> to showcase a simple spotlight
example using its <code>itemSelected</code> event. In this example, you can use arrow
keys to select items as well as click on an item to select it.
</p>
<p>
Though this functionality looks a little complicated, it is very easy to
implement. This is because the YUI Carousel Control handles the keyboard
event and the mouse click event for setting the selection. When an item is
selected, the YUI Carousel Control triggers an <code>itemSelected</code> event. This
example subscribes to the <code>itemSelected</code> event to display the selected
image in the spotlight.
</p>
</div>
<div class="example-container module ">
<div class="hd exampleHd">
<p class="newWindowButton yui-skin-sam"><!--<span id="newWindowLinkx"><span class="first-child">--><a href="csl_selection_clean.html" target="_blank">View example in new window.</a><!--</span></span>-->
</div> <div id="example-canvas" class="bd">
<!--BEGIN SOURCE CODE FOR EXAMPLE =============================== -->
<!-- The Carousel container -->
<div id="container">
<ol id="carousel">
<li>
<img src="http://farm1.static.flickr.com/135/342099636_7b05b7cde5_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/136/342099938_fdef3ca3b5_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/147/342099522_3827eaa929_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/143/342100011_ec4d338c71_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/161/342100080_0fe4f9ccb0_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/153/342100324_82589c0ebe_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/147/342100376_d0336252a7_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/156/342100472_b9bc985fa4_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/133/342100566_39dae4698f_s.jpg">
</li>
</ol>
</div>
<!-- The spotlight container -->
<div id="spotlight"></div>
<style type="text/css">
/* Style the spotlight container */
#spotlight {
border: 1px solid #ccc;
height: 180px;
margin: 10px auto;
padding: 1px;
width: 240px;
}
.yui-carousel-element li {
opacity: 0.6;
}
.yui-carousel-element .yui-carousel-item-selected {
opacity: 1;
}
</style>
<script>
(function () {
var carousel;
// Get the image link from within its (parent) container.
function getImage(parent) {
var el = parent.firstChild;
while (el) { // walk through till as long as there's an element
if (el.nodeName.toUpperCase() == "IMG") { // found an image
// flickr uses "_s" suffix for small, and "_m" for big
// images respectively
return el.src.replace(/_s\.jpg$/, "_m.jpg");
}
el = el.nextSibling;
}
return "";
}
YAHOO.util.Event.onDOMReady(function (ev) {
var el, item,
spotlight = YAHOO.util.Dom.get("spotlight"),
carousel = new YAHOO.widget.Carousel("container");
carousel.render(); // get ready for rendering the widget
carousel.show(); // display the widget
// display the first selected item in the spotlight
item = carousel.getElementForItem(carousel.get("selectedItem"));
if (item) {
spotlight.innerHTML = "<img src=\"" + getImage(item) + "\">";
}
carousel.on("itemSelected", function (index) {
// item has the reference to the Carousel's item
item = carousel.getElementForItem(index);
if (item) {
spotlight.innerHTML = "<img src=\""+getImage(item)+"\">";
}
});
});
})();
</script>
<!--END SOURCE CODE FOR EXAMPLE =============================== -->
</div>
</div>
</div>
<h2 class="first">Using the Carousel Control to Spotlight the Selected Item</h2>
<p>
Here we will use the <a href="http://developer.yahoo.com/yui/carousel/">YUI Carousel Control</a>'s <code>itemSelected</code> event to display
the selected image.</p>
<p>
This example has the following dependencies:
</p>
<textarea name="code" class="HTML" cols="60" rows="1"><link type="text/css" rel="stylesheet" href="http://yui.yahooapis.com/2.6.0/build/carousel/assets/skins/sam/carousel.css">
<script src="http://yui.yahooapis.com/2.6.0/build/yahoo/yahoo-dom-event.js"></script>
<script src="http://yui.yahooapis.com/2.6.0/build/element/element-beta-min.js"></script>
<script src="http://yui.yahooapis.com/2.6.0/build/carousel/carousel-beta-min.js"></script></textarea>
<p>
This example uses progressive enhancement; the Carousel is created
from an ordered list.
</p>
<textarea name="code" class="HTML" cols="60" rows="1"><div id="container">
<ol>
<li>
<img src="http://farm1.static.flickr.com/135/342099636_7b05b7cde5_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/136/342099938_fdef3ca3b5_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/147/342099522_3827eaa929_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/143/342100011_ec4d338c71_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/161/342100080_0fe4f9ccb0_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/153/342100324_82589c0ebe_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/147/342100376_d0336252a7_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/156/342100472_b9bc985fa4_s.jpg">
</li>
<li>
<img src="http://farm1.static.flickr.com/133/342100566_39dae4698f_s.jpg">
</li>
</ol>
</div></textarea>
<p>
We will add a container element where we can display the spotlight image.
</p>
<textarea name="code" class="HTML" cols="60" rows="1"><div id="spotlight"></div></textarea>
<p>
We'll have only one CSS rule to set the height for the Carousel items.
</p>
<textarea name="code" class="CSS" cols="60" rows="1">
.yui-carousel-element li {
height: 75px;
width: 75px;
}</textarea>
<p>
Since we have the elements in place, we can invoke the Carousel's
constructor to create the widget. The Carousel's <code>selectedItem</code> property
returns the index of the currently selected item. So, using that property
and the <code>getElementForItem()</code> API, we can display the image of the selected item when the
Carousel is rendered.
</p>
<textarea name="code" class="JScript" cols="60" rows="1">YAHOO.util.Event.onDOMReady(function (ev) {
var carousel = new YAHOO.widget.Carousel("container");
carousel.render(); // get ready for rendering the widget
carousel.show(); // display the widget
// display the first selected item in the spotlight
spotlight.innerHTML = "&lt;img src=\"" +
getImage(carousel.getElementForItem(carousel.get("selectedItem"))) + "\"&gt;";
}</textarea>
</textarea>
<p>
Now, we can subscribe to the <code>selectedItem</code> event that the Carousel exposes.
This event is triggered whenever an item is selected and it returns the
index of the selected item. With the index of the item, we can use the
Carousel's <code>getElementForItem()</code> API to get the reference to the Carousel's item (an <code>li</code> element in
our case).
</p>
<textarea name="code" class="JScript" cols="60" rows="1">carousel.on("itemSelected", function (index) {
// item has the reference to the Carousel's item
var item = carousel.getElementForItem(index);
});</textarea>
<p>
Once the reference to the Carousel's item is obtained, it is
straightforward to implement a function that extracts the image within it.
</p>
<textarea name="code" class="JScript" cols="60" rows="1">// Get the image link from within its (parent) container.
function getImage(parent) {
var el = parent.firstChild;
while (el) { // walk through till as long as there's an element
if (el.nodeName.toUpperCase() == "IMG") { // found an image
// flickr uses "_s" suffix for small, and "_m" for big images respectively
return el.src.replace(/_s\.jpg$/, "_m.jpg");
}
el = el.nextSibling;
}
return "";</textarea>
</div>
<div class="yui-u">
<div id="loggerModule" class="yui-skin-sam">
<h3 class="firstContent">YUI Logger Output:</h3>
<div id="loggerGloss"><p><strong>Note:</strong> Logging and debugging is currently turned off for this example.</p>
<p class="loggerButton"><span id="loggerLink"><span class="first-child"><a href="csl_selection_log.html">Reload with logging<br />
and debugging enabled.</a></span></span></p></div>
</div>
<div id="examples">
<h3>Carousel Control Examples:</h3>
<div id="exampleToc">
<ul>
<li class='selected'><a href='../carousel/csl_selection.html'>Spotlight example</a></li><li><a href='../carousel/csl_circular.html'>Circular Carousel example</a></li><li><a href='../carousel/csl_reveal.html'>Partially revealing previous and next items</a></li><li><a href='../carousel/csl_imagentext.html'>Using both images and text within an item</a></li><li><a href='../carousel/csl_dynload2.html'>Using Ajax for deferred loading of items</a></li><li><a href='../carousel/carousel-ariaplugin.html'>Using the Carousel ARIA Plugin</a></li> </ul>
</div>
</div>
<div id="module">
<h3>More Carousel Control Resources:</h3>
<ul>
<li><a href="http://developer.yahoo.com/yui/carousel/">User's Guide</a> (external)</li>
<li><a href="../../docs/module_carousel.html">API Documentation</a></li>
<li><a href="http://yuiblog.com/assets/pdf/cheatsheets/carousel.pdf">Cheat Sheet PDF</a> (external)</li></ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui-b" id="tocWrapper">
<!-- TABLE OF CONTENTS -->
<div id="toc">
<ul>
<li class="sect first">Yahoo! UI Library</li><li class="item"><a title="The Yahoo! User Interface Library (YUI)" href="http://developer.yahoo.com/yui/">Home (external)</a></li><li class="item"><a title="The Yahoo! User Interface Blog" href="http://yuiblog.com">YUIBlog (external)</a></li><li class="item"><a title="The Yahoo! Group YDN-JavaScript hosts the YUI community forum" href="http://tech.groups.yahoo.com/group/ydn-javascript/">YUI Discussion Forum (external)</a></li><li class="item"><a title="The YUI Library can be downloaded from SourceForge" href="http://sourceforge.net/projects/yui/">YUI on Sourceforge (external)</a></li><li class="item"><a title="Instantly searchable API documentation for the entire YUI library." href="../../docs/index.html">API Documentation</a></li><li class="item"><a title="Examples of every YUI utility and control in action" href="../../examples/">Functional Examples</a></li><li class="item"><a title="Videos and podcasts from the YUI Team and from the Yahoo! frontend engineering community." href="http://developer.yahoo.com/yui/theater/">YUI Theater (external)</a></li><li class="item"><a title="YUI is free and open, offered under a BSD license." href="http://developer.yahoo.com/yui/license.html">YUI License (external)</a></li><li class="sect">YUI Functional Examples</li><li class="item"><a title="The YUI Animation Utility - Functional Examples" href="../../examples/animation/index.html">Animation</a></li><li class="item"><a title="The YUI AutoComplete Control - Functional Examples" href="../../examples/autocomplete/index.html">AutoComplete</a></li><li class="item"><a title="The YUI Browser History Manager - Functional Examples" href="../../examples/history/index.html">Browser History Manager</a></li><li class="item"><a title="The YUI Button Control - Functional Examples" href="../../examples/button/index.html">Button</a></li><li class="item"><a title="The YUI Calendar Control - Functional Examples" href="../../examples/calendar/index.html">Calendar</a></li><li class="selected "><a title="The YUI Carousel Control - Functional Examples" href="../../examples/carousel/index.html">Carousel</a></li><li class="item"><a title="The YUI Charts Control - Functional Examples" href="../../examples/charts/index.html">Charts (experimental)</a></li><li class="item"><a title="The YUI Color Picker Control - Functional Examples" href="../../examples/colorpicker/index.html">Color Picker</a></li><li class="item"><a title="The YUI Cookie Utility - Functional Examples" href="../../examples/cookie/index.html">Cookie</a></li><li class="item"><a title="The YUI Connection Manager (AJAX) - Functional Examples" href="../../examples/connection/index.html">Connection Manager</a></li><li class="item"><a title="The YUI Container Family (Module, Overlay, Tooltip, Panel, Dialog, SimpleDialog) - Functional Examples" href="../../examples/container/index.html">Container</a></li><li class="item"><a title="The YUI DataTable Control - Functional Examples" href="../../examples/datatable/index.html">DataTable</a></li><li class="item"><a title="The YUI Dom Collection - Functional Examples" href="../../examples/dom/index.html">Dom</a></li><li class="item"><a title="The YUI Drag &amp; Drop Utility - Functional Examples" href="../../examples/dragdrop/index.html">Drag &amp; Drop</a></li><li class="item"><a title="The YUI Event Utility - Functional Examples" href="../../examples/event/index.html">Event</a></li><li class="item"><a title="The YUI Get Utility - Functional Examples" href="../../examples/get/index.html">Get</a></li><li class="item"><a title="The YUI ImageCropper Control - Functional Examples" href="../../examples/imagecropper/index.html">ImageCropper</a></li><li class="item"><a title="The YUI ImageLoader Utility - Functional Examples" href="../../examples/imageloader/index.html">ImageLoader</a></li><li class="item"><a title="The YUI JSON Utility - Functional Examples" href="../../examples/json/index.html">JSON</a></li><li class="item"><a title="The YUI Layout Manager - Functional Examples" href="../../examples/layout/index.html">Layout Manager</a></li><li class="item"><a title="The YUI Logger Control - Functional Examples" href="../../examples/logger/index.html">Logger</a></li><li class="item"><a title="The YUI Menu Control - Functional Examples" href="../../examples/menu/index.html">Menu</a></li><li class="item"><a title="The YUI Paginator - Functional Examples" href="../../examples/paginator/index.html">Paginator</a></li><li class="item"><a title="The YUI Profiler Utility - Functional Examples" href="../../examples/profiler/index.html">Profiler</a></li><li class="item"><a title="The YUI ProfileViewer Control - Functional Examples" href="../../examples/profilerviewer/index.html">ProfilerViewer</a></li><li class="item"><a title="The YUI Resize Utility - Functional Examples" href="../../examples/resize/index.html">Resize</a></li><li class="item"><a title="The YUI Rich Text Editor - Functional Examples" href="../../examples/editor/index.html">Rich Text Editor</a></li><li class="item"><a title="The YUI Selector Utility - Functional Examples" href="../../examples/selector/index.html">Selector</a></li><li class="item"><a title="The YUI Slider Control - Functional Examples" href="../../examples/slider/index.html">Slider</a></li><li class="item"><a title="The YUI TabView Control - Functional Examples" href="../../examples/tabview/index.html">TabView</a></li><li class="item"><a title="The YUI TreeView Control - Functional Examples" href="../../examples/treeview/index.html">TreeView</a></li><li class="item"><a title="The YUI Uploader Utility - Functional Examples" href="../../examples/uploader/index.html">Uploader (experimental)</a></li><li class="item"><a title="The YUI YAHOO Global Object - Functional Examples" href="../../examples/yahoo/index.html">YAHOO Global Object</a></li><li class="item"><a title="The YUI Loader Utility - Functional Examples" href="../../examples/yuiloader/index.html">YUI Loader</a></li><li class="item"><a title="The YUI Test Utility - Functional Examples" href="../../examples/yuitest/index.html">YUI Test</a></li><li class="item"><a title="YUI Reset CSS - Functional Examples" href="../../examples/reset/index.html">Reset CSS</a></li><li class="item"><a title="YUI Base CSS - Functional Examples" href="../../examples/base/index.html">Base CSS</a></li><li class="item"><a title="YUI Fonts CSS - Functional Examples" href="../../examples/fonts/index.html">Fonts CSS</a></li><li class="item"><a title="YUI Grids CSS - Functional Examples" href="../../examples/grids/index.html">Grids CSS</a></li><li class="sect">YUI Articles on the YUI Website</li><li class="item"><a title="Answers to Frequently Asked Questions about the YUI Library" href="http://developer.yahoo.com/yui/articles/faq/">YUI FAQ (external)</a></li><li class="item"><a title="Yahoo!'s philosophy of Graded Browser Support" href="http://developer.yahoo.com/yui/articles/gbs/">Graded Browser Support (external)</a></li><li class="item"><a title="Reporting Bugs and Making Feature Requests for YUI Components" href="http://developer.yahoo.com/yui/articles/reportingbugs/">Bug Reports/Feature Requests (external)</a></li><li class="item"><a title="Serve YUI source files from Yahoo! -- free, fast, and simple" href="http://developer.yahoo.com/yui/articles/hosting/">Serving YUI Files from Yahoo! (external)</a></li><li class="item"><a title="Best practices for working with web services while protecting user privacy" href="http://developer.yahoo.com/security/">Security Best Practices (external)</a></li></ul>
</div>
</div>
</div><!--closes bd-->
<div id="ft">
<p class="first">Copyright &copy; 2008 Yahoo! Inc. All rights reserved.</p>
<p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> -
<a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> -
<a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> -
<a href="http://careers.yahoo.com/">Job Openings</a></p>
</div>
</div>
<script src="../../assets/dpSyntaxHighlighter.js"></script>
<script language="javascript">
dp.SyntaxHighlighter.HighlightAll('code');
</script>
<script src='../../assets/YUIexamples.js'></script>
</body>
</html>