+ * Defines the static fields which need to be aggregated, + * when this class is used as the main class passed to + * the Base.build method. + *
+ * @property _buildCfg + * @type Object + * @static + * @final + * @private + */ +Widget._buildCfg = { + aggregates : ["HTML_PARSER"] +}; + +/** + * Static property provides a string to identify the class. + *+ * Currently used to apply class identifiers to the bounding box + * and to classify events fired by the widget. + *
+ * + * @property Widget.NAME + * @type String + * @static + */ +Widget.NAME = WIDGET; + +/** + * Constant used to identify state changes originating from + * the DOM (as opposed to the JavaScript model). + * + * @property Widget.UI_SRC + * @type String + * @static + * @final + */ +Widget.UI_SRC = "ui"; + +var UI = Widget.UI_SRC; + +/** + * Static property used to define the default attribute + * configuration for the Widget. + * + * @property Widget.ATTRS + * @type Object + * @static + */ +Widget.ATTRS = { + + /** + * Flag indicating whether or not this object + * has been through the render lifecycle phase. + * + * @attribute rendered + * @readOnly + * @default false + * @type boolean + */ + rendered: { + value:false, + readOnly:true + }, + + /** + * @attribute boundingBox + * @description The outermost DOM node for the Widget, used for sizing and positioning + * of a Widget as well as a containing element for any decorator elements used + * for skinning. + * @type Node + */ + boundingBox: { + value:null, + setter: function(node) { + return this._setBoundingBox(node); + }, + writeOnce: true + }, + + /** + * @attribute contentBox + * @description A DOM node that is a direct descendent of a Widget's bounding box that + * houses its content. + * @type Node + */ + contentBox: { + value:null, + setter: function(node) { + return this._setContentBox(node); + }, + writeOnce: true + }, + + /** + * @attribute tabIndex + * @description Number (between -32767 to 32767) indicating the widget's + * position in the default tab flow. The value is used to set the + * "tabIndex" attribute on the widget's bounding box. Negative values allow + * the widget to receive DOM focus programmatically (by calling the focus + * method), while being removed from the default tab flow. A value of + * null removes the "tabIndex" attribute from the widget's bounding box. + * @type Number + * @default null + */ + tabIndex: { + + value: 0, + validator: function (val) { + return (L.isNumber(val) || L.isNull(val)); + } + + }, + + /** + * @attribute focused + * @description Boolean indicating if the Widget, or one of its descendants, + * has focus. + * @readOnly + * @default false + * @type boolean + */ + focused: { + value: false, + readOnly:true + }, + + /** + * @attribute disabled + * @description Boolean indicating if the Widget should be disabled. The disabled implementation + * is left to the specific classes extending widget. + * @default false + * @type boolean + */ + disabled: { + value: false + }, + + /** + * @attribute visible + * @description Boolean indicating weather or not the Widget is visible. + * @default true + * @type boolean + */ + visible: { + value: true + }, + + /** + * @attribute height + * @description String with units, or number, representing the height of the Widget. If a number is provided, + * the default unit, defined by the Widgets DEF_UNIT, property is used. + * @default "" + * @type {String | Number} + */ + height: { + value: EMPTY + }, + + /** + * @attribute width + * @description String with units, or number, representing the width of the Widget. If a number is provided, + * the default unit, defined by the Widgets DEF_UNIT, property is used. + * @default "" + * @type {String | Number} + */ + width: { + value: EMPTY + }, + + /** + * @attribute moveStyles + * @description Flag defining whether or not style properties from the content box + * should be moved to the bounding box when wrapped (as defined by the WRAP_STYLES property) + * @default false + * @type boolean + */ + moveStyles: { + value: false + }, + + /** + * @attribute locale + * @description + * The default locale for the widget. NOTE: Using get/set on the "strings" attribute will + * return/set strings for this locale. + * @default "en" + * @type String + */ + locale : { + value: "en" + }, + + /** + * @attribute strings + * @description Collection of strings used to label elements of the Widget's UI. + * @default null + * @type Object + */ + strings: { + setter: function(val) { + return this._setStrings(val, this.get(LOCALE)); + }, + + getter: function() { + return this.getStrings(this.get(LOCALE)); + } + } +}; + +/** + * Cached lowercase version of Widget.NAME + * + * @property Widget._NAME_LOWERCASE + * @private + * @static + */ +Widget._NAME_LOWERCASE = Widget.NAME.toLowerCase(); + +/** + * Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined + * by theY.config.classNamePrefix attribute used by ClassNameManager and
+ * Widget.NAME.toLowerCase() (e.g. "yui-widget-xxxxx-yyyyy", based on default values for
+ * the prefix and widget class name).
+ * + * The instance based version of this method can be used to generate standard prefixed classnames, + * based on the instances NAME, as opposed to Widget.NAME. This method should be used when you + * need to use a constant class name across different types instances. + *
+ * @method getClassName + * @param {String*} args* 0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name + */ +Widget.getClassName = function() { + var args = Y.Array(arguments, 0, true); + args.splice(0, 0, this._NAME_LOWERCASE); + return ClassNameManager.getClassName.apply(ClassNameManager, args); +}; + +/** + * Returns the widget instance whose bounding box contains, or is, the given node. + *+ * In the case of nested widgets, the nearest bounding box ancestor is used to + * return the widget instance. + *
+ * @method Widget.getByNode + * @static + * @param node {Node | String} The node for which to return a Widget instance. If a selector + * string is passed in, which selects more than one node, the first node found is used. + * @return {Widget} Widget instance, or null if not found. + */ +Widget.getByNode = function(node) { + var widget, + bbMarker = Widget.getClassName(); + + node = Node.get(node); + if (node) { + node = (node.hasClass(bbMarker)) ? node : node.ancestor("." + bbMarker); + if (node) { + widget = _instances[node.get(ID)]; + } + } + + return widget || null; +}; + +/** + * Object hash, defining how attribute values are to be parsed from + * markup contained in the widget's content box. e.g.: + *
+ * {
+ * // Set single Node references using selector syntax
+ * // (selector is run through node.query)
+ * titleNode: "span.yui-title",
+ * // Set NodeList references using selector syntax
+ * // (array indicates selector is to be run through node.queryAll)
+ * listNodes: ["li.yui-item"],
+ * // Set other attribute types, using a parse function.
+ * // Context is set to the widget instance.
+ * label: function(contentBox) {
+ * return contentBox.query("span.title").get("innerHTML");
+ * }
+ * }
+ *
+ *
+ * @property Widget.HTML_PARSER
+ * @type Object
+ * @static
+ */
+Widget.HTML_PARSER = {};
+
+Y.extend(Widget, Y.Base, {
+
+ /**
+ * Returns a class name prefixed with the the value of the
+ * YUI.config.classNamePrefix attribute + the instances NAME property.
+ * Uses YUI.config.classNameDelimiter attribute to delimit the provided strings.
+ * e.g.
+ *
+ *
+ * // returns "yui-slider-foo-bar", for a slider instance
+ * var scn = slider.getClassName('foo','bar');
+ *
+ * // returns "yui-overlay-foo-bar", for an overlay instance
+ * var ocn = slider.getClassName('foo','bar');
+ *
+ *
+ *
+ * @method getClassName
+ * @param {String}+ One or more classname bits to be joined and prefixed
+ */
+ getClassName: function () {
+ var args = Y.Array(arguments, 0, true);
+ args.splice(0, 0, this._name);
+ return ClassNameManager.getClassName.apply(ClassNameManager, args);
+ },
+
+ /**
+ * Initializer lifecycle implementation for the Widget class. Registers the
+ * widget instance, and runs through the Widget's HTML_PARSER definition.
+ *
+ * @method initializer
+ * @protected
+ * @param config {Object} Configuration object literal for the widget
+ */
+ initializer: function(config) {
+ Y.log('initializer called', 'life', 'widget');
+
+ /**
+ * Notification event, which widget implementations can fire, when
+ * they change the content of the widget. This event has no default
+ * behavior and cannot be prevented, so the "on" or "after"
+ * moments are effectively equivalent (with on listeners being invoked before
+ * after listeners).
+ *
+ * @event widget:contentUpdate
+ * @preventable false
+ * @param {EventFacade} e The Event Facade
+ */
+ this.publish(ContentUpdate, { preventable:false });
+
+ this._name = this.constructor.NAME.toLowerCase();
+
+ var nodeId = this.get(BOUNDING_BOX).get(ID);
+ if (nodeId) {
+ _instances[nodeId] = this;
+ }
+
+ var htmlConfig = this._parseHTML(this.get(CONTENT_BOX));
+ if (htmlConfig) {
+ Y.aggregate(config, htmlConfig, false);
+ }
+ },
+
+ /**
+ * Descructor lifecycle implementation for the Widget class. Purges events attached
+ * to the bounding box (and all child nodes) and removes the Widget from the
+ * list of registered widgets.
+ *
+ * @method destructor
+ * @protected
+ */
+ destructor: function() {
+ Y.log('destructor called', 'life', 'widget');
+
+ var boundingBox = this.get(BOUNDING_BOX);
+
+ Y.Event.purgeElement(boundingBox, true);
+
+ var nodeId = boundingBox.get(ID);
+ if (nodeId && nodeId in _instances) {
+ delete _instances[nodeId];
+ }
+ },
+
+ /**
+ * Establishes the initial DOM for the widget. Invoking this
+ * method will lead to the creating of all DOM elements for
+ * the widget (or the manipulation of existing DOM elements
+ * for the progressive enhancement use case).
+ * + * This method should only be invoked once for an initialized + * widget. + *
+ *+ * It delegates to the widget specific renderer method to do + * the actual work. + *
+ * + * @method render + * @chainable + * @final + * @param parentNode {Object | String} Optional. The Node under which the + * Widget is to be rendered. This can be a Node instance or a CSS selector string. + *+ * If the selector string returns more than one Node, the first node will be used + * as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox + * are not currently in the document. If it's not provided, the Widget will be rendered + * to the body of the current document in this case. + *
+ */ + render: function(parentNode) { + + if (this.get(DESTROYED)) { + Y.log("Render failed; widget has been destroyed", "error", "widget"); + return; + } + + if (!this.get(RENDERED)) { + /** + * Lifcyle event for the render phase, fired prior to rendering the UI + * for the widget (prior to invoking the widgets renderer method). + *+ * Subscribers to the "on" moment of this event, will be notified + * before the widget is rendered. + *
+ *+ * Subscribers to the "after" momemt of this event, will be notified + * after rendering is complete. + *
+ * + * @event widget:render + * @preventable _defRenderFn + * @param {EventFacade} e The Event Facade + */ + this.publish(RENDER, {queuable:false, defaultFn: this._defRenderFn}); + + parentNode = (parentNode) ? Node.get(parentNode) : null; + if (parentNode && !parentNode.inDoc()) { + parentNode = null; + } + + this.fire(RENDER, {parentNode: parentNode}); + } + + return this; + }, + + /** + * Default render handler + * + * @method _defRenderFn + * @protected + * @param {EventFacade} e The Event object + * @param {Node} parentNode The parent node to render to, if passed in to therender method
+ */
+ _defRenderFn : function(e) {
+
+ this._renderUI(e.parentNode);
+ this._bindUI();
+ this._syncUI();
+
+ this.renderer();
+
+ this._set(RENDERED, true);
+ },
+
+ /**
+ * Creates DOM (or manipulates DOM for progressive enhancement)
+ * This method is invoked by render() and is not chained
+ * automatically for the class hierarchy (like initializer, destructor)
+ * so it should be chained manually for subclasses if required.
+ *
+ * @method renderer
+ * @protected
+ */
+ renderer: function() {
+ this.renderUI();
+ this.bindUI();
+ this.syncUI();
+ },
+
+ /**
+ * Configures/Sets up listeners to bind Widget State to UI/DOM
+ *
+ * This method is not called by framework and is not chained
+ * automatically for the class hierarchy.
+ *
+ * @method bindUI
+ * @protected
+ */
+ bindUI: function() {},
+
+ /**
+ * Adds nodes to the DOM
+ *
+ * This method is not called by framework and is not chained
+ * automatically for the class hierarchy.
+ *
+ * @method renderUI
+ * @protected
+ */
+ renderUI: function() {},
+
+ /**
+ * Refreshes the rendered UI, based on Widget State
+ *
+ * This method is not called by framework and is not chained
+ * automatically for the class hierarchy.
+ *
+ * @method syncUI
+ *
+ */
+ syncUI: function(){},
+
+ /**
+ * @method hide
+ * @description Shows the Module element by setting the "visible" attribute to "false".
+ */
+ hide: function() {
+ return this.set(VISIBLE, false);
+ },
+
+ /**
+ * @method show
+ * @description Shows the Module element by setting the "visible" attribute to "true".
+ */
+ show: function() {
+ return this.set(VISIBLE, true);
+ },
+
+ /**
+ * @method focus
+ * @description Causes the Widget to receive the focus by setting the "focused"
+ * attribute to "true".
+ */
+ focus: function () {
+ return this._set(FOCUSED, true);
+ },
+
+ /**
+ * @method blur
+ * @description Causes the Widget to lose focus by setting the "focused" attribute
+ * to "false"
+ */
+ blur: function () {
+ return this._set(FOCUSED, false);
+ },
+
+ /**
+ * @method enable
+ * @description Set the Widget's "disabled" attribute to "false".
+ */
+ enable: function() {
+ return this.set(DISABLED, false);
+ },
+
+ /**
+ * @method disabled
+ * @description Set the Widget's "disabled" attribute to "true".
+ */
+ disable: function() {
+ return this.set(DISABLED, true);
+ },
+
+ /**
+ * Utilitity method used to apply the HTML_PARSER configuration for the
+ * instance, to retrieve config data values.
+ *
+ * @method _parseHTML
+ * @private
+ * @param node {Node} Root node to use to parse markup for configuration data
+ * @return config {Object} configuration object, with values found in the HTML, populated
+ */
+ _parseHTML : function(node) {
+
+ var schema = this._getHtmlParser(),
+ data,
+ val;
+
+ if (schema && node && node.hasChildNodes()) {
+
+ O.each(schema, function(v, k, o) {
+ val = null;
+
+ if (L.isFunction(v)) {
+ val = v.call(this, node);
+ } else {
+ if (L.isArray(v)) {
+ val = node.queryAll(v[0]);
+ } else {
+ val = node.query(v);
+ }
+ }
+
+ if (val !== null && val !== undefined) {
+ data = data || {};
+ data[k] = val;
+ }
+
+ }, this);
+ }
+
+ return data;
+ },
+
+ /**
+ * Moves a pre-defined set of style rules (WRAP_STYLES) from one node to another.
+ *
+ * @method _moveStyles
+ * @private
+ * @param {Node} nodeFrom The node to gather the styles from
+ * @param {Node} nodeTo The node to apply the styles to
+ */
+ _moveStyles: function(nodeFrom, nodeTo) {
+
+ var styles = this.WRAP_STYLES,
+ pos = nodeFrom.getStyle('position'),
+ contentBox = this.get(CONTENT_BOX),
+ xy = [0,0],
+ h, w;
+
+ if (!this.get('height')) {
+ h = contentBox.get('offsetHeight');
+ }
+
+ if (!this.get('width')) {
+ w = contentBox.get('offsetWidth');
+ }
+
+ if (pos === 'absolute') {
+ xy = nodeFrom.getXY();
+ nodeTo.setStyles({
+ right: 'auto',
+ bottom: 'auto'
+ });
+
+ nodeFrom.setStyles({
+ right: 'auto',
+ bottom: 'auto'
+ });
+ }
+
+ Y.each(styles, function(v, k) {
+ var s = nodeFrom.getStyle(k);
+ nodeTo.setStyle(k, s);
+ if (v === false) {
+ nodeFrom.setStyle(k, '');
+ } else {
+ nodeFrom.setStyle(k, v);
+ }
+ });
+
+ if (pos === 'absolute') {
+ nodeTo.setXY(xy);
+ }
+
+ if (h) {
+ this.set('height', h);
+ }
+
+ if (w) {
+ this.set('width', w);
+ }
+ },
+
+ /**
+ * Helper method to collect the boundingBox and contentBox, set styles and append to the provided parentNode, if not
+ * already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used
+ * as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and
+ * the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered
+ * to the current document's body.
+ *
+ * @method _renderBox
+ * @private
+ * @param {Node} parentNode The parentNode to render the widget to. If not provided, and both the boundingBox and
+ * the contentBox are not currently in the document, the widget will be rendered to the current document's body.
+ */
+ _renderBox: function(parentNode) {
+
+ var contentBox = this.get(CONTENT_BOX),
+ boundingBox = this.get(BOUNDING_BOX),
+ doc = boundingBox.get(OWNER_DOCUMENT) || contentBox.get(OWNER_DOCUMENT),
+ body;
+
+ if (!boundingBox.compareTo(contentBox.get(PARENT_NODE))) {
+ if (this.get('moveStyles')) {
+ this._moveStyles(contentBox, boundingBox);
+ }
+ // If contentBox box is already in the document, have boundingBox box take it's place
+ if (contentBox.inDoc(doc)) {
+ contentBox.get(PARENT_NODE).replaceChild(boundingBox, contentBox);
+ }
+ boundingBox.appendChild(contentBox);
+ }
+
+ if (!boundingBox.inDoc(doc) && !parentNode) {
+ body = Node.get(BODY);
+ if (body.get(FIRST_CHILD)) {
+ // Special case when handling body as default (no parentNode), always try to insert.
+ body.insertBefore(boundingBox, body.get(FIRST_CHILD));
+ } else {
+ body.appendChild(boundingBox);
+ }
+ } else {
+ if (parentNode && !parentNode.compareTo(boundingBox.get(PARENT_NODE))) {
+ parentNode.appendChild(boundingBox);
+ }
+ }
+ },
+
+ /**
+ * Setter for the boundingBox attribute
+ *
+ * @method _setBoundingBox
+ * @private
+ * @param Node/String
+ * @return Node
+ */
+ _setBoundingBox: function(node) {
+ return this._setBox(node, this.BOUNDING_TEMPLATE);
+ },
+
+ /**
+ * Setter for the contentBox attribute
+ *
+ * @method _setContentBox
+ * @private
+ * @param {Node|String} node
+ * @return Node
+ */
+ _setContentBox: function(node) {
+ return this._setBox(node, this.CONTENT_TEMPLATE);
+ },
+
+ /**
+ * Helper method to set the bounding/content box, or create it from
+ * the provided template if not found.
+ *
+ * @method _setBox
+ * @private
+ *
+ * @param {Node|String} node The node reference
+ * @param {String} template HTML string template for the node
+ * @return {Node} The node
+ */
+ _setBox : function(node, template) {
+ node = Node.get(node) || Node.create(template);
+
+ var sid = Y.stamp(node);
+ if (!node.get(ID)) {
+ node.set(ID, sid);
+ }
+ return node;
+ },
+
+ /**
+ * Initializes the UI state for the Widget's bounding/content boxes.
+ *
+ * @method _renderUI
+ * @protected
+ * @param {Node} The parent node to rendering the widget into
+ */
+ _renderUI: function(parentNode) {
+ this._renderBoxClassNames();
+ this._renderBox(parentNode);
+ },
+
+ /**
+ * Applies standard class names to the boundingBox and contentBox
+ *
+ * @method _renderBoxClassNames
+ * @protected
+ */
+ _renderBoxClassNames : function() {
+ var classes = this._getClasses(),
+ boundingBox = this.get(BOUNDING_BOX),
+ contentBox = this.get(CONTENT_BOX),
+ name, i;
+
+ boundingBox.addClass(Widget.getClassName());
+
+ // Start from Widget Sub Class
+ for (i = classes.length-3; i >= 0; i--) {
+ name = classes[i].NAME;
+ if (name) {
+ boundingBox.addClass(ClassNameManager.getClassName(name.toLowerCase()));
+ }
+ }
+
+ // Use instance based name for content box
+ contentBox.addClass(this.getClassName(CONTENT));
+ },
+
+ /**
+ * Sets up DOM and CustomEvent listeners for the widget.
+ *
+ * @method _bindUI
+ * @protected
+ */
+ _bindUI: function() {
+ this.after('visibleChange', this._afterVisibleChange);
+ this.after('disabledChange', this._afterDisabledChange);
+ this.after('heightChange', this._afterHeightChange);
+ this.after('widthChange', this._afterWidthChange);
+ this.after('focusedChange', this._afterFocusedChange);
+
+ this._bindDOMListeners();
+ },
+
+ /**
+ * Sets up DOM listeners, on elements rendered by the widget.
+ *
+ * @method _bindDOMListeners
+ * @protected
+ */
+ _bindDOMListeners : function() {
+
+ var oDocument = this.get(BOUNDING_BOX).get("ownerDocument");
+
+ oDocument.on("focus", this._onFocus, this);
+
+ // Fix for Webkit:
+ // Document doesn't receive focus in Webkit when the user mouses
+ // down on it, so the "focused" attribute won't get set to the
+ // correct value.
+
+ if (Y.UA.webkit) {
+ oDocument.on("mousedown", this._onDocMouseDown, this);
+ }
+
+ },
+
+ /**
+ * Updates the widget UI to reflect the attribute state.
+ *
+ * @method _syncUI
+ * @protected
+ */
+ _syncUI: function() {
+ this._uiSetVisible(this.get(VISIBLE));
+ this._uiSetDisabled(this.get(DISABLED));
+ this._uiSetHeight(this.get(HEIGHT));
+ this._uiSetWidth(this.get(WIDTH));
+ this._uiSetFocused(this.get(FOCUSED));
+ this._uiSetTabIndex(this.get(TAB_INDEX));
+ },
+
+ /**
+ * Sets the height on the widget's bounding box element
+ *
+ * @method _uiSetHeight
+ * @protected
+ * @param {String | Number} val
+ */
+ _uiSetHeight: function(val) {
+ if (L.isNumber(val)) {
+ val = val + this.DEF_UNIT;
+ }
+ this.get(BOUNDING_BOX).setStyle(HEIGHT, val);
+ },
+
+ /**
+ * Sets the width on the widget's bounding box element
+ *
+ * @method _uiSetWidth
+ * @protected
+ * @param {String | Number} val
+ */
+ _uiSetWidth: function(val) {
+ if (L.isNumber(val)) {
+ val = val + this.DEF_UNIT;
+ }
+ this.get(BOUNDING_BOX).setStyle(WIDTH, val);
+ },
+
+ /**
+ * Sets the visible state for the UI
+ *
+ * @method _uiSetVisible
+ * @protected
+ * @param {boolean} val
+ */
+ _uiSetVisible: function(val) {
+
+ var box = this.get(BOUNDING_BOX),
+ sClassName = this.getClassName(HIDDEN);
+
+ if (val === true) {
+ box.removeClass(sClassName);
+ } else {
+ box.addClass(sClassName);
+ }
+ },
+
+ /**
+ * Sets the disabled state for the UI
+ *
+ * @protected
+ * @param {boolean} val
+ */
+ _uiSetDisabled: function(val) {
+
+ var box = this.get(BOUNDING_BOX),
+ sClassName = this.getClassName(DISABLED);
+
+ if (val === true) {
+ box.addClass(sClassName);
+ } else {
+ box.removeClass(sClassName);
+ }
+ },
+
+
+ /**
+ * Set the tabIndex on the widget's rendered UI
+ *
+ * @method _uiSetTabIndex
+ * @protected
+ * @param Number
+ */
+ _uiSetTabIndex: function(index) {
+
+ var boundingBox = this.get(BOUNDING_BOX);
+
+ if (L.isNumber(index)) {
+ boundingBox.set(TAB_INDEX, index);
+ }
+ else {
+ boundingBox.removeAttribute(TAB_INDEX);
+ }
+
+ },
+
+
+ /**
+ * Sets the focused state for the UI
+ *
+ * @protected
+ * @param {boolean} val
+ * @param {string} src String representing the source that triggered an update to
+ * the UI.
+ */
+ _uiSetFocused: function(val, src) {
+
+ var box = this.get(BOUNDING_BOX),
+ sClassName = this.getClassName(FOCUSED);
+
+ if (val === true) {
+ box.addClass(sClassName);
+ if (src !== UI) {
+ box.focus();
+ }
+ } else {
+ box.removeClass(sClassName);
+ if (src !== UI) {
+ box.blur();
+ }
+ }
+ },
+
+
+
+ /**
+ * Default visible attribute state change handler
+ *
+ * @method _afterVisibleChange
+ * @protected
+ * @param {EventFacade} evt The event facade for the attribute change
+ */
+ _afterVisibleChange: function(evt) {
+ this._uiSetVisible(evt.newVal);
+ },
+
+ /**
+ * Default disabled attribute state change handler
+ *
+ * @method _afterDisabledChange
+ * @protected
+ * @param {EventFacade} evt The event facade for the attribute change
+ */
+ _afterDisabledChange: function(evt) {
+ this._uiSetDisabled(evt.newVal);
+ },
+
+ /**
+ * Default height attribute state change handler
+ *
+ * @method _afterHeightChange
+ * @protected
+ * @param {EventFacade} evt The event facade for the attribute change
+ */
+ _afterHeightChange: function(evt) {
+ this._uiSetHeight(evt.newVal);
+ },
+
+ /**
+ * Default widget attribute state change handler
+ *
+ * @method _afterWidthChange
+ * @protected
+ * @param {EventFacade} evt The event facade for the attribute change
+ */
+ _afterWidthChange: function(evt) {
+ this._uiSetWidth(evt.newVal);
+ },
+
+ /**
+ * Default focused attribute state change handler
+ *
+ * @method _afterFocusedChange
+ * @protected
+ * @param {EventFacade} evt The event facade for the attribute change
+ */
+ _afterFocusedChange: function(evt) {
+ this._uiSetFocused(evt.newVal, evt.src);
+ },
+
+ /**
+ * @method _onDocMouseDown
+ * @description "mousedown" event handler for the owner document of the
+ * widget's bounding box.
+ * @protected
+ * @param {EventFacade} evt The event facade for the DOM focus event
+ */
+ _onDocMouseDown: function (evt) {
+
+ if (this._hasDOMFocus) {
+ this._onFocus(evt);
+ }
+
+ },
+
+ /**
+ * DOM focus event handler, used to sync the state of the Widget with the DOM
+ *
+ * @method _onFocus
+ * @protected
+ * @param {EventFacade} evt The event facade for the DOM focus event
+ */
+ _onFocus: function (evt) {
+
+ var target = evt.target,
+ boundingBox = this.get(BOUNDING_BOX),
+ bFocused = (boundingBox.compareTo(target) || boundingBox.contains(target));
+
+ this._hasDOMFocus = bFocused;
+ this._set(FOCUSED, bFocused, { src: UI });
+
+ },
+
+ /**
+ * Generic toString implementation for all widgets.
+ *
+ * @method toString
+ * @return {String} The default string value for the widget [ displays the NAME of the instance, and the unique id ]
+ */
+ toString: function() {
+ return this.constructor.NAME + "[" + this._yuid + "]";
+ },
+
+ /**
+ * Default unit to use for dimension values
+ *
+ * @property DEF_UNIT
+ */
+ DEF_UNIT : "px",
+
+ /**
+ * Static property defining the markup template for content box.
+ *
+ * @property CONTENT_TEMPLATE
+ * @type String
+ */
+ CONTENT_TEMPLATE : "",
+
+ /**
+ * Static property defining the markup template for bounding box.
+ *
+ * @property BOUNDING_TEMPLATE
+ * @type String
+ */
+ BOUNDING_TEMPLATE : "",
+
+ /**
+ * Static property listing the styles that are mimiced on the bounding box from the content box.
+ *
+ * @property WRAP_STYLES
+ * @type Object
+ */
+ WRAP_STYLES : {
+ height: '100%',
+ width: '100%',
+ zIndex: false,
+ position: 'static',
+ top: '0',
+ left: '0',
+ bottom: '',
+ right: '',
+ padding: '',
+ margin: ''
+ },
+
+ /**
+ * Sets strings for a particular locale, merging with any existing
+ * strings which may already be defined for the locale.
+ *
+ * @method _setStrings
+ * @protected
+ * @param {Object} strings The hash of string key/values to set
+ * @param {Object} locale The locale for the string values being set
+ */
+ _setStrings : function(strings, locale) {
+ var strs = this._strings;
+ locale = locale.toLowerCase();
+
+ if (!strs[locale]) {
+ strs[locale] = {};
+ }
+
+ Y.aggregate(strs[locale], strings, true);
+ return strs[locale];
+ },
+
+ /**
+ * Returns the strings key/value hash for a paricular locale, without locale lookup applied.
+ *
+ * @method _getStrings
+ * @protected
+ * @param {Object} locale
+ */
+ _getStrings : function(locale) {
+ return this._strings[locale.toLowerCase()];
+ },
+
+ /**
+ * Gets the entire strings hash for a particular locale, performing locale lookup.
+ * + * If no values of the key are defined for a particular locale the value for the + * default locale (in initial locale set for the class) is returned. + *
+ * @method getStrings + * @param {String} locale (optional) The locale for which the string value is required. Defaults to the current locale, if not provided. + */ + // TODO: Optimize/Cache. Clear cache on _setStrings call. + getStrings : function(locale) { + + locale = (locale || this.get(LOCALE)).toLowerCase(); + + Y.log("getStrings: For " + locale, "info", "widget"); + + var defLocale = this.getDefaultLocale().toLowerCase(), + defStrs = this._getStrings(defLocale), + strs = (defStrs) ? Y.merge(defStrs) : {}, + localeSegments = locale.split(HYPHEN); + + // If locale is different than the default, or needs lookup support + if (locale !== defLocale || localeSegments.length > 1) { + var lookup = ""; + for (var i = 0, l = localeSegments.length; i < l; ++i) { + lookup += localeSegments[i]; + + Y.log("getStrings: Merging in strings from: " + lookup, "info", "widget"); + + var localeStrs = this._getStrings(lookup); + if (localeStrs) { + Y.aggregate(strs, localeStrs, true); + } + lookup += HYPHEN; + } + } + + return strs; + }, + + /** + * Gets the string for a particular key, for a particular locale, performing locale lookup. + *+ * If no values if defined for the key, for the given locale, the value for the + * default locale (in initial locale set for the class) is returned. + *
+ * @method getString + * @param {String} key The key. + * @param {String} locale (optional) The locale for which the string value is required. Defaults to the current locale, if not provided. + */ + getString : function(key, locale) { + + locale = (locale || this.get(LOCALE)).toLowerCase(); + + Y.log("getString: For " + locale, "info", "widget"); + + var defLocale = (this.getDefaultLocale()).toLowerCase(), + strs = this._getStrings(defLocale) || {}, + str = strs[key], + idx = locale.lastIndexOf(HYPHEN); + + // If locale is different than the default, or needs lookup support + if (locale !== defLocale || idx != -1) { + do { + Y.log("getString: Performing lookup for: " + locale, "info", "widget"); + + strs = this._getStrings(locale); + if (strs && key in strs) { + str = strs[key]; + break; + } + idx = locale.lastIndexOf(HYPHEN); + // Chop of last locale segment + if (idx != -1) { + locale = locale.substring(0, idx); + } + + } while (idx != -1); + } + + return str; + }, + + /** + * Returns the default locale for the widget (the locale value defined by the + * widget class, or provided by the user during construction). + * + * @method getDefaultLocale + * @return {String} The default locale for the widget + */ + getDefaultLocale : function() { + return this._conf.get(LOCALE, INIT_VALUE); + }, + + /** + * Private stings hash, used to store strings in locale specific buckets. + * + * @property _strings + * @private + * @type Object + */ + _strings: null, + + /** + * Gets the HTML_PARSER definition for this instance, by merging HTML_PARSER + * definitions across the class hierarchy. + * + * @method _getHtmlParser + * @return {Object} HTML_PARSER definition for this instance + */ + _getHtmlParser : function() { + if (!this._HTML_PARSER) { + var classes = this._getClasses(), + parser = {}, + i, p; + + for (i = classes.length - 1; i >= 0; i--) { + p = classes[i].HTML_PARSER; + if (p) { + Y.mix(parser, p, true); + } + } + + this._HTML_PARSER = parser; + } + + return this._HTML_PARSER; + } +}); + +Y.Widget = Widget; + + + +}, '3.0.0b1' ,{requires:['base', 'node', 'classnamemanager']});