API: menu menubar.js (YUI Library)

# Yahoo! UI Library

### Menu 2.8.2r1

Yahoo! UI Library > menu > menubar.js (source view)
Search:
Filters Show Private Show Protected Show Deprecated

    (function () {

    	var Lang = YAHOO.lang,

    		// String constants

    		_STATIC = "static",
    		_DYNAMIC_STATIC = "dynamic," + _STATIC,
    		_DISABLED = "disabled",
    		_SELECTED = "selected",
    		_AUTO_SUBMENU_DISPLAY = "autosubmenudisplay",
    		_SUBMENU = "submenu",
    		_VISIBLE = "visible",
    		_SPACE = " ",
    		_SUBMENU_TOGGLE_REGION = "submenutoggleregion",
    		_MENUBAR = "MenuBar";

    /**
    * Horizontal collection of items, each of which can contain a submenu.
    *
    * @param {String} p_oElement String specifying the id attribute of the
    * <code>&#60;div&#62;</code> element of the menu bar.
    * @param {String} p_oElement String specifying the id attribute of the
    * <code>&#60;select&#62;</code> element to be used as the data source for the
    * menu bar.
    * @param {<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
    * one-html.html#ID-22445964">HTMLDivElement</a>} p_oElement Object specifying
    * the <code>&#60;div&#62;</code> element of the menu bar.
    * @param {<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
    * one-html.html#ID-94282980">HTMLSelectElement</a>} p_oElement Object
    * specifying the <code>&#60;select&#62;</code> element to be used as the data
    * source for the menu bar.
    * @param {Object} p_oConfig Optional. Object literal specifying the
    * configuration for the menu bar. See configuration class documentation for
    * more details.
    * @class MenuBar
    * @constructor
    * @extends YAHOO.widget.Menu
    * @namespace YAHOO.widget
    */
    YAHOO.widget.MenuBar = function(p_oElement, p_oConfig) {

        YAHOO.widget.MenuBar.superclass.constructor.call(this, p_oElement, p_oConfig);

    };

    /**
    * @method checkPosition
    * @description Checks to make sure that the value of the "position" property
    * is one of the supported strings. Returns true if the position is supported.
    * @private
    * @param {Object} p_sPosition String specifying the position of the menu.
    * @return {Boolean}
    */
    function checkPosition(p_sPosition) {

    	var returnVal = false;

        if (Lang.isString(p_sPosition)) {

            returnVal = (_DYNAMIC_STATIC.indexOf((p_sPosition.toLowerCase())) != -1);

        }

        return returnVal;

    }

    var Event = YAHOO.util.Event,
        MenuBar = YAHOO.widget.MenuBar,

        POSITION_CONFIG =  {
    		key: "position",
    		value: _STATIC,
    		validator: checkPosition,
    		supercedes: [_VISIBLE]
    	},

    	SUBMENU_ALIGNMENT_CONFIG =  {
    		key: "submenualignment",
    		value: ["tl","bl"]
    	},

    	AUTO_SUBMENU_DISPLAY_CONFIG =  {
    		key: _AUTO_SUBMENU_DISPLAY,
    		value: false,
    		validator: Lang.isBoolean,
    		suppressEvent: true
    	},

    	SUBMENU_TOGGLE_REGION_CONFIG = {
    		key: _SUBMENU_TOGGLE_REGION,
    		value: false,
    		validator: Lang.isBoolean
    	};

    Lang.extend(MenuBar, YAHOO.widget.Menu, {

    /**
    * @method init
    * @description The MenuBar class's initialization method. This method is
    * automatically called by the constructor, and sets up all DOM references for
    * pre-existing markup, and creates required markup if it is not already present.
    * @param {String} p_oElement String specifying the id attribute of the
    * <code>&#60;div&#62;</code> element of the menu bar.
    * @param {String} p_oElement String specifying the id attribute of the
    * <code>&#60;select&#62;</code> element to be used as the data source for the
    * menu bar.
    * @param {<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
    * one-html.html#ID-22445964">HTMLDivElement</a>} p_oElement Object specifying
    * the <code>&#60;div&#62;</code> element of the menu bar.
    * @param {<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
    * one-html.html#ID-94282980">HTMLSelectElement</a>} p_oElement Object
    * specifying the <code>&#60;select&#62;</code> element to be used as the data
    * source for the menu bar.
    * @param {Object} p_oConfig Optional. Object literal specifying the
    * configuration for the menu bar. See configuration class documentation for
    * more details.
    */
    init: function(p_oElement, p_oConfig) {

        if(!this.ITEM_TYPE) {

            this.ITEM_TYPE = YAHOO.widget.MenuBarItem;

        }

        // Call the init of the superclass (YAHOO.widget.Menu)

        MenuBar.superclass.init.call(this, p_oElement);

        this.beforeInitEvent.fire(MenuBar);

        if(p_oConfig) {

            this.cfg.applyConfig(p_oConfig, true);

        }

        this.initEvent.fire(MenuBar);

    },

    // Constants

    /**
    * @property CSS_CLASS_NAME
    * @description String representing the CSS class(es) to be applied to the menu
    * bar's <code>&#60;div&#62;</code> element.
    * @default "yuimenubar"
    * @final
    * @type String
    */
    CSS_CLASS_NAME: "yuimenubar",

    /**
    * @property SUBMENU_TOGGLE_REGION_WIDTH
    * @description Width (in pixels) of the area of a MenuBarItem that, when pressed, will toggle the
    * display of the MenuBarItem's submenu.
    * @default 20
    * @final
    * @type Number
    */
    SUBMENU_TOGGLE_REGION_WIDTH: 20,

    // Protected event handlers

    /**
    * @method _onKeyDown
    * @description "keydown" Custom Event handler for the menu bar.
    * @private
    * @param {String} p_sType String representing the name of the event that
    * was fired.
    * @param {Array} p_aArgs Array of arguments sent when the event was fired.
    * @param {YAHOO.widget.MenuBar} p_oMenuBar Object representing the menu bar
    * that fired the event.
    */
    _onKeyDown: function(p_sType, p_aArgs, p_oMenuBar) {

        var oEvent = p_aArgs[0],
            oItem = p_aArgs[1],
            oSubmenu,
            oItemCfg,
            oNextItem;

        if(oItem && !oItem.cfg.getProperty(_DISABLED)) {

            oItemCfg = oItem.cfg;

            switch(oEvent.keyCode) {

                case 37:    // Left arrow
                case 39:    // Right arrow

                    if(oItem == this.activeItem && !oItemCfg.getProperty(_SELECTED)) {

                        oItemCfg.setProperty(_SELECTED, true);

                    }
                    else {

                        oNextItem = (oEvent.keyCode == 37) ?
                            oItem.getPreviousEnabledSibling() :
                            oItem.getNextEnabledSibling();

                        if(oNextItem) {

                            this.clearActiveItem();

                            oNextItem.cfg.setProperty(_SELECTED, true);

    						oSubmenu = oNextItem.cfg.getProperty(_SUBMENU);

    						if(oSubmenu) {

    							oSubmenu.show();
    							oSubmenu.setInitialFocus();

    						}
    						else {
    							oNextItem.focus();
    						}

                        }

                    }

                    Event.preventDefault(oEvent);

                break;

                case 40:    // Down arrow

                    if(this.activeItem != oItem) {

                        this.clearActiveItem();

                        oItemCfg.setProperty(_SELECTED, true);
                        oItem.focus();

                    }

                    oSubmenu = oItemCfg.getProperty(_SUBMENU);

                    if(oSubmenu) {

                        if(oSubmenu.cfg.getProperty(_VISIBLE)) {

                            oSubmenu.setInitialSelection();
                            oSubmenu.setInitialFocus();

                        }
                        else {

                            oSubmenu.show();
                            oSubmenu.setInitialFocus();

                        }

                    }

                    Event.preventDefault(oEvent);

                break;

            }

        }

        if(oEvent.keyCode == 27 && this.activeItem) { // Esc key

            oSubmenu = this.activeItem.cfg.getProperty(_SUBMENU);

            if(oSubmenu && oSubmenu.cfg.getProperty(_VISIBLE)) {

                oSubmenu.hide();
                this.activeItem.focus();

            }
            else {

                this.activeItem.cfg.setProperty(_SELECTED, false);
                this.activeItem.blur();

            }

            Event.preventDefault(oEvent);

        }

    },

    /**
    * @method _onClick
    * @description "click" event handler for the menu bar.
    * @protected
    * @param {String} p_sType String representing the name of the event that
    * was fired.
    * @param {Array} p_aArgs Array of arguments sent when the event was fired.
    * @param {YAHOO.widget.MenuBar} p_oMenuBar Object representing the menu bar
    * that fired the event.
    */
    _onClick: function(p_sType, p_aArgs, p_oMenuBar) {

        MenuBar.superclass._onClick.call(this, p_sType, p_aArgs, p_oMenuBar);

        var oItem = p_aArgs[1],
            bReturnVal = true,
        	oItemEl,
            oEvent,
            oTarget,
            oActiveItem,
            oConfig,
            oSubmenu,
            nMenuItemX,
            nToggleRegion;

    	var toggleSubmenuDisplay = function () {

    		if(oSubmenu.cfg.getProperty(_VISIBLE)) {

    			oSubmenu.hide();

    		}
    		else {

    			oSubmenu.show();

    		}

    	};

        if(oItem && !oItem.cfg.getProperty(_DISABLED)) {

            oEvent = p_aArgs[0];
            oTarget = Event.getTarget(oEvent);
            oActiveItem = this.activeItem;
            oConfig = this.cfg;

            // Hide any other submenus that might be visible

            if(oActiveItem && oActiveItem != oItem) {

                this.clearActiveItem();

            }

            oItem.cfg.setProperty(_SELECTED, true);

            // Show the submenu for the item

            oSubmenu = oItem.cfg.getProperty(_SUBMENU);

            if(oSubmenu) {

    			oItemEl = oItem.element;
    			nMenuItemX = YAHOO.util.Dom.getX(oItemEl);
    			nToggleRegion = nMenuItemX + (oItemEl.offsetWidth - this.SUBMENU_TOGGLE_REGION_WIDTH);

    			if (oConfig.getProperty(_SUBMENU_TOGGLE_REGION)) {

    				if (Event.getPageX(oEvent) > nToggleRegion) {

    					toggleSubmenuDisplay();

    					Event.preventDefault(oEvent);

    					/*
    						 Return false so that other click event handlers are not called when the
    						 user clicks inside the toggle region.
    					*/
    					bReturnVal = false;

    				}

            	}
    			else {

    				toggleSubmenuDisplay();

                }

            }

        }

    	return bReturnVal;

    },

    // Public methods

    /**
    * @method configSubmenuToggle
    * @description Event handler for when the "submenutoggleregion" configuration property of
    * a MenuBar changes.
    * @param {String} p_sType The name of the event that was fired.
    * @param {Array} p_aArgs Collection of arguments sent when the event was fired.
    */
    configSubmenuToggle: function (p_sType, p_aArgs) {

    	var bSubmenuToggle = p_aArgs[0];

    	if (bSubmenuToggle) {

    		this.cfg.setProperty(_AUTO_SUBMENU_DISPLAY, false);

    	}

    },

    /**
    * @method toString
    * @description Returns a string representing the menu bar.
    * @return {String}
    */
    toString: function() {

        var sReturnVal = _MENUBAR,
            sId = this.id;

        if(sId) {

            sReturnVal += (_SPACE + sId);

        }

        return sReturnVal;

    },

    /**
    * @description Initializes the class's configurable properties which can be
    * changed using the menu bar's Config object ("cfg").
    * @method initDefaultConfig
    */
    initDefaultConfig: function() {

        MenuBar.superclass.initDefaultConfig.call(this);

        var oConfig = this.cfg;

    	// Add configuration properties

        /*
            Set the default value for the "position" configuration property
            to "static" by re-adding the property.
        */

        /**
        * @config position
        * @description String indicating how a menu bar should be positioned on the
        * screen.  Possible values are "static" and "dynamic."  Static menu bars
        * are visible by default and reside in the normal flow of the document
        * (CSS position: static).  Dynamic menu bars are hidden by default, reside
        * out of the normal flow of the document (CSS position: absolute), and can
        * overlay other elements on the screen.
        * @default static
        * @type String
        */
        oConfig.addProperty(
            POSITION_CONFIG.key,
            {
                handler: this.configPosition,
                value: POSITION_CONFIG.value,
                validator: POSITION_CONFIG.validator,
                supercedes: POSITION_CONFIG.supercedes
            }
        );

        /*
            Set the default value for the "submenualignment" configuration property
            to ["tl","bl"] by re-adding the property.
        */

        /**
        * @config submenualignment
        * @description Array defining how submenus should be aligned to their
        * parent menu bar item. The format is: [itemCorner, submenuCorner].
        * @default ["tl","bl"]
        * @type Array
        */
        oConfig.addProperty(
            SUBMENU_ALIGNMENT_CONFIG.key,
            {
                value: SUBMENU_ALIGNMENT_CONFIG.value,
                suppressEvent: SUBMENU_ALIGNMENT_CONFIG.suppressEvent
            }
        );

        /*
            Change the default value for the "autosubmenudisplay" configuration
            property to "false" by re-adding the property.
        */

        /**
        * @config autosubmenudisplay
        * @description Boolean indicating if submenus are automatically made
        * visible when the user mouses over the menu bar's items.
        * @default false
        * @type Boolean
        */
    	oConfig.addProperty(
    	   AUTO_SUBMENU_DISPLAY_CONFIG.key,
    	   {
    	       value: AUTO_SUBMENU_DISPLAY_CONFIG.value,
    	       validator: AUTO_SUBMENU_DISPLAY_CONFIG.validator,
    	       suppressEvent: AUTO_SUBMENU_DISPLAY_CONFIG.suppressEvent
           }
        );

        /**
        * @config submenutoggleregion
        * @description Boolean indicating if only a specific region of a MenuBarItem should toggle the
        * display of a submenu.  The default width of the region is determined by the value of the
        * SUBMENU_TOGGLE_REGION_WIDTH property.  If set to true, the autosubmenudisplay
        * configuration property will be set to false, and any click event listeners will not be
        * called when the user clicks inside the submenu toggle region of a MenuBarItem.  If the
        * user clicks outside of the submenu toggle region, the MenuBarItem will maintain its
        * standard behavior.
        * @default false
        * @type Boolean
        */
    	oConfig.addProperty(
    	   SUBMENU_TOGGLE_REGION_CONFIG.key,
    	   {
    	       value: SUBMENU_TOGGLE_REGION_CONFIG.value,
    	       validator: SUBMENU_TOGGLE_REGION_CONFIG.validator,
    	       handler: this.configSubmenuToggle
           }
        );

    }

    }); // END YAHOO.lang.extend

    }());

Copyright © 2010 Yahoo! Inc. All rights reserved.