|
0
|
1 |
|
|
|
2 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
|
3 |
<html> |
|
|
4 |
<head> |
|
|
5 |
<title>YUI Library Examples: Widget: Creating custom widget classes</title> |
|
|
6 |
<meta http-equiv="content-type" content="text/html; charset=utf-8"> |
|
|
7 |
<link rel="stylesheet" type="text/css" href="../../assets/yui.css" > |
|
|
8 |
|
|
|
9 |
<style> |
|
|
10 |
/*Supplemental CSS for the YUI distribution*/ |
|
|
11 |
#custom-doc { width: 95%; min-width: 950px; } |
|
|
12 |
#pagetitle {background-image: url(../../assets/bg_hd.gif);} |
|
|
13 |
/* #pagetitle h1 {background-image: url(../../assets/title_h_bg.gif);}*/ |
|
|
14 |
</style> |
|
|
15 |
|
|
|
16 |
<link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css"> |
|
|
17 |
<link type="text/css" rel="stylesheet" href="../../build/cssfonts/fonts-min.css" /> |
|
|
18 |
<script type="text/javascript" src="../../build/yui/yui-min.js"></script> |
|
|
19 |
<style type="text/css"> |
|
|
20 |
|
|
|
21 |
/* Standard Module Widget CSS */ |
|
|
22 |
.yui-standardmodule-hidden { |
|
|
23 |
display:none; |
|
|
24 |
} |
|
|
25 |
|
|
|
26 |
.yui-standardmodule { |
|
|
27 |
margin:10px; |
|
|
28 |
} |
|
|
29 |
|
|
|
30 |
.yui-standardmodule-content { |
|
|
31 |
padding:3px; |
|
|
32 |
border:1px solid #666; |
|
|
33 |
} |
|
|
34 |
|
|
|
35 |
.yui-standardmodule-content .yui-widget-hd { |
|
|
36 |
padding:5px; |
|
|
37 |
border:2px solid #aa0000; |
|
|
38 |
background-color:#fff; |
|
|
39 |
overflow:auto; |
|
|
40 |
} |
|
|
41 |
|
|
|
42 |
.yui-standardmodule-content .yui-widget-bd { |
|
|
43 |
padding:5px; |
|
|
44 |
border:2px solid #0000aa; |
|
|
45 |
background-color:#fff; |
|
|
46 |
overflow:auto; |
|
|
47 |
} |
|
|
48 |
|
|
|
49 |
.yui-standardmodule-content .yui-widget-ft { |
|
|
50 |
padding:5px; |
|
|
51 |
border:2px solid #00aa00; |
|
|
52 |
background-color:#fff; |
|
|
53 |
overflow:auto; |
|
|
54 |
} |
|
|
55 |
|
|
|
56 |
/* Positionable Widget CSS */ |
|
|
57 |
.yui-positionable { |
|
|
58 |
position:absolute; |
|
|
59 |
} |
|
|
60 |
|
|
|
61 |
.yui-positionable-content { |
|
|
62 |
text-align:center; |
|
|
63 |
border:1px solid #000; |
|
|
64 |
background-color:#999966; |
|
|
65 |
color:#fff; |
|
|
66 |
padding:10px; |
|
|
67 |
} |
|
|
68 |
|
|
|
69 |
.yui-positionable-hidden { |
|
|
70 |
visibility:hidden; |
|
|
71 |
} |
|
|
72 |
|
|
|
73 |
/* Alignable Widget CSS */ |
|
|
74 |
.yui-alignable { |
|
|
75 |
position:absolute; |
|
|
76 |
} |
|
|
77 |
|
|
|
78 |
.yui-alignable-content { |
|
|
79 |
text-align:center; |
|
|
80 |
border:1px solid #000000; |
|
|
81 |
background-color:#004C6D; |
|
|
82 |
color:#fff; |
|
|
83 |
padding:2px; |
|
|
84 |
} |
|
|
85 |
|
|
|
86 |
.yui-alignable-hidden { |
|
|
87 |
visibility:hidden; |
|
|
88 |
} |
|
|
89 |
|
|
|
90 |
|
|
|
91 |
/* Example Layout CSS */ |
|
|
92 |
.widget-build-example { |
|
|
93 |
border:1px solid #000; |
|
|
94 |
background-color:#eee; |
|
|
95 |
padding:5px; |
|
|
96 |
margin:10px 0; |
|
|
97 |
} |
|
|
98 |
|
|
|
99 |
.widget-build-example button, .widget-build-example label, .widget-build-example select, .widget-build-example input { |
|
|
100 |
margin-right:5px; |
|
|
101 |
} |
|
|
102 |
|
|
|
103 |
.widget-build-example button.fail { |
|
|
104 |
color:#cc0000; |
|
|
105 |
margin-left:10px; |
|
|
106 |
} |
|
|
107 |
|
|
|
108 |
.widget-build-example .filler { |
|
|
109 |
color:#999; |
|
|
110 |
} |
|
|
111 |
|
|
|
112 |
#x, #y { |
|
|
113 |
width:3em; |
|
|
114 |
} |
|
|
115 |
|
|
|
116 |
#widget2-example, #widget3-example { |
|
|
117 |
height:15em; |
|
|
118 |
} |
|
|
119 |
|
|
|
120 |
#widget2-example select, #widget3-example select { |
|
|
121 |
width:100%; |
|
|
122 |
} |
|
|
123 |
|
|
|
124 |
#alignment p { |
|
|
125 |
color:#dddd00; |
|
|
126 |
} |
|
|
127 |
</style> |
|
|
128 |
</head> |
|
|
129 |
<body id="yahoo-com" class=" yui-skin-sam"> |
|
|
130 |
<div id="custom-doc" class="yui-t2"> |
|
|
131 |
<div id="hd"> |
|
|
132 |
<div id="ygunav"> |
|
|
133 |
<p> |
|
|
134 |
<em> |
|
|
135 |
<a href="http://developer.yahoo.com/yui/3/">YUI 3.x Home</a> <i> - </i> |
|
|
136 |
</em> |
|
|
137 |
</p> |
|
|
138 |
<form action="http://search.yahoo.com/search" id="sitesearchform"> |
|
|
139 |
<input name="vs" type="hidden" value="developer.yahoo.com"> |
|
|
140 |
<input name="vs" type="hidden" value="yuiblog.com"> |
|
|
141 |
<div id="sitesearch"> |
|
|
142 |
<label for="searchinput">Site Search (YDN & YUIBlog): </label> |
|
|
143 |
<input type="text" id="searchinput" name="p"> |
|
|
144 |
<input type="submit" value="Search" id="searchsubmit" class="ygbt"> |
|
|
145 |
</div> |
|
|
146 |
</form> |
|
|
147 |
</div> |
|
|
148 |
<div id="ygma"><a href="../../"><img src="../../assets/logo.gif" border="0" width="200" height="93"></a></div> |
|
|
149 |
<div id="pagetitle"><h1>YUI Library Examples: Widget: Creating custom widget classes</h1></div> |
|
|
150 |
</div> |
|
|
151 |
<div id="bd"> |
|
|
152 |
|
|
|
153 |
<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> |
|
|
154 |
|
|
|
155 |
<div id="yui-main"> |
|
|
156 |
<div class="yui-b"> |
|
|
157 |
<div class="yui-ge"> |
|
|
158 |
<div class="yui-u first example" id="main"> |
|
|
159 |
|
|
|
160 |
<h2>Widget: Creating custom widget classes</h2> |
|
|
161 |
|
|
|
162 |
<div id="example" class="promo"> |
|
|
163 |
<p> |
|
|
164 |
This example shows how you can mix and match the <code>WidgetPostion</code>, <code>WidgetPositionExt</code>, <code>WidgetStack</code> and <code>WidgetStdMod</code> extensions to build custom versions of the <code>Widget</code> class, using <code>Base.build</code>. |
|
|
165 |
</p> |
|
|
166 |
|
|
|
167 |
<div class="module example-container "> |
|
|
168 |
<div class="hd exampleHd"> |
|
|
169 |
<p class="newWindowButton yui-skin-sam"> |
|
|
170 |
<a href="widget-build_clean.html" target="_blank">View example in new window.</a> |
|
|
171 |
</p> |
|
|
172 |
</div> <div id="example-canvas" class="bd"> |
|
|
173 |
|
|
|
174 |
|
|
|
175 |
<!--BEGIN SOURCE CODE FOR EXAMPLE =============================== --> |
|
|
176 |
|
|
|
177 |
|
|
|
178 |
<ol> |
|
|
179 |
<li><code>Widget</code> with <code>WidgetStdMod</code> |
|
|
180 |
|
|
|
181 |
<div class="widget-build-example" id="widget1-example"> |
|
|
182 |
<input type="text" id="content" value=""> |
|
|
183 |
<select id="section"> |
|
|
184 |
<option value="header">Header</option> |
|
|
185 |
<option value="body">Body</option> |
|
|
186 |
<option value="footer">Footer</option> |
|
|
187 |
</select> |
|
|
188 |
<button type="button" id="setContent">Set Content</button> |
|
|
189 |
<button type="button" class="fail" id="tryMove">move() (should fail)</button> |
|
|
190 |
|
|
|
191 |
<div id="widget1"> |
|
|
192 |
<div class="yui-widget-hd">Module Header</div> |
|
|
193 |
<div class="yui-widget-bd">Module Body</div> |
|
|
194 |
<div class="yui-widget-ft">Module Footer</div> |
|
|
195 |
</div> |
|
|
196 |
|
|
|
197 |
<p class="filler">Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nunc pretium quam eu mi varius pulvinar. Duis orci arcu, ullamcorper sit amet, luctus ut, interdum ac, quam.</p> |
|
|
198 |
</div> |
|
|
199 |
</li> |
|
|
200 |
|
|
|
201 |
<li><code>Widget</code> with <code>WidgetPosition, WidgetStack</code> |
|
|
202 |
|
|
|
203 |
<div class="widget-build-example" id="widget2-example"> |
|
|
204 |
<label>X: <input type="text" id="x" value="0" ></label> |
|
|
205 |
<label>Y: <input type="text" id="y" value="0" ></label> |
|
|
206 |
<button type="button" id="move">Move</button> |
|
|
207 |
<button type="button" class="fail" id="tryContent">setStdModContent() (should fail)</button> |
|
|
208 |
|
|
|
209 |
<div id="widget2"><strong>Positionable Widget</strong></div> |
|
|
210 |
|
|
|
211 |
<p class="filler"> |
|
|
212 |
<select> |
|
|
213 |
<option>Prevent IE6 Bleedthrough</option> |
|
|
214 |
</select> |
|
|
215 |
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nunc pretium quam eu mi varius pulvinar. Duis orci arcu, ullamcorper sit amet, luctus ut, interdum ac, quam. Pellentesque euismod. Nam tincidunt, purus in ultrices congue, urna neque posuere arcu, aliquam tristique purus sapien id nulla. Etiam rhoncus nulla at leo. Cras scelerisque nisl in nibh. Sed eget odio. Morbi elit elit, porta a, convallis sit amet, rhoncus non, felis. Mauris nulla pede, pretium eleifend, porttitor at, rutrum id, orci. Quisque non urna. Nulla aliquam rhoncus est. |
|
|
216 |
</p> |
|
|
217 |
</div> |
|
|
218 |
</li> |
|
|
219 |
|
|
|
220 |
<li><code>Widget</code> with <code>WidgetPosition, WidgetStack, WidgetPositionExt</code></strong> |
|
|
221 |
|
|
|
222 |
<div class="widget-build-example" id="widget3-example"> |
|
|
223 |
<button type="button" id="run">Run Through Alignment</button> |
|
|
224 |
<p class="filler"> |
|
|
225 |
<select> |
|
|
226 |
<option>Prevent IE6 Bleedthrough</option> |
|
|
227 |
</select> |
|
|
228 |
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nunc pretium quam eu mi varius pulvinar. Duis orci arcu, ullamcorper sit amet, luctus ut, interdum ac, quam. Pellentesque euismod. Nam tincidunt, purus in ultrices congue, urna neque posuere arcu, aliquam tristique purus sapien id nulla. Etiam rhoncus nulla at leo. Cras scelerisque nisl in nibh. Sed eget odio. Morbi elit elit, porta a, convallis sit amet, rhoncus non, felis. Mauris nulla pede, pretium eleifend, porttitor at, rutrum id, orci. Quisque non urna. Nulla aliquam rhoncus est. |
|
|
229 |
</p> |
|
|
230 |
</div> |
|
|
231 |
</li> |
|
|
232 |
</ol> |
|
|
233 |
|
|
|
234 |
|
|
|
235 |
<script type="text/javascript"> |
|
|
236 |
YUI({base:"../../build/", timeout: 10000}).use("widget", "widget-position", "widget-stack", "widget-position-ext", "widget-stdmod", "queue", function(Y) { |
|
|
237 |
|
|
|
238 |
|
|
|
239 |
|
|
|
240 |
// WIDGET 1 : Build Widget with StdMod, but no positioning/stacking support. |
|
|
241 |
|
|
|
242 |
var StandardModule = Y.Base.build("standardModule", Y.Widget, [Y.WidgetStdMod]); |
|
|
243 |
|
|
|
244 |
var stdmod = new StandardModule({ |
|
|
245 |
contentBox: "#widget1", |
|
|
246 |
width:"12em", |
|
|
247 |
height:"12em" |
|
|
248 |
}); |
|
|
249 |
stdmod.render(); |
|
|
250 |
|
|
|
251 |
var contentInput = Y.Node.get("#content"); |
|
|
252 |
var sectionInput = Y.Node.get("#section"); |
|
|
253 |
|
|
|
254 |
Y.on("click", function(e) { |
|
|
255 |
var content = contentInput.get("value"); |
|
|
256 |
var section = sectionInput.get("value"); |
|
|
257 |
|
|
|
258 |
stdmod.setStdModContent(section, content); |
|
|
259 |
|
|
|
260 |
}, "#setContent"); |
|
|
261 |
|
|
|
262 |
Y.on("click", function(e) { |
|
|
263 |
try { |
|
|
264 |
stdmod.move([0,0]); |
|
|
265 |
} catch (e) { |
|
|
266 |
alert("move() is " + typeof stdmod.move + ", stdmod.hasImpl(Y.WidgetPosition) : " + stdmod.hasImpl(Y.WidgetPosition)); |
|
|
267 |
} |
|
|
268 |
}, "#tryMove"); |
|
|
269 |
|
|
|
270 |
|
|
|
271 |
|
|
|
272 |
// WIDGET 2: Build Widget with Position support and Stack support, but no StdMod support or Position Extras support. |
|
|
273 |
|
|
|
274 |
var Positionable = Y.Base.build("positionable", Y.Widget, [Y.WidgetPosition, Y.WidgetStack]); |
|
|
275 |
|
|
|
276 |
var positionable = new Positionable({ |
|
|
277 |
contentBox: "#widget2", |
|
|
278 |
width:"10em", |
|
|
279 |
zIndex:1 |
|
|
280 |
}); |
|
|
281 |
positionable.render("#widget2-example"); |
|
|
282 |
|
|
|
283 |
var xy = Y.Node.get("#widget2-example > p").getXY(); |
|
|
284 |
|
|
|
285 |
positionable.move(xy[0], xy[1]); |
|
|
286 |
|
|
|
287 |
var xInput = Y.Node.get("#x"); |
|
|
288 |
var yInput = Y.Node.get("#y"); |
|
|
289 |
|
|
|
290 |
xInput.set("value", Math.round(xy[0])); |
|
|
291 |
yInput.set("value", Math.round(xy[1])); |
|
|
292 |
|
|
|
293 |
Y.on("click", function(e) { |
|
|
294 |
var x = parseInt(xInput.get("value")); |
|
|
295 |
var y = parseInt(yInput.get("value")); |
|
|
296 |
|
|
|
297 |
positionable.move(x,y); |
|
|
298 |
|
|
|
299 |
}, "#move"); |
|
|
300 |
|
|
|
301 |
Y.on("click", function(e) { |
|
|
302 |
try { |
|
|
303 |
positionable.setStdModContent("header", "new content"); |
|
|
304 |
} catch (e) { |
|
|
305 |
alert("setStdModContent() is " + typeof positionable.setStdModContent + ", positionable.hasImpl(Y.WidgetStdMod) : " + positionable.hasImpl(Y.WidgetStdMod)); |
|
|
306 |
} |
|
|
307 |
}, "#tryContent"); |
|
|
308 |
|
|
|
309 |
|
|
|
310 |
|
|
|
311 |
// WIDGET 3: Build Widget with Position, PositionExt and Stack support, but no StdMod support. |
|
|
312 |
|
|
|
313 |
var Alignable = Y.Base.build("alignable", Y.Widget, [Y.WidgetPosition, Y.WidgetPositionExt, Y.WidgetStack]); |
|
|
314 |
|
|
|
315 |
var alignable = new Alignable({ |
|
|
316 |
width:"13em", |
|
|
317 |
align : { |
|
|
318 |
node: "#widget3-example", |
|
|
319 |
points: ["cc", "cc"] |
|
|
320 |
}, |
|
|
321 |
zIndex:1 |
|
|
322 |
}); |
|
|
323 |
alignable.get("contentBox").set("innerHTML", '<strong>Alignable Widget</strong><div id="alignment"><p>#widget3-example</p><p>[center, center]</p></div>'); |
|
|
324 |
alignable.render("#widget3-example"); |
|
|
325 |
|
|
|
326 |
Y.on('click', function() { |
|
|
327 |
var stepDelay = 2500; |
|
|
328 |
var currAlignment = Y.Node.get("#alignment"); |
|
|
329 |
var steps = [ |
|
|
330 |
function() { |
|
|
331 |
alignable.set("align", {node:"#widget3-example", points:["lc", "rc"]}); |
|
|
332 |
currAlignment.set("innerHTML", "<p>#widget3-example</p><p>[left-center, right-center]</p>"); |
|
|
333 |
}, |
|
|
334 |
function() { |
|
|
335 |
alignable.set("align", {node:"#widget3-example", points:["tr", "br"]}); |
|
|
336 |
currAlignment.set("innerHTML", "<p>#widget3-example</p><p>[top-right, bottom-right]</p>"); |
|
|
337 |
}, |
|
|
338 |
function() { |
|
|
339 |
alignable.set("centered", "#widget3-example"); |
|
|
340 |
currAlignment.set("innerHTML", "<p>#widget3-example</p><p>centered</p>"); |
|
|
341 |
}, |
|
|
342 |
function() { |
|
|
343 |
alignable.set("align", {points:["rc", "rc"]}); |
|
|
344 |
currAlignment.set("innerHTML", "<p>viewport</p><p>[right-center, right-center]</p>"); |
|
|
345 |
}, |
|
|
346 |
function() { |
|
|
347 |
alignable.set("centered", true); |
|
|
348 |
currAlignment.set("innerHTML", "<p>viewport</p><p>centered</p>"); |
|
|
349 |
}, |
|
|
350 |
function() { |
|
|
351 |
alignable.set("align", {node:"#widget3-example", points:["cc", "cc"]}); |
|
|
352 |
currAlignment.set("innerHTML", "<p>#widget3-example</p><p>[center, center]</p>"); |
|
|
353 |
} |
|
|
354 |
]; |
|
|
355 |
|
|
|
356 |
var q = new Y.AsyncQueue(); |
|
|
357 |
for (var i = 0; i < steps.length; i++){ |
|
|
358 |
q.add({ |
|
|
359 |
timeout: (i === 0) ? 0 : stepDelay, |
|
|
360 |
fn:steps[i] |
|
|
361 |
}); |
|
|
362 |
} |
|
|
363 |
q.run(); |
|
|
364 |
|
|
|
365 |
}, "#run"); |
|
|
366 |
|
|
|
367 |
}); |
|
|
368 |
</script> |
|
|
369 |
|
|
|
370 |
<!--END SOURCE CODE FOR EXAMPLE =============================== --> |
|
|
371 |
|
|
|
372 |
|
|
|
373 |
</div> |
|
|
374 |
</div> |
|
|
375 |
</div> |
|
|
376 |
|
|
|
377 |
<h3>Creating Custom Widget Classes</h3> |
|
|
378 |
|
|
|
379 |
<p>The <code>Base</code> class provides a <code>build</code> method which can be used to create custom versions of classes which derive from <code>Base</code> by adding extension classes to them.</p> |
|
|
380 |
|
|
|
381 |
<p>Widget currently ships with four such extensions: <code>WidgetPosition</code>, <code>WidgetStack</code>, <code>WidgetPositionExt</code> and <code>WidgetStdMod</code>. |
|
|
382 |
These extensions are used to build the basic <code>Overlay</code> widget, but can also be used individually, to create custom versions of the base <code>Widget</code> class.</p> |
|
|
383 |
|
|
|
384 |
<h3>Widget with WidgetStdMod support</h3> |
|
|
385 |
|
|
|
386 |
<p>Adding the <code>WidgetStdMod</code> extension to Widget, creates a statically positioned Widget, with support for standard module format sections - header, body and footer, which maybe useful in portal type use cases, where the positioning/stacking capabilities which come bundled with Overlay are not required.</p> |
|
|
387 |
|
|
|
388 |
<p>To create a custom class, we use <a href="../../api/Base.html#method_Base.build"><code>Base.build</code></a>, which is described in detail on the documention page for <a href="http://developer.yahoo.com/yui/3/base/#extensions">Base</a>.</p> |
|
|
389 |
|
|
|
390 |
<p>We pass in <code>Widget</code> as the main class we want to add extensions to, and <code>WidgetStdMod</code> as the extension we'd like added to the main class:</p> |
|
|
391 |
|
|
|
392 |
<textarea name="code" class="JScript" rows="1" cols="60"> |
|
|
393 |
var StandardModule = Y.Base.build("standardModule", Y.Widget, [Y.WidgetStdMod]); |
|
|
394 |
|
|
|
395 |
// Render from Markup |
|
|
396 |
var stdmod = new StandardModule({ |
|
|
397 |
contentBox: "#widget1", |
|
|
398 |
width:"12em", |
|
|
399 |
height:"12em" |
|
|
400 |
}); |
|
|
401 |
stdmod.render(); |
|
|
402 |
</textarea> |
|
|
403 |
|
|
|
404 |
<p><code>Base.build</code> will:</p> |
|
|
405 |
<ol> |
|
|
406 |
<li>Create a new class which extends <code>Widget</code></li> |
|
|
407 |
<li>Aggregate known <code>Base</code> and <code>Widget</code> fields, such as <code>ATTRS</code> and <code>HTML_PARSER</code> from <code>WidgetStdMod</code> on the new class</li> |
|
|
408 |
<li>Augment prototype methods from <code>WidgetStdMod</code> onto the new class prototype</li> |
|
|
409 |
</ol> |
|
|
410 |
|
|
|
411 |
<p>The first argument to build is the <code>NAME</code> of the new class we are creating, just like the <code>NAME</code> we define when extending the Widget class directly.</p> |
|
|
412 |
|
|
|
413 |
<p>Note that the <code>Widget</code> class is unchanged, allowing you to still create <code>Widget</code> instances without any standard module support, along with <code>StandardModule</code> instances which have standard module support.</p> |
|
|
414 |
|
|
|
415 |
<h4>Testing It Out</h4> |
|
|
416 |
|
|
|
417 |
<p>The example attempts to set content on an instance of the newly created <code>StandardModule</code> class, using the <code>setStdModContent</code> method which is added by the extension (which would otherwise not exist on the Widget instance).</p> |
|
|
418 |
|
|
|
419 |
<textarea name="code" class="JScript" rows="1" cols="60"> |
|
|
420 |
var contentInput = Y.Node.get("#content"); |
|
|
421 |
var sectionInput = Y.Node.get("#section"); |
|
|
422 |
|
|
|
423 |
// This should work, since the StandardModule widget has settable |
|
|
424 |
// header/body/footer sections |
|
|
425 |
Y.on("click", function(e) { |
|
|
426 |
|
|
|
427 |
var content = contentInput.get("value"); |
|
|
428 |
var section = sectionInput.get("value"); |
|
|
429 |
|
|
|
430 |
stdmod.setStdModContent(section, content); |
|
|
431 |
|
|
|
432 |
}, "#setContent"); |
|
|
433 |
</textarea> |
|
|
434 |
|
|
|
435 |
<p>To verify that no unrequested features are added, we also attempt to move the instance using the <code>move</code> method, which is not part of the base Widget class, and would be added by the <code>WidgetPosition</code> extension. This verifies that the other example classes we'll create, which do create new classes which use <code>WidgetPosition</code>, have not modified the base Widget class.</p> |
|
|
436 |
|
|
|
437 |
<textarea name="code" class="JScript" rows="1" cols="60"> |
|
|
438 |
// This shoud fail, since the StandardModule widget is not positionable |
|
|
439 |
Y.on("click", function(e) { |
|
|
440 |
try { |
|
|
441 |
stdmod.move([0,0]); |
|
|
442 |
} catch (e) { |
|
|
443 |
alert("move() is " + typeof stdmod.move + ", stdmod.hasImpl(Y.WidgetPosition) : " + stdmod.hasImpl(Y.WidgetPosition)); |
|
|
444 |
} |
|
|
445 |
}, "#tryMove"); |
|
|
446 |
</textarea> |
|
|
447 |
|
|
|
448 |
<p>Note that <code>Base.build</code> adds a <code>hasImpl</code> method to the built class, which allows you to query whether or not it has a particular extension applied.</p> |
|
|
449 |
|
|
|
450 |
<h4>CSS Considerations</h4> |
|
|
451 |
|
|
|
452 |
<p>We need to define the CSS which goes with this new <code>StandardModule</code> class we have created. The only rule really required out of the box is the rule which handles visibility (<code>yui-standardmodule-hidden</code>). The "standardmodule" used in the class name comes from the <code>NAME</code> property we set up for the new class, and is used to prefix all state related classes added to the widgets bounding box. |
|
|
453 |
Since the <code>StandardModule</code> class is not positionable, we use <code>display:none</code> to define the <code>hidden</code> state.</p> |
|
|
454 |
|
|
|
455 |
<textarea name="code" class="CSS" rows="1" cols="60"> |
|
|
456 |
|
|
|
457 |
/* Visibility - How to handle visibility for this new widget */ |
|
|
458 |
.yui-standardmodule-hidden { |
|
|
459 |
display:none; |
|
|
460 |
} |
|
|
461 |
</textarea> |
|
|
462 |
|
|
|
463 |
<p>The other "yui-standardmodule" rules are only used to create the required look/feel for this particular example, and do not impact the StandardModule widget's functionality.</p> |
|
|
464 |
|
|
|
465 |
<h3>Widget with WidgetPosition and WidgetStack support</h3> |
|
|
466 |
|
|
|
467 |
<p>As with <code>StandardModule</code>, we use <code>Base.build</code> to create the new <code>Positionable</code> widget class. This time we add <code>WidgetPosition</code> and <code>WidgetStack</code> support to the base <code>Widget</code> class to create a basic XY positionable widget, with shimming and z-index support.</p> |
|
|
468 |
|
|
|
469 |
<textarea name="code" class="JScript" rows="1" cols="60"> |
|
|
470 |
var Positionable = Y.Base.build("positionable", Y.Widget, [Y.WidgetPosition, Y.WidgetStack]); |
|
|
471 |
|
|
|
472 |
// Render from markup |
|
|
473 |
var positionable = new Positionable({ |
|
|
474 |
contentBox: "#widget2", |
|
|
475 |
width:"10em", |
|
|
476 |
height:"10em", |
|
|
477 |
zIndex:1 |
|
|
478 |
}); |
|
|
479 |
positionable.render("#widget2-example"); |
|
|
480 |
|
|
|
481 |
var xy = Y.Node.get("#widget2-example > p").getXY(); |
|
|
482 |
|
|
|
483 |
positionable.move(xy[0], xy[1]); |
|
|
484 |
</textarea> |
|
|
485 |
|
|
|
486 |
<p>We <strong>don't</strong> add <code>WidgetPositionExt</code> or <code>WidgetStdMod</code> support, so the widget doesn't have extended positioning support (align, center) or standard module support. Hence we position it manually using the <code>move</code> method which the <code>WidgetPosition</code> extension provides.</p> |
|
|
487 |
|
|
|
488 |
<h4>Testing It Out</h4> |
|
|
489 |
|
|
|
490 |
<p>We should now be able to invoke the <code>move</code> method on an instance of the newly created <code>Positionable</code> class:</p> |
|
|
491 |
|
|
|
492 |
<textarea name="code" class="JScript" rows="1" cols="60"> |
|
|
493 |
// This should work, since Positionable has basic XY Positioning support |
|
|
494 |
Y.on("click", function(e) { |
|
|
495 |
var x = parseInt(xInput.get("value")); |
|
|
496 |
var y = parseInt(yInput.get("value")); |
|
|
497 |
|
|
|
498 |
positionable.move(x,y); |
|
|
499 |
|
|
|
500 |
}, "#move"); |
|
|
501 |
</textarea> |
|
|
502 |
|
|
|
503 |
<p>And, as with the <code>StandardModule</code> class, we should not be allowed to invoke any methods from an extension which we didn't request:</p> |
|
|
504 |
|
|
|
505 |
<textarea name="code" class="JScript" rows="1" cols="60"> |
|
|
506 |
// This should fail, since Positionable does not have Standard Module sections |
|
|
507 |
Y.on("click", function(e) { |
|
|
508 |
try { |
|
|
509 |
positionable.setStdModContent("header", "new content"); |
|
|
510 |
} catch (e) { |
|
|
511 |
alert("setStdModContent() is " + typeof positionable.setStdModContent + ", positionable.hasImpl(Y.WidgetStdMod) : " + positionable.hasImpl(Y.WidgetStdMod)); |
|
|
512 |
} |
|
|
513 |
}, "#tryContent"); |
|
|
514 |
</textarea> |
|
|
515 |
|
|
|
516 |
<h4>CSS Considerations</h4> |
|
|
517 |
|
|
|
518 |
<p>Since now we have a positionable widget, with z-index support, we set the widget to be absolutely positioned by default, and control it's hidden state using <code>visibility</code> as opposed to <code>display</code></p> |
|
|
519 |
|
|
|
520 |
<textarea name="code" class="CSS" rows="1" cols="60"> |
|
|
521 |
/* Define absolute positioning as the default for positionable widgets */ |
|
|
522 |
.yui-positionable { |
|
|
523 |
position:absolute; |
|
|
524 |
} |
|
|
525 |
|
|
|
526 |
/* |
|
|
527 |
In order to be able to position the widget when hidden, we define hidden |
|
|
528 |
to use visibility, as opposed to display |
|
|
529 |
*/ |
|
|
530 |
.yui-positionable-hidden { |
|
|
531 |
visibility:hidden; |
|
|
532 |
} |
|
|
533 |
</textarea> |
|
|
534 |
|
|
|
535 |
<h3>Widget with WidgetPosition, WidgetStack and WidgetPositionExt support</h3> |
|
|
536 |
|
|
|
537 |
<p>Lastly, we'll attempt to create a new widget class, which, in addition to basic positioning and stacking support, also has extended positioning support, allowing us to align it with other elements on the page.</p> |
|
|
538 |
|
|
|
539 |
<p>Again, we use <code>Base.build</code> to create our new <code>Alignable</code> widget class, by combining <code>WidgetPosition</code>, <code>WidgetStack</code> and <code>WidgetPositionExt</code> with the base widget class:</p> |
|
|
540 |
|
|
|
541 |
<textarea name="code" class="JScript" rows="1" cols="60"> |
|
|
542 |
var Alignable = Y.Base.build("alignable", Y.Widget, [Y.WidgetPosition, Y.WidgetPositionExt, Y.WidgetStack]); |
|
|
543 |
|
|
|
544 |
var alignable = new Alignable({ |
|
|
545 |
width:"13em", |
|
|
546 |
align : { |
|
|
547 |
node: "#widget3-example", |
|
|
548 |
points: ["cc", "cc"] |
|
|
549 |
}, |
|
|
550 |
zIndex:1 |
|
|
551 |
}); |
|
|
552 |
alignable.get("contentBox").set("innerHTML", '<strong>Alignable Widget</strong><div id="alignment"><p>#widget3-example</p><p>[center, center]</p></div>'); |
|
|
553 |
alignable.render("#widget3-example"); |
|
|
554 |
</textarea> |
|
|
555 |
|
|
|
556 |
<h4>Testing It Out</h4> |
|
|
557 |
|
|
|
558 |
<p>We'll attempt to align an instance of the <code>Alignable</code> class, using some of the additional attributes which <code>WidgetPositionExt</code> adds to the base <code>Widget</code> class: <code>align</code> and <code>centered</code>:</p> |
|
|
559 |
|
|
|
560 |
<textarea name="code" class="JScript" rows="1" cols="60"> |
|
|
561 |
// Align left-center egde of widget to right-center edge of the node with id "widget3-example" |
|
|
562 |
alignable.set("align", {node:"#widget3-example", points:["lc", "rc"]}); |
|
|
563 |
|
|
|
564 |
// Align top-right corner of widget to bottom-right corner of the node with id "widget3-example" |
|
|
565 |
alignable.set("align", {node:"#widget3-example", points:["tr", "br"]}); |
|
|
566 |
|
|
|
567 |
// Center the widget in the node with id "widget3-example" |
|
|
568 |
alignable.set("centered", "widget3-example"); |
|
|
569 |
|
|
|
570 |
// Align the right-center edge of the widget to the right center edge of the viewport (since a node is not provided to 'align') |
|
|
571 |
alignable.set("align", {points:["rc", "rc"]}); |
|
|
572 |
|
|
|
573 |
// Center the widget in the viewport (wince a node is not provided to 'centered') |
|
|
574 |
alignable.set("centered", true); |
|
|
575 |
|
|
|
576 |
// Return the node to it's original alignment (centered in the node with id "widget3-example") |
|
|
577 |
// NOTE: centered is a shortcut for align : { points:["cc", "cc"] } |
|
|
578 |
alignable.set("align", {node:"#widget3-example", points:["cc", "cc"]}); |
|
|
579 |
</textarea> |
|
|
580 |
|
|
|
581 |
<h4>CSS Considerations</h4> |
|
|
582 |
|
|
|
583 |
<p>The <code>Alignable</code> widget class, has the same core CSS rules as the <code>Positionable</code> class, to define how it is positioned and how it is hidden:</p> |
|
|
584 |
|
|
|
585 |
<textarea name="code" class="CSS" rows="1" cols="60"> |
|
|
586 |
/* Define absolute positioning as the default for alignable widgets */ |
|
|
587 |
.yui-alignable { |
|
|
588 |
position:absolute; |
|
|
589 |
} |
|
|
590 |
|
|
|
591 |
/* |
|
|
592 |
In order to be able to position the widget when hidden, we define hidden |
|
|
593 |
to use visibility, as opposed to display |
|
|
594 |
*/ |
|
|
595 |
.yui-alignable-hidden { |
|
|
596 |
visibility:hidden; |
|
|
597 |
} |
|
|
598 |
</textarea> |
|
|
599 |
</div> |
|
|
600 |
<div class="yui-u sidebar"> |
|
|
601 |
|
|
|
602 |
|
|
|
603 |
<div id="examples" class="mod box4"> |
|
|
604 |
<div class="hd"> |
|
|
605 |
<h4> |
|
|
606 |
Widget Examples:</h4> |
|
|
607 |
</div> |
|
|
608 |
<div class="bd"> |
|
|
609 |
<ul> |
|
|
610 |
<li><a href='../widget/widget-extend.html'>Extending the base widget class</a></li><li class='selected'><a href='../widget/widget-build.html'>Creating custom widget classes</a></li><li><a href='../widget/widget-tooltip.html'>Creating a simple Tooltip widget</a></li> </ul> |
|
|
611 |
</div> |
|
|
612 |
</div> |
|
|
613 |
|
|
|
614 |
<div class="mod box4"> |
|
|
615 |
<div class="hd"> |
|
|
616 |
<h4>More Widget Resources:</h4> |
|
|
617 |
</div> |
|
|
618 |
<div class="bd"> |
|
|
619 |
<ul> |
|
|
620 |
<!-- <li><a href="http://developer.yahoo.com/yui/widget/">User's Guide</a> (external)</li> --> |
|
|
621 |
<li><a href="../../api/module_widget.html">API Documentation</a></li> |
|
|
622 |
</ul> |
|
|
623 |
</div> |
|
|
624 |
</div> |
|
|
625 |
</div> |
|
|
626 |
</div> |
|
|
627 |
|
|
|
628 |
</div> |
|
|
629 |
</div> |
|
|
630 |
|
|
|
631 |
|
|
|
632 |
<div class="yui-b toc3" id="tocWrapper"> |
|
|
633 |
<!-- TABLE OF CONTENTS --> |
|
|
634 |
<div id="toc"> |
|
|
635 |
|
|
|
636 |
<ul> |
|
|
637 |
<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="selected "><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 & Drop - Functional Examples" href="../../examples/dd/index.html">Drag & 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="item"><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> |
|
|
638 |
</div> |
|
|
639 |
</div> |
|
|
640 |
</div><!--closes bd--> |
|
|
641 |
|
|
|
642 |
<div id="ft"> |
|
|
643 |
<p class="first">Copyright © 2009 Yahoo! Inc. All rights reserved.</p> |
|
|
644 |
<p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> - |
|
|
645 |
<a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> - |
|
|
646 |
<a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> - |
|
|
647 |
<a href="http://careers.yahoo.com/">Job Openings</a></p> |
|
|
648 |
</div> |
|
|
649 |
</div> |
|
|
650 |
<script src="../../assets/dpSyntaxHighlighter.js"></script> |
|
|
651 |
<script language="javascript"> |
|
|
652 |
dp.SyntaxHighlighter.HighlightAll('code'); |
|
|
653 |
</script> |
|
|
654 |
</body> |
|
|
655 |
</html> |