GlideMenus

API Function Reference

Here are the functions you will use to hide and show menus.

/** actuatorMouseover
 * event        - event
 * menuId       - the menu's id.
 * dir          - the direction of animation.
 * adjX         - how far left the menu shoud be (+/-).
 * adjY         - how far down the menu shoud be (+/-).
 */
actuatorMouseover(event, menuId, dir, adjX, adjY);
actuatorMouseout(event, menuId);


/** showMenu
 * event        - event
 * id           - the menu's id.
 * dir          - the direction of animation. 
 * adjX         - how far left the menu shoud be (+/-).
 * adjY         - how far down the menu shoud be (+/-).
 */
showMenu(event, id, dir, adjX, adjY);
hideMenu(id);


/** headerMouseover
 * call headerMouseover(this) for a text-header.
 * call headerMouseover("imgName") for an img-header.
 */
headerMouseover(imgName_or_element);
headerMouseout(imgName_or_element);



/** showSubMenu
 * e            - event
 * parentMenuId - the id of the menu's parent menu.
 * id           - the menu's id.
 * dir          - the direction of animation 
 * adjX         - how far left the menu shoud be (+/-).
 * adjY         - how far down the menu shoud be (+/-).
 */
showSubMenu(e, parentMenuId, id, dir, adjX, adjY);
hideSubMenu(id);

 

Explanation

What Do These Functions Do?

 
actuatorMouseover(event, menuId, dir, adjX, adjY);
actuatorMouseout(event, menuId);

Call actuatorMouseover and actuatorMouseout in onmouseover and onmouseout event handlers, respectively.

If GlideParams.CLICK_SHOW is false, then the associated menu will be shown. Otherwise, the actuator will be highlighted.

Actuator Highlighting

If the actuator is an image, it will use the image with GlideParams.IMG_OVER_EXT. Otherwise, it will add " hover" to the element's class attribute. You may make your own CSS rules for .hover { }.

 
 
showMenu(e, id, dir, adjX, adjY);
hideMenu(id);

Call showMenu and hideMenu to show or hide the menu.

 
 
headerMouseover(imgName_or_element);
headerMouseout(imgName_or_element);

Call headerMouseover and headerMouseout to hilite a header img or element and to hide the active menu. This is used when the header does not have a menu.

 
 
showSubMenu(e, parentMenuId, id, dir, adjX, adjY);
hideSubMenu(id);

Call showSubMenu and hideSubMenu to show or hide a submenu.

Next in this tutorial: Frequently Asked Questions