/**
* The Menu class creates a container that holds a vertical list representing
* a set of options or commands. Menu is the base class for all
* menu containers.
* @param {String} p_oElement String specifying the id attribute of the
* <code><div></code> element of the menu.
* @param {String} p_oElement String specifying the id attribute of the
* <code><select></code> element to be used as the data source
* for the menu.
* @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><div></code> element of the menu.
* @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><select></code> element to be used as
* the data source for the menu.
* @param {Object} p_oConfig Optional. Object literal specifying the
* configuration for the menu. See configuration class documentation for
* more details.
* @namespace YAHOO.widget
* @class Menu
* @constructor
* @extends YAHOO.widget.Overlay
*/
(function() {
var Dom = YAHOO.util.Dom,
Event = YAHOO.util.Event,
Lang = YAHOO.lang;
YAHOO.widget.Menu = function(p_oElement, p_oConfig) {
if(p_oConfig) {
this.parent = p_oConfig.parent;
this.lazyLoad = p_oConfig.lazyLoad || p_oConfig.lazyload;
this.itemData = p_oConfig.itemData || p_oConfig.itemdata;
}
YAHOO.widget.Menu.superclass.constructor.call(
this,
p_oElement,
p_oConfig
);
};
YAHOO.lang.extend(YAHOO.widget.Menu, YAHOO.widget.Overlay, {
// Constants
/**
* @property CSS_CLASS_NAME
* @description String representing the CSS class(es) to be applied to the
* menu's <code><div></code> element.
* @default "yuimenu"
* @final
* @type String
*/
CSS_CLASS_NAME: "yuimenu",
/**
* @property ITEM_TYPE
* @description Object representing the type of menu item to instantiate and
* add when parsing the child nodes (either <code><li></code> element,
* <code><optgroup></code> element or <code><option></code>)
* of the menu's source HTML element.
* @default YAHOO.widget.MenuItem
* @final
* @type YAHOO.widget.MenuItem
*/
ITEM_TYPE: null,
/**
* @property GROUP_TITLE_TAG_NAME
* @description String representing the tagname of the HTML element used to
* title the menu's item groups.
* @default H6
* @final
* @type String
*/
GROUP_TITLE_TAG_NAME: "h6",
// Private properties
/**
* @property _nHideDelayId
* @description Number representing the time-out setting used to cancel the
* hiding of a menu.
* @default null
* @private
* @type Number
*/
_nHideDelayId: null,
/**
* @property _nShowDelayId
* @description Number representing the time-out setting used to cancel the
* showing of a menu.
* @default null
* @private
* @type Number
*/
_nShowDelayId: null,
/**
* @property _nSubmenuHideDelayId
* @description Number representing the time-out setting used to cancel the
* hiding of a submenu.
* @default null
* @private
* @type Number
*/
_nSubmenuHideDelayId: null,
/**
* @property _nBodyScrollId
* @description Number representing the time-out setting used to cancel the
* scrolling of the menu's body element.
* @default null
* @private
* @type Number
*/
_nBodyScrollId: null,
/**
* @property _bHideDelayEventHandlersAssigned
* @description Boolean indicating if the "mouseover" and "mouseout" event
* handlers used for hiding the menu via a call to "window.setTimeout" have
* already been assigned.
* @default false
* @private
* @type Boolean
*/
_bHideDelayEventHandlersAssigned: false,
/**
* @property _bHandledMouseOverEvent
* @description Boolean indicating the current state of the menu's
* "mouseover" event.
* @default false
* @private
* @type Boolean
*/
_bHandledMouseOverEvent: false,
/**
* @property _bHandledMouseOutEvent
* @description Boolean indicating the current state of the menu's
* "mouseout" event.
* @default false
* @private
* @type Boolean
*/
_bHandledMouseOutEvent: false,
/**
* @property _aGroupTitleElements
* @description Array of HTML element used to title groups of menu items.
* @default []
* @private
* @type Array
*/
_aGroupTitleElements: null,
/**
* @property _aItemGroups
* @description Multi-dimensional Array representing the menu items as they
* are grouped in the menu.
* @default []
* @private
* @type Array
*/
_aItemGroups: null,
/**
* @property _aListElements
* @description Array of <code><ul></code> elements, each of which is
* the parent node for each item's <code><li></code> element.
* @default []
* @private
* @type Array
*/
_aListElements: null,
/**
* @property _nCurrentMouseX
* @description The current x coordinate of the mouse inside the area of
* the menu.
* @default 0
* @private
* @type Number
*/
_nCurrentMouseX: 0,
/**
* @property _nMaxHeight
* @description The original value of the "maxheight" configuration property
* as set by the user.
* @default -1
* @private
* @type Number
*/
_nMaxHeight: -1,
/**
* @property _bStopMouseEventHandlers
* @description Stops "mouseover," "mouseout," and "mousemove" event handlers
* from executing.
* @default false
* @private
* @type Boolean
*/
_bStopMouseEventHandlers: false,
/**
* @property _sClassName
* @description The current value of the "classname" configuration attribute.
* @default null
* @private
* @type String
*/
_sClassName: null,
// Public properties
/**
* @property lazyLoad
* @description Boolean indicating if the menu's "lazy load" feature is
* enabled. If set to "true," initialization and rendering of the menu's
* items will be deferred until the first time it is made visible. This
* property should be set via the constructor using the configuration
* object literal.
* @default false
* @type Boolean
*/
lazyLoad: false,
/**
* @property itemData
* @description Array of items to be added to the menu. The array can contain
* strings representing the text for each item to be created, object literals
* representing the menu item configuration properties, or MenuItem instances.
* This property should be set via the constructor using the configuration
* object literal.
* @default null
* @type Array
*/
itemData: null,
/**
* @property activeItem
* @description Object reference to the item in the menu that has focus.
* @default null
* @type YAHOO.widget.MenuItem
*/
activeItem: null,
/**
* @property parent
* @description Object reference to the menu's parent menu or menu item.
* This property can be set via the constructor using the configuration
* object literal.
* @default null
* @type YAHOO.widget.MenuItem
*/
parent: null,
/**
* @property srcElement
* @description Object reference to the HTML element (either
* <code><select></code> or <code><div></code>) used to
* create the menu.
* @default null
* @type <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
* level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
* href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
* html#ID-22445964">HTMLDivElement</a>
*/
srcElement: null,
// Events
/**
* @event mouseOverEvent
* @description Fires when the mouse has entered the menu. Passes back
* the DOM Event object as an argument.
*/
mouseOverEvent: null,
/**
* @event mouseOutEvent
* @description Fires when the mouse has left the menu. Passes back the DOM
* Event object as an argument.
* @type YAHOO.util.CustomEvent
*/
mouseOutEvent: null,
/**
* @event mouseDownEvent
* @description Fires when the user mouses down on the menu. Passes back the
* DOM Event object as an argument.
* @type YAHOO.util.CustomEvent
*/
mouseDownEvent: null,
/**
* @event mouseUpEvent
* @description Fires when the user releases a mouse button while the mouse is
* over the menu. Passes back the DOM Event object as an argument.
* @type YAHOO.util.CustomEvent
*/
mouseUpEvent: null,
/**
* @event clickEvent
* @description Fires when the user clicks the on the menu. Passes back the
* DOM Event object as an argument.
* @type YAHOO.util.CustomEvent
*/
clickEvent: null,
/**
* @event keyPressEvent
* @description Fires when the user presses an alphanumeric key when one of the
* menu's items has focus. Passes back the DOM Event object as an argument.
* @type YAHOO.util.CustomEvent
*/
keyPressEvent: null,
/**
* @event keyDownEvent
* @description Fires when the user presses a key when one of the menu's items
* has focus. Passes back the DOM Event object as an argument.
* @type YAHOO.util.CustomEvent
*/
keyDownEvent: null,
/**
* @event keyUpEvent
* @description Fires when the user releases a key when one of the menu's items
* has focus. Passes back the DOM Event object as an argument.
* @type YAHOO.util.CustomEvent
*/
keyUpEvent: null,
/**
* @event itemAddedEvent
* @description Fires when an item is added to the menu.
* @type YAHOO.util.CustomEvent
*/
itemAddedEvent: null,
/**
* @event itemRemovedEvent
* @description Fires when an item is removed to the menu.
* @type YAHOO.util.CustomEvent
*/
itemRemovedEvent: null,
/**
* @method init
* @description The Menu 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><div></code> element of the menu.
* @param {String} p_oElement String specifying the id attribute of the
* <code><select></code> element to be used as the data source
* for the menu.
* @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><div></code> element of the menu.
* @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><select></code> element to be used as
* the data source for the menu.
* @param {Object} p_oConfig Optional. Object literal specifying the
* configuration for the menu. See configuration class documentation for
* more details.
*/
init: function(p_oElement, p_oConfig) {
this._aItemGroups = [];
this._aListElements = [];
this._aGroupTitleElements = [];
if(!this.ITEM_TYPE) {
this.ITEM_TYPE = YAHOO.widget.MenuItem;
}
var oElement;
if(typeof p_oElement == "string") {
oElement = document.getElementById(p_oElement);
}
else if(p_oElement.tagName) {
oElement = p_oElement;
}
if(oElement && oElement.tagName) {
switch(oElement.tagName.toUpperCase()) {
case "DIV":
this.srcElement = oElement;
if(!oElement.id) {
oElement.setAttribute("id", Dom.generateId());
}
/*
Note: we don't pass the user config in here yet
because we only want it executed once, at the lowest
subclass level.
*/
YAHOO.widget.Menu.superclass.init.call(this, oElement);
this.beforeInitEvent.fire(YAHOO.widget.Menu);
this.logger = new YAHOO.widget.LogWriter(this.toString());
this.logger.log("Source element: " + this.srcElement.tagName);
break;
case "SELECT":
this.srcElement = oElement;
/*
The source element is not something that we can use
outright, so we need to create a new Overlay
Note: we don't pass the user config in here yet
because we only want it executed once, at the lowest
subclass level.
*/
YAHOO.widget.Menu.superclass.init.call(this, Dom.generateId());
this.beforeInitEvent.fire(YAHOO.widget.Menu);
this.logger = new YAHOO.widget.LogWriter(this.toString());
this.logger.log("Source element: " + this.srcElement.tagName);
break;
}
}
else {
/*
Note: we don't pass the user config in here yet
because we only want it executed once, at the lowest
subclass level.
*/
YAHOO.widget.Menu.superclass.init.call(this, p_oElement);
this.beforeInitEvent.fire(YAHOO.widget.Menu);
this.logger = new YAHOO.widget.LogWriter(this.toString());
this.logger.log("No source element found. " +
"Created element with id: " + this.id);
}
if(this.element) {
var oEl = this.element;
Dom.addClass(oEl, this.CSS_CLASS_NAME);
// Subscribe to Custom Events
this.initEvent.subscribe(this._onInit, this, true);
this.beforeRenderEvent.subscribe(this._onBeforeRender, this, true);
this.renderEvent.subscribe(this._setWidth, this, true);
this.beforeShowEvent.subscribe(this._onBeforeShow, this, true);
this.showEvent.subscribe(this._onShow, this, true);
this.beforeHideEvent.subscribe(this._onBeforeHide, this, true);
this.hideEvent.subscribe(this._onHide, this, true);
this.mouseOverEvent.subscribe(this._onMouseOver, this, true);
this.mouseOutEvent.subscribe(this._onMouseOut, this, true);
this.clickEvent.subscribe(this._onClick, this, true);
this.keyDownEvent.subscribe(this._onKeyDown, this, true);
this.keyPressEvent.subscribe(this._onKeyPress, this, true);
YAHOO.widget.Module.textResizeEvent.subscribe(
this._onTextResize,
this,
true
);
if(p_oConfig) {
this.cfg.applyConfig(p_oConfig, true);
}
// Register the Menu instance with the MenuManager
YAHOO.widget.MenuManager.addMenu(this);
this.initEvent.fire(YAHOO.widget.Menu);
}
},
// Private methods
/**
* @method _initSubTree
* @description Iterates the childNodes of the source element to find nodes
* used to instantiate menu and menu items.
* @private
*/
_initSubTree: function() {
var oNode;
if(this.srcElement.tagName.toUpperCase() == "DIV") {
/*
Populate the collection of item groups and item
group titles
*/
oNode = this.body.firstChild;
var nGroup = 0,
sGroupTitleTagName = this.GROUP_TITLE_TAG_NAME.toUpperCase();
do {
if(oNode && oNode.tagName) {
switch(oNode.tagName.toUpperCase()) {
case sGroupTitleTagName:
this._aGroupTitleElements[nGroup] = oNode;
break;
case "UL":
this._aListElements[nGroup] = oNode;
this._aItemGroups[nGroup] = [];
nGroup++;
break;
}
}
}
while((oNode = oNode.nextSibling));
/*
Apply the "first-of-type" class to the first UL to mimic
the "first-of-type" CSS3 psuedo class.
*/
if(this._aListElements[0]) {
Dom.addClass(this._aListElements[0], "first-of-type");
}
}
oNode = null;
this.logger.log("Searching DOM for items to initialize.");
if(this.srcElement.tagName) {
var sSrcElementTagName = this.srcElement.tagName.toUpperCase();
switch(sSrcElementTagName) {
case "DIV":
if(this._aListElements.length > 0) {
this.logger.log("Found " +
this._aListElements.length +
" item groups to initialize.");
var i = this._aListElements.length - 1;
do {
oNode = this._aListElements[i].firstChild;
this.logger.log("Scanning " +
this._aListElements[i].childNodes.length +
" child nodes for items to initialize.");
do {
if(
oNode &&
oNode.tagName &&
oNode.tagName.toUpperCase() == "LI"
) {
this.logger.log("Initializing " +
oNode.tagName + " node.");
this.addItem(
new this.ITEM_TYPE(
oNode,
{ parent: this }
),
i
);
}
}
while((oNode = oNode.nextSibling));
}
while(i--);
}
break;
case "SELECT":
this.logger.log("Scanning " +
this.srcElement.childNodes.length +
" child nodes for items to initialize.");
oNode = this.srcElement.firstChild;
do {
if(oNode && oNode.tagName) {
switch(oNode.tagName.toUpperCase()) {
case "OPTGROUP":
case "OPTION":
this.logger.log("Initializing " +
oNode.tagName + " node.");
this.addItem(
new this.ITEM_TYPE(
oNode,
{ parent: this }
)
);
break;
}
}
}
while((oNode = oNode.nextSibling));
break;
}
}
},
/**
* @method _getFirstEnabledItem
* @description Returns the first enabled item in the menu.
* @return {YAHOO.widget.MenuItem}
* @private
*/
_getFirstEnabledItem: function() {
var aItems = this.getItems(),
nItems = aItems.length,
oItem;
for(var i=0; i<nItems; i++) {
oItem = aItems[i];
if(
oItem &&
!oItem.cfg.getProperty("disabled") &&
oItem.element.style.display != "none"
) {
return oItem;
}
}
},
/**
* @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}
*/
_checkPosition: function(p_sPosition) {
if(typeof p_sPosition == "string") {
var sPosition = p_sPosition.toLowerCase();
return ("dynamic,static".indexOf(sPosition) != -1);
}
},
/**
* @method _addItemToGroup
* @description Adds a menu item to a group.
* @private
* @param {Number} p_nGroupIndex Number indicating the group to which the
* item belongs.
* @param {YAHOO.widget.MenuItem} p_oItem Object reference for the MenuItem
* instance to be added to the menu.
* @param {String} p_oItem String specifying the text of the item to be added
* to the menu.
* @param {Object} p_oItem Object literal containing a set of menu item
* configuration properties.
* @param {Number} p_nItemIndex Optional. Number indicating the index at
* which the menu item should be added.
* @return {YAHOO.widget.MenuItem}
*/
_addItemToGroup: function(p_nGroupIndex, p_oItem, p_nItemIndex) {
var oItem;
if(p_oItem instanceof this.ITEM_TYPE) {
oItem = p_oItem;
oItem.parent = this;
}
else if(typeof p_oItem == "string") {
oItem = new this.ITEM_TYPE(p_oItem, { parent: this });
}
else if(typeof p_oItem == "object") {
p_oItem.parent = this;
oItem = new this.ITEM_TYPE(p_oItem.text, p_oItem);
}
if(oItem) {
var nGroupIndex = typeof p_nGroupIndex == "number" ? p_nGroupIndex : 0,
aGroup = this._getItemGroup(nGroupIndex),
oGroupItem;
if(!aGroup) {
aGroup = this._createItemGroup(nGroupIndex);
}
if(typeof p_nItemIndex == "number") {
var bAppend = (p_nItemIndex >= aGroup.length);
if(aGroup[p_nItemIndex]) {
aGroup.splice(p_nItemIndex, 0, oItem);
}
else {
aGroup[p_nItemIndex] = oItem;
}
oGroupItem = aGroup[p_nItemIndex];
if(oGroupItem) {
if(
bAppend &&
(
!oGroupItem.element.parentNode ||
oGroupItem.element.parentNode.nodeType == 11
)
) {
this._aListElements[nGroupIndex].appendChild(
oGroupItem.element
);
}
else {
function getNextItemSibling(p_aArray, p_nStartIndex) {
return (
p_aArray[p_nStartIndex] ||
getNextItemSibling(
p_aArray,
(p_nStartIndex+1)
)
);
}
var oNextItemSibling =
getNextItemSibling(aGroup, (p_nItemIndex+1));
if(
oNextItemSibling &&
(
!oGroupItem.element.parentNode ||
oGroupItem.element.parentNode.nodeType == 11
)
) {
this._aListElements[nGroupIndex].insertBefore(
oGroupItem.element,
oNextItemSibling.element
);
}
}
oGroupItem.parent = this;
this._subscribeToItemEvents(oGroupItem);
this._configureSubmenu(oGroupItem);
this._updateItemProperties(nGroupIndex);
this.logger.log("Item inserted." +
" Text: " + oGroupItem.cfg.getProperty("text") + ", " +
" Index: " + oGroupItem.index + ", " +
" Group Index: " + oGroupItem.groupIndex);
this.itemAddedEvent.fire(oGroupItem);
return oGroupItem;
}
}
else {
var nItemIndex = aGroup.length;
aGroup[nItemIndex] = oItem;
oGroupItem = aGroup[nItemIndex];
if(oGroupItem) {
if(
!Dom.isAncestor(
this._aListElements[nGroupIndex],
oGroupItem.element
)
) {
this._aListElements[nGroupIndex].appendChild(
oGroupItem.element
);
}
oGroupItem.element.setAttribute("groupindex", nGroupIndex);
oGroupItem.element.setAttribute("index", nItemIndex);
oGroupItem.parent = this;
oGroupItem.index = nItemIndex;
oGroupItem.groupIndex = nGroupIndex;
this._subscribeToItemEvents(oGroupItem);
this._configureSubmenu(oGroupItem);
if(nItemIndex === 0) {
Dom.addClass(oGroupItem.element, "first-of-type");
}
this.logger.log("Item added." +
" Text: " + oGroupItem.cfg.getProperty("text") + ", " +
" Index: " + oGroupItem.index + ", " +
" Group Index: " + oGroupItem.groupIndex);
this.itemAddedEvent.fire(oGroupItem);
return oGroupItem;
}
}
}
},
/**
* @method _removeItemFromGroupByIndex
* @description Removes a menu item from a group by index. Returns the menu
* item that was removed.
* @private
* @param {Number} p_nGroupIndex Number indicating the group to which the menu
* item belongs.
* @param {Number} p_nItemIndex Number indicating the index of the menu item
* to be removed.
* @return {YAHOO.widget.MenuItem}
*/
_removeItemFromGroupByIndex: function(p_nGroupIndex, p_nItemIndex) {
var nGroupIndex = typeof p_nGroupIndex == "number" ? p_nGroupIndex : 0,
aGroup = this._getItemGroup(nGroupIndex);
if(aGroup) {
var aArray = aGroup.splice(p_nItemIndex, 1),
oItem = aArray[0];
if(oItem) {
// Update the index and className properties of each member
this._updateItemProperties(nGroupIndex);
if(aGroup.length === 0) {
// Remove the UL
var oUL = this._aListElements[nGroupIndex];
if(this.body && oUL) {
this.body.removeChild(oUL);
}
// Remove the group from the array of items
this._aItemGroups.splice(nGroupIndex, 1);
// Remove the UL from the array of ULs
this._aListElements.splice(nGroupIndex, 1);
/*
Assign the "first-of-type" class to the new first UL
in the collection
*/
oUL = this._aListElements[0];
if(oUL) {
Dom.addClass(oUL, "first-of-type");
}
}
this.itemRemovedEvent.fire(oItem);
// Return a reference to the item that was removed
return oItem;
}
}
},
/**
* @method _removeItemFromGroupByValue
* @description Removes a menu item from a group by reference. Returns the
* menu item that was removed.
* @private
* @param {Number} p_nGroupIndex Number indicating the group to which the
* menu item belongs.
* @param {YAHOO.widget.MenuItem} p_oItem Object reference for the MenuItem
* instance to be removed.
* @return {YAHOO.widget.MenuItem}
*/
_removeItemFromGroupByValue: function(p_nGroupIndex, p_oItem) {
var aGroup = this._getItemGroup(p_nGroupIndex);
if(aGroup) {
var nItems = aGroup.length,
nItemIndex = -1;
if(nItems > 0) {
var i = nItems-1;
do {
if(aGroup[i] == p_oItem) {
nItemIndex = i;
break;
}
}
while(i--);
if(nItemIndex > -1) {
return this._removeItemFromGroupByIndex(
p_nGroupIndex,
nItemIndex
);
}
}
}
},
/**
* @method _updateItemProperties
* @description Updates the "index," "groupindex," and "className" properties
* of the menu items in the specified group.
* @private
* @param {Number} p_nGroupIndex Number indicating the group of items to update.
*/
_updateItemProperties: function(p_nGroupIndex) {
var aGroup = this._getItemGroup(p_nGroupIndex),
nItems = aGroup.length;
if(nItems > 0) {
var i = nItems - 1,
oItem,
oLI;
// Update the index and className properties of each member
do {
oItem = aGroup[i];
if(oItem) {
oLI = oItem.element;
oItem.index = i;
oItem.groupIndex = p_nGroupIndex;
oLI.setAttribute("groupindex", p_nGroupIndex);
oLI.setAttribute("index", i);
Dom.removeClass(oLI, "first-of-type");
}
}
while(i--);
if(oLI) {
Dom.addClass(oLI, "first-of-type");
}
}
},
/**
* @method _createItemGroup
* @description Creates a new menu item group (array) and its associated
* <code><ul></code> element. Returns an aray of menu item groups.
* @private
* @param {Number} p_nIndex Number indicating the group to create.
* @return {Array}
*/
_createItemGroup: function(p_nIndex) {
if(!this._aItemGroups[p_nIndex]) {
this._aItemGroups[p_nIndex] = [];
var oUL = document.createElement("ul");
this._aListElements[p_nIndex] = oUL;
return this._aItemGroups[p_nIndex];
}
},
/**
* @method _getItemGroup
* @description Returns the menu item group at the specified index.
* @private
* @param {Number} p_nIndex Number indicating the index of the menu item group
* to be retrieved.
* @return {Array}
*/
_getItemGroup: function(p_nIndex) {
var nIndex = ((typeof p_nIndex == "number") ? p_nIndex : 0);
return this._aItemGroups[nIndex];
},
/**
* @method _configureSubmenu
* @description Subscribes the menu item's submenu to its parent menu's events.
* @private
* @param {YAHOO.widget.MenuItem} p_oItem Object reference for the MenuItem
* instance with the submenu to be configured.
*/
_configureSubmenu: function(p_oItem) {
var oSubmenu = p_oItem.cfg.getProperty("submenu");
if(oSubmenu) {
/*
Listen for configuration changes to the parent menu
so they they can be applied to the submenu.
*/
this.cfg.configChangedEvent.subscribe(
this._onParentMenuConfigChange,
oSubmenu,
true
);
this.renderEvent.subscribe(
this._onParentMenuRender,
oSubmenu,
true
);
oSubmenu.beforeShowEvent.subscribe(
this._onSubmenuBeforeShow,
oSubmenu,
true
);
oSubmenu.showEvent.subscribe(
this._onSubmenuShow,
oSubmenu,
true
);
oSubmenu.hideEvent.subscribe(
this._onSubmenuHide,
oSubmenu,
true
);
}
},
/**
* @method _subscribeToItemEvents
* @description Subscribes a menu to a menu item's event.
* @private
* @param {YAHOO.widget.MenuItem} p_oItem Object reference for the MenuItem
* instance whose events should be subscribed to.
*/
_subscribeToItemEvents: function(p_oItem) {
p_oItem.focusEvent.subscribe(this._onMenuItemFocus, p_oItem, this);
p_oItem.blurEvent.subscribe(this._onMenuItemBlur, this, true);
p_oItem.cfg.configChangedEvent.subscribe(
this._onMenuItemConfigChange,
p_oItem,
this
);
},
/**
* @method _getOffsetWidth
* @description Returns the offset width of the menu's
* <code><div></code> element.
* @private
*/
_getOffsetWidth: function() {
var oClone = this.element.cloneNode(true);
Dom.setStyle(oClone, "width", "");
document.body.appendChild(oClone);
var sWidth = oClone.offsetWidth;
document.body.removeChild(oClone);
return sWidth;
},
/**
* @method _setWidth
* @description Sets the width of the menu's root <code><div></code>
* element to its offsetWidth.
* @private
*/
_setWidth: function() {
if(this.cfg.getProperty("position") == "dynamic") {
var sWidth;
if(this.element.parentNode.tagName.toUpperCase() == "BODY") {
if(this.browser == "opera") {
sWidth = this._getOffsetWidth();
}
else {
Dom.setStyle(this.element, "width", "auto");
sWidth = this.element.offsetWidth;
}
}
else {
sWidth = this._getOffsetWidth();
}
this.cfg.setProperty("width", (sWidth + "px"));
}
},
/**
* @method _cancelHideDelay
* @description Cancels the call to "hideMenu."
* @private
*/
_cancelHideDelay: function() {
var oRoot = this.getRoot();
if(oRoot._nHideDelayId) {
window.clearTimeout(oRoot._nHideDelayId);
}
},
/**
* @method _execHideDelay
* @description Hides the menu after the number of milliseconds specified by
* the "hidedelay" configuration property.
* @private
*/
_execHideDelay: function() {
this._cancelHideDelay();
var oRoot = this.getRoot(),
me = this;
function hideMenu() {
if(oRoot.activeItem) {
oRoot.clearActiveItem();
}
if(oRoot == me && me.cfg.getProperty("position") == "dynamic") {
me.hide();
}
}
oRoot._nHideDelayId =
window.setTimeout(hideMenu, oRoot.cfg.getProperty("hidedelay"));
},
/**
* @method _cancelShowDelay
* @description Cancels the call to the "showMenu."
* @private
*/
_cancelShowDelay: function() {
var oRoot = this.getRoot();
if(oRoot._nShowDelayId) {
window.clearTimeout(oRoot._nShowDelayId);
}
},
/**
* @method _execShowDelay
* @description Shows the menu after the number of milliseconds specified by
* the "showdelay" configuration property have ellapsed.
* @private
* @param {YAHOO.widget.Menu} p_oMenu Object specifying the menu that should
* be made visible.
*/
_execShowDelay: function(p_oMenu) {
var oRoot = this.getRoot();
function showMenu() {
if(p_oMenu.parent.cfg.getProperty("selected")) {
p_oMenu.show();
}
}
oRoot._nShowDelayId =
window.setTimeout(showMenu, oRoot.cfg.getProperty("showdelay"));
},
/**
* @method _execSubmenuHideDelay
* @description Hides a submenu after the number of milliseconds specified by
* the "submenuhidedelay" configuration property have ellapsed.
* @private
* @param {YAHOO.widget.Menu} p_oSubmenu Object specifying the submenu that
* should be hidden.
* @param {Number} p_nMouseX The x coordinate of the mouse when it left
* the specified submenu's parent menu item.
* @param {Number} p_nHideDelay The number of milliseconds that should ellapse
* before the submenu is hidden.
*/
_execSubmenuHideDelay: function(p_oSubmenu, p_nMouseX, p_nHideDelay) {
var me = this;
p_oSubmenu._nSubmenuHideDelayId = window.setTimeout(function () {
if(me._nCurrentMouseX > (p_nMouseX + 10)) {
p_oSubmenu._nSubmenuHideDelayId = window.setTimeout(function () {
p_oSubmenu.hide();
}, p_nHideDelay);
}
else {
p_oSubmenu.hide();
}
}, 50);
},
// Protected methods
/**
* @method _disableScrollHeader
* @description Disables the header used for scrolling the body of the menu.
* @protected
*/
_disableScrollHeader: function() {
if(!this._bHeaderDisabled) {
Dom.addClass(this.header, "topscrollbar_disabled");
this._bHeaderDisabled = true;
}
},
/**
* @method _disableScrollFooter
* @description Disables the footer used for scrolling the body of the menu.
* @protected
*/
_disableScrollFooter: function() {
if(!this._bFooterDisabled) {
Dom.addClass(this.footer, "bottomscrollbar_disabled");
this._bFooterDisabled = true;
}
},
/**
* @method _enableScrollHeader
* @description Enables the header used for scrolling the body of the menu.
* @protected
*/
_enableScrollHeader: function() {
if(this._bHeaderDisabled) {
Dom.removeClass(this.header, "topscrollbar_disabled");
this._bHeaderDisabled = false;
}
},
/**
* @method _enableScrollFooter
* @description Enables the footer used for scrolling the body of the menu.
* @protected
*/
_enableScrollFooter: function() {
if(this._bFooterDisabled) {
Dom.removeClass(this.footer, "bottomscrollbar_disabled");
this._bFooterDisabled = false;
}
},
/**
* @method _onMouseOver
* @description "mouseover" event handler for the menu.
* @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.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
_onMouseOver: function(p_sType, p_aArgs, p_oMenu) {
if(this._bStopMouseEventHandlers) {
return false;
}
var oEvent = p_aArgs[0],
oItem = p_aArgs[1],
oTarget = Event.getTarget(oEvent);
if(
!this._bHandledMouseOverEvent &&
(oTarget == this.element || Dom.isAncestor(this.element, oTarget))
) {
// Menu mouseover logic
this._nCurrentMouseX = 0;
Event.addListener(
this.element,
"mousemove",
this._onMouseMove,
this,
true
);
this.clearActiveItem();
if(this.parent && this._nSubmenuHideDelayId) {
window.clearTimeout(this._nSubmenuHideDelayId);
this.parent.cfg.setProperty("selected", true);
var oParentMenu = this.parent.parent;
oParentMenu.activeItem = this.parent;
oParentMenu._bHandledMouseOutEvent = true;
oParentMenu._bHandledMouseOverEvent = false;
}
this._bHandledMouseOverEvent = true;
this._bHandledMouseOutEvent = false;
}
if(
oItem && !oItem.handledMouseOverEvent &&
!oItem.cfg.getProperty("disabled") &&
(oTarget == oItem.element || Dom.isAncestor(oItem.element, oTarget))
) {
// Menu Item mouseover logic
var nShowDelay = this.cfg.getProperty("showdelay"),
bShowDelay = (nShowDelay > 0);
if(bShowDelay) {
this._cancelShowDelay();
}
var oActiveItem = this.activeItem;
if(oActiveItem) {
oActiveItem.cfg.setProperty("selected", false);
}
var oItemCfg = oItem.cfg;
// Select and focus the current menu item
oItemCfg.setProperty("selected", true);
oItem.focus();
if(this.cfg.getProperty("autosubmenudisplay")) {
// Show the submenu this menu item
var oSubmenu = oItemCfg.getProperty("submenu");
if(oSubmenu) {
if(bShowDelay) {
this._execShowDelay(oSubmenu);
}
else {
oSubmenu.show();
}
}
}
oItem.handledMouseOverEvent = true;
oItem.handledMouseOutEvent = false;
}
},
/**
* @method _onMouseOut
* @description "mouseout" event handler for the menu.
* @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.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
_onMouseOut: function(p_sType, p_aArgs, p_oMenu) {
if(this._bStopMouseEventHandlers) {
return false;
}
var oEvent = p_aArgs[0],
oItem = p_aArgs[1],
oRelatedTarget = Event.getRelatedTarget(oEvent),
bMovingToSubmenu = false;
if(oItem && !oItem.cfg.getProperty("disabled")) {
var oItemCfg = oItem.cfg,
oSubmenu = oItemCfg.getProperty("submenu");
if(
oSubmenu &&
(
oRelatedTarget == oSubmenu.element ||
Dom.isAncestor(oSubmenu.element, oRelatedTarget)
)
) {
bMovingToSubmenu = true;
}
if(
!oItem.handledMouseOutEvent &&
(
(
oRelatedTarget != oItem.element &&
!Dom.isAncestor(oItem.element, oRelatedTarget)
) || bMovingToSubmenu
)
) {
// Menu Item mouseout logic
if(!bMovingToSubmenu) {
oItem.cfg.setProperty("selected", false);
if(oSubmenu) {
var nSubmenuHideDelay =
this.cfg.getProperty("submenuhidedelay"),
nShowDelay = this.cfg.getProperty("showdelay");
if(
!(this instanceof YAHOO.widget.MenuBar) &&
nSubmenuHideDelay > 0 &&
nShowDelay >= nSubmenuHideDelay
) {
this._execSubmenuHideDelay(
oSubmenu,
Event.getPageX(oEvent),
nSubmenuHideDelay
);
}
else {
oSubmenu.hide();
}
}
}
oItem.handledMouseOutEvent = true;
oItem.handledMouseOverEvent = false;
}
}
if(
!this._bHandledMouseOutEvent &&
(
(
oRelatedTarget != this.element &&
!Dom.isAncestor(this.element, oRelatedTarget)
)
|| bMovingToSubmenu
)
) {
// Menu mouseout logic
Event.removeListener(this.element, "mousemove", this._onMouseMove);
this._nCurrentMouseX = Event.getPageX(oEvent);
this._bHandledMouseOutEvent = true;
this._bHandledMouseOverEvent = false;
}
},
/**
* @method _onMouseMove
* @description "click" event handler for the menu.
* @protected
* @param {Event} p_oEvent Object representing the DOM event object passed
* back by the event utility (YAHOO.util.Event).
* @param {YAHOO.widget.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
_onMouseMove: function(p_oEvent, p_oMenu) {
if(this._bStopMouseEventHandlers) {
return false;
}
this._nCurrentMouseX = Event.getPageX(p_oEvent);
},
/**
* @method _onClick
* @description "click" event handler for the menu.
* @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.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
_onClick: function(p_sType, p_aArgs, p_oMenu) {
var oEvent = p_aArgs[0],
oItem = p_aArgs[1],
oTarget = Event.getTarget(oEvent);
if(oItem && !oItem.cfg.getProperty("disabled")) {
var oItemCfg = oItem.cfg,
oSubmenu = oItemCfg.getProperty("submenu");
/*
ACCESSIBILITY FEATURE FOR SCREEN READERS:
Expand/collapse the submenu when the user clicks
on the submenu indicator image.
*/
if(oTarget == oItem.submenuIndicator && oSubmenu) {
if(oSubmenu.cfg.getProperty("visible")) {
oSubmenu.hide();
oSubmenu.parent.focus();
}
else {
this.clearActiveItem();
this.activeItem = oItem;
oItem.cfg.setProperty("selected", true);
oSubmenu.show();
}
}
else {
var sURL = oItemCfg.getProperty("url"),
bCurrentPageURL = (sURL.substr((sURL.length-1),1) == "#"),
sTarget = oItemCfg.getProperty("target"),
bHasTarget = (sTarget && sTarget.length > 0);
/*
Prevent the browser from following links
equal to "#"
*/
if(
oTarget.tagName.toUpperCase() == "A" &&
bCurrentPageURL && !bHasTarget
) {
Event.preventDefault(oEvent);
}
if(
oTarget.tagName.toUpperCase() != "A" &&
!bCurrentPageURL && !bHasTarget
) {
/*
Follow the URL of the item regardless of
whether or not the user clicked specifically
on the anchor element.
*/
document.location = sURL;
}
/*
If the item doesn't navigate to a URL and it doesn't have
a submenu, then collapse the menu tree.
*/
if(bCurrentPageURL && !oSubmenu) {
var oRoot = this.getRoot();
if(oRoot.cfg.getProperty("position") == "static") {
oRoot.clearActiveItem();
}
else if(oRoot.cfg.getProperty("clicktohide")) {
oRoot.hide();
}
}
}
}
},
/**
* @method _onKeyDown
* @description "keydown" event handler for the menu.
* @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.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
_onKeyDown: function(p_sType, p_aArgs, p_oMenu) {
var oEvent = p_aArgs[0],
oItem = p_aArgs[1],
me = this,
oSubmenu;
/*
This function is called to prevent a bug in Firefox. In Firefox,
moving a DOM element into a stationary mouse pointer will cause the
browser to fire mouse events. This can result in the menu mouse
event handlers being called uncessarily, especially when menus are
moved into a stationary mouse pointer as a result of a
key event handler.
*/
function stopMouseEventHandlers() {
me._bStopMouseEventHandlers = true;
window.setTimeout(function() {
me._bStopMouseEventHandlers = false;
}, 10);
}
if(oItem && !oItem.cfg.getProperty("disabled")) {
var oItemCfg = oItem.cfg,
oParentItem = this.parent,
oRoot,
oNextItem;
switch(oEvent.keyCode) {
case 38: // Up arrow
case 40: // Down arrow
if(
oItem == this.activeItem &&
!oItemCfg.getProperty("selected")
) {
oItemCfg.setProperty("selected", true);
}
else {
oNextItem = (oEvent.keyCode == 38) ?
oItem.getPreviousEnabledSibling() :
oItem.getNextEnabledSibling();
if(oNextItem) {
this.clearActiveItem();
oNextItem.cfg.setProperty("selected", true);
oNextItem.focus();
if(this.cfg.getProperty("maxheight") > 0) {
var oBody = this.body;
oBody.scrollTop =
(
oNextItem.element.offsetTop +
oNextItem.element.offsetHeight
) - oBody.offsetHeight;
var nScrollTop = oBody.scrollTop,
nScrollTarget =
oBody.scrollHeight - oBody.offsetHeight;
if(nScrollTop === 0) {
this._disableScrollHeader();
this._enableScrollFooter();
}
else if(nScrollTop == nScrollTarget) {
this._enableScrollHeader();
this._disableScrollFooter();
}
else {
this._enableScrollHeader();
this._enableScrollFooter();
}
}
}
}
Event.preventDefault(oEvent);
stopMouseEventHandlers();
break;
case 39: // Right arrow
oSubmenu = oItemCfg.getProperty("submenu");
if(oSubmenu) {
if(!oItemCfg.getProperty("selected")) {
oItemCfg.setProperty("selected", true);
}
oSubmenu.show();
oSubmenu.setInitialSelection();
}
else {
oRoot = this.getRoot();
if(oRoot instanceof YAHOO.widget.MenuBar) {
oNextItem = oRoot.activeItem.getNextEnabledSibling();
if(oNextItem) {
oRoot.clearActiveItem();
oNextItem.cfg.setProperty("selected", true);
oSubmenu = oNextItem.cfg.getProperty("submenu");
if(oSubmenu) {
oSubmenu.show();
}
oNextItem.focus();
}
}
}
Event.preventDefault(oEvent);
stopMouseEventHandlers();
break;
case 37: // Left arrow
if(oParentItem) {
var oParentMenu = oParentItem.parent;
if(oParentMenu instanceof YAHOO.widget.MenuBar) {
oNextItem =
oParentMenu.activeItem.getPreviousEnabledSibling();
if(oNextItem) {
oParentMenu.clearActiveItem();
oNextItem.cfg.setProperty("selected", true);
oSubmenu = oNextItem.cfg.getProperty("submenu");
if(oSubmenu) {
oSubmenu.show();
}
oNextItem.focus();
}
}
else {
this.hide();
oParentItem.focus();
}
}
Event.preventDefault(oEvent);
stopMouseEventHandlers();
break;
}
}
if(oEvent.keyCode == 27) { // Esc key
if(this.cfg.getProperty("position") == "dynamic") {
this.hide();
if(this.parent) {
this.parent.focus();
}
}
else if(this.activeItem) {
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 _onKeyPress
* @description "keypress" event handler for a Menu instance.
* @protected
* @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.
* @param {YAHOO.widget.Menu} p_oMenu The Menu instance that fired the event.
*/
_onKeyPress: function(p_sType, p_aArgs, p_oMenu) {
var oEvent = p_aArgs[0];
if(oEvent.keyCode == 40 || oEvent.keyCode == 38) {
YAHOO.util.Event.preventDefault(oEvent);
}
},
/**
* @method _onTextResize
* @description "textresize" event handler for the menu.
* @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.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
_onTextResize: function(p_sType, p_aArgs, p_oMenu) {
if(this.browser == "gecko" && !this._handleResize) {
this._handleResize = true;
return;
}
var oConfig = this.cfg;
if(oConfig.getProperty("position") == "dynamic") {
oConfig.setProperty("width", (this._getOffsetWidth() + "px"));
}
},
/**
* @method _onScrollTargetMouseOver
* @description "mouseover" event handler for the menu's "header" and "footer"
* elements. Used to scroll the body of the menu up and down when the
* menu's "maxheight" configuration property is set to a value greater than 0.
* @protected
* @param {Event} p_oEvent Object representing the DOM event object passed
* back by the event utility (YAHOO.util.Event).
* @param {YAHOO.widget.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
_onScrollTargetMouseOver: function(p_oEvent, p_oMenu) {
this._cancelHideDelay();
var oTarget = Event.getTarget(p_oEvent),
oBody = this.body,
me = this,
nScrollTarget,
fnScrollFunction;
function scrollBodyDown() {
var nScrollTop = oBody.scrollTop;
if(nScrollTop < nScrollTarget) {
oBody.scrollTop = (nScrollTop + 1);
me._enableScrollHeader();
}
else {
oBody.scrollTop = nScrollTarget;
window.clearInterval(me._nBodyScrollId);
me._disableScrollFooter();
}
}
function scrollBodyUp() {
var nScrollTop = oBody.scrollTop;
if(nScrollTop > 0) {
oBody.scrollTop = (nScrollTop - 1);
me._enableScrollFooter();
}
else {
oBody.scrollTop = 0;
window.clearInterval(me._nBodyScrollId);
me._disableScrollHeader();
}
}
if(Dom.hasClass(oTarget, "hd")) {
fnScrollFunction = scrollBodyUp;
}
else {
nScrollTarget = oBody.scrollHeight - oBody.offsetHeight;
fnScrollFunction = scrollBodyDown;
}
this._nBodyScrollId = window.setInterval(fnScrollFunction, 10);
},
/**
* @method _onScrollTargetMouseOut
* @description "mouseout" event handler for the menu's "header" and "footer"
* elements. Used to stop scrolling the body of the menu up and down when the
* menu's "maxheight" configuration property is set to a value greater than 0.
* @protected
* @param {Event} p_oEvent Object representing the DOM event object passed
* back by the event utility (YAHOO.util.Event).
* @param {YAHOO.widget.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
_onScrollTargetMouseOut: function(p_oEvent, p_oMenu) {
window.clearInterval(this._nBodyScrollId);
this._cancelHideDelay();
},
// Private methods
/**
* @method _onInit
* @description "init" event handler for the menu.
* @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.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
_onInit: function(p_sType, p_aArgs, p_oMenu) {
if(
(
(this.parent && !this.lazyLoad) ||
(!this.parent && this.cfg.getProperty("position") == "static") ||
(
!this.parent &&
!this.lazyLoad &&
this.cfg.getProperty("position") == "dynamic"
)
) &&
this.getItemGroups().length === 0
) {
if(this.srcElement) {
this._initSubTree();
}
if(this.itemData) {
this.addItems(this.itemData);
}
}
else if(this.lazyLoad) {
this.cfg.fireQueue();
}
},
/**
* @method _onBeforeRender
* @description "beforerender" event handler for the menu. Appends all of the
* <code><ul></code>, <code><li></code> and their accompanying
* title elements to the body element of the menu.
* @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.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
_onBeforeRender: function(p_sType, p_aArgs, p_oMenu) {
var oConfig = this.cfg,
oEl = this.element,
nListElements = this._aListElements.length;
if(nListElements > 0) {
var i = 0,
bFirstList = true,
oUL,
oGroupTitle;
do {
oUL = this._aListElements[i];
if(oUL) {
if(bFirstList) {
Dom.addClass(oUL, "first-of-type");
bFirstList = false;
}
if(!Dom.isAncestor(oEl, oUL)) {
this.appendToBody(oUL);
}
oGroupTitle = this._aGroupTitleElements[i];
if(oGroupTitle) {
if(!Dom.isAncestor(oEl, oGroupTitle)) {
oUL.parentNode.insertBefore(oGroupTitle, oUL);
}
Dom.addClass(oUL, "hastitle");
}
}
i++;
}
while(i < nListElements);
}
},
/**
* @method _onBeforeShow
* @description "beforeshow" event handler for the menu.
* @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.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
_onBeforeShow: function(p_sType, p_aArgs, p_oMenu) {
if(this.lazyLoad && this.getItemGroups().length === 0) {
if(this.srcElement) {
this._initSubTree();
}
if(this.itemData) {
if(
this.parent && this.parent.parent &&
this.parent.parent.srcElement &&
this.parent.parent.srcElement.tagName.toUpperCase() == "SELECT"
) {
var nOptions = this.itemData.length;
for(var n=0; n<nOptions; n++) {
if(this.itemData[n].tagName) {
this.addItem((new this.ITEM_TYPE(this.itemData[n])));
}
}
}
else {
this.addItems(this.itemData);
}
}
var oSrcElement = this.srcElement;
if(oSrcElement) {
if(oSrcElement.tagName.toUpperCase() == "SELECT") {
if(Dom.inDocument(oSrcElement)) {
this.render(oSrcElement.parentNode);
}
else {
this.render(this.cfg.getProperty("container"));
}
}
else {
this.render();
}
}
else {
if(this.parent) {
this.render(this.parent.element);
}
else {
this.render(this.cfg.getProperty("container"));
}
}
}
if(this.cfg.getProperty("position") == "dynamic") {
var nViewportHeight = Dom.getViewportHeight();
if(this.element.offsetHeight >= nViewportHeight) {
var nMaxHeight = this.cfg.getProperty("maxheight");
/*
Cache the original value for the "maxheight" configuration
property so that we can set it back when the menu is hidden.
*/
this._nMaxHeight = nMaxHeight;
this.cfg.setProperty("maxheight", (nViewportHeight - 20));
}
if(this.cfg.getProperty("maxheight") > 0) {
var oBody = this.body;
if(oBody.scrollTop > 0) {
oBody.scrollTop = 0;
}
this._disableScrollHeader();
this._enableScrollFooter();
}
}
},
/**
* @method _onShow
* @description "show" event handler for the menu.
* @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.Menu} p_oMenu Object representing the menu that fired
* the event.
*/
_onShow: function(p_sType, p_aArgs, p_oMenu) {
this.setInitialFocus();
var oParent = this.parent;
if(oParent) {
var oParentMenu = oParent.parent,
aParentAlignment = oParentMenu.cfg.getProperty("submenualignment"),
aAlignment = this.cfg.getProperty("submenualignment");
if(
(aParentAlignment[0] != aAlignment[0]) &&
(aParentAlignment[1] != aAlignment[1])
) {
this.cfg.setProperty(
"submenualignment",
[ aParentAlignment[0], aParentAlignment[1] ]
);
}
if(
!oParentMenu.cfg.getProperty("autosubmenudisplay") &&
oParentMenu.cfg.getProperty("position") == "static"
) {
oParentMenu.cfg.setProperty("autosubmenudisplay", true);
function disableAutoSubmenuDisplay(p_oEvent) {
if(
p_oEvent.type == "mousedown" ||
(p_oEvent.type == "keydown" && p_oEvent.keyCode == 27)
) {
/*
Set the "autosubmenudisplay" to "false" if the user
clicks outside the menu bar.
*/
var oTarget = Event.getTarget(p_oEvent);
if(
oTarget != oParentMenu.element ||
!YAHOO.util.Dom.isAncestor(oParentMenu.element, oTarget)
) {
oParentMenu.cfg.setProperty(
"autosubmenudisplay",
false
);
Event.removeListener(
document,
"mousedown",
disableAutoSubmenuDisplay
);
Event.removeListener(
document,
"keydown",
disableAutoSubmenuDisplay
);
}
}
}
Event.addListener(document, "mousedown", disableAutoSubmenuDisplay);
Event.addListener(document, "keydown", disableAutoSubmenuDisplay);
}
}
else if(!oParent && this.lazyLoad) {
this.cfg.refireEvent("xy");
}
},
/**
* @method _onBeforeHide
* @description "beforehide" event handler for the menu.
* @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.Menu} p_oMenu Object representing the menu that fired
* the event.
*/
_onBeforeHide: function(p_sType, p_aArgs, p_oMenu) {
var oActiveItem = this.activeItem;
if(oActiveItem) {
var oConfig = oActiveItem.cfg;
oConfig.setProperty("selected", false);
var oSubmenu = oConfig.getProperty("submenu");
if(oSubmenu) {
oSubmenu.hide();
}
oActiveItem.blur();
}
},
/**
* @method _onHide
* @description "hide" event handler for the menu.
* @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.Menu} p_oMenu Object representing the menu that fired
* the event.
*/
_onHide: function(p_sType, p_aArgs, p_oMenu) {
if(this._nMaxHeight != -1) {
this.cfg.setProperty("maxheight", this._nMaxHeight);
this._nMaxHeight = -1;
}
},
/**
* @method _onParentMenuConfigChange
* @description "configchange" event handler for a submenu.
* @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.Menu} p_oSubmenu Object representing the submenu that
* subscribed to the event.
*/
_onParentMenuConfigChange: function(p_sType, p_aArgs, p_oSubmenu) {
var sPropertyName = p_aArgs[0][0],
oPropertyValue = p_aArgs[0][1];
switch(sPropertyName) {
case "iframe":
case "constraintoviewport":
case "hidedelay":
case "showdelay":
case "submenuhidedelay":
case "clicktohide":
case "effect":
case "classname":
p_oSubmenu.cfg.setProperty(sPropertyName, oPropertyValue);
break;
}
},
/**
* @method _onParentMenuRender
* @description "render" event handler for a submenu. Renders a
* submenu in response to the firing of its parent's "render" event.
* @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.Menu} p_oSubmenu Object representing the submenu that
* subscribed to the event.
*/
_onParentMenuRender: function(p_sType, p_aArgs, p_oSubmenu) {
var oParentMenu = p_oSubmenu.parent.parent,
oConfig = {
constraintoviewport:
oParentMenu.cfg.getProperty("constraintoviewport"),
xy: [0,0],
clicktohide: oParentMenu.cfg.getProperty("clicktohide"),
effect: oParentMenu.cfg.getProperty("effect"),
showdelay: oParentMenu.cfg.getProperty("showdelay"),
hidedelay: oParentMenu.cfg.getProperty("hidedelay"),
submenuhidedelay: oParentMenu.cfg.getProperty("submenuhidedelay"),
classname: oParentMenu.cfg.getProperty("classname")
};
/*
Only sync the "iframe" configuration property if the parent
menu's "position" configuration is the same.
*/
if(
this.cfg.getProperty("position") ==
oParentMenu.cfg.getProperty("position")
) {
oConfig.iframe = oParentMenu.cfg.getProperty("iframe");
}
p_oSubmenu.cfg.applyConfig(oConfig);
if(!this.lazyLoad) {
var oLI = this.parent.element;
if(this.element.parentNode == oLI) {
this.render();
}
else {
this.render(oLI);
}
}
},
/**
* @method _onSubmenuBeforeShow
* @description "beforeshow" event handler for a submenu.
* @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.Menu} p_oSubmenu Object representing the submenu that
* subscribed to the event.
*/
_onSubmenuBeforeShow: function(p_sType, p_aArgs, p_oSubmenu) {
var oParent = this.parent,
aAlignment = oParent.parent.cfg.getProperty("submenualignment");
this.cfg.setProperty(
"context",
[oParent.element, aAlignment[0], aAlignment[1]]
);
var nScrollTop = oParent.parent.body.scrollTop;
if(
(this.browser == "gecko" || this.browser == "safari")
&& nScrollTop > 0
) {
this.cfg.setProperty("y", (this.cfg.getProperty("y") - nScrollTop));
}
},
/**
* @method _onSubmenuShow
* @description "show" event handler for a submenu.
* @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.Menu} p_oSubmenu Object representing the submenu that
* subscribed to the event.
*/
_onSubmenuShow: function(p_sType, p_aArgs, p_oSubmenu) {
var oParent = this.parent;
oParent.submenuIndicator.firstChild.nodeValue =
oParent.EXPANDED_SUBMENU_INDICATOR_TEXT;
},
/**
* @method _onSubmenuHide
* @description "hide" Custom Event handler for a submenu.
* @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.Menu} p_oSubmenu Object representing the submenu that
* subscribed to the event.
*/
_onSubmenuHide: function(p_sType, p_aArgs, p_oSubmenu) {
var oParent = this.parent;
oParent.submenuIndicator.firstChild.nodeValue =
oParent.COLLAPSED_SUBMENU_INDICATOR_TEXT;
},
/**
* @method _onMenuItemFocus
* @description "focus" event handler for the menu's items.
* @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.MenuItem} p_oItem Object representing the menu item
* that fired the event.
*/
_onMenuItemFocus: function(p_sType, p_aArgs, p_oItem) {
this.activeItem = p_oItem;
},
/**
* @method _onMenuItemBlur
* @description "blur" event handler for the menu's items.
* @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.
*/
_onMenuItemBlur: function(p_sType, p_aArgs) {
this.activeItem = null;
},
/**
* @method _onMenuItemConfigChange
* @description "configchange" event handler for the menu's items.
* @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.MenuItem} p_oItem Object representing the menu item
* that fired the event.
*/
_onMenuItemConfigChange: function(p_sType, p_aArgs, p_oItem) {
var sProperty = p_aArgs[0][0];
switch(sProperty) {
case "submenu":
var oSubmenu = p_aArgs[0][1];
if(oSubmenu) {
this._configureSubmenu(p_oItem);
}
break;
case "text":
case "helptext":
/*
A change to an item's "text" or "helptext"
configuration properties requires the width of the parent
menu to be recalculated.
*/
if(this.element.style.width) {
var sWidth = this._getOffsetWidth() + "px";
Dom.setStyle(this.element, "width", sWidth);
}
break;
}
},
// Public event handlers for configuration properties
/**
* @method enforceConstraints
* @description The default event handler executed when the moveEvent is fired,
* if the "constraintoviewport" configuration property is set to true.
* @param {String} type The name of the event that was fired.
* @param {Array} args Collection of arguments sent when the
* event was fired.
* @param {Array} obj Array containing the current Menu instance
* and the item that fired the event.
*/
enforceConstraints: function(type, args, obj) {
var oConfig = this.cfg,
pos = args[0],
x = pos[0],
y = pos[1],
offsetHeight = this.element.offsetHeight,
offsetWidth = this.element.offsetWidth,
viewPortWidth = YAHOO.util.Dom.getViewportWidth(),
viewPortHeight = YAHOO.util.Dom.getViewportHeight(),
scrollX = Math.max(
document.documentElement.scrollLeft,
document.body.scrollLeft
),
scrollY = Math.max(
document.documentElement.scrollTop,
document.body.scrollTop
),
nPadding = (
this.parent &&
this.parent.parent instanceof YAHOO.widget.MenuBar
) ? 0 : 10,
topConstraint = scrollY + nPadding,
leftConstraint = scrollX + nPadding,
bottomConstraint = scrollY + viewPortHeight - offsetHeight - nPadding,
rightConstraint = scrollX + viewPortWidth - offsetWidth - nPadding,
aContext = oConfig.getProperty("context"),
oContextElement = aContext ? aContext[0] : null;
if (x < 10) {
x = leftConstraint;
} else if ((x + offsetWidth) > viewPortWidth) {
if(
oContextElement &&
((x - oContextElement.offsetWidth) > offsetWidth)
) {
x = (x - (oContextElement.offsetWidth + offsetWidth));
}
else {
x = rightConstraint;
}
}
if (y < 10) {
y = topConstraint;
} else if (y > bottomConstraint) {
if(oContextElement && (y > offsetHeight)) {
y = ((y + oContextElement.offsetHeight) - offsetHeight);
}
else {
y = bottomConstraint;
}
}
oConfig.setProperty("x", x, true);
oConfig.setProperty("y", y, true);
oConfig.setProperty("xy", [x,y], true);
},
/**
* @method configVisible
* @description Event handler for when the "visible" configuration property
* the menu changes.
* @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.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
configVisible: function(p_sType, p_aArgs, p_oMenu) {
if(this.cfg.getProperty("position") == "dynamic") {
YAHOO.widget.Menu.superclass.configVisible.call(
this,
p_sType,
p_aArgs,
p_oMenu
);
}
else {
var bVisible = p_aArgs[0],
sDisplay = Dom.getStyle(this.element, "display");
if(bVisible) {
if(sDisplay != "block") {
this.beforeShowEvent.fire();
Dom.setStyle(this.element, "display", "block");
this.showEvent.fire();
}
}
else {
if(sDisplay == "block") {
this.beforeHideEvent.fire();
Dom.setStyle(this.element, "display", "none");
this.hideEvent.fire();
}
}
}
},
/**
* @method configPosition
* @description Event handler for when the "position" configuration property
* of the menu changes.
* @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.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
configPosition: function(p_sType, p_aArgs, p_oMenu) {
var sCSSPosition = p_aArgs[0] == "static" ? "static" : "absolute",
oCfg = this.cfg;
Dom.setStyle(this.element, "position", sCSSPosition);
if(sCSSPosition == "static") {
/*
Remove the iframe for statically positioned menus since it will
intercept mouse events.
*/
oCfg.setProperty("iframe", false);
// Statically positioned menus are visible by default
Dom.setStyle(this.element, "display", "block");
oCfg.setProperty("visible", true);
}
else {
/*
Even though the "visible" property is queued to
"false" by default, we need to set the "visibility" property to
"hidden" since Overlay's "configVisible" implementation checks the
element's "visibility" style property before deciding whether
or not to show an Overlay instance.
*/
Dom.setStyle(this.element, "visibility", "hidden");
}
if(sCSSPosition == "absolute") {
var nZIndex = oCfg.getProperty("zindex");
if(!nZIndex || nZIndex === 0) {
nZIndex = this.parent ?
(this.parent.parent.cfg.getProperty("zindex") + 1) : 1;
oCfg.setProperty("zindex", nZIndex);
}
}
},
/**
* @method configIframe
* @description Event handler for when the "iframe" configuration property of
* the menu changes.
* @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.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
configIframe: function(p_sType, p_aArgs, p_oMenu) {
if(this.cfg.getProperty("position") == "dynamic") {
YAHOO.widget.Menu.superclass.configIframe.call(
this,
p_sType,
p_aArgs,
p_oMenu
);
}
},
/**
* @method configHideDelay
* @description Event handler for when the "hidedelay" configuration property
* of the menu changes.
* @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.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
configHideDelay: function(p_sType, p_aArgs, p_oMenu) {
var nHideDelay = p_aArgs[0],
oMouseOutEvent = this.mouseOutEvent,
oMouseOverEvent = this.mouseOverEvent,
oKeyDownEvent = this.keyDownEvent;
if(nHideDelay > 0) {
/*
Only assign event handlers once. This way the user change
the value for the hidedelay as many times as they want.
*/
if(!this._bHideDelayEventHandlersAssigned) {
oMouseOutEvent.subscribe(this._execHideDelay, true);
oMouseOverEvent.subscribe(this._cancelHideDelay, this, true);
oKeyDownEvent.subscribe(this._cancelHideDelay, this, true);
this._bHideDelayEventHandlersAssigned = true;
}
}
else {
oMouseOutEvent.unsubscribe(this._execHideDelay, this);
oMouseOverEvent.unsubscribe(this._cancelHideDelay, this);
oKeyDownEvent.unsubscribe(this._cancelHideDelay, this);
this._bHideDelayEventHandlersAssigned = false;
}
},
/**
* @method configContainer
* @description Event handler for when the "container" configuration property
of the menu changes.
* @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.Menu} p_oMenu Object representing the menu that
* fired the event.
*/
configContainer: function(p_sType, p_aArgs, p_oMenu) {
var oElement = p_aArgs[0];
if(typeof oElement == 'string') {
this.cfg.setProperty(
"container",
document.getElementById(oElement),
true
);
}
},
/**
* @method configMaxHeight
* @description Event handler for when the "maxheight" configuration property of
* a Menu 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.
* @param {YAHOO.widget.Menu} p_oMenu The Menu instance fired
* the event.
*/
configMaxHeight: function(p_sType, p_aArgs, p_oMenu) {
var nMaxHeight = p_aArgs[0],
oBody = this.body,
oHeader = this.header,
oFooter = this.footer,
fnMouseOver = this._onScrollTargetMouseOver,
fnMouseOut = this._onScrollTargetMouseOut;
if((nMaxHeight > 0) && (oBody.offsetHeight > nMaxHeight)) {
if(!this.cfg.getProperty("width")) {
this._setWidth();
}
if(!oHeader && !oFooter) {
this.setHeader(" ");
this.setFooter(" ");
oHeader = this.header;
oFooter = this.footer;
Dom.addClass(oHeader, "topscrollbar");
Dom.addClass(oFooter, "bottomscrollbar");
this.element.insertBefore(oHeader, oBody);
this.element.appendChild(oFooter);
Event.addListener(oHeader, "mouseover", fnMouseOver, this, true);
Event.addListener(oHeader, "mouseout", fnMouseOut, this, true);
Event.addListener(oFooter, "mouseover", fnMouseOver, this, true);
Event.addListener(oFooter, "mouseout", fnMouseOut, this, true);
}
var nHeight =
(
nMaxHeight -
(this.footer.offsetHeight + this.header.offsetHeight)
);
Dom.setStyle(oBody, "height", (nHeight + "px"));
Dom.setStyle(oBody, "overflow", "hidden");
}
else if(oHeader && oFooter) {
Dom.setStyle(oBody, "height", "auto");
Dom.setStyle(oBody, "overflow", "visible");
Event.removeListener(oHeader, "mouseover", fnMouseOver);
Event.removeListener(oHeader, "mouseout", fnMouseOut);
Event.removeListener(oFooter, "mouseover", fnMouseOver);
Event.removeListener(oFooter, "mouseout", fnMouseOut);
this.element.removeChild(oHeader);
this.element.removeChild(oFooter);
this.header = null;
this.footer = null;
}
},
/**
* @method configClassName
* @description Event handler for when the "classname" configuration property of
* a menu 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.
* @param {YAHOO.widget.Menu} p_oMenu The Menu instance fired the event.
*/
configClassName: function(p_sType, p_aArgs, p_oMenu) {
var sClassName = p_aArgs[0];
if(this._sClassName) {
Dom.removeClass(this.element, this._sClassName);
}
Dom.addClass(this.element, sClassName);
this._sClassName = sClassName;
},
// Public methods
/**
* @method initEvents
* @description Initializes the custom events for the menu.
*/
initEvents: function() {
YAHOO.widget.Menu.superclass.initEvents.call(this);
// Create custom events
var CustomEvent = YAHOO.util.CustomEvent;
this.mouseOverEvent = new CustomEvent("mouseOverEvent", this);
this.mouseOutEvent = new CustomEvent("mouseOutEvent", this);
this.mouseDownEvent = new CustomEvent("mouseDownEvent", this);
this.mouseUpEvent = new CustomEvent("mouseUpEvent", this);
this.clickEvent = new CustomEvent("clickEvent", this);
this.keyPressEvent = new CustomEvent("keyPressEvent", this);
this.keyDownEvent = new CustomEvent("keyDownEvent", this);
this.keyUpEvent = new CustomEvent("keyUpEvent", this);
this.itemAddedEvent = new CustomEvent("itemAddedEvent", this);
this.itemRemovedEvent = new CustomEvent("itemRemovedEvent", this);
},
/**
* @method getRoot
* @description Finds the menu's root menu.
*/
getRoot: function() {
var oItem = this.parent;
if(oItem) {
var oParentMenu = oItem.parent;
return oParentMenu ? oParentMenu.getRoot() : this;
}
else {
return this;
}
},
/**
* @method toString
* @description Returns a string representing the menu.
* @return {String}
*/
toString: function() {
return ("Menu " + this.id);
},
/**
* @method setItemGroupTitle
* @description Sets the title of a group of menu items.
* @param {String} p_sGroupTitle String specifying the title of the group.
* @param {Number} p_nGroupIndex Optional. Number specifying the group to which
* the title belongs.
*/
setItemGroupTitle: function(p_sGroupTitle, p_nGroupIndex) {
if(typeof p_sGroupTitle == "string" && p_sGroupTitle.length > 0) {
var nGroupIndex = typeof p_nGroupIndex == "number" ? p_nGroupIndex : 0,
oTitle = this._aGroupTitleElements[nGroupIndex];
if(oTitle) {
oTitle.innerHTML = p_sGroupTitle;
}
else {
oTitle = document.createElement(this.GROUP_TITLE_TAG_NAME);
oTitle.innerHTML = p_sGroupTitle;
this._aGroupTitleElements[nGroupIndex] = oTitle;
}
var i = this._aGroupTitleElements.length - 1,
nFirstIndex;
do {
if(this._aGroupTitleElements[i]) {
Dom.removeClass(this._aGroupTitleElements[i], "first-of-type");
nFirstIndex = i;
}
}
while(i--);
if(nFirstIndex !== null) {
Dom.addClass(
this._aGroupTitleElements[nFirstIndex],
"first-of-type"
);
}
}
},
/**
* @method addItem
* @description Appends an item to the menu.
* @param {YAHOO.widget.MenuItem} p_oItem Object reference for the MenuItem
* instance to be added to the menu.
* @param {String} p_oItem String specifying the text of the item to be added
* to the menu.
* @param {Object} p_oItem Object literal containing a set of menu item
* configuration properties.
* @param {Number} p_nGroupIndex Optional. Number indicating the group to
* which the item belongs.
* @return {YAHOO.widget.MenuItem}
*/
addItem: function(p_oItem, p_nGroupIndex) {
if(p_oItem) {
return this._addItemToGroup(p_nGroupIndex, p_oItem);
}
},
/**
* @method addItems
* @description Adds an array of items to the menu.
* @param {Array} p_aItems Array of items to be added to the menu. The array
* can contain strings specifying the text for each item to be created, object
* literals specifying each of the menu item configuration properties,
* or MenuItem instances.
* @param {Number} p_nGroupIndex Optional. Number specifying the group to
* which the items belongs.
* @return {Array}
*/
addItems: function(p_aItems, p_nGroupIndex) {
if(Lang.isArray(p_aItems)) {
var nItems = p_aItems.length,
aItems = [],
oItem;
for(var i=0; i<nItems; i++) {
oItem = p_aItems[i];
if(oItem) {
if(Lang.isArray(oItem)) {
aItems[aItems.length] = this.addItems(oItem, i);
}
else {
aItems[aItems.length] =
this._addItemToGroup(p_nGroupIndex, oItem);
}
}
}
if(aItems.length) {
return aItems;
}
}
},
/**
* @method insertItem
* @description Inserts an item into the menu at the specified index.
* @param {YAHOO.widget.MenuItem} p_oItem Object reference for the MenuItem
* instance to be added to the menu.
* @param {String} p_oItem String specifying the text of the item to be added
* to the menu.
* @param {Object} p_oItem Object literal containing a set of menu item
* configuration properties.
* @param {Number} p_nItemIndex Number indicating the ordinal position at which
* the item should be added.
* @param {Number} p_nGroupIndex Optional. Number indicating the group to which
* the item belongs.
* @return {YAHOO.widget.MenuItem}
*/
insertItem: function(p_oItem, p_nItemIndex, p_nGroupIndex) {
if(p_oItem) {
return this._addItemToGroup(p_nGroupIndex, p_oItem, p_nItemIndex);
}
},
/**
* @method removeItem
* @description Removes the specified item from the menu.
* @param {YAHOO.widget.MenuItem} p_oObject Object reference for the MenuItem
* instance to be removed from the menu.
* @param {Number} p_oObject Number specifying the index of the item
* to be removed.
* @param {Number} p_nGroupIndex Optional. Number specifying the group to
* which the item belongs.
* @return {YAHOO.widget.MenuItem}
*/
removeItem: function(p_oObject, p_nGroupIndex) {
if(typeof p_oObject != "undefined") {
var oItem;
if(p_oObject instanceof YAHOO.widget.MenuItem) {
oItem = this._removeItemFromGroupByValue(p_nGroupIndex, p_oObject);
}
else if(typeof p_oObject == "number") {
oItem = this._removeItemFromGroupByIndex(p_nGroupIndex, p_oObject);
}
if(oItem) {
oItem.destroy();
this.logger.log("Item removed." +
" Text: " + oItem.cfg.getProperty("text") + ", " +
" Index: " + oItem.index + ", " +
" Group Index: " + oItem.groupIndex);
return oItem;
}
}
},
/**
* @method getItems
* @description Returns an array of all of the items in the menu.
* @return {Array}
*/
getItems: function() {
var aGroups = this._aItemGroups,
nGroups = aGroups.length;
return (
(nGroups == 1) ? aGroups[0] :
(Array.prototype.concat.apply([], aGroups))
);
},
/**
* @method getItemGroups
* @description Multi-dimensional Array representing the menu items as they
* are grouped in the menu.
* @return {Array}
*/
getItemGroups: function() {
return this._aItemGroups;
},
/**
* @method getItem
* @description Returns the item at the specified index.
* @param {Number} p_nItemIndex Number indicating the ordinal position of the
* item to be retrieved.
* @param {Number} p_nGroupIndex Optional. Number indicating the group to which
* the item belongs.
* @return {YAHOO.widget.MenuItem}
*/
getItem: function(p_nItemIndex, p_nGroupIndex) {
if(typeof p_nItemIndex == "number") {
var aGroup = this._getItemGroup(p_nGroupIndex);
if(aGroup) {
return aGroup[p_nItemIndex];
}
}
},
/**
* @method clearContent
* @description Removes all of the content from the menu, including the menu
* items, group titles, header and footer.
*/
clearContent: function() {
var aItems = this.getItems(),
nItems = aItems.length,
oElement = this.element,
oBody = this.body,
oHeader = this.header,
oFooter = this.footer;
if(nItems > 0) {
var i = nItems - 1,
oItem,
oSubmenu;
do {
oItem = aItems[i];
if(oItem) {
oSubmenu = oItem.cfg.getProperty("submenu");
if(oSubmenu) {
this.cfg.configChangedEvent.unsubscribe(
this._onParentMenuConfigChange,
oSubmenu
);
this.renderEvent.unsubscribe(
this._onParentMenuRender,
oSubmenu
);
}
oItem.destroy();
}
}
while(i--);
}
if(oHeader) {
Event.purgeElement(oHeader);
oElement.removeChild(oHeader);
}
if(oFooter) {
Event.purgeElement(oFooter);
oElement.removeChild(oFooter);
}
if(oBody) {
Event.purgeElement(oBody);
oBody.innerHTML = "";
}
this._aItemGroups = [];
this._aListElements = [];
this._aGroupTitleElements = [];
},
/**
* @method destroy
* @description Removes the menu's <code><div></code> element
* (and accompanying child nodes) from the document.
*/
destroy: function() {
// Remove all DOM event listeners
Event.purgeElement(this.element);
// Remove Custom Event listeners
this.mouseOverEvent.unsubscribeAll();
this.mouseOutEvent.unsubscribeAll();
this.mouseDownEvent.unsubscribeAll();
this.mouseUpEvent.unsubscribeAll();
this.clickEvent.unsubscribeAll();
this.keyPressEvent.unsubscribeAll();
this.keyDownEvent.unsubscribeAll();
this.keyUpEvent.unsubscribeAll();
this.itemAddedEvent.unsubscribeAll();
this.itemRemovedEvent.unsubscribeAll();
YAHOO.widget.Module.textResizeEvent.unsubscribe(this._onTextResize, this);
// Remove all items
this.clearContent();
this._aItemGroups = null;
this._aListElements = null;
this._aGroupTitleElements = null;
// Continue with the superclass implementation of this method
YAHOO.widget.Menu.superclass.destroy.call(this);
this.logger.log("Destroyed.");
},
/**
* @method setInitialFocus
* @description Sets focus to the menu's first enabled item.
*/
setInitialFocus: function() {
var oItem = this._getFirstEnabledItem();
if(oItem) {
oItem.focus();
}
},
/**
* @method setInitialSelection
* @description Sets the "selected" configuration property of the menu's first
* enabled item to "true."
*/
setInitialSelection: function() {
var oItem = this._getFirstEnabledItem();
if(oItem) {
oItem.cfg.setProperty("selected", true);
}
},
/**
* @method clearActiveItem
* @description Sets the "selected" configuration property of the menu's active
* item to "false" and hides the item's submenu.
* @param {Boolean} p_bBlur Boolean indicating if the menu's active item
* should be blurred.
*/
clearActiveItem: function(p_bBlur) {
if(this.cfg.getProperty("showdelay") > 0) {
this._cancelShowDelay();
}
var oActiveItem = this.activeItem;
if(oActiveItem) {
var oConfig = oActiveItem.cfg;
oConfig.setProperty("selected", false);
var oSubmenu = oConfig.getProperty("submenu");
if(oSubmenu) {
oSubmenu.hide();
}
if(p_bBlur) {
oActiveItem.blur();
}
}
},
/**
* @description Initializes the class's configurable properties which can be
* changed using the menu's Config object ("cfg").
* @method initDefaultConfig
*/
initDefaultConfig: function() {
YAHOO.widget.Menu.superclass.initDefaultConfig.call(this);
var oConfig = this.cfg;
// Add configuration attributes
/*
Change the default value for the "visible" configuration
property to "false" by re-adding the property.
*/
/**
* @config visible
* @description Boolean indicating whether or not the menu is visible. If
* the menu's "position" configuration property is set to "dynamic" (the
* default), this property toggles the menu's <code><div></code>
* element's "visibility" style property between "visible" (true) or
* "hidden" (false). If the menu's "position" configuration property is
* set to "static" this property toggles the menu's
* <code><div></code> element's "display" style property
* between "block" (true) or "none" (false).
* @default false
* @type Boolean
*/
oConfig.addProperty(
"visible",
{
value:false,
handler:this.configVisible,
validator:this.cfg.checkBoolean
}
);
/*
Change the default value for the "constraintoviewport" configuration
property to "true" by re-adding the property.
*/
/**
* @config constraintoviewport
* @description Boolean indicating if the menu will try to remain inside
* the boundaries of the size of viewport.
* @default true
* @type Boolean
*/
oConfig.addProperty(
"constraintoviewport",
{
value:true,
handler:this.configConstrainToViewport,
validator:this.cfg.checkBoolean,
supercedes:["iframe","x","y","xy"]
}
);
/**
* @config position
* @description String indicating how a menu should be positioned on the
* screen. Possible values are "static" and "dynamic." Static menus are
* visible by default and reside in the normal flow of the document
* (CSS position: static). Dynamic menus 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 dynamic
* @type String
*/
oConfig.addProperty(
"position",
{
value: "dynamic",
handler: this.configPosition,
validator: this._checkPosition,
supercedes: ["visible"]
}
);
/**
* @config submenualignment
* @description Array defining how submenus should be aligned to their
* parent menu item. The format is: [itemCorner, submenuCorner]. By default
* a submenu's top left corner is aligned to its parent menu item's top
* right corner.
* @default ["tl","tr"]
* @type Array
*/
oConfig.addProperty("submenualignment", { value: ["tl","tr"] } );
/**
* @config autosubmenudisplay
* @description Boolean indicating if submenus are automatically made
* visible when the user mouses over the menu's items.
* @default true
* @type Boolean
*/
oConfig.addProperty(
"autosubmenudisplay",
{
value: true,
validator: oConfig.checkBoolean
}
);
/**
* @config showdelay
* @description Number indicating the time (in milliseconds) that should
* expire before a submenu is made visible when the user mouses over
* the menu's items.
* @default 250
* @type Number
*/
oConfig.addProperty(
"showdelay",
{
value: 250,
validator: oConfig.checkNumber
}
);
/**
* @config hidedelay
* @description Number indicating the time (in milliseconds) that should
* expire before the menu is hidden.
* @default 0
* @type Number
*/
oConfig.addProperty(
"hidedelay",
{
value: 0,
validator: oConfig.checkNumber,
handler: this.configHideDelay,
suppressEvent: true
}
);
/**
* @config submenuhidedelay
* @description Number indicating the time (in milliseconds) that should
* expire before a submenu is hidden when the user mouses out of a menu item
* heading in the direction of a submenu. The value must be greater than or
* equal to the value specified for the "showdelay" configuration property.
* @default 250
* @type Number
*/
oConfig.addProperty(
"submenuhidedelay",
{
value: 250,
validator: oConfig.checkNumber
}
);
/**
* @config clicktohide
* @description Boolean indicating if the menu will automatically be
* hidden if the user clicks outside of it.
* @default true
* @type Boolean
*/
oConfig.addProperty(
"clicktohide",
{
value: true,
validator: oConfig.checkBoolean
}
);
/**
* @config container
* @description HTML element reference or string specifying the id
* attribute of the HTML element that the menu's markup should be
* rendered into.
* @type <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
* level-one-html.html#ID-58190037">HTMLElement</a>|String
* @default document.body
*/
oConfig.addProperty(
"container",
{
value:document.body,
handler:this.configContainer
}
);
/**
* @config maxheight
* @description Defines the maximum height (in pixels) for a menu before the
* contents of the body are scrolled.
* @default 0
* @type Number
*/
oConfig.addProperty(
"maxheight",
{
value: 0,
validator: oConfig.checkNumber,
handler: this.configMaxHeight
}
);
/**
* @config classname
* @description CSS class to be applied to the menu's root
* <code><div></code> element. The specified class(es) are
* appended in addition to the default class as specified by the menu's
* CSS_CLASS_NAME constant.
* @default null
* @type String
*/
oConfig.addProperty(
"classname",
{
value: null,
handler: this.configClassName,
validator: this._checkString
}
);
}
}); // END YAHOO.lang.extend
})();