<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Example: Creating Custom Widget Classes With Extensions</title>
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic,700italic">
<link rel="stylesheet" href="../../build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="../../build/yui/yui-min.js"></script>
</head>
<body>
<!--
<a href="https://github.com/yui/yui3"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a>
-->
<div id="doc">
<div id="hd">
<h1><img src="http://yuilibrary.com/img/yui-logo.png"></h1>
</div>
<h1>Example: Creating Custom Widget Classes With Extensions</h1>
<div class="yui3-g">
<div class="yui3-u-3-4">
<div id="main">
<div class="content"><style type="text/css" scoped>
/* Standard Module Widget CSS */
.yui3-standardmodule-hidden {
display:none;
}
.yui3-standardmodule {
margin:10px;
}
.yui3-standardmodule-content {
padding:3px;
border:1px solid #666;
}
.yui3-standardmodule-content .yui3-widget-hd {
padding:5px;
border:2px solid #aa0000;
background-color:#fff;
overflow:auto;
}
.yui3-standardmodule-content .yui3-widget-bd {
padding:5px;
border:2px solid #0000aa;
background-color:#fff;
overflow:auto;
}
.yui3-standardmodule-content .yui3-widget-ft {
padding:5px;
border:2px solid #00aa00;
background-color:#fff;
overflow:auto;
}
/* Positionable Widget CSS */
.yui3-positionable {
position:absolute;
}
.yui3-positionable-content {
text-align:center;
border:1px solid #000;
background-color:#999966;
color:#fff;
padding:10px;
}
.yui3-positionable-hidden {
visibility:hidden;
}
/* Alignable Widget CSS */
.yui3-alignable {
position:absolute;
}
.yui3-alignable-content {
text-align:center;
border:1px solid #000000;
background-color:#004C6D;
color:#fff;
padding:1px;
}
.yui3-alignable-hidden {
visibility:hidden;
}
/* Example Layout CSS */
.widget-build-example {
border:1px solid #ccc;
padding:5px;
}
.widget-build-example button, .widget-build-example label, .widget-build-example select, .widget-build-example input {
margin-right:5px;
}
.widget-build-example button.fail {
color:#cc0000;
margin-left:10px;
}
.widget-build-example .filler {
color:#999;
}
#x, #y {
width:3em;
}
#widget-build-examples dd {
margin-left:0;
}
#widget-build-examples dt {
margin-bottom:1em;
margin-top:1em;
}
#widget2-example, #widget3-example {
height:15em;
}
#widget2-example select, #widget3-example select {
width:100%;
}
#alignment p {
margin:0;
padding:2px;
color:#dddd00;
}
</style>
<div class="intro">
<p>This example shows how you can mix and match the <code>WidgetPosition</code>, <code>WidgetPositionAlign</code>, <code>WidgetStack</code> and <code>WidgetStdMod</code> extensions to build custom versions of the <code>Widget</code> class, using <code>Base.create</code>.</p>
</div>
<div class="example">
<dl id="widget-build-examples">
<dt><code>Widget</code> with <code>WidgetStdMod</code></dt>
<dd>
<form class="widget-build-example" id="widget1-example" action="#">
<input type="text" id="content" value="">
<select id="section">
<option value="header">Header</option>
<option value="body">Body</option>
<option value="footer">Footer</option>
</select>
<button type="submit" id="setHTML">Set Content</button>
<button type="button" class="fail" id="tryMove">move() (should fail)</button>
<div id="widget1">
<div class="yui3-widget-hd">Module Header</div>
<div class="yui3-widget-bd">Module Body</div>
<div class="yui3-widget-ft">Module Footer</div>
</div>
<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>
</form>
</dd>
<dt><code>Widget</code> with <code>WidgetPosition, WidgetStack</code></dt>
<dd>
<form class="widget-build-example" id="widget2-example" action="#">
<label>X: <input type="text" id="x" value="0" ></label>
<label>Y: <input type="text" id="y" value="0" ></label>
<button type="submit" id="move">Move</button>
<button type="button" class="fail" id="tryContent">setStdModContent() (should fail)</button>
<div id="widget2"><strong>Positionable Widget</strong></div>
<p class="filler">
<select>
<option>Prevent IE6 Bleedthrough</option>
</select>
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.
</p>
</form>
</dd>
<dt><code>Widget</code> with <code>WidgetPosition, WidgetStack, WidgetPositionAlign</code></dt>
<dd>
<div class="widget-build-example" id="widget3-example">
<button type="button" id="run">Step Through Alignments (every 2.5s)</button>
<p class="filler">
<select>
<option>Prevent IE6 Bleedthrough</option>
</select>
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.
</p>
</div>
</dd>
</dl>
<script type="text/javascript">
YUI().use("widget", "widget-position", "widget-stack", "widget-position-align", "widget-stdmod", "async-queue", "escape", function(Y) {
// WIDGET 1 : Build Widget with StdMod, but no positioning/stacking support.
var StandardModule = Y.Base.create("standardModule", Y.Widget, [Y.WidgetStdMod]);
var stdmod = new StandardModule({
srcNode: "#widget1",
width:"12em",
height:"12em"
});
stdmod.render();
var contentInput = Y.one("#content");
var sectionInput = Y.one("#section");
Y.on("submit", function(e) {
e.preventDefault();
var content = Y.Escape.html(contentInput.get("value"));
var section = sectionInput.get("value");
stdmod.setStdModContent(section, content);
}, "#widget1-example");
Y.on("click", function(e) {
try {
stdmod.move([0,0]);
} catch (e) {
alert("move() is " + typeof stdmod.move + ", stdmod.hasImpl(Y.WidgetPosition) : " + stdmod.hasImpl(Y.WidgetPosition));
}
}, "#tryMove");
// WIDGET 2: Build Widget with Position support and Stack support, but no StdMod support or Position Extras support.
var Positionable = Y.Base.create("positionable", Y.Widget, [Y.WidgetPosition, Y.WidgetStack]);
var positionable = new Positionable({
srcNode: "#widget2",
width:"10em",
zIndex:1
});
positionable.render("#widget2-example");
var xy = Y.one("#widget2-example > p").getXY();
positionable.move(xy[0], xy[1]);
var xInput = Y.one("#x");
var yInput = Y.one("#y");
xInput.set("value", Math.round(xy[0]));
yInput.set("value", Math.round(xy[1]));
Y.on("submit", function(e) {
e.preventDefault();
var x = parseInt(xInput.get("value"));
var y = parseInt(yInput.get("value"));
positionable.move(x,y);
}, "#widget2-example");
Y.on("click", function(e) {
try {
positionable.setStdModContent("header", "new content");
} catch (e) {
alert("setStdModContent() is " + typeof positionable.setStdModContent + ", positionable.hasImpl(Y.WidgetStdMod) : " + positionable.hasImpl(Y.WidgetStdMod));
}
}, "#tryContent");
// WIDGET 3: Build Widget with Position, PositionExt and Stack support, but no StdMod support.
var Alignable = Y.Base.create("alignable", Y.Widget, [Y.WidgetPosition, Y.WidgetPositionAlign, Y.WidgetStack]);
var alignable = new Alignable({
width:"14em",
align : {
node: "#widget3-example",
points: ["cc", "cc"]
},
zIndex:1
});
alignable.get("contentBox").set("innerHTML", '<strong>Alignable Widget</strong><div id="alignment"><p>#widget3-example</p><p>[center, center]</p></div>');
alignable.render("#widget3-example");
// Example Alignments Queue
var stepDelay = 2500;
var currAlignment = Y.one("#alignment");
var steps = [
function() {
alignable.set("align", {node:"#widget3-example", points:["lc", "rc"]});
currAlignment.set("innerHTML", "<p>#widget3-example</p><p>[left-center, right-center]</p>");
},
function() {
alignable.set("align", {node:"#widget3-example", points:["tr", "br"]});
currAlignment.set("innerHTML", "<p>#widget3-example</p><p>[top-right, bottom-right]</p>");
},
function() {
alignable.set("centered", "#widget3-example");
currAlignment.set("innerHTML", "<p>#widget3-example</p><p>centered</p>");
},
function() {
alignable.set("align", {points:["rc", "rc"]});
currAlignment.set("innerHTML", "<p>viewport</p><p>[right-center, right-center]</p>");
},
function() {
alignable.set("centered", true);
currAlignment.set("innerHTML", "<p>viewport</p><p>centered</p>");
},
function() {
alignable.set("align", {node:"#widget3-example", points:["cc", "cc"]});
currAlignment.set("innerHTML", "<p>#widget3-example</p><p>[center, center]</p>");
}
];
var runBtn = Y.one("#run");
var label = runBtn.get("text");
var q = new Y.AsyncQueue();
q.after("complete", function() {
runBtn.set("text", label);
});
runBtn.on('click', function() {
if (q.isRunning()) {
q.stop();
this.set("text", label);
} else {
for (var i = 0; i < steps.length; i++){
q.add({
timeout: (i === 0) ? 0 : stepDelay,
fn:steps[i]
});
}
q.run();
this.set("text", "Stop");
}
});
});
</script>
</div>
<h2>Creating Custom Widget Classes</h2>
<p>The <code>Base</code> class provides a <code>create</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>
<p>Widget currently ships with four such extensions: <code>WidgetPosition</code>, <code>WidgetStack</code>, <code>WidgetPositionAlign</code> and <code>WidgetStdMod</code>.
These extensions are used to create the basic <code>Overlay</code> widget, but can also be used individually, to create custom versions of the base <code>Widget</code> class.</p>
<h2>Widget with WidgetStdMod support</h2>
<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>
<p>To create a custom class, we use <a href="http://yuilibrary.com/yui/docs/api/Base.html#method_Base.create"><code>Base.create</code></a>, which is described in detail on the documention page for <a href="../base/index.html#extensions">Base</a>.</p>
<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>
<pre class="code prettyprint">var StandardModule = Y.Base.create("standardModule", Y.Widget, [Y.WidgetStdMod]);
// Render from Markup
var stdmod = new StandardModule({
contentBox: "#widget1",
width:"12em",
height:"12em"
});
stdmod.render();</pre>
<p><code>Base.create</code> will:</p>
<ol>
<li>Create a new class which extends <code>Widget</code></li>
<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>
<li>Augment prototype methods from <code>WidgetStdMod</code> onto the new class prototype</li>
</ol>
<p>The first argument to create 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>
<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>
<h3>Testing It Out</h3>
<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>
<pre class="code prettyprint">var contentInput = Y.one("#content");
var sectionInput = Y.one("#section");
// This should work, since the StandardModule widget has settable
// header/body/footer sections
Y.on("submit", function(e) {
e.preventDefault();
var content = Y.Escape.html(contentInput.get("value"));
var section = sectionInput.get("value");
stdmod.setStdModContent(section, content);
}, "#widget1-example");</pre>
<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>
<pre class="code prettyprint">// This shoud fail, since the StandardModule widget is not positionable
Y.on("click", function(e) {
try {
stdmod.move([0,0]);
} catch (e) {
alert("move() is " + typeof stdmod.move + ", stdmod.hasImpl(Y.WidgetPosition) : "
+ stdmod.hasImpl(Y.WidgetPosition));
}
}, "#tryMove");</pre>
<p>Note that <code>Base.create</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>
<h3>CSS Considerations</h3>
<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.
Since the <code>StandardModule</code> class is not positionable, we use <code>display:none</code> to define the <code>hidden</code> state.</p>
<pre class="code prettyprint">/* Visibility - How to handle visibility for this new widget */
.yui3-standardmodule-hidden {
display:none;
}</pre>
<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>
<h2>Widget with WidgetPosition and WidgetStack support</h2>
<p>As with <code>StandardModule</code>, we use <code>Base.create</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>
<pre class="code prettyprint">var Positionable = Y.Base.create("positionable", Y.Widget,
[Y.WidgetPosition, Y.WidgetStack]);
// Render from markup
var positionable = new Positionable({
contentBox: "#widget2",
width:"10em",
height:"10em",
zIndex:1
});
positionable.render("#widget2-example");
var xy = Y.one("#widget2-example > p").getXY();
positionable.move(xy[0], xy[1]);</pre>
<p>We <strong>don't</strong> add <code>WidgetPositionAlign</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>
<h3>Testing It Out</h3>
<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>
<pre class="code prettyprint">// This should work, since Positionable has basic XY Positioning support
Y.on("submit", function(e) {
e.preventDefault();
var x = parseInt(xInput.get("value"));
var y = parseInt(yInput.get("value"));
positionable.move(x,y);
}, "#widget2-example");</pre>
<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>
<pre class="code prettyprint">// This should fail, since Positionable does not have Standard Module sections
Y.on("click", function(e) {
try {
positionable.setStdModContent("header", "new content");
} catch (e) {
alert("setStdModContent() is " + typeof positionable.setStdModContent +
", positionable.hasImpl(Y.WidgetStdMod) : " + positionable.hasImpl(Y.WidgetStdMod));
}
}, "#tryContent");</pre>
<h3>CSS Considerations</h3>
<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>
<pre class="code prettyprint">/* Define absolute positioning as the default for positionable widgets */
.yui3-positionable {
position:absolute;
}
/*
In order to be able to position the widget when hidden, we define hidden
to use visibility, as opposed to display
*/
.yui3-positionable-hidden {
visibility:hidden;
}</pre>
<h2>Widget with WidgetPosition, WidgetStack and WidgetPositionAlign support</h2>
<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>
<p>Again, we use <code>Base.create</code> to create our new <code>Alignable</code> widget class, by combining <code>WidgetPosition</code>, <code>WidgetStack</code> and <code>WidgetPositionAlign</code> with the base widget class:</p>
<pre class="code prettyprint">var Alignable = Y.Base.create("alignable", Y.Widget,
[Y.WidgetPosition, Y.WidgetPositionAlign, Y.WidgetStack]);
var alignable = new Alignable({
width:"14em",
align : {
node: "#widget3-example",
points: ["cc", "cc"]
},
zIndex:1
});
alignable.get("contentBox").set("innerHTML",
'<strong>Alignable Widget</strong><div id="alignment"><p>#widget3-example</p> \
<p>[center, center]</p></div>');
alignable.render("#widget3-example");</pre>
<h3>Testing It Out</h3>
<p>We'll attempt to align an instance of the <code>Alignable</code> class, using some of the additional attributes which <code>WidgetPositionAlign</code> adds to the base <code>Widget</code> class: <code>align</code> and <code>centered</code>:</p>
<pre class="code prettyprint">// Align left-center egde of widget to
// right-center edge of the node with id "widget3-example"
alignable.set("align", {node:"#widget3-example", points:["lc", "rc"]});
// Align top-right corner of widget to
// bottom-right corner of the node with id "widget3-example"
alignable.set("align", {node:"#widget3-example", points:["tr", "br"]});
// Center the widget in the node with id "widget3-example"
alignable.set("centered", "widget3-example");
// Align the right-center edge of the widget to
// the right center edge of the viewport (since a node is not provided to 'align')
alignable.set("align", {points:["rc", "rc"]});
// Center the widget in the viewport (wince a node is not provided to 'centered')
alignable.set("centered", true);
// Return the node to it's original alignment
// (centered in the node with id "widget3-example")
// NOTE: centered is a shortcut for align : { points:["cc", "cc"] }
alignable.set("align", {node:"#widget3-example", points:["cc", "cc"]});</pre>
<h3>CSS Considerations</h3>
<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>
<pre class="code prettyprint">/* Define absolute positioning as the default for alignable widgets */
.yui3-alignable {
position:absolute;
}
/*
In order to be able to position the widget when hidden, we define hidden
to use visibility, as opposed to display
*/
.yui3-alignable-hidden {
visibility:hidden;
}</pre>
<h2>Complete Example Source</h2>
<pre class="code prettyprint"><dl id="widget-build-examples">
<dt><code>Widget</code> with <code>WidgetStdMod</code></dt>
<dd>
<form class="widget-build-example" id="widget1-example" action="#">
<input type="text" id="content" value="">
<select id="section">
<option value="header">Header</option>
<option value="body">Body</option>
<option value="footer">Footer</option>
</select>
<button type="submit" id="setHTML">Set Content</button>
<button type="button" class="fail" id="tryMove">move() (should fail)</button>
<div id="widget1">
<div class="yui3-widget-hd">Module Header</div>
<div class="yui3-widget-bd">Module Body</div>
<div class="yui3-widget-ft">Module Footer</div>
</div>
<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>
</form>
</dd>
<dt><code>Widget</code> with <code>WidgetPosition, WidgetStack</code></dt>
<dd>
<form class="widget-build-example" id="widget2-example" action="#">
<label>X: <input type="text" id="x" value="0" ></label>
<label>Y: <input type="text" id="y" value="0" ></label>
<button type="submit" id="move">Move</button>
<button type="button" class="fail" id="tryContent">setStdModContent() (should fail)</button>
<div id="widget2"><strong>Positionable Widget</strong></div>
<p class="filler">
<select>
<option>Prevent IE6 Bleedthrough</option>
</select>
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.
</p>
</form>
</dd>
<dt><code>Widget</code> with <code>WidgetPosition, WidgetStack, WidgetPositionAlign</code></dt>
<dd>
<div class="widget-build-example" id="widget3-example">
<button type="button" id="run">Step Through Alignments (every 2.5s)</button>
<p class="filler">
<select>
<option>Prevent IE6 Bleedthrough</option>
</select>
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.
</p>
</div>
</dd>
</dl>
<script type="text/javascript">
YUI().use("widget", "widget-position", "widget-stack", "widget-position-align", "widget-stdmod", "async-queue", "escape", function(Y) {
// WIDGET 1 : Build Widget with StdMod, but no positioning/stacking support.
var StandardModule = Y.Base.create("standardModule", Y.Widget, [Y.WidgetStdMod]);
var stdmod = new StandardModule({
srcNode: "#widget1",
width:"12em",
height:"12em"
});
stdmod.render();
var contentInput = Y.one("#content");
var sectionInput = Y.one("#section");
Y.on("submit", function(e) {
e.preventDefault();
var content = Y.Escape.html(contentInput.get("value"));
var section = sectionInput.get("value");
stdmod.setStdModContent(section, content);
}, "#widget1-example");
Y.on("click", function(e) {
try {
stdmod.move([0,0]);
} catch (e) {
alert("move() is " + typeof stdmod.move + ", stdmod.hasImpl(Y.WidgetPosition) : " + stdmod.hasImpl(Y.WidgetPosition));
}
}, "#tryMove");
// WIDGET 2: Build Widget with Position support and Stack support, but no StdMod support or Position Extras support.
var Positionable = Y.Base.create("positionable", Y.Widget, [Y.WidgetPosition, Y.WidgetStack]);
var positionable = new Positionable({
srcNode: "#widget2",
width:"10em",
zIndex:1
});
positionable.render("#widget2-example");
var xy = Y.one("#widget2-example > p").getXY();
positionable.move(xy[0], xy[1]);
var xInput = Y.one("#x");
var yInput = Y.one("#y");
xInput.set("value", Math.round(xy[0]));
yInput.set("value", Math.round(xy[1]));
Y.on("submit", function(e) {
e.preventDefault();
var x = parseInt(xInput.get("value"));
var y = parseInt(yInput.get("value"));
positionable.move(x,y);
}, "#widget2-example");
Y.on("click", function(e) {
try {
positionable.setStdModContent("header", "new content");
} catch (e) {
alert("setStdModContent() is " + typeof positionable.setStdModContent + ", positionable.hasImpl(Y.WidgetStdMod) : " + positionable.hasImpl(Y.WidgetStdMod));
}
}, "#tryContent");
// WIDGET 3: Build Widget with Position, PositionExt and Stack support, but no StdMod support.
var Alignable = Y.Base.create("alignable", Y.Widget, [Y.WidgetPosition, Y.WidgetPositionAlign, Y.WidgetStack]);
var alignable = new Alignable({
width:"14em",
align : {
node: "#widget3-example",
points: ["cc", "cc"]
},
zIndex:1
});
alignable.get("contentBox").set("innerHTML", '<strong>Alignable Widget</strong><div id="alignment"><p>#widget3-example</p><p>[center, center]</p></div>');
alignable.render("#widget3-example");
// Example Alignments Queue
var stepDelay = 2500;
var currAlignment = Y.one("#alignment");
var steps = [
function() {
alignable.set("align", {node:"#widget3-example", points:["lc", "rc"]});
currAlignment.set("innerHTML", "<p>#widget3-example</p><p>[left-center, right-center]</p>");
},
function() {
alignable.set("align", {node:"#widget3-example", points:["tr", "br"]});
currAlignment.set("innerHTML", "<p>#widget3-example</p><p>[top-right, bottom-right]</p>");
},
function() {
alignable.set("centered", "#widget3-example");
currAlignment.set("innerHTML", "<p>#widget3-example</p><p>centered</p>");
},
function() {
alignable.set("align", {points:["rc", "rc"]});
currAlignment.set("innerHTML", "<p>viewport</p><p>[right-center, right-center]</p>");
},
function() {
alignable.set("centered", true);
currAlignment.set("innerHTML", "<p>viewport</p><p>centered</p>");
},
function() {
alignable.set("align", {node:"#widget3-example", points:["cc", "cc"]});
currAlignment.set("innerHTML", "<p>#widget3-example</p><p>[center, center]</p>");
}
];
var runBtn = Y.one("#run");
var label = runBtn.get("text");
var q = new Y.AsyncQueue();
q.after("complete", function() {
runBtn.set("text", label);
});
runBtn.on('click', function() {
if (q.isRunning()) {
q.stop();
this.set("text", label);
} else {
for (var i = 0; i < steps.length; i++){
q.add({
timeout: (i === 0) ? 0 : stepDelay,
fn:steps[i]
});
}
q.run();
this.set("text", "Stop");
}
});
});
</script></pre>
</div>
</div>
</div>
<div class="yui3-u-1-4">
<div class="sidebar">
<div class="sidebox">
<div class="hd">
<h2 class="no-toc">Examples</h2>
</div>
<div class="bd">
<ul class="examples">
<li data-description="Shows how to extend the base widget class, to create your own Widgets.">
<a href="widget-extend.html">Extending the Base Widget Class</a>
</li>
<li data-description="Shows how to use Base.create and mix/match extensions to create custom Widget classes.">
<a href="widget-build.html">Creating Custom Widget Classes With Extensions</a>
</li>
<li data-description="Shows how to create an IO plugin for Widget.">
<a href="widget-plugin.html">Creating a Widget Plugin</a>
</li>
<li data-description="Shows how to extend the Widget class, and add WidgetPosition and WidgetStack to create a Tooltip widget class.">
<a href="widget-tooltip.html">Creating a Simple Tooltip Widget With Extensions</a>
</li>
<li data-description="Shows how to extend the Widget class, and add WidgetParent and WidgetChild to create a simple ListBox widget.">
<a href="widget-parentchild-listbox.html">Creating a Hierarchical ListBox Widget</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script>
YUI.Env.Tests = {
examples: [],
project: '../assets',
assets: '../assets/widget',
name: 'widget-build',
title: 'Creating Custom Widget Classes With Extensions',
newWindow: '',
auto: false
};
YUI.Env.Tests.examples.push('widget-extend');
YUI.Env.Tests.examples.push('widget-build');
YUI.Env.Tests.examples.push('widget-plugin');
YUI.Env.Tests.examples.push('widget-tooltip');
YUI.Env.Tests.examples.push('widget-parentchild-listbox');
</script>
<script src="../assets/yui/test-runner.js"></script>
</body>
</html>