Yahoo! UI Library

node-menunav  3.0.0pr2

Yahoo! UI Library > node-menunav > plugin.NodeMenuNav
Search:
 
Filters

Class plugin.NodeMenuNav

The NodeMenuNav class is a plugin for a Node instance. The class is used via the plug method of Node and should not be instantiated directly.

Properties

_activeItem - protected Node

Node instance representing the MenuNav's active descendent - the menuitem or menu label the user is currently interacting with.
Default Value: null

_activeMenu - protected Node

Node instance representing the menu that is the parent of the MenuNav's active descendent.
Default Value: null

_autoSubmenuDisplay - protected Boolean

Boolean indicating if submenus are automatically made visible when the user mouses over the menu's items.
Default Value: true

_blockMouseEvent - protected Boolean

Boolean indicating whether or not to handle the "mouseover" event.
Default Value: false

_currentMouseX - protected Number

Number representing the current x coordinate of the mouse inside the MenuNav.
Default Value: 0

_firstItem - protected Node

Node instance representing the first item (menuitem or menu label) in the root menu of a MenuNav.
Default Value: null

_hasFocus - protected Boolean

Boolean indicating if the MenuNav has focus.
Default Value: false

_hideAllSubmenusTimer - protected Object

Timer used to hide a all submenus.
Default Value: null

_hideSubmenuTimer - protected Object

Timer used to hide a submenu.
Default Value: null

_movingToSubmenu - protected Boolean

Boolean indicating if the mouse is moving from a menu label to its corresponding submenu.
Default Value: false

_rootMenu - protected Node

Node instance representing the root menu in the MenuNav.
Default Value: null

_showSubmenuTimer - protected Object

Timer used to show a submenu.
Default Value: null

NodeMenuNav.SHIM_TEMPLATE - String

String representing the HTML used to create the <iframe> shim used to prevent <select> elements from poking through menus in IE 6.
Default Value: "<iframe frameborder="0" tabindex="-1" class="yui-shim" title="Menu Stacking Shim" src="javascript:false;"></iframe>"

NodeMenuNav.SHIM_TEMPLATE_TITLE - String

String representing the value for the title attribute for the shim used to prevent <select> elements from poking through menus in IE 6.
Default Value: "Menu Stacking Shim"

Methods

_applyARIA

protected void _applyARIA ( menu )
Applies the ARIA Roles, States and Properties to the supplied menu.
Parameters:
menu <Node> Node instance representing a menu.
Returns: void

_cancelHideSubmenuTimer

protected void _cancelHideSubmenuTimer ( )
Cancels the timer used to hide a submenu.
Returns: void

_cancelShowSubmenuTimer

protected void _cancelShowSubmenuTimer ( )
Cancels the timer used to show a submenu.
Returns: void

_clearActiveItem

protected void _clearActiveItem ( )
Clears the MenuNav's active descendent.
Returns: void

_focusItem

protected void _focusItem ( item )
Focuses the specified menuitem or menu label.
Parameters:
item <Node> Node instance representing a menuitem or menu label.
Returns: void

_getTopmostSubmenu

protected Node _getTopmostSubmenu ( menu )
Returns the topmost submenu of a submenu hierarchy.
Parameters:
menu <Node> Node instance representing a menu.
Returns: Node
Node instance representing a menu.

_hideAllSubmenus

protected void _hideAllSubmenus ( menu )
Hides all submenus of the specified menu.
Parameters:
menu <Node> Node instance representing a menu.
Returns: void

_hideMenu

protected void _hideMenu ( menu , activateAndFocusLabel )
Hides the specified menu.
Parameters:
menu <Node> Node instance representing a menu.
activateAndFocusLabel <Boolean> Boolean indicating if the label for the specified menu should be focused and set as active.
Returns: void

_isRoot

protected Boolean _isRoot ( menu )
Returns a boolean indicating if the specified menu is the root menu in the MenuNav.
Parameters:
menu <Node> Node instance representing a menu.
Returns: Boolean
Boolean indicating if the specified menu is the root menu in the MenuNav.

_onDocFocus

protected void _onDocFocus ( event )
"focus" event handler for the owner document of the MenuNav.
Parameters:
event <Object> Object representing the DOM event.
Returns: void

_onDocMouseDown

protected void _onDocMouseDown ( event )
"mousedown" event handler for the owner document of the MenuNav.
Parameters:
event <Object> Object representing the DOM event.
Returns: void

_onHorizontalMenuKeyDown

protected void _onHorizontalMenuKeyDown ( event )
"keydown" event handler for horizontal menus of a MenuNav.
Parameters:
event <Object> Object representing the DOM event.
Returns: void

_onKeyDown

protected void _onKeyDown ( event )
"keydown" event handler for the MenuNav.
Parameters:
event <Object> Object representing the DOM event.
Returns: void

_onKeyPress

protected void _onKeyPress ( event )
"keypress" event handler for the MenuNav.
Parameters:
event <Object> Object representing the DOM event.
Returns: void

_onMenuItemMouseOut

protected void _onMenuItemMouseOut ( menuItem , event )
"mouseout" event handler for a menuitem.
Parameters:
menuItem <Node> Node instance representing a menuitem.
event <Object> Object representing the DOM event.
Returns: void

_onMenuItemMouseOver

protected void _onMenuItemMouseOver ( menuItem , event )
"mouseover" event handler for a menuitem.
Parameters:
menuItem <Node> Node instance representing a menuitem.
event <Object> Object representing the DOM event.
Returns: void

_onMenuLabelMouseOut

protected void _onMenuLabelMouseOut ( menuLabel , event )
"mouseout" event handler for a menu label.
Parameters:
menuLabel <Node> Node instance representing a menu label.
event <Object> Object representing the DOM event.
Returns: void

_onMenuLabelMouseOver

protected void _onMenuLabelMouseOver ( menuLabel , event )
"mouseover" event handler for a menu label.
Parameters:
menuLabel <Node> Node instance representing a menu label.
event <Object> Object representing the DOM event.
Returns: void

_onMenuMouseOut

protected void _onMenuMouseOut ( menu , event )
"mouseout" event handler for a menu.
Parameters:
menu <Node> Node instance representing a menu.
event <Object> Object representing the DOM event.
Returns: void

_onMenuMouseOver

protected void _onMenuMouseOver ( menu , event )
"mouseover" event handler for a menu.
Parameters:
menu <Node> Node instance representing a menu.
event <Object> Object representing the DOM event.
Returns: void

_onMouseMove

protected void _onMouseMove ( event )
"mousemove" event handler for the MenuNav.
Parameters:
event <Object> Object representing the DOM event.
Returns: void

_onMouseOut

protected void _onMouseOut ( event )
"mouseout" event handler for the MenuNav.
Parameters:
event <Object> Object representing the DOM event.
Returns: void

_onMouseOver

protected void _onMouseOver ( event )
"mouseover" event handler for the MenuNav.
Parameters:
event <Object> Object representing the DOM event.
Returns: void

_onVerticalMenuKeyDown

protected void _onVerticalMenuKeyDown ( event )
"keydown" event handler for vertical menus of a MenuNav.
Parameters:
event <Object> Object representing the DOM event.
Returns: void

_setActiveItem

protected void _setActiveItem ( item )
Sets the specified menuitem or menu label as the MenuNav's active descendent.
Parameters:
item <Node> Node instance representing a menuitem or menu label.
Returns: void

_showMenu

protected void _showMenu ( menu )
Shows the specified menu.
Parameters:
menu <Node> Node instance representing a menu.
Returns: void

_toggleSubmenuDisplay

protected void _toggleSubmenuDisplay ( event )
"mousedown," "keydown," and "click" event handler for the MenuNav used to toggle the display of a submenu.
Parameters:
event <Object> Object representing the DOM event.
Returns: void
Copyright © 2008 Yahoo! Inc. All rights reserved.