1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>YUI Library Examples: Get Utility: Quickstart Example: Getting a Script File with YUI Get</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../assets/yui.css" >
<style>
/*Supplemental CSS for the YUI distribution*/
#custom-doc { width: 95%; min-width: 950px; }
#pagetitle {background-image: url(../../assets/bg_hd.gif);}
</style>
<link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css">
<!--Script and CSS includes for YUI dependencies on this page-->
<link rel="stylesheet" type="text/css" href="../../build/logger/assets/skins/sam/logger.css" />
<link rel="stylesheet" type="text/css" href="../../build/button/assets/skins/sam/button.css" />
<script type="text/javascript" src="../../build/yuiloader/yuiloader-min.js"></script>
<script type="text/javascript" src="../../build/event/event-min.js"></script>
<script type="text/javascript" src="../../build/dom/dom-min.js"></script>
<script type="text/javascript" src="../../build/logger/logger-min.js"></script>
<script type="text/javascript" src="../../build/element/element-min.js"></script>
<script type="text/javascript" src="../../build/button/button-min.js"></script>
<!--begin custom header content for this example-->
<style type="text/css">
#returnedData {background-color:#0000ff; color:#ffffff; padding:1em; margin-top:1em; white-space:normal;}
</style>
<!--end custom header content for this example-->
<script type="text/javascript">
//enable passthrough of errors from YUI Event:
if ((typeof YAHOO !== "undefined") && (YAHOO.util) && (YAHOO.util.Event)) {
YAHOO.util.Event.throwErrors = true;
}
</script>
</head>
<body id="yahoo-com" class="yui-skin-sam">
<div id="custom-doc" class="yui-t2">
<div id="hd">
<div id="ygunav">
<p><em><a href="http://developer.yahoo.com/yui/">YUI Library Home</a></em></p>
<form action="http://search.yahoo.com/search" id="sitesearchform">
<input name="vs" type="hidden" value="developer.yahoo.com">
<input name="vs" type="hidden" value="yuiblog.com">
<div id="sitesearch">
<label for="searchinput">Site Search (YDN & YUIBlog): </label>
<input type="text" id="searchinput" name="p">
<input type="submit" value="Search" id="searchsubmit" class="ygbt">
</div>
</form> </div>
<div id="ygma"><a href="../../"><img src="../../assets/yui.gif" border="0" height="38"></a></div>
<div id="pagetitle"><h1>YUI Library Examples: Get Utility: Quickstart Example: Getting a Script File with YUI Get</h1></div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-ge">
<div class="yui-u first example">
<div class="promo">
<h1>Get Utility: Quickstart Example: Getting a Script File with YUI Get</h1>
<div class="exampleIntro">
<p>This example explores the simplest and most common use case for the <a href="http://developer.yahoo.com/yui/get">YUI Get Utility</a>: fetching a script with <code>YAHOO.util.Get.script()</code> and making use of its contents.</p>
<p>Click the button to retrieve the script and output its data to the blue box. The tutorial below gives you a full description of how to use this technique.</p>
</div>
<div class="example-container module ">
<div class="hd exampleHd">
<p class="newWindowButton yui-skin-sam"><!--<span id="newWindowLinkx"><span class="first-child">--><a href="get-script-simple_clean.html" target="_blank">View example in new window.</a><!--</span></span>-->
</div> <div id="example-canvas" class="bd">
<!--BEGIN SOURCE CODE FOR EXAMPLE =============================== -->
<div>
<button id="getScript">Get Data from Script</button>
</div>
<pre id="returnedData">
Data returned from the loaded script will appear here after you click the button above.
</pre>
<script language="JavaScript">
(function() {
//We'll use a YUI Button to actuate our request for the script:
var button = new YAHOO.widget.Button("getScript", {type: "link"});
//When the button is clicked, we'll make the script request:
button.on("click", function() {
YAHOO.log("Button was clicked; loading script with Get Utility.", "info", "example");
//We have a .js file at assets/simple_get.js. We will get
//that script with the Get Utility:
YAHOO.util.Get.script("../get/assets/simple_get.js", {
//ALL OF THE CONFIGURATION OPTIONS BELOW ARE OPTIONAL;
//IN MANY CASES, YOU'LL NEED ONLY TO DEFINE YOUR SUCCESS/
//FAILURE HANDLERS.
//callback to fire when the script is successfully loaded:
onSuccess: function(obj) {
YAHOO.log("Success handler was called. Transaction ID: " + obj.tId, "info", "example");
document.getElementById("returnedData").innerHTML = YAHOO.lang.dump(YAHOO.simple_get.data, 3);
},
//callback to fire if the script does not successfully load:
onFailure: function(o) {
YAHOO.log("Failure handler was called. Transaction ID: " + obj.tId, "info", "example");
},
//context under which success and failure handlers should run;
//default is the current window, which we'll use for this example:
scope: window,
//by default, the script will be added to the current
//window; use this property to override that default
//(we're just using the default in this example):
win: window,
//will be passed as a member of the callback object to
//the success or failure handler:
data: {testData: "value"},
//For Safari 2.x, which does not support the script's onload
//event to determine when the script is loaded; instead, Get
//will check for the presence of this varName (which is
//defined in the script we're retrieving) and use its presence
//to determine when the script has been successfully loaded:
varName: ["YAHOO.simple_get.data"]
});
});
})();
</script>
<!--END SOURCE CODE FOR EXAMPLE =============================== -->
</div>
</div>
</div>
<h2 class="first">Quickstart Example: Getting a Script File with YUI Get</h2>
<p>In this simple example, we perform the most common task for which the Get Utility is used: retrieving a script and adding it to the page.</p>
<p>The contents of the script we're fetching (<code>assets/simple_get.js</code>) are as follows:</p>
<textarea name="code" class="JScript">
//when this script is loaded by the YUI Get Utility,
//all of its contents will be evaluated in the context
//of the window object -- it has all the access to the
//page, the DOM, cookies, etc., that any other script
//would have, even if you've loaded it from a disparate
//domain.
//create a globally accessible namespace, assuming
//that YUI is already present:
YAHOO.namespace("simple_get");
//store some data:
YAHOO.simple_get.data = {
script: "assets/simple_get.js",
loaded: "loaded using YUI's Get Utility",
time: new Date().toString()
}
</textarea>
<p>The script file above defines a new namespace and then adds a property to that namespace. There are no restrictions on what we can do in the retrieved script; it can contain any correct JavaScript. When retrieved, it will be evaluated by the browser in the context of the window to which it was added. By default, it will be added to the current window and evaluated in that context.</p>
<p>In this page, we create a button and wire it so that when it's clicked the Get Utility will create a script node and populate it with the file above.</p>
<textarea name="code" class="JScript">//We'll use a YUI Button to actuate our request for the script:
var button = new YAHOO.widget.Button("getScript", {type: "link"});
//When the button is clicked, we'll make the script request:
button.on("click", function() {
//We have a .js file at assets/simple_get.js. We will get
//that script with the Get Utility:
YAHOO.util.Get.script("../get/assets/simple_get.js", {
//callback to fire when the script is successfully loaded:
onSuccess: function(obj) {
YAHOO.log("Success handler was called. Transaction ID: " + obj.tId, "info", "example");
document.getElementById("returnedData").innerHTML = YAHOO.lang.dump(YAHOO.simple_get.data, 3);
}
});
});
</textarea>
<p>Above you see the important parts of this script. In the Button's click handler, we invoke <code>YAHOO.util.Get.script</code> and pass it the URI of the script to be loaded. (The script can be on your server or on a third-party server; it is not restricted by the <a href="http://en.wikipedia.org/wiki/Same_origin_policy">Same Origin Policy</a>, which is why this is a popular approach for consuming JSON-based web services.) We also tell Get what we want to do once the script is loaded by defining an <code>onSuccess</code> configuration property. This property consists of a function in which we can make use of the contents of <code>assets/simple_get.js</code>.</p>
<h2>Full Script Source for This Example:</h2>
<p>The full script source used in this example appears below; read through the inline comments to get a full understanding of how to use the Get Utility in the simple use case of retrieving a script file and making use of its contents.</p>
<textarea name="code" class="JScript">
(function() {
//We'll use a YUI Button to actuate our request for the script:
var button = new YAHOO.widget.Button("getScript", {type: "link"});
//When the button is clicked, we'll make the script request:
button.on("click", function() {
YAHOO.log("Button was clicked; loading script with Get Utility.", "info", "example");
//We have a .js file at assets/simple_get.js. We will get
//that script with the Get Utility:
YAHOO.util.Get.script("../get/assets/simple_get.js", {
//ALL OF THE CONFIGURATION OPTIONS BELOW ARE OPTIONAL;
//IN MANY CASES, YOU'LL NEED ONLY TO DEFINE YOUR SUCCESS/
//FAILURE HANDLERS.
//callback to fire when the script is successfully loaded:
onSuccess: function(obj) {
YAHOO.log("Success handler was called. Transaction ID: " + obj.tId, "info", "example");
document.getElementById("returnedData").innerHTML = YAHOO.lang.dump(YAHOO.simple_get.data, 3);
},
//callback to fire if the script does not successfully load:
onFailure: function(o) {
YAHOO.log("Failure handler was called. Transaction ID: " + obj.tId, "info", "example");
},
//context under which success and failure handlers should run;
//default is the current window, which we'll use for this example:
scope: window,
//by default, the script will be added to the current
//window; use this property to override that default
//(we're just using the default in this example):
win: window,
//will be passed as a member of the callback object to
//the success or failure handler:
data: {testData: "value"},
//For Safari 2.x, which does not support the script's onload
//event to determine when the script is loaded; instead, Get
//will check for the presence of this varName (which is
//defined in the script we're retrieving) and use its presence
//to determine when the script has been successfully loaded:
varName: ["YAHOO.simple_get.data"]
});
});
})();
</textarea>
<h2>Configuration for This Example</h2>
<p>You can load the necessary JavaScript and CSS for this example from Yahoo's servers. <a href="http://developer.yahoo.com/yui/articles/hosting/?button&get&MIN#configure">Click here to load the YUI Dependency Configurator with all of this example's dependencies preconfigured</a>.</p>
</div>
<div class="yui-u">
<div id="loggerModule" class="yui-skin-sam">
<h3 class="firstContent">YUI Logger Output:</h3>
<div id="loggerDiv"></div>
</div>
<div id="examples">
<h3>Get Utility Examples:</h3>
<div id="exampleToc">
<ul>
<li class='selected'><a href='../get/get-script-simple.html'>Quickstart Example: Getting a Script File with YUI Get</a></li><li><a href='../get/get-script-basic.html'>Getting a Script Node with JSON Data from a Web Service</a></li><li><a href='../get/get-css-basic.html'>Getting CSS Style Sheets</a></li><li><a href='../layout/adv_layout.html'>Complex Application (included with examples for Layout Manager)</a></li> </ul>
</div>
</div>
<div id="module">
<h3>More Get Utility Resources:</h3>
<ul>
<li><a href="http://developer.yahoo.com/yui/get/">User's Guide</a> (external)</li>
<li><a href="../../docs/module_get.html">API Documentation</a></li>
<li><a href="http://yuiblog.com/assets/pdf/cheatsheets/get.pdf">Cheat Sheet PDF</a> (external)</li></ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui-b" id="tocWrapper">
<!-- TABLE OF CONTENTS -->
<div id="toc">
<ul>
<li class="sect first">Yahoo! UI Library</li><li class="item"><a title="The Yahoo! User Interface Library (YUI)" href="http://developer.yahoo.com/yui/">Home (external)</a></li><li class="item"><a title="The Yahoo! User Interface Blog" href="http://yuiblog.com">YUIBlog (external)</a></li><li class="item"><a title="YUILibrary.com hosts the YUI community forums" href="http://yuilibrary.com/forum/">YUI Discussion Forum (external)</a></li><li class="item"><a title="The YUI Library source can be checked out from GitHub" href="http://github.com/yui/">YUI on GitHub</a></li><li class="item"><a title="Instantly searchable API documentation for the entire YUI library." href="../../docs/index.html">API Documentation</a></li><li class="item"><a title="Examples of every YUI utility and control in action" href="../../examples/">Functional Examples</a></li><li class="item"><a title="Videos and podcasts from the YUI Team and from the Yahoo! frontend engineering community." href="http://developer.yahoo.com/yui/theater/">YUI Theater (external)</a></li><li class="item"><a title="YUI is free and open, offered under a BSD license." href="http://developer.yahoo.com/yui/license.html">YUI License (external)</a></li><li class="sect">YUI Functional Examples</li><li class="item"><a title="The YUI Animation Utility - Functional Examples" href="../../examples/animation/index.html">Animation</a></li><li class="item"><a title="The YUI AutoComplete Control - Functional Examples" href="../../examples/autocomplete/index.html">AutoComplete</a></li><li class="item"><a title="The YUI Browser History Manager - Functional Examples" href="../../examples/history/index.html">Browser History Manager</a></li><li class="item"><a title="The YUI Button Control - Functional Examples" href="../../examples/button/index.html">Button</a></li><li class="item"><a title="The YUI Calendar Control - Functional Examples" href="../../examples/calendar/index.html">Calendar</a></li><li class="item"><a title="The YUI Carousel Control - Functional Examples" href="../../examples/carousel/index.html">Carousel</a></li><li class="item"><a title="The YUI Charts Control - Functional Examples" href="../../examples/charts/index.html">Charts</a></li><li class="item"><a title="The YUI Color Picker Control - Functional Examples" href="../../examples/colorpicker/index.html">Color Picker</a></li><li class="item"><a title="The YUI Cookie Utility - Functional Examples" href="../../examples/cookie/index.html">Cookie</a></li><li class="item"><a title="The YUI Connection Manager (AJAX) - Functional Examples" href="../../examples/connection/index.html">Connection Manager</a></li><li class="item"><a title="The YUI Container Family (Module, Overlay, Tooltip, Panel, Dialog, SimpleDialog) - Functional Examples" href="../../examples/container/index.html">Container</a></li><li class="item"><a title="The YUI DataTable Control - Functional Examples" href="../../examples/datatable/index.html">DataTable</a></li><li class="item"><a title="The YUI Dom Collection - Functional Examples" href="../../examples/dom/index.html">Dom</a></li><li class="item"><a title="The YUI Drag & Drop Utility - Functional Examples" href="../../examples/dragdrop/index.html">Drag & Drop</a></li><li class="item"><a title="The YUI Event Utility - Functional Examples" href="../../examples/event/index.html">Event</a></li><li class="selected "><a title="The YUI Get Utility - Functional Examples" href="../../examples/get/index.html">Get</a></li><li class="item"><a title="The YUI ImageCropper Control - Functional Examples" href="../../examples/imagecropper/index.html">ImageCropper</a></li><li class="item"><a title="The YUI ImageLoader Utility - Functional Examples" href="../../examples/imageloader/index.html">ImageLoader</a></li><li class="item"><a title="The YUI JSON Utility - Functional Examples" href="../../examples/json/index.html">JSON</a></li><li class="item"><a title="The YUI Layout Manager - Functional Examples" href="../../examples/layout/index.html">Layout Manager</a></li><li class="item"><a title="The YUI Logger Control - Functional Examples" href="../../examples/logger/index.html">Logger</a></li><li class="item"><a title="The YUI Menu Control - Functional Examples" href="../../examples/menu/index.html">Menu</a></li><li class="item"><a title="The YUI Paginator - Functional Examples" href="../../examples/paginator/index.html">Paginator</a></li><li class="item"><a title="The YUI Profiler Utility - Functional Examples" href="../../examples/profiler/index.html">Profiler</a></li><li class="item"><a title="The YUI ProfileViewer Control - Functional Examples" href="../../examples/profilerviewer/index.html">ProfilerViewer</a></li><li class="item"><a title="The YUI ProgressBar Control - Functional Examples" href="../../examples/progressbar/index.html">ProgressBar</a></li><li class="item"><a title="The YUI Resize Utility - Functional Examples" href="../../examples/resize/index.html">Resize</a></li><li class="item"><a title="The YUI Rich Text Editor - Functional Examples" href="../../examples/editor/index.html">Rich Text Editor</a></li><li class="item"><a title="The YUI Selector Utility - Functional Examples" href="../../examples/selector/index.html">Selector</a></li><li class="item"><a title="The YUI Slider Control - Functional Examples" href="../../examples/slider/index.html">Slider</a></li><li class="item"><a title="The YUI Storage Utility - Functional Examples" href="../../examples/storage/index.html">Storage</a></li><li class="item"><a title="The YUI SWF Utility - Functional Examples" href="../../examples/swf/index.html">SWF</a></li><li class="item"><a title="The YUI SWFStore Utility - Functional Examples" href="../../examples/swfstore/index.html">SWFStore</a></li><li class="item"><a title="The YUI Stylesheet Utility - Functional Examples" href="../../examples/stylesheet/index.html">Stylesheet</a></li><li class="item"><a title="The YUI TabView Control - Functional Examples" href="../../examples/tabview/index.html">TabView</a></li><li class="item"><a title="The YUI TreeView Control - Functional Examples" href="../../examples/treeview/index.html">TreeView</a></li><li class="item"><a title="The YUI Uploader Utility - Functional Examples" href="../../examples/uploader/index.html">Uploader (experimental)</a></li><li class="item"><a title="The YUI YAHOO Global Object - Functional Examples" href="../../examples/yahoo/index.html">YAHOO Global Object</a></li><li class="item"><a title="The YUI Loader Utility - Functional Examples" href="../../examples/yuiloader/index.html">YUI Loader</a></li><li class="item"><a title="The YUI Test Utility - Functional Examples" href="../../examples/yuitest/index.html">YUI Test</a></li><li class="item"><a title="YUI Reset CSS - Functional Examples" href="../../examples/reset/index.html">Reset CSS</a></li><li class="item"><a title="YUI Base CSS - Functional Examples" href="../../examples/base/index.html">Base CSS</a></li><li class="item"><a title="YUI Fonts CSS - Functional Examples" href="../../examples/fonts/index.html">Fonts CSS</a></li><li class="item"><a title="YUI Grids CSS - Functional Examples" href="../../examples/grids/index.html">Grids CSS</a></li><li class="sect">YUI Articles on the YUI Website</li><li class="item"><a title="Answers to Frequently Asked Questions about the YUI Library" href="http://developer.yahoo.com/yui/articles/faq/">YUI FAQ (external)</a></li><li class="item"><a title="Yahoo!'s philosophy of Graded Browser Support" href="http://developer.yahoo.com/yui/articles/gbs/">Graded Browser Support (external)</a></li><li class="item"><a title="Reporting Bugs and Making Feature Requests for YUI Components" href="http://developer.yahoo.com/yui/articles/reportingbugs/">Bug Reports/Feature Requests (external)</a></li><li class="item"><a title="Serve YUI source files from Yahoo! -- free, fast, and simple" href="http://developer.yahoo.com/yui/articles/hosting/">Serving YUI Files from Yahoo! (external)</a></li><li class="item"><a title="Best practices for working with web services while protecting user privacy" href="http://developer.yahoo.com/security/">Security Best Practices (external)</a></li></ul>
</div>
</div>
</div><!--closes bd-->
<div id="ft">
<p class="first">Copyright © 2011 Yahoo! Inc. All rights reserved.</p>
<p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> -
<a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> -
<a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> -
<a href="http://careers.yahoo.com/">Job Openings</a></p>
</div>
</div>
<script src="../../assets/syntax.js"></script>
<script src="../../assets/dpSyntaxHighlighter.js"></script>
<script language="javascript">
dp.SyntaxHighlighter.HighlightAll('code');
</script>
<script src='../../assets/YUIexamples.js'></script>
</body>
</html>
|
