// Title:        Plone javascript menu
// Description:  Adaption of Tigra Menu for plone
// URL:          http://www.3captus.com/downloads/ploneJSMenu
// Version:      0.9
//
// Changes:
//    - use top level menu created by plone (portal-globalnav)
//      as level0 menu
//    - change zindex of generated menu item as 30 + depth
//      to make it display on top of other plone javascript
//      contents
//    - replace root level menu with plone portal-globalnav
//    - remove single quote from comment to make the coloring
//      works in vim editor
//    - make source code 80 column terminal friendly
//

// Title: Tigra Menu
// Description: Free JavaScript Menu Navigation
// URL: http://www.javascript-menu.com/
// Version: 2.1 (commented source)
// Date: 06/26/2007
// Tech. Support: http://www.softcomplex.com/forum/forumdisplay_29/
// Notes: This script is free. Visit official site for further details.

// ----------------------------------------------------------------------------
// global collection containing all menus on current page
var A_MENUS = [];

// ----------------------------------------------------------------------------
// menu class
function menu (a_items, a_tpl, plone_menu) {

	// browser check
	if (!document.body || !document.body.style)
		return;

	// store items structure
	this.a_config = a_items;

	// store template structure
	this.a_tpl = a_tpl;

	// get menu id
	this.n_id = A_MENUS.length;

	// declare collections
	this.a_index = [];
	this.a_children = [];

	// assigh methods and event handlers
	this.expand      = menu_expand;
	this.collapse    = menu_collapse;

	this.onclick     = menu_onclick;
	this.onmouseout  = menu_onmouseout;
	this.onmouseover = menu_onmouseover;
	this.onmousedown = menu_onmousedown;

	// default level scope description structure 
	this.a_tpl_def = {
		'block_top'  : 16,
		'block_left' : 16,
		'top'        : 20,
		'left'       : 4,
		'width'      : 120,
		'height'     : 22,
		'hide_delay' : 0,
		'expd_delay' : 0,
		'css'        : {
			'inner' : '',
			'outer' : ''
		}
	};
	
	// assign methods and properties required to imulate parent item
	this.getprop = function (s_key) {
		return this.a_tpl_def[s_key];
	};

	this.o_root = this;
	this.n_depth = -1;
	this.n_x = 0;
	this.n_y = 0;

	// 	init items recursively
	for (n_order = 0; n_order < a_items.length; n_order++)
		new menu_item(this, n_order, plone_menu[n_order]);

	// register self in global collection
	A_MENUS[this.n_id] = this;
}

// ----------------------------------------------------------------------------
function menu_collapse (n_id) {
	// cancel item open delay
	clearTimeout(this.o_showtimer);

	// by default collapse to root level
	var n_tolevel = (n_id ? this.a_index[n_id].n_depth : 0);
	
	// hide all items over the level specified
	for (n_id = 0; n_id < this.a_index.length; n_id++) {
		var o_curritem = this.a_index[n_id];
		if (o_curritem.n_depth > n_tolevel && o_curritem.b_visible) {
			o_curritem.e_oelement.style.visibility = 'hidden';
			o_curritem.b_visible = false;
		}
	}

	// reset current item if mouse has gone out of items
	if (!n_id)
		this.o_current = null;
}

// ----------------------------------------------------------------------------
function menu_expand (n_id) {

	// expand only when mouse is over some menu item
	if (this.o_hidetimer)
		return;

	// lookup current item
	var o_item = this.a_index[n_id];

	// close previously opened items
	if (this.o_current && this.o_current.n_depth >= o_item.n_depth)
		this.collapse(o_item.n_id);
	this.o_current = o_item;

	// exit if there are no children to open
	if (!o_item.a_children)
		return;

	// show direct child items
	for (var n_order = 0; n_order < o_item.a_children.length; n_order++) {
		var o_curritem = o_item.a_children[n_order];
		o_curritem.e_oelement.style.visibility = 'visible';
		o_curritem.b_visible = true;
	}
}

// ----------------------------------------------------------------------------
function menu_onclick (n_id) {
	var o_item = this.a_index[n_id];
	var s_link = o_item.a_config[1];
	if (!s_link)
		return true;
	if (String(s_link).toLowerCase().indexOf('javascript:') == 0)
		return eval(s_link);
	if (o_item.a_config[2] && o_item.a_config[2]['tw'])
		window.open(s_link, o_item.a_config[2]['tw']);
	else
		window.location = s_link;
	return true;
}

// ----------------------------------------------------------------------------
function menu_onmouseout (n_id) {

	// lookup new item objects
	var o_item = this.a_index[n_id];

	// apply rollout
    if (o_item.n_depth != 0) {
	    o_item.e_oelement.className = o_item.getstyle(0, 0);
	    o_item.e_ielement.className = o_item.getstyle(1, 0);
    }

	// update status line	
	o_item.upstatus(7);

	// run mouseover timer
	this.o_hidetimer = setTimeout('A_MENUS['+ this.n_id +'].collapse();',
		o_item.getprop('hide_delay'));
}

// ----------------------------------------------------------------------------
function menu_onmouseover (n_id) {

	// cancel mouseoute menu close and item open delay
	clearTimeout(this.o_hidetimer);
	this.o_hidetimer = null;
	clearTimeout(this.o_showtimer);

	// lookup new item objects
	var o_item = this.a_index[n_id];

	// update status line	
	o_item.upstatus();

	// apply rollover
    if (o_item.n_depth != 0) {
	    o_item.e_oelement.className = o_item.getstyle(0, 1);
	    o_item.e_ielement.className = o_item.getstyle(1, 1);
    }
	
	// if onclick open is set then no more actions required
	if (o_item.getprop('expd_delay') < 0)
		return;

	// run expand timer
	this.o_showtimer = setTimeout(
        'A_MENUS['+ this.n_id +'].expand(' + n_id + ');',
		o_item.getprop('expd_delay'));

}

// ----------------------------------------------------------------------------
// called when mouse button is pressed on menu item
// ----------------------------------------------------------------------------
function menu_onmousedown (n_id) {
	
	// lookup new item objects
	var o_item = this.a_index[n_id];

	// apply mouse down style
    if (o_item.n_depth != 0) {
	    o_item.e_oelement.className = o_item.getstyle(0, 2);
	    o_item.e_ielement.className = o_item.getstyle(1, 2);
    }

	this.expand(n_id);
}

// ----------------------------------------------------------------------------
// menu item Class
function menu_item (o_parent, n_order, level0_element) {

	// store parameters passed to the constructor
	this.n_depth  = o_parent.n_depth + 1;
	this.a_config = o_parent.a_config[n_order + (this.n_depth ? 3 : 0)];

	// return if required parameters are missing
	if (!this.a_config) return;

	// store info from parent item
	this.o_root    = o_parent.o_root;
	this.o_parent  = o_parent;
	this.n_order   = n_order;

	// register in global and parent collections
	this.n_id = this.o_root.a_index.length;
	this.o_root.a_index[this.n_id] = this;
	o_parent.a_children[n_order] = this;

	// calculate items coordinates
	var o_root = this.o_root,
		a_tpl  = this.o_root.a_tpl;

	// assign methods
	this.getprop  = mitem_getprop;
	this.getstyle = mitem_getstyle;
	this.upstatus = mitem_upstatus;

	this.n_x = n_order
		? o_parent.a_children[n_order - 1].n_x + this.getprop('left')
		: o_parent.n_x + this.getprop('block_left');

	this.n_y = n_order
		? o_parent.a_children[n_order - 1].n_y + this.getprop('top')
		: o_parent.n_y + this.getprop('block_top');

    // a hack to enable dynamic width for the first 2 levels
    this.n_x = absoluteX(this, o_parent, level0_element);
    if (this.n_y < absoluteY(this, o_parent, level0_element)) {
        this.n_y = absoluteY(this, o_parent, level0_element);
    }

    // prepare variable for HTML
    var div_ielement_id = 'e' + o_root.n_id + '_' + this.n_id + 'i';
    var div_oelement_id = 'e' + o_root.n_id + '_' + this.n_id + 'o';
    var div_oclass = this.getstyle(0, 0);
    var div_iclass = this.getstyle(1, 0);
    var div_otitle = this.a_config[2] && this.a_config[2]['tt'] 
            ? this.a_config[2]['tt'] : '';

    var ostyle_width = this.getprop('width');
    if (ostyle_width == 'auto') {
        ostyle_width += ';';
    } else {
        ostyle_width = this.getprop('width') + 'px;';
    }
    var ostyle_visibility = 'hidden' + ';';
    var ostyle_position = 'absolute' + ';';
    var ostyle_top = this.n_y + 'px;'
    var ostyle_left = this.n_x + 'px;'
    var ostyle_height = this.getprop('height') + 'px;'
    var ostyle_zindex = this.n_depth + 30 + ';'
    var ostyle_cursor = (this.a_config[1] ? 'pointer' : 'default') + ';'

    var div_ostyle = 
        'visibility:' + ostyle_visibility +
        'position:' + ostyle_position +
        'top:'  + ostyle_top +
        'left:' + ostyle_left +
        'width:' + ostyle_width + 
        'height:' + ostyle_height +
        'z-index:' + ostyle_zindex +
        'cursor:' + ostyle_cursor;
    var div_item_str = 'A_MENUS[' + o_root.n_id + ']';

    // generate items HMTL
    document.write (
        '<div ', 'id="', div_oelement_id, '" ', 
            'class="', div_oclass, '" ', 
            'title="', div_otitle, '" ',
            'style="', div_ostyle, '" ',
            'onclick="', 'return ', div_item_str, '.onclick(', this.n_id, ');"',
            'onmouseout="' , div_item_str, '.onmouseout(', this.n_id, ');"',
            'onmouseover="', div_item_str, '.onmouseover(', this.n_id, ');"',
            'onmousedown="', div_item_str, '.onmousedown(', this.n_id, ');">', 
        '<div id="', div_ielement_id, '" ', 'class="', div_iclass, '">',
            this.a_config[0], '</div>',
        '</div>'
    );

	this.e_ielement = document.getElementById(div_ielement_id);
	this.e_oelement = document.getElementById(div_oelement_id);

	this.b_visible = !this.n_depth;

	// no more initialization if leaf
	if (this.a_config.length < 4)
		return;

	// node specific methods and properties
	this.a_children = [];

	// init downline recursively
	for (var n_order = 0; n_order < this.a_config.length - 3; n_order++)
		new menu_item(this, n_order, level0_element);
}

// ----------------------------------------------------------------------------
// reads property from template file, inherits from parent level if not found
// ----------------------------------------------------------------------------
function mitem_getprop (s_key) {

	// check if value is defined for current level
	var s_value = null,
		a_level = this.o_root.a_tpl[this.n_depth];

	// return value if explicitly defined
	if (a_level)
		s_value = a_level[s_key];

	// request recursively from parent levels if not defined
	return (s_value == null ? this.o_parent.getprop(s_key) : s_value);
}
// ----------------------------------------------------------------------------
// reads property from template file, inherits from parent level if not found
// ----------------------------------------------------------------------------
function mitem_getstyle (n_pos, n_state) {

	var a_css = this.getprop('css');
	var a_oclass = a_css[n_pos ? 'inner' : 'outer'];

	// same class for all states	
	if (typeof(a_oclass) == 'string')
		return a_oclass;

	// inherit class from previous state if not explicitly defined
	for (var n_currst = n_state; n_currst >= 0; n_currst--)
		if (a_oclass[n_currst])
			return a_oclass[n_currst];
}

// ----------------------------------------------------------------------------
// updates status bar message of the browser
// ----------------------------------------------------------------------------
function mitem_upstatus (b_clear) {
	window.setTimeout("window.status=unescape('" + (b_clear
		? ''
		: (this.a_config[2] && this.a_config[2]['sb']
			? escape(this.a_config[2]['sb'])
			: escape(this.a_config[0]) + (this.a_config[1]
				? ' ('+ escape(this.a_config[1]) + ')'
				: ''))) + "')", 10);
}

// ----------------------------------------------------------------------------
// calculate dynamic xposition based on actually menu width of 1st level
// ----------------------------------------------------------------------------
function absoluteX(currDef, parentDef, level0_parent) {
    var x = 0;

    if (currDef.n_depth == 1) {
        var element;
        for (var i=0; i < level0_parent.childNodes.length; i++) {
            element = level0_parent.childNodes.item(i);
            if (element.nodeName == 'A') 
                break;
        }
        x = element.offsetLeft - 1;
    } else {
        x = currDef.n_x;
    }
    return x;
}

// ----------------------------------------------------------------------------
// calculate dynamic yposition based on actually menu width of 1st level
// ----------------------------------------------------------------------------
function absoluteY(currDef, parentDef, level0_parent) {
    var y = 0;

    if (currDef.n_depth == 1) {
        var element;
        for (var i=0; i < level0_parent.childNodes.length; i++) {
            element = level0_parent.childNodes.item(i);
            if (element.nodeName == 'A') 
                break;
        }
        y = element.offsetTop + element.offsetHeight;
    } else {
        y = currDef.n_y;
    }
    return y;
}

// ----------------------------------------------------------------------------
// return plone global menu items (portal-globalnav)
// ----------------------------------------------------------------------------
function getPloneMenu(id) {
    var elements = document.getElementById(id).childNodes;
    var results = new Array();

    for (var i=0; i < elements.length - 1; i++) {
        if (elements.item(i).nodeName == 'LI') {
            results.push(elements.item(i));
        }
    }
    return results;
}

// ----------------------------------------------------------------------------
// that is all folks
