widget-extend.mustache revision e808b8824ca1091c8efb5669db9129e68e5e1c14
<style type="text/css" scoped>
.yui3-js-enabled .yui3-spinner-loading {
display:none;
}
.yui3-spinner-hidden {
display:none;
}
.yui3-spinner {
display:-moz-inline-stack;
display:inline-block;
zoom:1;
*display:inline;
vertical-align:middle;
}
.yui3-spinner-content {
padding:1px;
position:relative;
}
.yui3-spinner-value {
width:2em;
height:1.5em;
text-align:right;
margin-right:22px;
vertical-align:top;
border:1px solid #000;
padding:2px;
}
.yui3-spinner-increment, .yui3-spinner-decrement {
position:absolute;
height:1em;
width:22px;
overflow:hidden;
text-indent:-10em;
border:1px solid #999;
margin:0;
padding:0px;
}
.yui3-spinner-increment {
top:1px;
*top:2px;
right:1px;
background:#ddd url({{componentAssets}}/arrows.png) no-repeat 50% 0px;
}
.yui3-spinner-decrement {
bottom:1px;
*bottom:2px;
right:1px;
background:#ddd url({{componentAssets}}/arrows.png) no-repeat 50% -20px;
}
#widget-extend-example {
padding:5px;
}
#widget-extend-example .hint {
margin-top:10px;
font-size:85%;
color:#00a;
}
</style>
<div class="intro">
<p>This example shows how to extend the base `Widget` class to create a simple, re-usable spinner control. The `Spinner` class created in the example is not intended to be a fully featured spinner. It is used here as a concrete example, to convey some of the key concepts to keep in mind when extending the `Widget` class.</p>
</div>
<div class="example">
{{>widget-extend-source}}
</div>
<h2>Extending The `Widget` Class</h2>
<h3>Basic Class Structure</h3>
<p>Widgets classes follow the general pattern implemented by the `Spinner` class, shown in the code snippet below. The basic pattern for setting up a new widget class involves:</p>
<ol>
<li>Defining the constructor function for the new widget class, which invokes the superclass constructor to kick off the initialization chain <em>(line 2)</em></li>
<li>Defining the static `NAME` property for the class, which is normally the class name in camel case, and is used to prefix events and CSS classes fired/created by the class <em>(line 11)</em></li>
<li>Defining the static `ATTRS` property for the class, which defines the set of attributes which the class will introduce, in addition to the superclass attributes <em>(line 18-57)</em></li>
<li>Extending the `Widget` class, and adding/overriding any prototype properties/methods <em>(line 61)</em></li>
</ol>
```
/* Spinner class constructor */
function Spinner(config) {
Spinner.superclass.constructor.apply(this, arguments);
}
/*
* Required NAME static field, to identify the Widget class and
* used as an event prefix, to generate class names etc. (set to the
* class name in camel case).
*/
Spinner.NAME = "spinner";
/*
* The attribute configuration for the Spinner widget. Attributes can be
* defined with default values, get/set functions and validator functions
* as with any other class extending Base.
*/
Spinner.ATTRS = {
// The minimum value for the spinner.
min : {
value:0
},
// The maximum value for the spinner.
max : {
value:100
},
// The current value of the spinner.
value : {
value:0,
validator: function(val) {
return this._validateValue(val);
}
},
// Amount to increment/decrement the spinner when the buttons,
// or arrow up/down keys are pressed.
minorStep : {
value:1
},
// Amount to increment/decrement the spinner when the page up/down keys are pressed.
majorStep : {
value:10
},
// The localizable strings for the spinner. This attribute is
// defined by the base Widget class but has an empty value. The
// spinner is simply providing a default value for the attribute.
strings: {
value: {
tooltip: "Press the arrow up/down keys for minor increments, \
page up/down for major increments.",
increment: "Increment",
decrement: "Decrement"
}
}
};
Y.extend(Spinner, Widget, {
// Methods/properties to add to the prototype of the new class
...
});
```
<p>Note that these steps are the same for any class which is derived from <a href="../base/index.html">`Base`</a>, nothing Widget-specific is involved yet.
Widget adds the concept of a rendered UI to the existing Base lifecycle (viz. init, destroy and attribute state configuration), which we'll see show up in Widget-specific areas below.</p>
<h3>The HTML_PARSER Property</h3>
<p>
The first Widget-specific property `Spinner` implements is the static <a href="{{apiDocs}}/Widget.html#property_Widget.HTML_PARSER">`HTML_PARSER`</a> property. It is used to set the initial widget configuration based on markup, providing basic progressive enhancement support.
</p>
<p>
The value of the `HTML_PARSER` property is an object literal, where each property is a widget attribute name, and the value is either a selector string (if the attribute is a node reference) or a function which is executed to provide
a value for the attribute from the markup on the page. Markup is essentially thought of as an additional data source for the user to set initial attribute values, outside of the configuration object passed to the constructor
<em>(values passed to the constructor will take precedence over values picked up from markup)</em>.
</p>
<p>For `Spinner`, `HTML_PARSER` defines a function for the `value` attribute, which sets the initial value of the spinner based on an input field if present in the markup.</p>
```
/*
* The HTML_PARSER static constant is used by the Widget base class to populate
* the configuration for the spinner instance from markup already on the page.
*
* The Spinner class attempts to set the value of the spinner widget if it
* finds the appropriate input element on the page.
*/
value: function (contentBox) {
var node = contentBox.one("." + Spinner.INPUT_CLASS);
return (node) ? parseInt(node.get("value")) : null;
}
};
```
<h3>Lifecycle Methods: initializer, destructor</h3>
<p>The `initializer` and `destructor` lifecycle methods are carried over from `Base`, and can be used to set up initial state during construction, and clean up state during destruction respectively.</p>
<p>For `Spinner`, there is nothing special we need to do in the `initializer` (attribute setup is already taken care of), but it's left in the example to round out the lifecycle discussion.</p>
<p>The `destructor` takes care of detaching any event listeners `Spinner` adds outside of the bounding box (event listeners on/inside the bounding box are purged by `Widget`'s `destructor`).</p>
```
/*
* initializer is part of the lifecycle introduced by
* the Widget class. It is invoked during construction,
* and can be used to set up instance specific state.
*
* The Spinner class does not need to perform anything
* specific in this method, but it is left in as an example.
*/
initializer: function(config) {
// Not doing anything special during initialization
},
/*
* destructor is part of the lifecycle introduced by
* the Widget class. It is invoked during destruction,
* and can be used to clean up instance specific state.
*
* The spinner cleans up any node references it's holding
* onto. The Widget classes destructor will purge the
* widget's bounding box of event listeners, so spinner
* only needs to clean up listeners it attaches outside of
* the bounding box.
*/
destructor : function() {
this.inputNode = null;
this.incrementNode = null;
this.decrementNode = null;
}
```
<h3>Rendering Lifecycle Methods: renderer, renderUI, bindUI, syncUI</h3>
<p>Widget adds a `render` method to the `init` and `destroy` lifecycle methods provided by Base. The `init` and `destroy` methods invoke the corresponding `initializer` and `destructor` implementations for the widget. Similarly, the `render` method invokes the `renderer` implementation for the widget. Note that the `renderer` method is not chained automatically, unlike the `initializer` and `destructor` methods.</p>
<p>The `Widget` class already provides a default `renderer` implementation, which invokes the following abstract methods in the order shown <em>(with their respective responsibilities)</em>:</p>
<ol>
<li>`renderUI()` : responsible for creating/adding elements to the DOM to render the widget.</li>
<li>`bindUI()` : responsible for binding event listeners (both attribute change and DOM event listeners) to 'activate' the rendered UI.</li>
<li>`syncUI()` : responsible for updating the rendered UI based on the current state of the widget.</li>
</ol>
<p>Since the `Spinner` class has no need to modify the `Widget` `renderer` implementation, it simply implements the above 3 methods to handle the render phase:</p>
```
/*
* For spinner the method adds the input (if it's not already
* present in the markup), and creates the increment/decrement buttons
*/
renderUI : function() {
this._renderInput();
this._renderButtons();
},
/*
* For spinner, the method:
*
* - Sets up the attribute change listener for the "value" attribute
*
* - Binds key listeners for the arrow/page keys
* - Binds mouseup/down listeners on the boundingBox, document respectively.
* - Binds a simple change listener on the input box.
*/
bindUI : function() {
this.after("valueChange", this._afterValueChange);
var boundingBox = this.get("boundingBox");
// Looking for a key event which will fire continuously across browsers
var keyEventSpec = (!Y.UA.opera) ? "down:" : "press:";
keyEventSpec += "38, 40, 33, 34";
boundingBox.get("ownerDocument"));
},
/*
* For spinner, the method sets the value of the input field,
* to match the current state of the value attribute.
*/
syncUI : function() {
this._uiSetValue(this.get("value"));
}
```
<h4>A Note On Key Event Listeners</h4>
<p>The `Spinner` uses Event's `"key"` support, to set up a listener for arrow up/down and page up/down keys on the spinner's bounding box (line 31).</p>
<p>Event's `"key"` support allows `Spinner` to define a single listener, which is only invoked for the key specification provided. The key specification in the above use case is `"down:38, 40, 33, 34"` for most browsers, indicating that
the `_onDirectionKey` method should only be called if the bounding box receives a keydown event with a character code which is either 38, 40, 33 or 34. `"key"` specifications can also contain more <a href="{{apiDocs}}/YUI.html#event_key">advanced filter criteria</a>, involving modifiers such as CTRL and SHIFT.</p>
<p>For the Spinner widget, we're looking for a key event which fires repeatedly while the key is held down. This differs for Opera, so we need to fork for the key event we're interested in. Future versions of `"key"` support will aim to provide this type of higher level cross-browser abstraction also.</p>
<h3>Attribute Supporting Methods</h3>
<p>Since all widgets are attribute-driven, they all follow a pretty similar pattern when it comes to how those attributes are used. For a given attribute, widgets will generally have:</p>
<ul>
<li>A prototype method to listen for changes in the attribute</li>
<li>A prototype method to update the state of the rendered UI, to reflect the value of an attribute.</li>
<li>A prototype method used to set/get/validate the attribute.</li>
</ul>
<p>These methods are kept on the prototype to facilitate customization at any of the levels - event handling, ui updates, set/get/validation logic.</p>
<p>For `Spinner`, these corresponding methods for the `value` attribute are: `_afterValueChange`, `_uiSetValue` and `_validateValue`:</p>
```
/*
* value attribute change listener. Updates the
* value in the rendered input box, whenever the
* attribute value changes.
*/
_afterValueChange : function(e) {
this._uiSetValue(e.newVal);
},
/*
* Updates the value of the input box to reflect
* the value passed in
*/
_uiSetValue : function(val) {
this.inputNode.set("value", val);
},
/*
* value attribute default validator. Verifies that
* the value being set lies between the min/max value
*/
_validateValue: function(val) {
var min = this.get("min"),
max = this.get("max");
return (Lang.isNumber(val) && val >= min && val <= max);
}
```
<p>Since this example focuses on general patterns for widget development, validator/set/get functions are not defined for attributes such as min/max in the interests of keeping the example simple, but could be, in a production ready spinner.</p>
<h3>Rendering Support Methods</h3>
<p>`Spinner`'s `renderUI` method hands off creation of the input field and buttons to the following helpers which use markup templates to generate node instances:</p>
```
/*
* Creates the input field for the spinner and adds it to
* the widget's content box, if not already in the markup.
*/
_renderInput : function() {
var contentBox = this.get("contentBox"),
input = contentBox.one("." + Spinner.INPUT_CLASS),
strings = this.get("strings");
if (!input) {
input = Node.create(Spinner.INPUT_TEMPLATE);
contentBox.appendChild(input);
}
input.set("title", strings.tooltip);
this.inputNode = input;
},
/*
* Creates the button controls for the spinner and adds them to
* the widget's content box, if not already in the markup.
*/
_renderButtons : function() {
var contentBox = this.get("contentBox"),
strings = this.get("strings");
var inc = this._createButton(strings.increment, this.getClassName("increment"));
var dec = this._createButton(strings.decrement, this.getClassName("decrement"));
},
/*
* Utility method, to create a spinner button
*/
_createButton : function(text, className) {
var btn = Y.Node.create(Spinner.BTN_TEMPLATE);
btn.set("innerHTML", text);
btn.set("title", text);
btn.addClass(className);
return btn;
}
```
<h3>DOM Event Listeners</h3>
<p>The DOM event listeners attached during `bindUI` are straightforward event listeners, which receive the event facade for the DOM event, and update the spinner state accordingly.</p>
<p>A couple of interesting points worth noting: In the `"key"` listener we set up, we can call `e.preventDefault()` without having to check the character code, since the `"key"` event specifier will only invoke the listener
if one of the specified keys is pressed (arrow/page up/down)</p>
<p>Also, to allow the spinner to update its value while the mouse button is held down, we set up a timer, which gets cleared out when we receive a mouseup event on the document.</p>
```
/*
*
* Increments/Decrements the spinner value, based on the key pressed.
*/
_onDirectionKey : function(e) {
...
switch (e.charCode) {
case 38:
newVal += minorStep;
break;
case 40:
newVal -= minorStep;
break;
case 33:
newVal += majorStep;
break;
case 34:
newVal -= majorStep;
break;
}
if (newVal !== currVal) {
this.set("value", newVal);
}
},
/*
* Bounding box mouse down handler. Will determine if the mouse down
* is on one of the spinner buttons, and increment/decrement the value
* accordingly.
*
* The method also sets up a timer, to support the user holding the mouse
* down on the spinner buttons. The timer is cleared when a mouse up event
* is detected.
*/
_onMouseDown : function(e) {
var node = e.target
...
if (node.hasClass(this.getClassName("increment"))) {
this.set("value", currVal + minorStep);
...
} else if (node.hasClass(this.getClassName("decrement"))) {
this.set("value", currVal - minorStep);
...
}
if (handled) {
this._setMouseDownTimers(dir);
}
},
/*
* Document mouse up handler. Clears the timers supporting
* the "mouse held down" behavior.
*/
_onDocMouseUp : function(e) {
this._clearMouseDownTimers();
},
/*
* Simple change handler, to make sure user does not input an invalid value
*/
_onInputChange : function(e) {
if (!this._validateValue(this.inputNode.get("value"))) {
// If the entered value is not valid, re-display the stored value
this.syncUI();
}
}
```
<h3>ClassName Support Methods</h3>
<p>A key part of developing widgets which work with the DOM is defining class names which it will use to mark the nodes it renders. These class names could be used to mark a node for later retrieval/lookup, for CSS application (both functional as well as cosmetic) or to indicate the current state of the widget.</p>
<p>The widget infrastructure uses the `ClassNameManager` utility, to generate consistently named classes to apply to the nodes it adds to the page:</p>
```
Y.ClassNameManager.getClassName(Spinner.NAME, "value");
...
this.getClassName("increment");
```
<p>
Class names generated by the Widget's `getClassName` prototype method use the NAME field of the widget, to generate a prefixed classname through `ClassNameManager` - e.g. for spinner the `this.getClassName("increment")` above will generate the class name `yui3-spinner-increment` ("yui" being the system level prefix, "spinner" being the widget name).
When you need to generate standard class names in static code (where you don't have a reference to `this.getClassName()`), you can use the ClassNameManager directly, as shown in line 1 above, to achieve the same results.
</p>
<h3>CSS Considerations</h3>
<p>Since widget uses the `getClassName` method to generate state-related class names and to mark the bounding box/content box of the widget (e.g. "yui3-[widgetname]-content", "yui3-[widgetname]-hidden", "yui3-[widgetname]-disabled"), we need to provide the default CSS handling for states we're interested in handling for the new Spinner widget. The "yui3-[widgetname]-hidden" class is probably one state class, which all widgets will provide implementations for.</p>
```
/* Progressive enhancement support, to hide the text box, if JavaScript is enabled, while we instantiate the rich control */
.yui3-js-enabled .yui3-spinner-loading {
display:none;
}
/* Controlling show/hide state using display (since this control is inline-block) */
.yui3-spinner-hidden {
display:none;
}
/* Bounding Box - Set the bounding box to be "inline block" for spinner */
.yui3-spinner {
display:inline-block;
zoom:1;
*display:inline;
}
/* Content Box - Start adding visual treatment for the spinner */
.yui3-spinner-content {
padding:1px;
}
/* Input Text Box, generated through getClassName("value") */
.yui3-spinner-value {
...
}
/* Button controls, generated through getClassName("increment") */
.yui3-spinner-increment, .yui3-spinner-decrement {
...
}
```
<h3>Using The Spinner Widget</h3>
<p>For the example, we have an input field already on the page, which we'd like to enhance to create a Spinner instance. We mark it with a yui3-spinner-loading class, so that if JavaScript is enabled, we can hide it while we're instantiating the rich control:</p>
```
<input type="text" id="numberField" class="yui3-spinner-loading" value="20">
```
<p>We provide the constructor for the Spinner with the `srcNode` which contains the input field with our initial value. The `HTML_PARSER` code we saw earlier will extract the value from the input field, and use it as the initial value for the Spinner instance:</p>
```
// Create a new Spinner instance, drawing its
// starting value from an input field already on the
// page (the #numberField text input box)
var spinner = new Spinner({
srcNode: "#numberField",
max:100,
min:0
});
```
<p>The custom widget class structure discussed above is captured in this <a href="{{componentAssets}}/mywidget.js.txt">"MyWidget" template file</a>, which you can use as a starting point to develop your own widgets.</p>
<h2>Complete Example Source</h2>
```
{{>widget-extend-source}}
```