src/cm/media/js/lib/yui/yui_3.0.0b1/examples/overlay/overlay-io-plugin.html
author Yves-Marie Haussonne <ymh.work+github@gmail.com>
Fri, 09 May 2014 18:35:26 +0200
changeset 656 a84519031134
parent 0 40c8f766c9b8
permissions -rw-r--r--
add link to "privacy policy" in the header test
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     1
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     2
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     3
<html>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     4
<head>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     5
	<title>YUI Library Examples: Overlay: IO Plugin</title>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     6
    <meta http-equiv="content-type" content="text/html; charset=utf-8">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     7
    	<link rel="stylesheet" type="text/css" href="../../assets/yui.css" >
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     8
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     9
<style>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    10
    /*Supplemental CSS for the YUI distribution*/
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    11
    #custom-doc { width: 95%; min-width: 950px; }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    12
    #pagetitle {background-image: url(../../assets/bg_hd.gif);}
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    13
/*    #pagetitle h1 {background-image: url(../../assets/title_h_bg.gif);}*/
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    14
</style>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    15
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    16
<link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    17
<link type="text/css" rel="stylesheet" href="../../build/cssfonts/fonts-min.css" />
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    18
<script type="text/javascript" src="../../build/yui/yui-min.js"></script>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    19
<style type="text/css">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    20
    .yui-overlay-content {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    21
        padding:5px;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    22
        background-color:#ccc;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    23
        border:1px solid #000;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    24
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    25
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    26
    .yui-overlay .yui-widget-hd, 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    27
    .yui-overlay .yui-widget-bd, 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    28
    .yui-overlay .yui-widget-ft {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    29
        background-color:#eee;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    30
        padding:2px;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    31
        border:1px solid #999;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    32
        text-align:left;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    33
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    34
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    35
    .yui-overlay .yui-widget-bd {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    36
        background-color:#fff;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    37
        text-align:center;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    38
        vertical-align:middle;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    39
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    40
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    41
    .yui-overlay .yui-widget-bd .yui-feed-data {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    42
        text-align:left;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    43
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    44
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    45
    .yui-overlay .yui-feed-selector .yui-prompt {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    46
        font-weight:bold;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    47
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    48
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    49
</style>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    50
</head>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    51
<body id="yahoo-com" class=" yui-skin-sam">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    52
<div id="custom-doc" class="yui-t2">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    53
<div id="hd">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    54
	<div id="ygunav">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    55
		<p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    56
            <em>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    57
                <a href="http://developer.yahoo.com/yui/3/">YUI 3.x Home</a> <i> - </i>	
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    58
            </em>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    59
		</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    60
		<form action="http://search.yahoo.com/search" id="sitesearchform">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    61
            <input name="vs" type="hidden" value="developer.yahoo.com">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    62
            <input name="vs" type="hidden" value="yuiblog.com">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    63
		    <div id="sitesearch">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    64
		    	<label for="searchinput">Site Search (YDN &amp; YUIBlog): </label>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    65
			    <input type="text" id="searchinput" name="p">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    66
			    <input type="submit" value="Search" id="searchsubmit" class="ygbt">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    67
		    </div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    68
		</form>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    69
    </div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    70
	<div id="ygma"><a href="../../"><img src="../../assets/logo.gif"  border="0" width="200" height="93"></a></div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    71
	<div id="pagetitle"><h1>YUI Library Examples: Overlay: IO Plugin</h1></div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    72
</div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    73
<div id="bd">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    74
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    75
	<div id="bar-note"><p><strong>Note:</strong> This is YUI 3.x. Looking for <a href="http://developer.yahoo.com/yui/">YUI 2.x</a>?</p></div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    76
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    77
	<div id="yui-main">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    78
		<div class="yui-b">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    79
		  <div class="yui-ge">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    80
			  <div class="yui-u first example" id="main">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    81
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    82
	<h2>Overlay: IO Plugin</h2>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    83
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    84
	<div id="example" class="promo">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    85
	<p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    86
	<p>This example shows how you can use Widget's plugin infrastructure to add additional features to an existing widget.</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    87
<p>We create an IO plugin class for <code>Overlay</code> called <code>StdModIOPlugin</code>. The plugin adds IO capabilities to the Overlay, bound to one of its standard module sections <em>(header, body or footer)</em>.</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    88
	</p>	
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    89
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    90
	<div class="module example-container ">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    91
			<div class="hd exampleHd">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    92
			<p class="newWindowButton yui-skin-sam">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    93
                <a href="overlay-io-plugin_clean.html" target="_blank">View example in new window.</a>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    94
            </p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    95
		</div>		<div id="example-canvas" class="bd">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    96
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    97
		
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    98
	<!--BEGIN SOURCE CODE FOR EXAMPLE =============================== -->
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    99
	
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   100
	<button type="button" id="show">Show Overlay</button>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   101
<button type="button" id="hide">Hide Overlay</button>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   102
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   103
<script type="text/javascript">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   104
YUI({base:"../../build/", timeout: 10000}).use("overlay", "substitute", "io", "json", "plugin", function(Y) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   105
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   106
    var StdMod = Y.WidgetStdMod;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   107
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   108
    /* Standard Module IO Plugin Constructor */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   109
    function StdModIOPlugin(config) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   110
        StdModIOPlugin.superclass.constructor.apply(this, arguments);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   111
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   112
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   113
    /* 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   114
     * The namespace for the plugin. This will be the property on the widget, which will 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   115
     * reference the plugin instance, when it's plugged in
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   116
     */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   117
    StdModIOPlugin.NS = "io";
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   118
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   119
    /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   120
     * The NAME of the StdModIOPlugin class. Used to prefix events generated
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   121
     * by the plugin class.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   122
     */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   123
    StdModIOPlugin.NAME = "stdModIOPlugin";
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   124
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   125
    /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   126
     * The default set of attributes for the StdModIOPlugin class.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   127
     */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   128
    StdModIOPlugin.ATTRS = {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   129
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   130
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   131
         * The uri to use for the io request
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   132
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   133
        uri : {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   134
            value:null
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   135
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   136
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   137
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   138
         * The io configuration object, to pass to io when intiating a transaction
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   139
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   140
        cfg : {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   141
            value:null
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   142
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   143
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   144
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   145
         * The default formatter to use when formatting response data. The default
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   146
         * implementation simply passes back the response data passed in. 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   147
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   148
        formatter : {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   149
            valueFn: function() {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   150
                return this._defFormatter;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   151
            }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   152
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   153
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   154
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   155
         * The Standard Module section to which the io plugin instance is bound.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   156
         * Response data will be used to populate this section, after passing through
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   157
         * the configured formatter.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   158
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   159
        section: {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   160
            value:StdMod.BODY,
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   161
            validator: function(val) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   162
                return (!val || val == StdMod.BODY || val == StdMod.HEADER || val == StdMod.FOOTER);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   163
            }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   164
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   165
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   166
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   167
         * The default loading indicator to use, when an io transaction is in progress.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   168
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   169
        loading: {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   170
            value: '<img class="yui-loading" width="32px" height="32px" src="assets/img/ajax-loader.gif">'
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   171
        }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   172
    };
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   173
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   174
    /* Extend the base plugin class */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   175
    Y.extend(StdModIOPlugin, Y.Plugin.Base, {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   176
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   177
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   178
         * Initialization code. Called when the 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   179
         * plugin is instantiated (whenever it's 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   180
         * plugged into the host)
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   181
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   182
        initializer: function(config) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   183
            Y.io.transport({
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   184
                id:'flash',
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   185
                yid: Y.id,
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   186
                src:'../../build/io/io.swf?stamp=' + (new Date()).getTime()
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   187
            });
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   188
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   189
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   190
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   191
         * Destruction code. Terminates the activeIO transaction if it exists
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   192
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   193
        destructor : function() {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   194
            if (this._activeIO) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   195
                Y.io.abort(this._activeIO);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   196
                this._activeIO = null;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   197
            }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   198
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   199
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   200
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   201
         * IO Plugin specific method, use to initiate a new io request using the current
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   202
         * io configuration settings.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   203
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   204
        refresh : function() {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   205
            section = this.get("section");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   206
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   207
            if (section && !this._activeIO) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   208
                var uri = this.get("uri");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   209
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   210
                if (uri) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   211
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   212
                    cfg = this.get("cfg") || {};
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   213
                    cfg.on = cfg.on || {};
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   214
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   215
                    cfg.on.start = cfg.on.start || Y.bind(this._defStartHandler, this);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   216
                    cfg.on.complete = cfg.on.complete || Y.bind(this._defCompleteHandler, this);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   217
    
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   218
                    cfg.on.success = cfg.on.success || Y.bind(this._defSuccessHandler, this);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   219
                    cfg.on.failure = cfg.on.failure || Y.bind(this._defFailureHandler, this);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   220
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   221
                    cfg.method = cfg.method;  // io defaults to "GET" if not defined
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   222
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   223
                    Y.io(uri, cfg);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   224
                }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   225
            }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   226
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   227
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   228
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   229
         * The default io transaction success handler
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   230
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   231
        _defSuccessHandler : function(id, o) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   232
            var response = o.responseXML || o.responseText;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   233
            var section = this.get("section");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   234
            var formatter = this.get("formatter");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   235
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   236
            this.get("host").setStdModContent(section, formatter(response));
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   237
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   238
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   239
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   240
         * The default io transaction failure handler
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   241
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   242
        _defFailureHandler : function(id, o) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   243
            this.get("host").setStdModContent(this.get("section"), "Failed to retrieve content");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   244
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   245
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   246
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   247
         * The default io transaction start handler
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   248
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   249
        _defStartHandler : function(id, o) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   250
            this._activeIO = o;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   251
            this.get("host").setStdModContent(this.get("section"), this.get("loading"));
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   252
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   253
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   254
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   255
         * The default io transaction complete handler
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   256
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   257
        _defCompleteHandler : function(id, o) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   258
            this._activeIO = null;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   259
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   260
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   261
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   262
         * The default response formatter
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   263
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   264
        _defFormatter : function(val) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   265
            return val
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   266
        }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   267
    });
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   268
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   269
    /* The Pipes feed URIs to be used to dispatch io transactions */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   270
    var pipes = {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   271
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   272
        // uri data
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   273
        baseUri : 'http:/'+'/pipes.yahooapis.com/pipes/pipe.run?_id=6b7b2c6a32f5a12e7259c36967052387&_render=json&url=http:/'+'/',
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   274
        feeds : {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   275
            ynews : {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   276
                title: 'Yahoo! US News',
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   277
                uri: 'rss.news.yahoo.com/rss/us'
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   278
            },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   279
            yui : {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   280
                title: 'YUI Blog',
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   281
                uri: 'feeds.yuiblog.com/YahooUserInterfaceBlog'
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   282
            },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   283
            slashdot : {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   284
                title: 'Slashdot',
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   285
                uri: 'rss.slashdot.org/Slashdot/slashdot'
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   286
            },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   287
            ajaxian: {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   288
                title: 'Ajaxian',
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   289
                uri: 'feeds.feedburner.com/ajaxian'
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   290
            },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   291
            daringfireball: {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   292
                title: 'Daring Fireball',
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   293
                uri: 'daringfireball.net/index.xml'
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   294
            },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   295
            wiredtech: {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   296
                title: 'Wire: Tech Biz',
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   297
                uri: 'www.wired.com/rss/techbiz.xml'
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   298
            },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   299
            techcrunch: {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   300
                title: 'TechCrunch',
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   301
                uri: 'feedproxy.google.com/Techcrunch'
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   302
            }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   303
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   304
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   305
        // The default formatter, responsible for converting the JSON responses recieved,
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   306
        // into HTML, using JSON for the parsing step, and substitute for some basic templating functionality
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   307
        formatter : function (val) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   308
            var formatted = "Error parsing feed data";
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   309
            try {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   310
                var json = Y.JSON.parse(val);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   311
                if (json && json.count) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   312
                    var html = ['<ul class="yui-feed-data">'];
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   313
                    var linkTemplate = '<li><a href="{link}" target="_blank">{title}</a></li>';
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   314
    
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   315
                    Y.each(json.value.items, function(v, i) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   316
                        if (i < 10) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   317
                            html.push(Y.substitute(linkTemplate, v));
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   318
                        }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   319
                    });
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   320
                    html.push("</ul>");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   321
                    formatted = html.join("");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   322
                } else {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   323
                    formatted = "No Data Available";
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   324
                }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   325
            } catch(e) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   326
                formatted = "Error parsing feed data";
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   327
            }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   328
            return formatted;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   329
        }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   330
    };
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   331
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   332
    /* Helper function, to generate the select dropdown markup from the pipes feed data */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   333
    function generateHeaderMarkup() {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   334
        var optTemplate = '<option value="{id}">{title}</option>',
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   335
            html = ['<select id="feedSelector" class="yui-feed-selector"><option value="-1" class="yui-prompt">Select a Feed...</option>'];
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   336
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   337
        Y.Object.each(pipes.feeds, function(v, k, o) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   338
            html.push(Y.substitute(optTemplate, {id:k, title:v.title}));
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   339
        });
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   340
        html.push('</select>');
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   341
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   342
        return html.join("");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   343
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   344
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   345
    /* Create a new Overlay instance, with content generated from script */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   346
    var overlay = new Y.Overlay({
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   347
        width:"40em",
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   348
        visible:false,
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   349
        align: {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   350
            node:"#show",
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   351
            points: [Y.WidgetPositionExt.TL, Y.WidgetPositionExt.BL]
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   352
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   353
        zIndex:10,
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   354
        headerContent: generateHeaderMarkup(),
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   355
        bodyContent: "Feed data will be displayed here"
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   356
    });
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   357
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   358
    /* 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   359
     * Add the Standard Module IO Plugin, and configure it to use flash, and a formatter specific
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   360
     * to the pipes response we're expecting from the uri request we'll send out.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   361
     */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   362
    overlay.plug({
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   363
        fn:StdModIOPlugin, 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   364
        cfg:{
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   365
            uri : pipes.baseUri + pipes.feeds["ynews"].uri,
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   366
            cfg:{
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   367
                xdr: {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   368
                    use:'flash'
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   369
                }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   370
            },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   371
            formatter: pipes.formatter
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   372
        }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   373
    });
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   374
    overlay.render();
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   375
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   376
    Y.on("change", function(e) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   377
        var val = this.get("value");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   378
        if (val != -1) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   379
            overlay.io.set("uri", pipes.baseUri + pipes.feeds[val].uri);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   380
            overlay.io.refresh();
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   381
        }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   382
    }, "#feedSelector");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   383
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   384
    Y.on("click", function(e) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   385
        overlay.show();
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   386
    }, "#show");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   387
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   388
    Y.on("click", function(e) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   389
        overlay.hide();
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   390
    }, "#hide");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   391
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   392
});
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   393
</script>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   394
	
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   395
	<!--END SOURCE CODE FOR EXAMPLE =============================== -->
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   396
	
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   397
		
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   398
		</div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   399
	</div>			
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   400
	</div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   401
		
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   402
	<h3>Creating an IO Plugin For Overlay</h3>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   403
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   404
<h4>Setting Up The YUI Instance</h4>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   405
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   406
<p>For this example, we'll pull in <code>overlay</code>; the <code>io</code>, <code>json</code> and <code>substitute</code> utility modules and the <code>plugin</code> module. The <code>io</code> module provides the XHR support we need for the IO plugin. The <code>json</code> and <code>substitute</code> modules provide the support we need to parse/transform JSON responses into HTML. The <code>Plugin</code> base class is the class we'll extend to create our io plugin class for <code>Overlay</code>. 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   407
The code to set up our sandbox instance is shown below:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   408
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   409
<textarea name="code" class="JScript" rows="1" cols="60">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   410
YUI({...}).use("overlay", "substitute", "io", "json", "plugin", function(Y) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   411
    // We'll write our code here, after pulling in the default Overlay widget, the IO utility, the Plugin base class along with the Substitute and JSON utilities
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   412
}
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   413
</textarea>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   414
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   415
<p>Using the <code>overlay</code> module will also pull down the default CSS required for overlay, on top of which we only need to add our required look/feel CSS for the example.</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   416
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   417
<h4>StdModIOPlugin Class Structure</h4>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   418
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   419
<p>The <code>StdModIOPlugin</code> class will extend the <code>Plugin</code> base class. Since <code>Plugin</code> derives from <code>Base</code>, we follow the same pattern we use for widgets and other utilities which extend Base to setup our new class.</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   420
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   421
<p>Namely:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   422
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   423
<ul>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   424
    <li>Setting up the constructor to invoke the superclass constructor</li>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   425
    <li>Setting up a <code>NAME</code> property, to identify the class</li>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   426
    <li>Setting up the default attributes, using the <code>ATTRS</code> property</li>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   427
    <li>Providing prototype implementations for anything we want executed during initialization and destruction using the <code>initializer</code> and <code>destructor</code> lifecycle methods</li>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   428
</ul>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   429
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   430
<p>Additionally, since this is a plugin, we provide a <code>NS</code> property for the class, which defines the property which will refer to the <code>StdModIOPlugin</code> instance on the host class (e.g. <code>overlay.io</code> will be an instance of <code>StdModIOPlugin</code>)</p>.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   431
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   432
<textarea name="code" class="JScript" rows="1" cols="60">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   433
    /* Standard Module IO Plugin Constructor */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   434
    function StdModIOPlugin(config) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   435
        StdModIOPlugin.superclass.constructor.apply(this, arguments);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   436
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   437
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   438
    /* 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   439
     * The namespace for the plugin. This will be the property on the widget, which will 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   440
     * reference the plugin instance, when it's plugged in
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   441
     */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   442
    StdModIOPlugin.NS = "io";
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   443
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   444
    /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   445
     * The NAME of the StdModIOPlugin class. Used to prefix events generated
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   446
     * by the plugin class.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   447
     */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   448
    StdModIOPlugin.NAME = "stdModIOPlugin";
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   449
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   450
    /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   451
     * The default set of attributes for the StdModIOPlugin class.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   452
     */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   453
    StdModIOPlugin.ATTRS = {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   454
        uri : {...},
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   455
        cfg : {...},
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   456
        formatter : {...},
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   457
        section: {...},
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   458
        loading: {...}
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   459
    };
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   460
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   461
    /* Extend the base plugin class */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   462
    Y.extend(StdModIOPlugin, Y.Plugin, {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   463
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   464
        // Lifecycle methods.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   465
        initializer: function() {...},
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   466
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   467
        // IO Plugin specific methods
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   468
        refresh : function() {...},
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   469
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   470
        // Default IO transaction handlers
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   471
        _defSuccessHandler : function(id, o) {...},
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   472
        _defFailureHandler : function(id, o) {...},
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   473
        _defStartHandler : function(id, o) {...},
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   474
        _defCompleteHandler : function(id, o) {...},
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   475
        _defFormatter : function(val) {...}
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   476
    });
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   477
</textarea>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   478
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   479
<h4>Plugin Attributes</h4>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   480
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   481
<p>The <code>StdModIOPlugin</code> is a fairly simple plugin class. It provides incremental functionality. It does not need to modify the behavior of any methods on the host Overlay instance, or monitor any Overlay events (unlike the <a href="overlay-anim-plugin.html">AnimPlugin</a> example).</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   482
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   483
<p>It sets up the following attributes, which are used to control how the IO plugin's <code>refresh</code> method behaves:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   484
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   485
<dl>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   486
    <dt>uri</dt>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   487
    <dd>The uri to use for the io request</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   488
    <dt>cfg</dt>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   489
    <dd>The io configuration object, to pass to io when initiating a transaction</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   490
    <dt>formatter</dt>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   491
    <dd>The formatter to use to formatting response data. The default implementation simply passes back the response data passed in, unchanged.</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   492
    <dt>section</dt>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   493
    <dd>The Standard Module section to which the io plugin instance is bound. Response data will be used to populate this section, after passing through the configured formatter.</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   494
    <dt>loading</dt>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   495
    <dd>The default content to display while an io transaction is in progress</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   496
</dl>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   497
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   498
<p>In terms of code, the attributes for the plugin are set up using the standard <code>ATTRS</code> property:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   499
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   500
<textarea name="code" class="JScript" rows="1" cols="60">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   501
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   502
    StdModIOPlugin.ATTRS = {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   503
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   504
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   505
         * The uri to use for the io request
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   506
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   507
        uri : {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   508
            value:null
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   509
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   510
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   511
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   512
         * The io configuration object, to pass to io when initiating a transaction
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   513
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   514
        cfg : {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   515
            value:null
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   516
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   517
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   518
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   519
         * The default formatter to use when formatting response data. The default
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   520
         * implementation simply passes back the response data passed in. 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   521
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   522
        formatter : {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   523
            valueFn: function() {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   524
                return this._defFormatter;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   525
            }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   526
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   527
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   528
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   529
         * The Standard Module section to which the io plugin instance is bound.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   530
         * Response data will be used to populate this section, after passing through
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   531
         * the configured formatter.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   532
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   533
        section: {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   534
            value:StdMod.BODY,
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   535
            validator: function(val) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   536
                return (!val || val == StdMod.BODY || val == StdMod.HEADER || val == StdMod.FOOTER);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   537
            }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   538
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   539
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   540
        /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   541
         * The default loading indicator to use, when an io transaction is in progress.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   542
         */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   543
        loading: {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   544
            value: '<img class="yui-loading" width="32px" height="32px" src="assets/img/ajax-loader.gif">'
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   545
        }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   546
    };
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   547
</textarea>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   548
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   549
<p>The <code>formatter</code> attribute uses <code>valueFn</code> to define an instance based default value; pointing to the <code>_defFormatter</code> method on the <code>StdModIOPlugin</code> instance.</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   550
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   551
<h4>Lifecycle Methods: initializer, destructor</h4>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   552
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   553
<p>For the purposes of this example, the <code>initializer</code> for the plugin activates the Flash based <a href="../../io/#xdr">XDR</a> transport so that the plugin is able to dispatch both in-domain and cross-domain requests (the transport used for any particular uri is controlled through the plugin's <code>cfg</code> attribute).</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   554
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   555
<p>The <code>destructor</code> terminates any existing transaction, if active when the plugin is destroyed (unplugged).</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   556
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   557
<textarea name="code" class="JScript" rows="1" cols="60">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   558
    initializer: function() {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   559
        Y.io.transport({
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   560
            id:'flash',
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   561
            yid: Y.id,
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   562
            src:'../../build/io/IO.swf?stamp=' + (new Date()).getTime()
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   563
        });
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   564
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   565
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   566
    /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   567
     * Destruction code. Terminates the activeIO transaction if it exists
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   568
     */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   569
    destructor : function() {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   570
        if (this._activeIO) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   571
            Y.io.abort(this._activeIO);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   572
            this._activeIO = null;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   573
        }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   574
    },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   575
</textarea>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   576
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   577
<h4>The refresh Method</h4>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   578
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   579
<p>The <code>refresh</code> method is the main public method which the plugin provides. It's responsible for dispatching the IO request, using the current state of the attributes defined of the plugin. Users will end up invoking the method from the plugin instance attached to the Overlay (<code>overlay.io.refresh()</code>).</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   580
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   581
<textarea name="code" class="JScript" rows="1" cols="60">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   582
    refresh : function() {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   583
        section = this.get("section");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   584
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   585
        if (section && !this._activeIO) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   586
            var uri = this.get("uri");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   587
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   588
            if (uri) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   589
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   590
                cfg = this.get("cfg") || {};
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   591
                cfg.on = cfg.on || {};
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   592
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   593
                cfg.on.start = cfg.on.start || Y.bind(this._defStartHandler, this);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   594
                cfg.on.complete = cfg.on.complete || Y.bind(this._defCompleteHandler, this);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   595
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   596
                cfg.on.success = cfg.on.success || Y.bind(this._defSuccessHandler, this);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   597
                cfg.on.failure = cfg.on.failure || Y.bind(this._defFailureHandler, this);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   598
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   599
                cfg.method = cfg.method; // io defaults to "GET" if not defined
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   600
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   601
                Y.io(uri, cfg);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   602
            }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   603
        }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   604
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   605
</textarea>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   606
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   607
<p>The <code>refresh</code> method, as implemented for the scope of this example, sets up the io configuration object for the transaction it is about to dispatch, filling in the default handlers for io's <code>start</code>, <code>complete</code>, <code>success</code> and <code>failure</code> events, if the user does not provide custom implementations.</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   608
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   609
<h4>The Default IO Event Handlers</h4>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   610
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   611
<p>The default success listener, pulls the response data from the response object, and uses it to update the content in the Overlay section defined by the <code>section</code> attribute. The response data is passed through the <code>formatter</code> configured for the plugin, converting it to the desired output format:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   612
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   613
<textarea name="code" class="JScript" rows="1" cols="60">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   614
    _defSuccessHandler : function(id, o) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   615
        var response = o.responseXML || o.responseText;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   616
        var section = this.get("section");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   617
        var formatter = this.get("formatter");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   618
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   619
        // Invoke Overlay method to set content in the currently configured section
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   620
        this.get("host").setStdModContent(section, formatter(response));
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   621
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   622
</textarea>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   623
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   624
<p>The default failure listener, displays an error message in the currently configured <code>section</code>, when io communication fails:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   625
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   626
<textarea name="code" class="JScript" rows="1" cols="60">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   627
    _defFailureHandler : function(id, o) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   628
        this.get("host").setStdModContent(this.get("section"), "Failed to retrieve content");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   629
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   630
</textarea>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   631
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   632
<p>The default start event listener renders the <code>loading</code> content, which remains in place while the transaction is in process, and also stores a reference to the "inprogress" io transaction:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   633
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   634
<textarea name="code" class="JScript" rows="1" cols="60">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   635
    _defStartHandler : function(id, o) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   636
        this._activeIO = o;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   637
        this.get("host").setStdModContent(this.get("section"), this.get("loading"));
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   638
    },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   639
</textarea>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   640
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   641
<p>The default complete event listener clears out the "inprogress" io transaction object:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   642
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   643
<textarea name="code" class="JScript" rows="1" cols="60">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   644
    _defCompleteHandler : function(id, o) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   645
        this._activeIO = null;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   646
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   647
</textarea>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   648
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   649
<h4>Using the Plugin</h4>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   650
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   651
<p>All objects derived from <a href="../../api/Base.html">Base</a> are <a href="../../api/Plugin.Host.html">Plugin Hosts</a>. They provide <a href="../../api/Plugin.Host.html#method_plug"><code>plug</code></a> and <a href="../../api/Plugin.Host.html#method_unplug"><code>unplug</code></a> methods to allow users to add/remove plugins to/from existing instances. 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   652
They also allow the user to specify the set of plugins to be applied to a new instance, along with their configurations, as part of the constructor arguments.</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   653
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   654
<p>In this example, we'll create a new instance of an Overlay:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   655
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   656
<textarea name="code" class="JScript" rows="1" cols="60">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   657
    /* Create a new Overlay instance, with content generated from script */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   658
    var overlay = new Y.Overlay({
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   659
        width:"40em",
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   660
        visible:false,
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   661
        align: {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   662
            node:"#show",
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   663
            points: [Y.WidgetPositionExt.TL, Y.WidgetPositionExt.BL]
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   664
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   665
        zIndex:10,
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   666
        headerContent: generateHeaderMarkup(),
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   667
        bodyContent: "Feed data will be displayed here"
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   668
    });
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   669
</textarea>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   670
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   671
<p>And then use the <code>plug</code> method to add the <code>StdModIOPlugin</code>, providing it with a configuration to use when sending out io transactions (The <a href="overlay-anim-plugin.html">Animation Plugin</a> example shows how you could do the same thing during construction):</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   672
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   673
<textarea name="code" class="JScript" rows="1" cols="60">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   674
    /*
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   675
     * Add the Standard Module IO Plugin, and configure it to use flash, and a formatter specific
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   676
     * to the pipes response we're expecting from the uri request we'll send out.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   677
     */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   678
    overlay.plug({
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   679
        fn:StdModIOPlugin, 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   680
        cfg:{
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   681
            uri : pipes.baseUri + pipes.feeds["ynews"].uri,
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   682
            cfg:{
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   683
                xdr: {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   684
                    use:'flash'
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   685
                }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   686
            },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   687
            formatter: pipes.formatter
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   688
        }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   689
    });
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   690
</textarea>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   691
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   692
<p>For this example, the io plugin is configured to use the <code>flash</code> cross-domain transport, to send out requests to the pipes API for the feed the user selects from the dropdown.</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   693
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   694
<h4>Getting Feed Data Through Pipes</h4>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   695
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   696
<p>We setup an object (<code>pipes</code>) to hold the feed URIs, which can be looked up and passed to the plugin to dispatch requests for new data:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   697
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   698
<textarea name="code" class="JScript" rows="1" cols="60">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   699
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   700
/* The Pipes feed URIs to be used to dispatch io transactions */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   701
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   702
var pipes = {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   703
    baseUri : 'http:/'+'/pipes.yahooapis.com/pipes/pipe.run?_id=6b7b2c6a32f5a12e7259c36967052387&_render=json&url=http:/'+'/',
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   704
    feeds : {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   705
        ynews : {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   706
            title: 'Yahoo! US News',
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   707
            uri: 'rss.news.yahoo.com/rss/us'
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   708
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   709
        yui : {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   710
            title: 'YUI Blog',
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   711
            uri: 'feeds.yuiblog.com/YahooUserInterfaceBlog'
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   712
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   713
        slashdot : {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   714
            title: 'Slashdot',
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   715
            uri: 'rss.slashdot.org/Slashdot/slashdot'
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   716
        },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   717
        ...
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   718
    },
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   719
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   720
    ...
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   721
</textarea>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   722
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   723
<p>The data structure also holds the default formatter (<code>pipes.formatter</code>) required to convert the JSON responses from the above URIs to HTML. The JSON utility is first used to parse the json response string. The resulting object is iterated around, using Y.each, and substitute is used to generate the list markup:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   724
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   725
<textarea name="code" class="JScript" rows="1" cols="60">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   726
    ...
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   727
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   728
    // The default formatter, responsible for converting the JSON responses received,
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   729
    // into HTML. JSON is used for the parsing step, and substitute for some basic 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   730
    // templating functionality
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   731
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   732
    formatter : function (val) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   733
        var formatted = "Error parsing feed data";
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   734
        try {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   735
            var json = Y.JSON.parse(val);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   736
            if (json && json.count) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   737
                var html = ['<ul class="yui-feed-data">'];
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   738
                var linkTemplate = '<li><a href="{link}" target="_blank">{title}</a></li>';
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   739
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   740
                // Loop around all the items returned, and feed them into the template above,
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   741
                // using substitute.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   742
                Y.each(json.value.items, function(v, i) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   743
                    if (i < 10) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   744
                        html.push(Y.substitute(linkTemplate, v));
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   745
                    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   746
                });
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   747
                html.push("</ul>");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   748
                formatted = html.join("");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   749
            } else {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   750
                formatted = "No Data Available";
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   751
            }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   752
        } catch(e) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   753
            formatted = "Error parsing feed data";
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   754
        }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   755
        return formatted;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   756
    }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   757
</textarea>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   758
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   759
<p>The <code>change</code> handler for the select dropdown binds everything together, taking the currently selected feed, constructing the URI for the feed, setting it on the plugin, and sending out the request:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   760
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   761
<textarea name="code" class="JScript" rows="1" cols="60">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   762
    /* Handle select change */
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   763
    Y.on("change", function(e) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   764
        var val = this.get("value");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   765
        if (val != -1) {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   766
            // Set the new URI value on the io plugin
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   767
            overlay.io.set("uri", pipes.baseUri + pipes.feeds[val].uri);
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   768
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   769
            // Send out a request to refresh the current section's contents
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   770
            overlay.io.refresh();
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   771
        }
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   772
    }, "#feedSelector");
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   773
</textarea>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   774
				</div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   775
				<div class="yui-u sidebar">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   776
					
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   777
				
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   778
					<div id="examples" class="mod box4">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   779
                        <div class="hd">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   780
						<h4>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   781
    Overlay Examples:</h4>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   782
                        </div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   783
						<div class="bd">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   784
							<ul>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   785
								<li><a href='../overlay/overlay-xy.html'>Basic XY Positioning</a></li><li><a href='../overlay/overlay-align.html'>Extended XY Positioning</a></li><li><a href='../overlay/overlay-stack.html'>Stack Support</a></li><li><a href='../overlay/overlay-stdmod.html'>Standard Module Support</a></li><li class='selected'><a href='../overlay/overlay-io-plugin.html'>IO Plugin</a></li><li><a href='../overlay/overlay-anim-plugin.html'>Animation Plugin</a></li><li><a href='../node-focusmanager/node-focusmanager-3.html'>Accessible Menu Button (included with examples for Focus Manager Node Plugin)</a></li>							</ul>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   786
						</div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   787
					</div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   788
					
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   789
					<div class="mod box4">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   790
                        <div class="hd">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   791
						<h4>More Overlay Resources:</h4>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   792
                        </div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   793
                        <div class="bd">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   794
						<ul>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   795
							<!-- <li><a href="http://developer.yahoo.com/yui/overlay/">User's Guide</a> (external)</li> -->
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   796
						<li><a href="../../api/module_overlay.html">API Documentation</a></li>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   797
</ul>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   798
                        </div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   799
					</div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   800
			  </div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   801
		</div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   802
		
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   803
		</div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   804
	</div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   805
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   806
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   807
<div class="yui-b toc3" id="tocWrapper">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   808
<!-- TABLE OF CONTENTS -->
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   809
<div id="toc">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   810
	
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   811
<ul>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   812
<li class="sect first">YUI 3.x Project</li><li class="item"><a title="The Yahoo! User Interface (YUI) Library, 3.x Branch, " href="http://developer.yahoo.com/yui/3/">YUI 3 Web Site (external)</a></li><li class="item"><a title="Examples of every YUI utility and control in action" href="../../examples/">YUI 3 Examples</a></li><li class="item"><a title="Instantly searchable API documentation for the entire YUI library." href="../../api/">YUI 3 API Docs</a></li><li class="item"><a title="The YUI Library can be downloaded from SourceForge" href="http://sourceforge.net/projects/yui/">YUI 3 on Sourceforge (external)</a></li><li class="item"><a title="YUI is free and open, offered under a BSD license." href="http://developer.yahoo.com/yui/3/license.html">YUI License (external)</a></li><li class="sect">YUI 3 Core - Examples</li><li class="item"><a title="YUI (Global Prerequisite) - Functional Examples" href="../../examples/yui/index.html">YUI (Global Prerequisite)</a></li><li class="item"><a title="Event - Functional Examples" href="../../examples/event/index.html">Event</a></li><li class="item"><a title="Node - Functional Examples" href="../../examples/node/index.html">Node</a></li><li class="sect">YUI 3 Component Infrastructure - Examples</li><li class="item"><a title="Attribute - Functional Examples" href="../../examples/attribute/index.html">Attribute</a></li><li class="item"><a title="Plugin - Functional Examples" href="../../examples/plugin/index.html">Plugin</a></li><li class="item"><a title="Widget - Functional Examples" href="../../examples/widget/index.html">Widget</a></li><li class="sect">YUI 3 Utilities - Examples</li><li class="item"><a title="Animation - Functional Examples" href="../../examples/anim/index.html">Animation</a></li><li class="item"><a title="Cache - Functional Examples" href="../../examples/cache/index.html">Cache</a></li><li class="item"><a title="Cookie - Functional Examples" href="../../examples/cookie/index.html">Cookie</a></li><li class="item"><a title="DataSchema - Functional Examples" href="../../examples/dataschema/index.html">DataSchema</a></li><li class="item"><a title="DataSource - Functional Examples" href="../../examples/datasource/index.html">DataSource</a></li><li class="item"><a title="DataType - Functional Examples" href="../../examples/datatype/index.html">DataType</a></li><li class="item"><a title="Drag &amp; Drop - Functional Examples" href="../../examples/dd/index.html">Drag &amp; Drop</a></li><li class="item"><a title="Get - Functional Examples" href="../../examples/get/index.html">Get</a></li><li class="item"><a title="History - Functional Examples" href="../../examples/history/index.html">History</a></li><li class="item"><a title="ImageLoader - Functional Examples" href="../../examples/imageloader/index.html">ImageLoader</a></li><li class="item"><a title="IO - Functional Examples" href="../../examples/io/index.html">IO</a></li><li class="item"><a title="JSON (JavaScript Object Notation) - Functional Examples" href="../../examples/json/index.html">JSON</a></li><li class="item"><a title="Queue - Functional Examples" href="../../examples/queue/index.html">Queue</a></li><li class="item"><a title="Stylesheet - Functional Examples" href="../../examples/stylesheet/index.html">Stylesheet</a></li><li class="sect">YUI 3 Widgets - Examples</li><li class="selected "><a title="Overlay - Functional Examples" href="../../examples/overlay/index.html">Overlay</a></li><li class="item"><a title="Slider - Functional Examples" href="../../examples/slider/index.html">Slider</a></li><li class="sect">YUI 3 Node Plugins - Examples</li><li class="item"><a title="FocusManager Node Plugin - Functional Examples" href="../../examples/node-focusmanager/index.html">FocusManager Node Plugin</a></li><li class="item"><a title="MenuNav Node Plugin - Functional Examples" href="../../examples/node-menunav/index.html">MenuNav Node Plugin</a></li><li class="sect">YUI 3 CSS - Examples</li><li class="item"><a title="YUI CSS Reset - Functional Examples" href="../../examples/cssreset/index.html">CSS Reset</a></li><li class="item"><a title="YUI Fonts - Functional Examples" href="../../examples/cssfonts/index.html">CSS Fonts</a></li><li class="item"><a title="YUI Base - Functional Examples" href="../../examples/cssbase/index.html">CSS Base</a></li><li class="sect">YUI 3 Developer Tools - Examples</li><li class="item"><a title="Console - Functional Examples" href="../../examples/console/index.html">Console</a></li><li class="item"><a title="Profiler - Functional Examples" href="../../examples/profiler/index.html">Profiler</a></li><li class="item"><a title="Test - Functional Examples" href="../../examples/test/index.html">Test</a></li><li class="sect">The YUI Community</li><li class="item"><a title="The Yahoo! User Interface Blog" href="http://yuiblog.com">YUI Blog (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 Forum (external)</a></li><li class="item"><a title="The Yahoo! Group yui3 is dedicated to the 3.x branch of the Yahoo! User Interface (YUI) Library." href="http://tech.groups.yahoo.com/group/yui3/">YUI 3 Forum (external)</a></li><li class="item"><a title="YUI is used by Yahoo! and by hundreds of other sites, including many you know and love." href="/yui/poweredby/">YUI Sightings (external)</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="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/3/articles/hosting/">Serving YUI Files from Yahoo! (external)</a></li></ul>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   813
</div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   814
</div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   815
	</div><!--closes bd-->
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   816
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   817
	<div id="ft">
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   818
        <p class="first">Copyright &copy; 2009 Yahoo! Inc. All rights reserved.</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   819
        <p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> - 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   820
            <a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> - 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   821
            <a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> - 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   822
            <a href="http://careers.yahoo.com/">Job Openings</a></p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   823
	</div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   824
</div>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   825
<script src="../../assets/dpSyntaxHighlighter.js"></script>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   826
<script language="javascript"> 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   827
dp.SyntaxHighlighter.HighlightAll('code'); 
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   828
</script>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   829
</body>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   830
</html>