The methods below apply to a NavBar object. Some only have an affect when used after the bar has been created while others will work either before or after. Those methods are marked with an asterisk.

• hide() - Hides the navigation bar from view.

• show() - Make the navigation bar visible.

• moveTo(x, y)* - Moves the bar to the specified coordinates. By default navigation bars will be positioned at (0, 0).

• moveBy(dx, dy)* - Moves the bar by the given values.

• getzIndex() - Returns the current zIndex value of the bar, Drop down menus for a bar will have the same zIndex as the bar itself.

• setzIndex(z) - Sets the zIndex value of the bar and. drop down menus. This allows you to set the stacking order when a bar overlaps another bar or positioned element.

• getWidth()* - Returns the current width of the bar. This is useful if you initially define a bar with a width of zero and want to find what the resulting width is after it has been created.

• getMinWidth() - Returns the minimum width allowed for the bar. This is based on the total width required for the headers.

• getAlign()* - Returns "left", "center" or "right" or a numeric value depending on the bar's current alignment setting. Alignment determines where the headers appear when a bar has a width set wider than that needed to fit all its headers. By default the alignment is "left".

• setAlign(alignment)* - Given a value of "left", "center" or "right" this will change the position of the headers relative to the bar. If a numeric value is given instead, the headers will be moved to the position that many pixels from the left edge of the bar. The headers will be repositioned dynamically if the bar has already been created.

• resize(width)* - Resizes the bar to the given width. If already created the headers will be repositioned according the the bar's current alignment setting. Note that if you specify a width less than the value given by getMinWidth() the bar will be resized using the minimum required width instead.

• invert()* - Toggles the placement of the menus. By default they drop down below the bar but they can also be made to appear above the bar.

• isInverted()* - Returns true if the bar has been inverted, false otherwise.

Using Navigation Bars in Frames

Frames are treated as individual windows by the browser. The bar and drop down menus cannot cross over the boundaries between frames, any more than an image on a page can be made to stick outside of the browser window. Likewise, you cannot have a drop down appear in a frame other than the one containing its parent bar.

Also note that you must use JavaScript code in the item links instead of plain URLs in order to make a link open in another frame or window. See the notes on Setting Item Links for details. This example demonstrates the technique.

Positioning a Navigation Bar

The bars and menus are dynamically positioned objects which float on top of the normal page contents. That means that if you want one to appear in a particular location on your page you'll have to find the coordinates of that spot and use the moveTo() method to place it there.

One easy way to do this is by embedding a transparent image within the page content. This reserves space for the bar and the image's coordinates can be found using some functions from the same DHTML Library code file used by the bar script. A working example demonstrates this best.

Please note that when the menus overlap elements such as form input boxes, buttons, applets or plugins on a page, the element underneath may bleed thru. This is due to the way the browser handles these elements and will vary depending on the browser. There is no fix for this so you must either try to avoid placing such elements near the menu or be willing to accept the unusual appearance. For an excellent discussion of this problem and details of which elements affect which browsers see the Webreference.com article titled Positioned Elements and OS Controls, Applets and Plug-ins .

Another factor to consider is the stacking order of the bar relative to any other positioned elements you may have, including other navigation bars. The getzIndex() and setzIndex() methods allow you to alter that value and control which element appears on top when two overlap.

The old version of the script had an option to automatically move the bar as the page was scrolled, keeping it in the same position relative to the window. That has been dropped in this version but you can easily create the same effect with a few lines of code. Another example demonstrates the basic technique.

How It Works

The navigation bars and drop down menus are composed of several layers which are built and added to the page dynamically based on the given NavBar object when the create() method is called.

Mouse events are captures for certain layer components to control the highlighting of items, the display of the drop down menus and to handle the link associated with each item when clicked on.

Layer Layout

First a base layer is created, using the border color. This acts as a container allowing the entire bar to be positioned and hidden or made visible. A filler layer is added, using the normal header background color. It's set to cover the base layer except for the surrounding border.

Then a layer is added to contain the headers. It acts much like the bar's base layer, providing a border around each header and allowing them to be moved as a group. This allows the headers to be easily aligned to the left, center or right of the bar.

Each header is made up of three layers, all the same size and stacked directly on top of each other. The first has the header text in it's normal foreground and background colors. The second also has the header text but in it's highlighted foreground and background colors. This highlighted layer is normally made invisible so the normal layer can be seen. The topmost layer is transparent and used to solely to capture mouse events for the header.

Each drop down menu is constructed separately. Again a single base layer is used to create the borders and act as a container for all the menu items. Just like the headers, each menu item also consists of three layers, the only difference being the colors used for each item layer. The menu base layer is normally set to be invisible, hiding it and the sub layers making up the items.

Event Capturing

First, the mousemove event is captured for the entire page. This allows the current mouse position to be tracked at all times. The mouse coordinates are stored in two global variables, mouseX and mouseY. These are used when the user mouses off a header as described below.

Each header and item captures three events, mouseover, mouseout and mouse click (IE) or mouseup (NS). On a mouseover, the highlight layer for the header or menu item is made visible and on a mouseout it is made invisible again, creating the highlight effect.

Controlling the Drop Down Menus

Additionally, when a header is moused over, the drop down menu associated with it is moved into position just below the header and made visible. The menu is aligned horizontally with the left edge of the header unless that would place the right edge of the menu past the end of the navigation bar. In that case, it is aligned with the right edge of the header.

This keeps the whole display within the left and right boundaries of the navigation bar while allowing longer text strings in the items. By overlapping the menus, more information can be placed in a given area without cluttering it because only one menu can be active at a given time.

When a mouseout occurs on a header, we first have to check to see if the mouse has moved onto the drop down menu. If not, the menu and header can be deactivated. That's where the mouseX and mouseY variables come into play. When a menu is activated, it's position on the page is saved and can then be compared to the current mouse coordinates.

The mouseout event for each menu's base layer is also captured so that when the user moves the mouse off a menu, it and its associated header can be deactivated.

Links

When an item or header is clicked on, the associated link string is checked. If it's a null string, nothing is done. If the string starts with "javascript:" the built-in eval() function is called with the string as an argument, causing the code to be executed.

For anything else, the string is taken to be a URL and the window's location is set to that value, causing the link to be followed.

Window Resizing

Netscape browsers have a bug that causes all DHTML information to be lost when the browser is resized. To correct this, the window resize event is captured so that the page can be reloaded after being resized. This rebuilds any and all navigation bars.

Note that some early releases of Netscape 4 have a bug that can cause a resize event to fire even when the window has not be resized. To correct this, the width and height of the window is saved at load time. On a resize, these are checked against the current width and height and a reload occurs only if the size has indeed changed.

To keep the behavior consistent with IE, resizes are handled the same way. However, when resizing an IE browser by dragging the window border, the 'Show window contents while dragging' display option on Windows platforms will cause the event to fire before the window can be resized, canceling the drag. This means the user would be unable to resize the browser via dragging.

To prevent this, a setTimeout() is used to reload the page. This allows the user a couple of seconds to resize the browser before the page gets refreshed and cancels the user drag action.

Source

Documentation

• index.html - examples and documentation.
• index2.html - examples and documentation.

• frames.html - frames example, frameset definition.
• header.html - frames example, top frame with navigation bar.
• main.html - frames example, bottom frame.
• positioning.html - positioning example.
• static.html - static bar example.

• dhtmllib.js - the cross-browser DHTML library
• navbar.js - the Navigation Bar code.
• navcond.js - combined version of the two .js files above, condensed for faster download.

The script is fairly large, so if you are concerned about download time use the condensed navcond.js version which can be used in place of the dhtmllib.js and navbar.js files (25K vs. 40K). It contains all the code in the other two files but has been stripped of most comments and formatting.

You can also download navbar.zip (57K) which contains all the JavaScript code files, documentation and examples.

Page 1 - Page 2