/* Copyright (c) 2008, Yahoo! Inc. All rights reserved. Code licensed under the BSD License: http://developer.yahoo.net/yui/license.txt version: 2.6.0 */ (function() { /** * The tabview module provides a widget for managing content bound to tabs. * @module tabview * @requires yahoo, dom, event, element * */ var Dom = YAHOO.util.Dom, Event = YAHOO.util.Event, Tab = YAHOO.widget.Tab, doc = document; // STRING CONSTANTS var ELEMENT = 'element'; /** * A widget to control tabbed views. * @namespace YAHOO.widget * @class TabView * @extends YAHOO.util.Element * @constructor * @param {HTMLElement | String | Object} el(optional) The html * element that represents the TabView, or the attribute object to use. * An element will be created if none provided. * @param {Object} attr (optional) A key map of the tabView's * initial attributes. Ignored if first arg is attributes object. */ var TabView = function(el, attr) { attr = attr || {}; if (arguments.length == 1 && !YAHOO.lang.isString(el) && !el.nodeName) { attr = el; // treat first arg as attr object el = attr.element || null; } if (!el && !attr.element) { // create if we dont have one el = _createTabViewElement.call(this, attr); } TabView.superclass.constructor.call(this, el, attr); }; YAHOO.extend(TabView, YAHOO.util.Element, { /** * The className to add when building from scratch. * @property CLASSNAME * @default "navset" */ CLASSNAME: 'yui-navset', /** * The className of the HTMLElement containing the TabView's tab elements * to look for when building from existing markup, or to add when building * from scratch. * All childNodes of the tab container are treated as Tabs when building * from existing markup. * @property TAB_PARENT_CLASSNAME * @default "nav" */ TAB_PARENT_CLASSNAME: 'yui-nav', /** * The className of the HTMLElement containing the TabView's label elements * to look for when building from existing markup, or to add when building * from scratch. * All childNodes of the content container are treated as content elements when * building from existing markup. * @property CONTENT_PARENT_CLASSNAME * @default "nav-content" */ CONTENT_PARENT_CLASSNAME: 'yui-content', _tabParent: null, _contentParent: null, /** * Adds a Tab to the TabView instance. * If no index is specified, the tab is added to the end of the tab list. * @method addTab * @param {YAHOO.widget.Tab} tab A Tab instance to add. * @param {Integer} index The position to add the tab. * @return void */ addTab: function(tab, index) { var tabs = this.get('tabs'); if (!tabs) { // not ready yet this._queue[this._queue.length] = ['addTab', arguments]; return false; } index = (index === undefined) ? tabs.length : index; var before = this.getTab(index); var self = this; var el = this.get(ELEMENT); var tabParent = this._tabParent; var contentParent = this._contentParent; var tabElement = tab.get(ELEMENT); var contentEl = tab.get('contentEl'); if ( before ) { tabParent.insertBefore(tabElement, before.get(ELEMENT)); } else { tabParent.appendChild(tabElement); } if ( contentEl && !Dom.isAncestor(contentParent, contentEl) ) { contentParent.appendChild(contentEl); } if ( !tab.get('active') ) { tab.set('contentVisible', false, true); /* hide if not active */ } else { this.set('activeTab', tab, true); } var activate = function(e) { YAHOO.util.Event.preventDefault(e); var silent = false; if (this == self.get('activeTab')) { silent = true; // dont fire activeTabChange if already active } self.set('activeTab', this, silent); }; tab.addListener( tab.get('activationEvent'), activate); tab.addListener('activationEventChange', function(e) { if (e.prevValue != e.newValue) { tab.removeListener(e.prevValue, activate); tab.addListener(e.newValue, activate); } }); tabs.splice(index, 0, tab); }, /** * Routes childNode events. * @method DOMEventHandler * @param {event} e The Dom event that is being handled. * @return void */ DOMEventHandler: function(e) { var el = this.get(ELEMENT); var target = YAHOO.util.Event.getTarget(e); var tabParent = this._tabParent; if (Dom.isAncestor(tabParent, target) ) { var tabEl; var tab = null; var contentEl; var tabs = this.get('tabs'); for (var i = 0, len = tabs.length; i < len; i++) { tabEl = tabs[i].get(ELEMENT); contentEl = tabs[i].get('contentEl'); if ( target == tabEl || Dom.isAncestor(tabEl, target) ) { tab = tabs[i]; break; // note break } } if (tab) { tab.fireEvent(e.type, e); } } }, /** * Returns the Tab instance at the specified index. * @method getTab * @param {Integer} index The position of the Tab. * @return YAHOO.widget.Tab */ getTab: function(index) { return this.get('tabs')[index]; }, /** * Returns the index of given tab. * @method getTabIndex * @param {YAHOO.widget.Tab} tab The tab whose index will be returned. * @return int */ getTabIndex: function(tab) { var index = null; var tabs = this.get('tabs'); for (var i = 0, len = tabs.length; i < len; ++i) { if (tab == tabs[i]) { index = i; break; } } return index; }, /** * Removes the specified Tab from the TabView. * @method removeTab * @param {YAHOO.widget.Tab} item The Tab instance to be removed. * @return void */ removeTab: function(tab) { var tabCount = this.get('tabs').length; var index = this.getTabIndex(tab); var nextIndex = index + 1; if ( tab == this.get('activeTab') ) { // select next tab if (tabCount > 1) { if (index + 1 == tabCount) { this.set('activeIndex', index - 1); } else { this.set('activeIndex', index + 1); } } } this._tabParent.removeChild( tab.get(ELEMENT) ); this._contentParent.removeChild( tab.get('contentEl') ); this._configs.tabs.value.splice(index, 1); }, /** * Provides a readable name for the TabView instance. * @method toString * @return String */ toString: function() { var name = this.get('id') || this.get('tagName'); return "TabView " + name; }, /** * The transiton to use when switching between tabs. * @method contentTransition */ contentTransition: function(newTab, oldTab) { newTab.set('contentVisible', true); oldTab.set('contentVisible', false); }, /** * setAttributeConfigs TabView specific properties. * @method initAttributes * @param {Object} attr Hash of initial attributes */ initAttributes: function(attr) { TabView.superclass.initAttributes.call(this, attr); if (!attr.orientation) { attr.orientation = 'top'; } var el = this.get(ELEMENT); if (!Dom.hasClass(el, this.CLASSNAME)) { Dom.addClass(el, this.CLASSNAME); } /** * The Tabs belonging to the TabView instance. * @attribute tabs * @type Array */ this.setAttributeConfig('tabs', { value: [], readOnly: true }); /** * The container of the tabView's label elements. * @property _tabParent * @private * @type HTMLElement */ this._tabParent = this.getElementsByClassName(this.TAB_PARENT_CLASSNAME, 'ul' )[0] || _createTabParent.call(this); /** * The container of the tabView's content elements. * @property _contentParent * @type HTMLElement * @private */ this._contentParent = this.getElementsByClassName(this.CONTENT_PARENT_CLASSNAME, 'div')[0] || _createContentParent.call(this); /** * How the Tabs should be oriented relative to the TabView. * @attribute orientation * @type String * @default "top" */ this.setAttributeConfig('orientation', { value: attr.orientation, method: function(value) { var current = this.get('orientation'); this.addClass('yui-navset-' + value); if (current != value) { this.removeClass('yui-navset-' + current); } switch(value) { case 'bottom': this.appendChild(this._tabParent); break; } } }); /** * The index of the tab currently active. * @attribute activeIndex * @type Int */ this.setAttributeConfig('activeIndex', { value: attr.activeIndex, method: function(value) { //this.set('activeTab', this.getTab(value)); }, validator: function(value) { return !this.getTab(value).get('disabled'); // cannot activate if disabled } }); /** * The tab currently active. * @attribute activeTab * @type YAHOO.widget.Tab */ this.setAttributeConfig('activeTab', { value: attr.activeTab, method: function(tab) { var activeTab = this.get('activeTab'); if (tab) { tab.set('active', true); //this._configs['activeIndex'].value = this.getTabIndex(tab); // keep in sync } if (activeTab && activeTab != tab) { activeTab.set('active', false); } if (activeTab && tab != activeTab) { // no transition if only 1 this.contentTransition(tab, activeTab); } else if (tab) { tab.set('contentVisible', true); } }, validator: function(value) { return !value.get('disabled'); // cannot activate if disabled } }); this.on('activeTabChange', this._handleActiveTabChange); this.on('activeIndexChange', this._handleActiveIndexChange); if ( this._tabParent ) { _initTabs.call(this); } // Due to delegation we add all DOM_EVENTS to the TabView container // but IE will leak when unsupported events are added, so remove these this.DOM_EVENTS.submit = false; this.DOM_EVENTS.focus = false; this.DOM_EVENTS.blur = false; for (var type in this.DOM_EVENTS) { if ( YAHOO.lang.hasOwnProperty(this.DOM_EVENTS, type) ) { this.addListener.call(this, type, this.DOMEventHandler); } } }, _handleActiveTabChange: function(e) { var activeIndex = this.get('activeIndex'), newIndex = this.getTabIndex(e.newValue); if (activeIndex !== newIndex) { if (!(this.set('activeIndex', newIndex)) ) { // NOTE: setting // revert if activeIndex update fails (cancelled via beforeChange) this.set('activeTab', e.prevValue); } } }, _handleActiveIndexChange: function(e) { // no set if called from ActiveTabChange event if (e.newValue !== this.getTabIndex(this.get('activeTab'))) { if (!(this.set('activeTab', this.getTab(e.newValue))) ) { // NOTE: setting // revert if activeTab update fails (cancelled via beforeChange) this.set('activeIndex', e.prevValue); } } } }); /** * Creates Tab instances from a collection of HTMLElements. * @method initTabs * @private * @return void */ var _initTabs = function() { var tab, attr, contentEl; var el = this.get(ELEMENT); var tabs = Dom.getChildren(this._tabParent); var contentElements = Dom.getChildren(this._contentParent); for (var i = 0, len = tabs.length; i < len; ++i) { attr = {}; if (contentElements[i]) { attr.contentEl = contentElements[i]; } tab = new YAHOO.widget.Tab(tabs[i], attr); this.addTab(tab); if (tab.hasClass(tab.ACTIVE_CLASSNAME) ) { this._configs.activeTab.value = tab; // dont invoke method this._configs.activeIndex.value = this.getTabIndex(tab); } } }; var _createTabViewElement = function(attr) { var el = doc.createElement('div'); if ( this.CLASSNAME ) { el.className = this.CLASSNAME; } return el; }; var _createTabParent = function(attr) { var el = doc.createElement('ul'); if ( this.TAB_PARENT_CLASSNAME ) { el.className = this.TAB_PARENT_CLASSNAME; } this.get(ELEMENT).appendChild(el); return el; }; var _createContentParent = function(attr) { var el = doc.createElement('div'); if ( this.CONTENT_PARENT_CLASSNAME ) { el.className = this.CONTENT_PARENT_CLASSNAME; } this.get(ELEMENT).appendChild(el); return el; }; YAHOO.widget.TabView = TabView; })(); (function() { var Dom = YAHOO.util.Dom, Event = YAHOO.util.Event, Lang = YAHOO.lang; // STRING CONSTANTS var CONTENT_EL = 'contentEl', LABEL_EL = 'labelEl', CONTENT = 'content', ELEMENT = 'element', CACHE_DATA = 'cacheData', DATA_SRC = 'dataSrc', DATA_LOADED = 'dataLoaded', DATA_TIMEOUT = 'dataTimeout', LOAD_METHOD = 'loadMethod', POST_DATA = 'postData', DISABLED = 'disabled'; /** * A representation of a Tab's label and content. * @namespace YAHOO.widget * @class Tab * @extends YAHOO.util.Element * @constructor * @param element {HTMLElement | String} (optional) The html element that * represents the TabView. An element will be created if none provided. * @param {Object} properties A key map of initial properties */ var Tab = function(el, attr) { attr = attr || {}; if (arguments.length == 1 && !Lang.isString(el) && !el.nodeName) { attr = el; el = attr.element; } if (!el && !attr.element) { el = _createTabElement.call(this, attr); } this.loadHandler = { success: function(o) { this.set(CONTENT, o.responseText); }, failure: function(o) { } }; Tab.superclass.constructor.call(this, el, attr); this.DOM_EVENTS = {}; // delegating to tabView }; YAHOO.extend(Tab, YAHOO.util.Element, { /** * The default tag name for a Tab's inner element. * @property LABEL_INNER_TAGNAME * @type String * @default "em" */ LABEL_TAGNAME: 'em', /** * The class name applied to active tabs. * @property ACTIVE_CLASSNAME * @type String * @default "selected" */ ACTIVE_CLASSNAME: 'selected', /** * The class name applied to active tabs. * @property ACTIVE_CLASSNAME * @type String * @default "selected" */ HIDDEN_CLASSNAME: 'yui-hidden', /** * The title applied to active tabs. * @property ACTIVE_TITLE * @type String * @default "active" */ ACTIVE_TITLE: 'active', /** * The class name applied to disabled tabs. * @property DISABLED_CLASSNAME * @type String * @default "disabled" */ DISABLED_CLASSNAME: DISABLED, /** * The class name applied to dynamic tabs while loading. * @property LOADING_CLASSNAME * @type String * @default "disabled" */ LOADING_CLASSNAME: 'loading', /** * Provides a reference to the connection request object when data is * loaded dynamically. * @property dataConnection * @type Object */ dataConnection: null, /** * Object containing success and failure callbacks for loading data. * @property loadHandler * @type object */ loadHandler: null, _loading: false, /** * Provides a readable name for the tab. * @method toString * @return String */ toString: function() { var el = this.get(ELEMENT); var id = el.id || el.tagName; return "Tab " + id; }, /** * setAttributeConfigs TabView specific properties. * @method initAttributes * @param {Object} attr Hash of initial attributes */ initAttributes: function(attr) { attr = attr || {}; Tab.superclass.initAttributes.call(this, attr); var el = this.get(ELEMENT); /** * The event that triggers the tab's activation. * @attribute activationEvent * @type String */ this.setAttributeConfig('activationEvent', { value: attr.activationEvent || 'click' }); /** * The element that contains the tab's label. * @attribute labelEl * @type HTMLElement */ this.setAttributeConfig(LABEL_EL, { value: attr.labelEl || _getlabelEl.call(this), method: function(value) { var current = this.get(LABEL_EL); if (current) { if (current == value) { return false; // already set } this.replaceChild(value, current); } else if (el.firstChild) { // ensure label is firstChild by default this.insertBefore(value, el.firstChild); } else { this.appendChild(value); } } }); /** * The tab's label text (or innerHTML). * @attribute label * @type String */ this.setAttributeConfig('label', { value: attr.label || _getLabel.call(this), method: function(value) { var labelEl = this.get(LABEL_EL); if (!labelEl) { // create if needed this.set(LABEL_EL, _createlabelEl.call(this)); } _setLabel.call(this, value); } }); /** * The HTMLElement that contains the tab's content. * @attribute contentEl * @type HTMLElement */ this.setAttributeConfig(CONTENT_EL, { value: attr.contentEl || document.createElement('div'), method: function(value) { var current = this.get(CONTENT_EL); if (current) { if (current == value) { return false; // already set } this.replaceChild(value, current); } } }); /** * The tab's content. * @attribute content * @type String */ this.setAttributeConfig(CONTENT, { value: attr.content, method: function(value) { this.get(CONTENT_EL).innerHTML = value; } }); var _dataLoaded = false; /** * The tab's data source, used for loading content dynamically. * @attribute dataSrc * @type String */ this.setAttributeConfig(DATA_SRC, { value: attr.dataSrc }); /** * Whether or not content should be reloaded for every view. * @attribute cacheData * @type Boolean * @default false */ this.setAttributeConfig(CACHE_DATA, { value: attr.cacheData || false, validator: Lang.isBoolean }); /** * The method to use for the data request. * @attribute loadMethod * @type String * @default "GET" */ this.setAttributeConfig(LOAD_METHOD, { value: attr.loadMethod || 'GET', validator: Lang.isString }); /** * Whether or not any data has been loaded from the server. * @attribute dataLoaded * @type Boolean */ this.setAttributeConfig(DATA_LOADED, { value: false, validator: Lang.isBoolean, writeOnce: true }); /** * Number if milliseconds before aborting and calling failure handler. * @attribute dataTimeout * @type Number * @default null */ this.setAttributeConfig(DATA_TIMEOUT, { value: attr.dataTimeout || null, validator: Lang.isNumber }); /** * Arguments to pass when POST method is used * @attribute postData * @default null */ this.setAttributeConfig(POST_DATA, { value: attr.postData || null }); /** * Whether or not the tab is currently active. * If a dataSrc is set for the tab, the content will be loaded from * the given source. * @attribute active * @type Boolean */ this.setAttributeConfig('active', { value: attr.active || this.hasClass(this.ACTIVE_CLASSNAME), method: function(value) { if (value === true) { this.addClass(this.ACTIVE_CLASSNAME); this.set('title', this.ACTIVE_TITLE); } else { this.removeClass(this.ACTIVE_CLASSNAME); this.set('title', ''); } }, validator: function(value) { return Lang.isBoolean(value) && !this.get(DISABLED) ; } }); /** * Whether or not the tab is disabled. * @attribute disabled * @type Boolean */ this.setAttributeConfig(DISABLED, { value: attr.disabled || this.hasClass(this.DISABLED_CLASSNAME), method: function(value) { if (value === true) { Dom.addClass(this.get(ELEMENT), this.DISABLED_CLASSNAME); } else { Dom.removeClass(this.get(ELEMENT), this.DISABLED_CLASSNAME); } }, validator: Lang.isBoolean }); /** * The href of the tab's anchor element. * @attribute href * @type String * @default '#' */ this.setAttributeConfig('href', { value: attr.href || this.getElementsByTagName('a')[0].getAttribute('href', 2) || '#', method: function(value) { this.getElementsByTagName('a')[0].href = value; }, validator: Lang.isString }); /** * The Whether or not the tab's content is visible. * @attribute contentVisible * @type Boolean * @default false */ this.setAttributeConfig('contentVisible', { value: attr.contentVisible, method: function(value) { if (value) { //this.get(CONTENT_EL).style.display = 'block'; Dom.removeClass(this.get(CONTENT_EL), this.HIDDEN_CLASSNAME); if ( this.get(DATA_SRC) ) { // load dynamic content unless already loading or loaded and caching if ( !this._loading && !(this.get(DATA_LOADED) && this.get(CACHE_DATA)) ) { this._dataConnect(); } } } else { Dom.addClass(this.get(CONTENT_EL), this.HIDDEN_CLASSNAME); } }, validator: Lang.isBoolean }); }, _dataConnect: function() { if (!YAHOO.util.Connect) { return false; } Dom.addClass(this.get(CONTENT_EL).parentNode, this.LOADING_CLASSNAME); this._loading = true; this.dataConnection = YAHOO.util.Connect.asyncRequest( this.get(LOAD_METHOD), this.get(DATA_SRC), { success: function(o) { this.loadHandler.success.call(this, o); this.set(DATA_LOADED, true); this.dataConnection = null; Dom.removeClass(this.get(CONTENT_EL).parentNode, this.LOADING_CLASSNAME); this._loading = false; }, failure: function(o) { this.loadHandler.failure.call(this, o); this.dataConnection = null; Dom.removeClass(this.get(CONTENT_EL).parentNode, this.LOADING_CLASSNAME); this._loading = false; }, scope: this, timeout: this.get(DATA_TIMEOUT) }, this.get(POST_DATA) ); } }); var _createTabElement = function(attr) { var el = document.createElement('li'); var a = document.createElement('a'); a.href = attr.href || '#'; el.appendChild(a); var label = attr.label || null; var labelEl = attr.labelEl || null; if (labelEl) { // user supplied labelEl if (!label) { // user supplied label label = _getLabel.call(this, labelEl); } } else { labelEl = _createlabelEl.call(this); } a.appendChild(labelEl); return el; }; var _getlabelEl = function() { return this.getElementsByTagName(this.LABEL_TAGNAME)[0]; }; var _createlabelEl = function() { var el = document.createElement(this.LABEL_TAGNAME); return el; }; var _setLabel = function(label) { var el = this.get(LABEL_EL); el.innerHTML = label; }; var _getLabel = function() { var label, el = this.get(LABEL_EL); if (!el) { return undefined; } return el.innerHTML; }; YAHOO.widget.Tab = Tab; })(); YAHOO.register("tabview", YAHOO.widget.TabView, {version: "2.6.0", build: "1321"});