JQUERY_contextMenu_学习

[menuContext首页:http://www.trendskitchens.co.nz/jquery/contextmenu/]

contextMenu的js文件学习:
/*
*!!!!!![$(x).contextMenu(id,options)---便于称呼先暂时称:对元素x的一次绑定(x可能是一个元素集合)]
* 元素x称为绑定元素
*给元素添加右键菜单[步骤]
*1.基本框架[如menu,shadow的div框架]仅初始化一次[第一次给元素绑定时-即页面中第一次执$(xx).contextMenu(id,options)时]
*2.右键菜单环境/状态-每次对一个元素绑定时初始化一次[如:menuStyle,itemStyle],
* 并将环境压入栈hash,且将环境信息在栈中的序号及绑定元素及事件对象绑定到绑定元素的contextmenu事件(右键)上
*/
//匿名函数定义+执行
(function($) {
//trigger事件源/绑定菜单的元素
//currentTarget??????
var menu, shadow, trigger, content, hash, currentTarget;
var defaults = {
menuStyle: {
listStyle: 'none',
padding: '1px',
margin: '0px',
backgroundColor: '#eee',
border: '1px solid #999',
width: '70px'
},
itemStyle: {
margin: '0px',
color: '#567',
display: 'block',
cursor: 'default',
padding: '3px',
border: '1px solid #ddd',
backgroundColor: 'transparent'
},
itemHoverStyle: {
border: '1px solid #0a246a',
backgroundColor: '#b6bdd2'
},
eventPosX: 'pageX',
eventPosY: 'pageY',
shadow : true,
onContextMenu: null,
//填充菜单内容完毕-显示菜单及阴影之前执行onShowMenu方法[相当于过滤器]
onShowMenu: null
};
//prototype原型-->实例方法
$.fn.contextMenu = function(id, options) {
if (!menu) {                                      // Create singleton menu
menu = $('<div id="jqContextMenu"></div>')
   .hide()
   .css({position:'absolute', zIndex:'500'})
   .appendTo('body')
   .bind('click', function(e) {
e.stopPropagation();
   });
}
if (!shadow) {
shadow = $('<div></div>')
.css({backgroundColor:'#000',position:'absolute',opacity:0.2,zIndex:499})
.appendTo('body')
.hide();
}
hash = hash || [];
//压栈-意途-每次初始化-将右键菜单环境/状态压入栈中-立刻将"最新压入栈中的环境的序号"绑定到元素上
hash.push({
id : id,
//继承$.extend(dest,src,src,src)
menuStyle: $.extend({}, defaults.menuStyle, options.menuStyle || {}),
itemStyle: $.extend({}, defaults.itemStyle, options.itemStyle || {}),
itemHoverStyle: $.extend({}, defaults.itemHoverStyle, options.itemHoverStyle || {}),
bindings: options.bindings || {},
shadow: options.shadow || options.shadow === false ? options.shadow : defaults.shadow,
onContextMenu: options.onContextMenu || defaults.onContextMenu,
onShowMenu: options.onShowMenu || defaults.onShowMenu,
eventPosX: options.eventPosX || defaults.eventPosX,
eventPosY: options.eventPosY || defaults.eventPosY
});
var index = hash.length - 1;
//给绑定元素绑定contextmenu事件(右键)(绑定元素可以是元素集合)
$(this).bind('contextmenu', function(e) {
//alert(e.srcElement.innerHTML);//alert(e.srcElement);//事件源
// Check if onContextMenu() defined|||
//初始化时,options中onContextMenu方法的意途：有选择性的绑定右键菜单[可根据条件使onContextMenu方法返回false,以至于实现一部分绑定,而个别元素不绑定]
var bShowContext = (!!hash[index].onContextMenu) ? hash[index].onContextMenu(e) : true;
if (bShowContext) display(index, this, e);
return false;
});
return this;
};
//trigger--即事件源[即被绑定菜单的元素?]
function display(index, trigger, e) {
//根据环境在栈中的序号index,取出对应的菜单环境
var cur = hash[index];
//根据id获取并复制(连事件一并复制)事先在页面上布置的菜单div,中的列表ul元素
content = $('#'+cur.id).find('ul:first').clone(true);
//给复制出来的菜单内容-添加菜单样式、条目样式及hover效果
content.css(cur.menuStyle).find('li').css(cur.itemStyle).hover(
function() {
$(this).css(cur.itemHoverStyle);
},
function(){
$(this).css(cur.itemStyle);
}
).find('img').css({verticalAlign:'middle',paddingRight:'4px'});

//menu变量-单例-即页面上只会同一时间只会出现一个右键菜单(事先布置的菜单填充到menu[id=jqContextMenu的div]中)
menu.html(content);

// if there's an onShowMenu, run it now -- must run after content has been added
// if you try to alter the content variable before the menu.html(), IE6 has issues
// updating the content
//[判断栈中菜单环境是否设置了onShowMenu方法-实质是初始化时在参数options中是否设置了onShowMenu]相当于过滤器
if (!!cur.onShowMenu) menu = cur.onShowMenu(e, menu);
//each方法--此处没有第三个参数,且cur.bindings为对象[非数组],即此处循环处理的是cur.bingdings对象中的各成员/方法,
//因此function(id,func)中id即为cur.bindings对象的属性名/方法名,而func即为cur.bindings对象的属性值/方法定义
//很明显,初始化时,所设置的options中的bindings对象中存放的全是方法名以及方法定义
$.each(cur.bindings, function(id, func) {
//以menu为上下文,根据id搜寻元素[即给cur.bindings中指定的菜单项绑定事件],并绑定click事件
$('#'+id, menu).bind('click', function(e) {
hide();
//trigger为事件源,currentTarget???
func(trigger, currentTarget);
});
});

//menu.css({'left':e[cur.eventPosX],'top':e[cur.eventPosY]}).show();
//设置菜单的坐标并显示菜单
menu.css({'left':e[cur.eventPosX],'top':e[cur.eventPosY]}).slideDown('fast');
//设置菜单的阴影坐标并显示
if (cur.shadow) shadow.css({width:menu.width(),height:menu.height(),left:e.pageX+4,top:e.pageY+4}).show();
//每执行一次display,即显示一次右键菜单,给document绑定一次click事件
$(document).one('click', hide);
}

function hide() {
//menu.hide();
menu.slideUp(200);
shadow.hide();
}

//Apply defaults
//为jQuery类增加全局/类变量?-----用途??????
$.contextMenu = {
defaults : function(userDefaults) {
$.each(userDefaults, function(i, val) {
if (typeof val == 'object' && defaults[i]) {
$.extend(defaults[i], val);
}
else defaults[i] = val;
});
}
};
})(jQuery);
//等于$(document).ready(function(){})
$(function() {
$('div.contextMenu').hide();
});