analytics/webcontent/ags/CToolbarButton.js

/********************************************************************************************************************************
* Licensed Materials - Property of IBM                                                                                          *
*                                                                                                                               *
* IBM Cognos Products: AGS                                                                                                      *
*                                                                                                                               *
* (C) Copyright IBM Corp. 2005, 2014                                                                                            *
*                                                                                                                               *
* US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. *
*********************************************************************************************************************************/

/*-----------------------------------------------------------------------------------------------------

Class :			CToolbarButton

Description :	

-----------------------------------------------------------------------------------------------------*/

var tbUniqueId = 0;

function makeId() {
	return tbUniqueId++;
}

gDropDownButtonStyle = new CUIStyle('dropDownArrow','dropDownArrowOver','','','');

function CToolbarButton(parent, action, iconPath, toolTip, style, bHideDropDown, label, dropDownToolTip, iconWidth, capability) {
	this.m_id = 'tbbutton'+makeId();
	this.m_bVisible = true;
	this.m_action = action;
	this.m_toolTip = toolTip;
	this.m_capability = capability;
	this.m_icon = (iconPath) ? new CIcon(iconPath, toolTip) : null;
	if(iconWidth!=null && iconPath!=null){
	    this.m_icon.setWidth(iconWidth);    
	}
	this.m_parent = parent;
	this.m_menu = null;
	if (typeof bHideDropDown == "boolean")
		this.m_bHideDropDown = bHideDropDown;
	else
		this.m_bHideDropDown = false;
	this.m_style = new CUIStyle(style.getNormalState(),style.getRolloverState(),style.getDepressedState(),style.getDepressedRolloverState(),style.getDisabledState());
	this.m_observers = new CObserver(this);	

	if(typeof this.m_parent == "object" && typeof this.m_parent.add == "function") 
		this.m_parent.add(this);

	this.m_label = (label) ? label : null;
	this.m_dropDownToolTip = (dropDownToolTip) ? dropDownToolTip : this.m_toolTip;
}

function CToolbarButton_getId() {
	return this.m_id;
}

function CToolbarButton_draw() {
	var html='';
	var tabindexVal = -1 ;
	
	if (AccessibilityHandler.isEnabled()) {
		tabindexVal = AccessibilityHandler.getTabindex(this);
	}

	html += '<div style="margin-right:3px;"><button type="button" role="menuitem" id="';
	html += this.m_id;
	html += '"';
	html += 'tabindex='+ tabindexVal +'';
	
	if(typeof this.getStyle() == "object") {
		html += ' class="' + this.getStyle().getActiveState() + '"';
		if (this.getStyle().getActiveState() != this.getStyle().getDisabledState())
		{
			html += ' hideFocus="true" accessKey="1"';
		}
	}
	if (this.m_toolTip != "")
	{
		html += ' title="' + this.m_toolTip + '"';
	}

	html += '>';
	if (this.m_icon != null)
	{
		html += this.m_icon.draw();
	}
	
	if (this.m_label != null)
	{
		html += this.m_label;
	}
	
	html += '</button>';

	if(this.m_menu != null && !this.m_bHideDropDown) {
		html += '<button type="button" role="menuitem" id="';
		html += ('menu' + this.getId());
		html += '"';
		html += 'tabindex='+ tabindexVal +'';
		if(typeof this.getStyle() == "object") {
			html += ' class="'+gDropDownButtonStyle.getActiveState() + '"';
			if (this.getStyle().getActiveState() != this.getStyle().getDisabledState())
			{
				html += ' hideFocus="true" accessKey="1"';
			}
		}
		if (this.m_dropDownToolTip != "")
		{
			html += ' title="' + this.m_dropDownToolTip + '"';
		}
		
		html += '><img border="0" src="../ags/images/toolbar_drop_arrow.gif"';
		if (this.m_dropDownToolTip != "")
		{
			html += ' alt="' + this.m_dropDownToolTip + '"';
			html += ' title="' + this.m_dropDownToolTip + '"';
		}
		html += ' width="7" height="16"/></button>';
	}

	html += '</div>';

	return html;
}

function CToolbarButton_attachEvents() {

	if(typeof this.getParent().getHTMLContainer != "function")
		return; // this method must be implemented by the parent

	htmlContainer = this.getParent().getHTMLContainer();
	if(htmlContainer == null)
		return;

	if(document.all && typeof(htmlContainer.document) != 'undefined'){
		hTbItem = eval(htmlContainer.document.getElementById(this.m_id));
	}else{
		hTbItem = eval(htmlContainer.ownerDocument.getElementById(this.m_id));
	}

	if(hTbItem == null)
		return; // just to be safe

	hTbItem.onmouseover = this.onmouseover;
	hTbItem.onmouseout = this.onmouseout;
	hTbItem.onmouseup = this.onmouseup;
	hTbItem.onkeypress = this.onkeypress;
	hTbItem.onfocus = this.onfocus;
	hTbItem.onblur = this.onblur;
	
	hTbItem.tbItem = eval(this);

	// attach the drop down arrow event handlers to the toolbar button as well
	if(this.m_menu != null && !this.m_bHideDropDown) {
		if(document.all && typeof(htmlContainer.document) != 'undefined'){
			hmenu = eval(htmlContainer.document.getElementById('menu'+this.getId()));
		}else{
			hmenu = eval(htmlContainer.ownerDocument.getElementById('menu'+this.getId()));
		}
		//hmenu = eval(document.all ? htmlContainer.document.getElementById('menu'+this.getId()) : htmlContainer.ownerDocument.getElementById('menu'+this.getId()));
		hmenu.onmouseover = this.onmouseover;
		hmenu.onmouseout = this.onmouseout;
		hmenu.onmouseup = this.onmouseup;
		hmenu.onkeypress = this.onkeypress;
		hmenu.onfocus = this.onfocus;
		hmenu.onblur = this.onblur;
		
		hmenu.tbItem = eval(this);
	}
}

function CToolbarButton_createDropDownMenu(menuStyle, dropDownToolTip) {
	this.m_dropDownToolTip = (dropDownToolTip) ? dropDownToolTip : this.m_toolTip;
	this.m_menu = new CMenu('dropDown'+this.getId(),menuStyle);
	this.m_menu.setParent(this);
	return this.m_menu;
}

function CToolbarButton_addOwnerDrawControl(control) {
	this.m_menu = control

	if(typeof control.setParent != "undefined")
		this.m_menu.setParent(this);
}

function CToolbarButton_getParent() {
	return this.m_parent;
}

function CToolbarButton_setParent(parent) {
	this.m_parent = parent;
}

function CToolbarButton_getAction() {
	return this.m_action;
}

function CToolbarButton_setAction(action) {
	this.m_action = action
}

function CToolbarButton_getToolTip() {
	return this.m_toolTip;
}

function CToolbarButton_setToolTip(tooltip) {
	this.m_toolTip = tooltip;
}

function CToolbarButton_getDropDownToolTip() {
	return this.m_dropDownToolTip;
}

function CToolbarButton_setDropDownToolTip(tooltip) {
	this.m_dropDownToolTip = tooltip;
}

function CToolbarButton_getIcon() {
	return this.m_icon;
}

function CToolbarButton_setIcon(iconPath) {
	this.m_icon.setPath(iconPath);
}

function CToolbarButton_enableTabindex() {
	this.getHTMLElement().setAttribute("tabindex", "0");
}

function CToolbarButton_disableTabindex() {
	this.getHTMLElement().setAttribute("tabindex", "-1");
}

function CToolbarButton_onfocus(evt) {
	//get the event in a cross-browser fashion
	evt = (evt) ? evt : ((event) ? event : null);

	var toolbarButton = this.tbItem;

	if(toolbarButton == null || !(toolbarButton instanceof CToolbarButton) || !toolbarButton.isEnabled())
		return;
	
	var parent = toolbarButton.getParent();
	
	if (toolbarButton.getMenu() != null && toolbarButton.getMenu().isVisible()) {
		toolbarButton.getMenu().remove();
	}
		
	if (AccessibilityHandler.isEnabled()) {
		for (var i=0; i<parent.getNumItems(); i++) {
			if (parent.get(i) instanceof CToolbarButton) {
				if (toolbarButton == parent.get(i)) {
					parent.get(i).enableTabindex();
					if(toolbarButton.getMenu() != null && !toolbarButton.m_bHideDropDown && ('menu'+toolbarButton.getId()) == this.id) {
						this.className = gDropDownButtonStyle.getActiveRolloverState();
					} else {
						this.className = toolbarButton.getStyle().getActiveRolloverState();
					}
				}
				else
					parent.get(i).disableTabindex();
			}
		}	
	}
}

function CToolbarButton_onmouseover(evt) {
	var toolbarButton = this.tbItem;
	if(typeof toolbarButton == "object") {
		if(!toolbarButton.isEnabled()) 
			return;
		if(toolbarButton.getMenu() != null && !toolbarButton.m_bHideDropDown && ('menu'+toolbarButton.getId()) == this.id) {
			this.className = gDropDownButtonStyle.getActiveRolloverState();
		} else {
			if(typeof toolbarButton.getStyle() == "object") 
				this.className = toolbarButton.getStyle().getActiveRolloverState();

			if(toolbarButton.getMenu() != null && !toolbarButton.m_bHideDropDown) {
				var dropDownArrow = null;
				if(document.all && typeof(this.document) != 'undefined'){
					dropDownArrow = this.document.getElementById('menu'+toolbarButton.getId());
				}else{
					dropDownArrow = this.ownerDocument.getElementById('menu'+toolbarButton.getId());
				}
				//var dropDownArrow = document.all ? this.document.getElementById('menu'+toolbarButton.getId()) : this.ownerDocument.getElementById('menu'+toolbarButton.getId());
				if(typeof dropDownArrow == "object")
					dropDownArrow.className = gDropDownButtonStyle.getActiveRolloverState();
			}
		}
		
		// send the message up to our parent
		if(toolbarButton.getParent() != null && typeof toolbarButton.getParent().onmouseover == "function")
			toolbarButton.getParent().onmouseover(evt);
			
		// notify our observers of this event			
		toolbarButton.getObservers().notify(CToolbarButton_onmouseover);		
	}
}

function CToolbarButton_onmouseout(evt) {
	toolbarButton = this.tbItem;
			
	if(typeof toolbarButton == "object") {
		if(!toolbarButton.isEnabled())
			return;
		if(toolbarButton.getMenu() != null && !toolbarButton.m_bHideDropDown && ('menu'+toolbarButton.getId()) == this.id) {
			this.className = gDropDownButtonStyle.getActiveState();
		} else {
			if(typeof toolbarButton.getStyle() == "object") 
				this.className = toolbarButton.getStyle().getActiveState();

			if(toolbarButton.getMenu() != null && !toolbarButton.m_bHideDropDown) {
				if(document.all && typeof(this.document) != 'undefined'){
					dropDownArrow = this.document.getElementById('menu'+toolbarButton.getId());
				}else{
					dropDownArrow = this.ownerDocument.getElementById('menu'+toolbarButton.getId());
				}
				//dropDownArrow = document.all ? this.document.getElementById('menu'+toolbarButton.getId()) : this.ownerDocument.getElementById('menu'+toolbarButton.getId());
				if(typeof dropDownArrow == "object")
					dropDownArrow.className = gDropDownButtonStyle.getActiveState();
			}

		}
		
		// send the message up to our parent
		if(toolbarButton.getParent() != null && typeof toolbarButton.getParent().onmouseout == "function")
			toolbarButton.getParent().onmouseout(evt);
			
		// notify our observers of this event		
		toolbarButton.getObservers().notify(CToolbarButton_onmouseout);	
	}
}

function CToolbarButton_onmouseup(evt) {

	//get the event in a cross-browser fashion
	evt = (evt) ? evt : ((event) ? event : null);

    var buttonValue = (document.all && typeof(this.document) != 'undefined')?1:0;

    if (evt.button != buttonValue) {
        //Only do it for left click
        return;
    }
    
	// get the toolbar button from the html element
	var toolbarButton = this.tbItem;

	if(toolbarButton != null) {
		if(!toolbarButton.isEnabled())
			return;
		var menu = toolbarButton.getMenu();
		if(menu != null && ((this.id == ('menu'+toolbarButton.getId())) || (toolbarButton.m_bHideDropDown && this.id == toolbarButton.getId()))) {
			if(menu.isVisible()) {
				menu.remove();
			} else {
				// the user clicked the drop down arrow
				if(typeof menu.setHTMLContainer != "undefined")
					menu.setHTMLContainer((document.all && typeof(this.document) != 'undefined')? this.document.body : this.ownerDocument.body);

				toolbarButton.showMenu(menu);
			}
		} else {
			eval(this.tbItem.m_action);	
		}
		
		// send the message up to our parent
		if(toolbarButton.getParent() != null && typeof toolbarButton.getParent().onmouseup == "function")
			toolbarButton.getParent().onmouseup(evt);
			
		// notify our observers of this event
		toolbarButton.getObservers().notify(CToolbarButton_onmouseup);		
	}
	
	if (this.blur && this.hasFocus && this.hasFocus()){
		this.blur();
	}

	evt.cancelBubble = true;
	return false;
}

function CToolbarButton_onkeypress(evt) {
	
	//get the event in a cross-browser fashion
	evt = (evt) ? evt : ((event) ? event : null);
	var keyCode = evt.keyCode || evt.which;
	
	if(AccessibilityHandler.isEnabled()) {
	
		//check the listener belong to CToolBar menu.
		if(!this.hasOwnProperty('tbItem')){
			return;
		}
		var toolbarButton = this.tbItem;

		//check for the Tab key press, transfer the event to HTML body.
		if (keyCode == 9) {
			return true;
		}
		
		//check for the space key press
		if (keyCode == 32) {
			var menu = toolbarButton.getMenu();
			if (menu != null) {
				toolbarButton.showMenu(menu);
			}
		}

		//check for the Left and Right key press
		else if (keyCode == 37 || keyCode == 39) {
			var nextItem = AccessibilityHandler.getNextItem(toolbarButton,keyCode);
			nextItem.setFocus();
		}
		
		else if (keyCode == 40) {
			var menu = toolbarButton.getMenu();
			if (menu != null && toolbarButton.getMenuType() == "dropDown") {
				toolbarButton.showMenu(menu);
			}
		}
		
		//check for the Enter key press
		else if (keyCode == 13) {
		
			if(toolbarButton != null) {
				if(!toolbarButton.isEnabled())
					return;
				var menu = toolbarButton.getMenu();
				if(menu != null && ((this.id == ('menu'+toolbarButton.getId())) || (toolbarButton.m_bHideDropDown && this.id == toolbarButton.getId()))) {
					if(menu.isVisible()) {
						menu.remove();
					} else {
						// the user clicked the drop down arrow
						if(typeof menu.setHTMLContainer != "undefined")
							menu.setHTMLContainer((document.all && typeof this.document != 'undefined') ? this.document.body : this.ownerDocument.body);
						toolbarButton.showMenu(menu);
					}
				} else {
					eval(toolbarButton.m_action);	
				}			
				
				// send the message up to our parent
				if(toolbarButton.getParent() != null && typeof toolbarButton.getParent().onkeypress == "function")
					toolbarButton.getParent().onkeypress(evt);
				
				// notify our observers of this event
				toolbarButton.getObservers().notify(CToolbarButton_onkeypress);		
			}		
		}	
	}	
	
	evt.cancelBubble = true;
	return false;
}

function CToolbarButton_showMenu(menu) {
	menu.draw();
	menu.show();
	if(menu.get(0) != null) {
		menu.get(0).setFocus();
	}
}

function CToolbarButton_getHTMLElement() {
    var htmlElement = null;
    if(this.getParent && typeof this.getParent().getHTMLContainer == "function") {
    	var htmlContainer = this.getParent().getHTMLContainer();
    	if(htmlContainer != null) {
			if(document.all && typeof htmlContainer.document != 'undefined'){
				htmlElement = htmlContainer.document.getElementById(this.getId());
			}else{
				htmlElement = htmlContainer.ownerDocument.getElementById(this.getId());
			}
    		//htmlElement = document.all ? htmlContainer.document.getElementById(this.getId()) : htmlContainer.ownerDocument.getElementById(this.getId());
    	}
    }
    return htmlElement;
}

function CToolbarButton_getMenu() {
	return this.m_menu; 
}

function CToolbarButton_getMenuType() {
	// current toolbar buttons only support drop down menus
	return 'dropDown';
}

function CToolbarButton_setStyle(style) {
	this.m_style = style;
}

function CToolbarButton_getStyle() {
	return this.m_style;
}

function CToolbarButton_isVisible() {
	return this.m_bVisible;
}

function CToolbarButton_hide() {
	this.m_bVisible = false;
}

function CToolbarButton_show() {
	this.m_bVisible = true;
}

function CToolbarButton_setCapability(capability) {
	this.m_capability = capability;
}

function CToolbarButton_getCapability() {
	return this.m_capability;
}

function CToolbarButton_enable() {

	this.getStyle().setActiveState('normal');
	this.getStyle().setActiveRolloverState('normal');
	if (this.getIcon())
	{
		this.getIcon().enable();
	}
	this.updateHTML();
}

function CToolbarButton_disable() {

	this.getStyle().setActiveState('disabled');
	this.getStyle().setActiveRolloverState('disabled');
	if (this.getIcon())
	{
		this.getIcon().disable();
	}
	this.updateHTML();
}

function CToolbarButton_isEnabled() {
	if  (this.getIcon())
	{
		return this.getIcon().isEnabled();
	}
	else
	{
		return true;
	}
}

function CToolbarButton_pressed() {
	this.getStyle().setActiveState('depressed');
	this.getStyle().setActiveRolloverState('depressed');
	this.updateHTML();
}

function CToolbarButton_reset() {

	this.getStyle().setActiveState('normal');
	this.getStyle().setActiveRolloverState('normal');
	this.updateHTML();
}

function CToolbarButton_updateHTML() {
	if(typeof this.getStyle() == "object") {
		if(typeof this.getParent().getHTMLContainer == "function") {
			var htmlContainer = this.getParent().getHTMLContainer();
			if(htmlContainer != null) {
				var htmlElement = null;
				if(document.all && typeof htmlContainer.document != "undefined"){
					htmlElement = htmlContainer.document.getElementById(this.getId());
				}else{
					htmlElement = htmlContainer.ownerDocument.getElementById(this.getId());
				}
				//var htmlElement = document.all ? htmlContainer.document.getElementById(this.getId()) : htmlContainer.ownerDocument.getElementById(this.getId());
				if(htmlElement != null) {
					var toolbarImage = htmlElement.getElementsByTagName("img");
					if(typeof toolbarImage != 'undefined') {
						if (this.getIcon())
						{
							if(this.getIcon().isEnabled()) {
								toolbarImage[0].src = this.getIcon().getPath();
							} else {
								toolbarImage[0].src = this.getIcon().getDisabledImagePath();
							}
						}
					}			
						
					if(this.getStyle().getActiveState() != this.getStyle().getDisabledState()) {
						htmlElement.tabIndex = 0;
						if (this.getMenu() != null && !this.m_bHideDropDown) {
							htmlElement.nextSibling.tabIndex = 0;
							htmlElement.nextSibling.accessKey = 1;
						}
					} else {
						if (htmlElement.tabIndex != 'undefined') {
							htmlElement.removeAttribute("tabIndex");
							htmlElement.removeAttribute("accessKey");
							if (this.getMenu() != null) {
								htmlElement.nextSibling.removeAttribute("tabIndex");
								htmlElement.nextSibling.removeAttribute("accessKey");
							}
						}
					}
					
					htmlElement.className = this.getStyle().getActiveState();
				}
			}
		}
	}
}

function CToolbarButton_getObservers() {
	return this.m_observers;
}

function CToolbarButton_setFocus() {
	if (this.m_menu != null && !this.m_bHideDropDown)
		document.getElementById(this.m_id).nextSibling.focus();
	else
		document.getElementById(this.m_id).focus();
}

CToolbarButton.prototype.draw = CToolbarButton_draw;
CToolbarButton.prototype.attachEvents = CToolbarButton_attachEvents;
CToolbarButton.prototype.onblur = CToolbarButton_onmouseout;
CToolbarButton.prototype.onfocus = CToolbarButton_onfocus;
CToolbarButton.prototype.onkeypress = CToolbarButton_onkeypress;
CToolbarButton.prototype.onmouseover = CToolbarButton_onmouseover;
CToolbarButton.prototype.onmouseout = CToolbarButton_onmouseout;
CToolbarButton.prototype.onmouseup = CToolbarButton_onmouseup;
CToolbarButton.prototype.setParent = CToolbarButton_setParent;
CToolbarButton.prototype.getParent = CToolbarButton_getParent;
CToolbarButton.prototype.getAction = CToolbarButton_getAction;
CToolbarButton.prototype.setAction = CToolbarButton_setAction;
CToolbarButton.prototype.getToolTip = CToolbarButton_getToolTip;
CToolbarButton.prototype.setToolTip = CToolbarButton_setToolTip;
CToolbarButton.prototype.getDropDownToolTip = CToolbarButton_getDropDownToolTip;
CToolbarButton.prototype.setDropDownToolTip = CToolbarButton_setDropDownToolTip;
CToolbarButton.prototype.getIcon = CToolbarButton_getIcon;
CToolbarButton.prototype.setIcon = CToolbarButton_setIcon;
CToolbarButton.prototype.getMenu = CToolbarButton_getMenu;
CToolbarButton.prototype.getMenuType = CToolbarButton_getMenuType;
CToolbarButton.prototype.getId = CToolbarButton_getId;
CToolbarButton.prototype.setStyle = CToolbarButton_setStyle;
CToolbarButton.prototype.getStyle = CToolbarButton_getStyle;
CToolbarButton.prototype.createDropDownMenu = CToolbarButton_createDropDownMenu;
CToolbarButton.prototype.addOwnerDrawControl = CToolbarButton_addOwnerDrawControl;
CToolbarButton.prototype.getObservers = CToolbarButton_getObservers;
CToolbarButton.prototype.update = new Function("return true");
CToolbarButton.prototype.isVisible = CToolbarButton_isVisible;
CToolbarButton.prototype.hide = CToolbarButton_hide;
CToolbarButton.prototype.show = CToolbarButton_show;
CToolbarButton.prototype.isEnabled = CToolbarButton_isEnabled;
CToolbarButton.prototype.enable = CToolbarButton_enable;
CToolbarButton.prototype.disable = CToolbarButton_disable;
CToolbarButton.prototype.pressed = CToolbarButton_pressed;
CToolbarButton.prototype.reset = CToolbarButton_reset;
CToolbarButton.prototype.setFocus = CToolbarButton_setFocus;
CToolbarButton.prototype.updateHTML = CToolbarButton_updateHTML;
CToolbarButton.prototype.setCapability = CToolbarButton_setCapability;
CToolbarButton.prototype.getCapability = CToolbarButton_getCapability;
CToolbarButton.prototype.getHTMLElement = CToolbarButton_getHTMLElement;
CToolbarButton.prototype.showMenu = CToolbarButton_showMenu;
CToolbarButton.prototype.enableTabindex = CToolbarButton_enableTabindex;
CToolbarButton.prototype.disableTabindex = CToolbarButton_disableTabindex;