Class DHTMLSuite.menuBar

Object
   |
   +--DHTMLSuite.menuBar

class DHTMLSuite.menuBar

Purpose of class: Creates a top bar menu strip. Demos:

• (A menu with a detailed description on how it is created)
• (Menu bar in a pane splitter pane)

Field Detail

activeSubItemsOnMouseOver

Object activeSubItemsOnMouseOver

createIframesForOldIeBrowsers

Object createIframesForOldIeBrowsers

cssPrefix

Object cssPrefix

layoutCSS

Object layoutCSS

menuBarBackgroundImage

Object menuBarBackgroundImage

menuBarHeight

Object menuBarHeight

menuBarObj

Object menuBarObj

menuBarState

Object menuBarState

menuItem_objects

Object menuItem_objects

menuItemCssPrefix

Object menuItemCssPrefix

menuItemLayoutCss

Object menuItemLayoutCss

objectIndex

Object objectIndex

submenuGroups

Object submenuGroups

submenuIframes

Object submenuIframes

targetId

Object targetId

DHTMLSuite.menuBar

DHTMLSuite.menuBar()

Author: Alf Magne Kalleland(www.dhtmlgoodies.com)
Version: 1.0

addMenuItems

void addMenuItems(menuItemObj)

Add menu items

Parameters:
DHTMLSuite - .menuModel menuModel Object of class DHTMLSuite.menuModel which holds menu data

appendMenuItems

void appendMenuItems(idOfParentMenuItem,newMenuModel)

This method appends menu items to the menu dynamically

Parameters:
Integer - idOfParentMenuItem - Parent id - where to append the new items.
menuModel - newMenuModel - Object of type menuModel. This menuModel will be appended as sub elements of defined idOfParentMenuItem

deleteMenuItems

void deleteMenuItems(idOfParentMenuItem,deleteParentElement)

This method deletes menu items from the menu dynamically

Parameters:
Number - idOfParentMenuItem - Parent id - parent id of the elements to delete.
Boolean - deleteParentElement - Should parent element also be deleted, or only sub elements?

hideMenuItem

void hideMenuItem(menuItemId)

This method doesn't delete menu items. it hides them only.

Parameters:
Number - menuItemId - Id of the item you want to hide.

hideSubMenus

void hideSubMenus(e)

Deactivate all sub menus ( collapse and set state back to regular ) In case you have a menu inside a scrollable container, call this method in an onscroll event for that element example document.getElementById('textContent').onscroll = menuBar.__hideSubMenus;

Parameters:
Event - e - this variable is present if this method is called from an event. You will never use this parameter

init

void init()

Initilizes the script - This method should be called after your set methods.

setActiveSubItemsOnMouseOver

void setActiveSubItemsOnMouseOver(activateSubOnMouseOver)

Specify if sub menus should be activated on mouse over(i.e. no matter what the menuState property is).

Parameters:
Boolean - activateSubOnMouseOver - Specify if sub menus should be activated on mouse over(i.e. no matter what the menuState property is).

setCreateIframesForOldIeBrowsers

void setCreateIframesForOldIeBrowsers(createIframesForOldIeBrowsers)

This method specifies if you want to the script to create iframes behind sub menu groups in order to cover eventual select boxes. This is needed if you have users with older IE browsers(prior to version 7) and when there's a chance that a sub menu could appear on top of a select box.

Parameters:
Boolean - createIframesForOldIeBrowsers = true if you want the script to create iframes to cover select boxes in older ie browsers.

setCssPrefix

void setCssPrefix(newCssPrefix)

Specify prefix of css classes used for the menu bar. Default css prefix is "DHTMLSuite_" and that's the prefix of all css classes inside menu-bar.css(the default css file). If you want some custom menu bars, create and include your own css files, replace DHTMLSuite_ in the class names with your own prefix and set the new prefix by calling this method. This is useful if you want to have two menus on the same page with different stylings.

Parameters:
String - newCssPrefix - New css prefix for the menu bar classes.

setIcon

void setIcon(menuItemId,newPath)

Replace menu icon for a menu item.

Parameters:
Integer - menuItemId - Id of menu item.
String - newPath - Path to new menu icon. Pass blank or false if you want to clear the menu item.

setLayoutCss

void setLayoutCss(nameOfNewCssFile)

Specify the css file for this menu bar

Parameters:
String - nameOfNewCssFile = Name of new css file.

setMenuItemCssPrefix

void setMenuItemCssPrefix(newCssPrefix)

Specify prefix of css classes used for the menu items. Default css prefix is "DHTMLSuite_". If you wish have some custom styling for some of your menus, create a separate css file and replace DHTMLSuite_ for the class names with your new prefix. This is useful if you want to have two menus on the same page with different stylings.

Parameters:
String - newCssPrefix - New css prefix for menu items.

setMenuItemLayoutCss

void setMenuItemLayoutCss(nameOfNewCssFile)

Specify the css file for the menu items

Parameters:
String - nameOfNewCssFile = Name of new css file.

setMenuItemState

void setMenuItemState(menuItemId,state)

This method changes the state of the menu bar(expanded or collapsed). This method is called when someone clicks on the arrow at the right of menu items.

Parameters:
Number - menuItemId - ID of the menu item we want to switch state for
String - state - New state(DHTMLSuite.menuBar.prototype.example = "disabled";)

setTarget

void setTarget(idOfHTMLElement)

Specify where this menu bar will be inserted. the element with this id will be parent of the menu bar.

Parameters:
String - idOfHTMLElement = Id of element where the menu will be inserted.

setText

void setText(menuItemId,newText)

Replace the text for a menu item

Parameters:
Integer - menuItemId - Id of menu item.
String - newText - New text for the menu item.

showMenuItem

void showMenuItem(menuItemId)

This method shows a menu item. If the item isn't hidden, nothing is done.

Parameters:
Number - menuItemId - Id of the item you want to show