path: root/org.eclipse.help.webapp/advanced/indexList.js

/*******************************************************************************
 * Copyright (c) 2005, 2006 Intel Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     Intel Corporation - initial API and implementation
 *     IBM Corporation 2006, refactored index view into a single frame
 *******************************************************************************/

var oldActive;
var oldActiveClass = "";

/**
 * Returns the target node of an event
 */
function getTarget(e) {
	var target;
  	if (isIE) {
   		target = window.event.srcElement;
   	} else {  	
  		target = e.target;
   	}

	return target;
}

/**
 * Returns the next tree node "down" from current one
 */
function getNextDown(node) {
	var a = getAnchorNode(node);
	if (!a) return null;

	// Try visible child first
	var li = a.parentNode;
	var ul = getChildNode(li, "UL");
	if (ul) {
		if (ul.className == "expanded") {
			return getDescendantNode(ul, "A");
		} else {
			var ulNext = getNextSibling(ul);
			if (ulNext && ulNext.nodeType == 1 && ulNext.tagName == "UL") {
				return getDescendantNode(ulNext, "A");
			}
		}
	}

	// Try next sibling in current UL
	var li_sib = getNextSibling(li);
	if (li_sib != null) {
		return getDescendantNode(li_sib, "A");
	}

	// Try child from next UL
	var ulNext = getNextSibling(li.parentNode);
	if (ulNext && ulNext.nodeType == 1 && ulNext.tagName == "UL") {
		return getDescendantNode(ulNext, "A");
	}

	// Try looking to parent's sibling
	while (li_sib == null) {
		var ul = li.parentNode;
		li = ul.parentNode;
		if (li.tagName != "LI") // reached the top, nothing else to do
			return null;

		li_sib = getNextSibling(li);
	}

	// found the next down sibling
	return getDescendantNode(li_sib, "A");
}

/**
 * Returns the next tree node "up" from current one
 */
function getNextUp(node) {
	var a = getAnchorNode(node);
	if (!a) return null;

	// Get previous sibling first
	var li = a.parentNode;
	var li_sib = getPrevSibling(li);
	if (li_sib != null) {
		// try to get the deepest node that preceeds this current node
		var candidate = getDescendantNode(li_sib, "A");
		var nextDown = getNextDown(candidate);
		while (nextDown != null && nextDown != node) {
			candidate = nextDown;
			nextDown = getNextDown(nextDown);
		}
		return getDescendantNode(candidate, "A");
	} else {
		// look into previous UL
		var ulPrev = getPrevSibling(li.parentNode);
		if (ulPrev && ulPrev.nodeType == 1 && ulPrev.tagName == "UL" && ulPrev.className == "expanded") {
			var li = getChildNode(ulPrev, "LI");
			var candidate = getDescendantNode(li, "A");
			var nextDown = getNextDown(candidate);
			while (nextDown != null && nextDown != node) {
				candidate = nextDown;
				nextDown = getNextDown(nextDown);
			}
			return getDescendantNode(candidate, "A");
		} else {
			// get the parent
			var li = li.parentNode.parentNode;
			if (li && li.tagName == "LI")
				return getDescendantNode(li, "A");
			else
				return null;
		}
	}
}

/**
 * Returns the next sibling element
 */
function getNextSibling(node) {
	var sib = node.nextSibling;
	while (sib && (sib.nodeType == 3 || sib.tagName == "SCRIPT")) // text or script node
		sib = sib.nextSibling;
	return sib;
}

/**
 * Returns the next sibling element
 */
function getPrevSibling(node) {
	var sib = node.previousSibling;
	while (sib && (sib.nodeType == 3 || sib.tagName == "SCRIPT")) // text or script node
		sib = sib.previousSibling;
	return sib;
}


/**
 * Returns the child node with specified tag
 */
function getChildNode(parent, childTag) {
	var list = parent.childNodes;
	if (list == null) return null;
	for (var i = 0; i < list.length; i++)
		if (list.item(i).tagName == childTag)
			return list.item(i);
	return null;
}

/**
 * Returns the descendat node with specified tag (depth-first searches)
 */
function getDescendantNode(parent, childTag) {	
	if (parent == null) return null;

	if (parent.tagName == childTag)
		return parent;

	var list = parent.childNodes;
	if (list == null) return null;
	for (var i = 0; i < list.length; i++) {
		var child = list.item(i);
		if (child.tagName == childTag)
			return child;

		child = getDescendantNode(child, childTag);
		if (child != null)
			return child;
	}
	return null;
}

/**
 * Returns the anchor of this click
 * NOTE: MOZILLA BUG WITH A:focus and A:active styles
 */
function getAnchorNode(node) {
	if (node == null) return null;

	if (node.nodeType == 3)  //"Node.TEXT_NODE")
		return node.parentNode;
	else if (node.tagName == "A")
		return node;
	else if (node.tagName == "IMG")
		return getChildNode(node.parentNode, "A");
	return null;
}

/**
 * Returns true when the node is the plus or minus icon
 */
function isPlusMinus(node) {
	return (node.nodeType != 3 && node.tagName == "IMG" && (node.className == "expanded" || node.className == "collapsed"));
}

/**
 * Returns the plus/minus icon for this tree node
 */
function getPlusMinus(node) {
	if (isPlusMinus(node))
		return node;
	else if (node.nodeType == 3)  //"Node.TEXT_NODE")
		return getChildNode(node.parentNode.parentNode, "IMG");
	else if (node.tagName == "IMG")
		return getChildNode(node.parentNode.parentNode, "IMG");
	else if (node.tagName == "A")
		return getChildNode(node.parentNode, "IMG");

	return null;
}

/**
 * Collapses a tree rooted at the specified element
 */
function collapse(node) {
	node.className = "collapsed";
	node.src = plus.src;
	node.alt = altExpandTopicTitles;
	node.title = altExpandTopicTitles;
	// set the UL as well
	var ul = getChildNode(node.parentNode, "UL");
	if (ul != null) ul.className = "collapsed";
}

/**
 * Expands a tree rooted at the specified element
 */
function expand(node) {
	node.className = "expanded";
	node.src = minus.src;
	node.alt = altCollapseTopicTitles;
	node.title = altCollapseTopicTitles;
	// set the UL as well
	var ul = getChildNode(node.parentNode, "UL");
	if (ul != null) {
		ul.className = "expanded";
		if (ul.id.length > 0) {
			if (!frames.dynLoadFrame) {
				return;
			}
			var ix = window.location.href.indexOf('?');
			if (ix < 0) {
				return;
			}
			var query = window.location.href.substr(ix);
			frames.dynLoadFrame.location = "tocFragment.jsp" + query + "&path=" + ul.id;
		}
	}
}

/**
 * Returns true when this is an expanded tree node
 */
function isExpanded(node) {
	return node.className == "expanded";
}

/**
 * Returns true when this is a collapsed tree node
 */
function isCollapsed(node) {
	return  node.className == "collapsed";
}

/**
 * Highlights link
 */
function highlightTopic(topic) {
	if (isMozilla) {
		// try-catch is a workaround for the getSelection() problem
		// reported for Safari 2.0.3
		try {
			window.getSelection().removeAllRanges();
		} catch (e) {}
	}

	var a = getAnchorNode(topic);
	if (a != null) {
		// TO DO:
		// parent.parent.parent.parent.setContentToolbarTitle(tocTitle);
		if (oldActive)
			oldActive.className = oldActiveClass;

		oldActive = a;
		oldActiveClass = a.className;
		a.className += " active";

		// it looks like the onclick event is not handled in mozilla
		// *** TO DO: handle failed synchronization, do not select in that case
		if (!isIE && a.onclick)
			a.onclick()
		//if (isIE)
		//	a.hideFocus = "true";
	}
}

/**
 * Selects a topic in the tree: expand tree and highlight it
 * returns true if success
 */
function selectTopicById(id) {
	var topic = document.getElementById(id);
	if (topic) {
		highlightTopic(topic);
		scrollToViewTop(topic);
		return true;
	}
	return false;
}
/**
 * Returns the horizontal offset on which the page should be scrolled to show the node.
 * Returns 0 if the node is already visible.
 */
function getVerticalScroll(node) {
	var nodeTop = node.offsetTop;
	var nodeBottom = nodeTop + node.offsetHeight;
	var pageTop = 0;
	var pageBottom = 0;

	if (isIE) {
		pageTop = document.body.scrollTop;
		pageBottom = pageTop + document.body.clientHeight;
	} else {
		pageTop = window.pageYOffset;
		pageBottom = pageTop + window.innerHeight - node.offsetHeight;
	}

	var scroll = 0;
	if (nodeTop >= pageTop) {
		if (nodeBottom <= pageBottom)
			scroll = 0; // already in view
		else
			scroll = nodeBottom - pageBottom;
	} else {
		scroll = nodeTop - pageTop;
	}

	return scroll;
}


/**
 * Scrolls the page to show the specified element
 */
function scrollIntoView(node) {
	var scroll = getVerticalScroll(node);
	if (scroll != 0)
		window.scrollBy(0, scroll);
}

/**
 * Scrolls the page so the node gets to the first line
 */
function scrollToViewTop(node) {
    if (node != null) {
	    window.scrollTo(0, node.offsetTop);
	}
}

/*
 * Currently called on IE only
 */
function focusHandler(e)
{
	/*if (isMozilla)
		return;
	*/
		
	try{
		if (oldActive){
			// only focus when the element is visible
			var scroll = getVerticalScroll(oldActive);
			if (scroll == 0)
				oldActive.focus();
		}		
	}
	catch(e){}
}

function sizeList() {
    resizeVertical("indexList", "typeinTable", null, 100, 5);
}

/**
 * display topic label in the status line on mouse over topic
 */
function mouseMoveHandler(e) {
	var overNode = getTarget(e);
	if (!overNode) return;

	overNode = getAnchorNode(overNode);
	if (overNode == null) {
		window.status = "";
		return;
	}

	if (!isIE)
		e.cancelBubble = false;

	if (overNode.title == "") {
		if (overNode.innerText)
			overNode.title = overNode.innerText;
		else if (overNode.text)
			overNode.title = overNode.text;
	}
	window.status = overNode.title;
}

/**
 * handler for expanding / collapsing topic tree
 */
function mouseClickHandler(e) {
	var clickedNode = getTarget(e);
	if (!clickedNode) return;

	var plus_minus = getPlusMinus(clickedNode);
	if (plus_minus != null) {
		if (isCollapsed(plus_minus)) 
			expand(plus_minus);
		else if (isPlusMinus(clickedNode) && isExpanded(plus_minus))
			// collapse only if click on minus image
			collapse(plus_minus);
	}

	var anchorNode = getAnchorNode(clickedNode);
	if (anchorNode) {
		highlightTopic(anchorNode);
		setTypeinValue(anchorNode);
	}

	if (isIE) {
		window.event.cancelBubble = true;
	} else {	    
		e.cancelBubble = true;
	}
}

/**
 * Handler for key down (arrows)
 */
function keyDownHandler(e) {
	var key = getKeycode(e);	
	var target = getEventTarget(e);
	if (target === null) return;
	if (target.id == "typein") {
	    return typeinKeyDownHandler(e);
	}

	if (key <37 || key > 40)
		return true;

	if (isIE) {
		window.event.cancelBubble = true;
	} else {	    
		e.cancelBubble = true;
	}

	if (key == 39) { // Right arrow, expand
		var clickedNode = getTarget(e);
		if (!clickedNode) return;

		var plus_minus = getPlusMinus(clickedNode);
		if (plus_minus != null)
		{
			if (isCollapsed(plus_minus))
				expand(plus_minus);

			highlightTopic(plus_minus);
			scrollIntoView(clickedNode);
		}
	} else if (key == 37) { // Left arrow,collapse
		var clickedNode = getTarget(e);
		if (!clickedNode) return;
		var plus_minus = getPlusMinus(clickedNode);
		if (plus_minus != null) {
			if (isExpanded(plus_minus))
				collapse(plus_minus);

			highlightTopic(plus_minus);
			scrollIntoView(clickedNode);
		}
	} else if (key == 40 ) { // down arrow
		var clickedNode = getTarget(e);
		if (!clickedNode) return;

		var next = getNextDown(clickedNode);
		if (next) {
			highlightTopic(next);
			setTypeinValue(next);
			next.focus();
		}

	} else if (key == 38) { // up arrow
		var clickedNode = getTarget(e);
		if (!clickedNode) return;

		var next = getNextUp(clickedNode);
		if (next) {
			highlightTopic(next);
			setTypeinValue(next);
			next.focus();
		}
	}

	return true;
}