Jquery庫的一些可用函式

Juery。著名的js庫。裡面很多實用的函式可以用。[@more@]

/**
* 定義一個全域性物件, 屬性 Version 在釋出的時候會替換為當前版本號
*/
var Prototype = {
Version:
}

/**
* 建立一種型別，注意其屬性 create 是一個方法，返回一個建構函式。
* 一般使用如下
* var X = Class.create(); 返回一個型別，類似於 java 的一個Class例項。
* 要使用 X 型別，需繼續用 new X()來獲取一個例項，如同 java 的 Class.newInstance()方法。
*
* 返回的建構函式會執行名為 initialize 的方法， initialize 是 Ruby 物件的構造器方法名字。
* 此時initialize方法還沒有定義，其後的程式碼中建立新型別時會建立相應的同名方法。
*
* 如果一定要從java上去理解。你可以理解為用Class.create()建立一個繼承java.lang.Class類的類。當然java不允許這樣做，因為Class類是final的
*
*/
var Class = {
create: function() {
return function() {
this.initialize.apply(this, arguments);
}
}
}

/**
* 建立一個物件，從變數名來思考，本意也許是定義一個抽象類，以後建立新物件都 extend 它。
* 但從其後程式碼的應用來看， Abstract 更多是為了保持名稱空間清晰的考慮。
* 也就是說，我們可以給 Abstract 這個物件例項新增新的物件定義。
*
* 從java去理解，就是動態給一個物件建立內部類。
*/
var Abstract = new Object();

/**
* 獲取引數物件的所有屬性和方法，有點象多重繼承。但是這種繼承是動態獲得的。
* 如：
* var a = new ObjectA(), b = new ObjectB();
* var c = a.extend(b);
* 此時 c 物件同時擁有 a 和 b 物件的屬性和方法。但是與多重繼承不同的是，c instanceof ObjectB 將返回false。
*/
Object.prototype.extend = function(object) {
for (property in object) {
this[property] = object[property];
}
return this;
}

/**
* 這個方法很有趣，它封裝一個javascript函式物件，返回一個新函式物件，新函式物件的主體和原物件相同，但是bind()方法引數將被用作當前物件的物件。
* 也就是說新函式中的 this 引用被改變為引數提供的物件。
* 比如：
*
*
* .................
*
* 那麼，呼叫aaa.showValue 將返回"aaa", 但呼叫aaa.showValue2 將返回"bbb"。
*
* apply 是ie5.5後才出現的新方法(Netscape好像很早就支援了)。
* 該方法更多的資料參考MSDN
* 還有一個 call 方法，應用起來和 apply 類似。可以一起研究下。
*/
Function.prototype.bind = function(object) {
var method = this;
return function() {
method.apply(object, arguments);
}
}

/**
* 和bind一樣，不過這個方法一般用做html控制元件物件的事件處理。所以要傳遞event物件
* 注意這時候，用到了 Function.call。它與 Function.apply 的不同好像僅僅是對引數形式的定義。
* 如同 java 兩個過載的方法。
*/
Function.prototype.bindAsEventListener = function(object) {
var method = this;
return function(event) {
method.call(object, event || window.event);
}
}

/**
* 將整數形式RGB顏色值轉換為HEX形式
*/
Number.prototype.toColorPart = function() {
var digits = this.toString(16);
if (this < 16) return '0' + digits;
return digits;
}

/**
* 典型 Ruby 風格的函式，將引數中的方法逐個呼叫，返回第一個成功執行的方法的返回值
*/
var Try = {
these: function() {
var returnValue;

for (var i = 0; i < arguments.length; i++) {
var lambda = arguments[i];
try {
returnValue = lambda();
break;
} catch (e) {}
}

return returnValue;
}
}

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

/**
* 一個設計精巧的定時執行器
* 首先由 Class.create() 建立一個 PeriodicalExecuter 型別，
* 然後用物件直接量的語法形式設定原型。
*
* 需要特別說明的是 rgisterCallback 方法，它呼叫上面定義的函式原型方法bind, 並傳遞自己為引數。
* 之所以這樣做，是因為 setTimeout 預設總以 window 物件為當前物件，也就是說，如果 registerCallback 方法定義如下的話：
* registerCallback: function() {
* setTimeout(this.onTimerEvent, this.frequency * 1000);
* }
* 那麼，this.onTimeoutEvent 方法執行失敗，因為它無法訪問 this.currentlyExecuting 屬性。
* 而使用了bind以後，該方法才能正確的找到this，也就是PeriodicalExecuter的當前例項。
*/
var PeriodicalExecuter = Class.create();
PeriodicalExecuter.prototype = {
initialize: function(callback, frequency) {
this.callback = callback;
this.frequency = frequency;
this.currentlyExecuting = false;

this.registerCallback();
},

registerCallback: function() {
setTimeout(this.onTimerEvent.bind(this), this.frequency * 1000);
},

onTimerEvent: function() {
if (!this.currentlyExecuting) {
try {
this.currentlyExecuting = true;
this.callback();
} finally {
this.currentlyExecuting = false;
}
}

this.registerCallback();
}
}

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

/**
* 這個函式就 Ruby 了。我覺得它的作用主要有兩個
* 1. 大概是 document.getElementById(id) 的最簡化呼叫。
* 比如：$("aaa") 將返回上 aaa 物件
* 2. 得到物件陣列
* 比如: $("aaa","bbb") 返回一個包括id為"aaa"和"bbb"兩個input控制元件物件的陣列。
*/
function $() {
var elements = new Array();

for (var i = 0; i < arguments.length; i++) {
var element = arguments[i];
if (typeof element == 'string')
element = document.getElementById(element);

if (arguments.length == 1)
return element;

elements.push(element);
}

return elements;
}
/**
* 定義 Ajax 物件, 靜態方法 getTransport 方法返回一個 XMLHttp 物件
*/
var Ajax = {
getTransport: function() {
return Try.these(
function() {return new ActiveXObject('Msxml2.XMLHTTP')},
function() {return new ActiveXObject(' Microsoft.XMLHTTP')},
function() {return new XMLHttpRequest()}
) || false;
},

emptyFunction: function() {}
}
/**
* 我以為此時的Ajax物件起到名稱空間的作用。
* Ajax.Base 宣告為一個基礎物件型別
* 注意 Ajax.Base 並沒有使用 Class.create() 的方式來建立，我想是因為作者並不希望 Ajax.Base 被庫使用者例項化。
* 作者在其他物件型別的宣告中，將會繼承於它。
* 就好像 java 中的私有抽象類
*/
Ajax.Base = function() {};
Ajax.Base.prototype = {
/**
* extend (見prototype.js中的定義) 的用法真是讓人耳目一新
* options 首先設定預設屬性，然後再 extend 引數物件，那麼引數物件中也有同名的屬性，那麼就覆蓋預設屬性值。
* 想想如果我寫這樣的實現，應該類似如下：
setOptions: function(options) {
this.options.methed = options.methed? options.methed : 'post';
..........
}
我想很多時候，java 限制了 js 的創意。
*/
setOptions: function(options) {
this.options = {
method: 'post',
asynchronous: true,
parameters: ''
}.extend(options || {});
}
}

/**
* Ajax.Request 封裝 XmlHttp
*/
Ajax.Request = Class.create();

/**
* 定義四種事件(狀態)， 參考
*/
Ajax.Request.Events =
['Uninitialized', 'Loading', 'Loaded', 'Interactive', 'Complete'];

/**
*
*/
Ajax.Request.prototype = (new Ajax.Base()).extend({
initialize: function(url, options) {
this.transport = Ajax.getTransport();
this.setOptions(options);

try {
if (this.options.method == 'get')
url += '?' + this.options.parameters + '&_=';

/**
* 此處好像強制使用了非同步方式，而不是依照 this.options.asynchronous 的值
*/
this.transport.open(this.options.method, url, true);

/**
* 這裡提供了 XmlHttp 傳輸過程中每個步驟的回撥函式
*/
if (this.options.asynchronous) {
this.transport.onreadystatechange = this.onStateChange.bind(this);
setTimeout((function() {this.respondToReadyState(1)}).bind(this), 10);
}

this.transport.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
this.transport.setRequestHeader('X-Prototype-Version', Prototype.Version);

if (this.options.method == 'post') {
this.transport.setRequestHeader('Connection', 'close');
this.transport.setRequestHeader('Content-type',
'application/x-www-form-urlencoded');
}

this.transport.send(this.options.method == 'post' ?
this.options.parameters + '&_=' : null);

} catch (e) {
}
},

onStateChange: function() {
var readyState = this.transport.readyState;
/**
* 如果不是 Loading 狀態，就呼叫回撥函式
*/
if (readyState != 1)
this.respondToReadyState(this.transport.readyState);
},

/**
* 回撥函式定義在 this.options 屬性中，比如:
var option = {
onLoaded : function(req) {...};
......
}
new Ajax.Request(url, option);
*/
respondToReadyState: function(readyState) {
var event = Ajax.Request.Events[readyState];
(this.options['on' + event] || Ajax.emptyFunction)(this.transport);
}
});

/**
* Ajax.Updater 用於繫結一個html元素與 XmlHttp呼叫的返回值。類似與 buffalo 的 bind。
* 如果 options 中有 insertion(from dom.js) 物件的話, insertion 能提供更多的插入控制。
*/
Ajax.Updater = Class.create();
Ajax.Updater.prototype = (new Ajax.Base()).extend({
initialize: function(container, url, options) {
this.container = $(container);
this.setOptions(options);

if (this.options.asynchronous) {
this.onComplete = this.options.onComplete;
this.options.onComplete = this.updateContent.bind(this);
}

this.request = new Ajax.Request(url, this.options);

if (!this.options.asynchronous)
this.updateContent();
},

updateContent: function() {
if (this.options.insertion) {
new this.options.insertion(this.container,
this.request.transport.responseText);
} else {
this.container.innerHTML = this.request.transport.responseText;
}

if (this.onComplete) {
setTimeout((function() {this.onComplete(this.request)}).bind(this), 10);
}
}
});
/**
* 針對 頁面元素物件 的工具類，提供一些簡單靜態方法
*/
var Field = {
/**
* 清除引數引用物件的值
*/
clear: function() {
for (var i = 0; i < arguments.length; i++)
$(arguments[i]).value = '';
},

/**
* 使引數引用物件獲取焦點
*/
focus: function(element) {
$(element).focus();
},

/**
* 判斷引數引用物件值是否為空，如為空，返回false, 反之true
*/
present: function() {
for (var i = 0; i < arguments.length; i++)
if ($(arguments[i]).value == '') return false;
return true;
},

/**
* 使選中引數引用物件
*/
select: function(element) {
$(element).select();
},

/**
* 使引數引用物件處於可編輯狀態
*/
activate: function(element) {
$(element).focus();
$(element).select();
}
}

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

/**
* 表單工具類
*/
var Form = {
/**
* 將表單元素序列化後的值組合成 QueryString 的形式
*/
serialize: function(form) {
var elements = Form.getElements($(form));
var queryComponents = new Array();

for (var i = 0; i < elements.length; i++) {
var queryComponent = Form.Element.serialize(elements[i]);
if (queryComponent)
queryComponents.push(queryComponent);
}

return queryComponents.join('&');
},

/**
* 得到表單的所有元素物件
*/
getElements: function(form) {
form = $(form);
var elements = new Array();

for (tagName in Form.Element.Serializers) {
var tagElements = form.getElementsByTagName(tagName);
for (var j = 0; j < tagElements.length; j++)
elements.push(tagElements[j]);
}
return elements;
},
/**
* 將指定表單的元素置於不可用狀態
*/
disable: function(form) {
var elements = Form.getElements(form);
for (var i = 0; i < elements.length; i++) {
var element = elements[i];
element.blur();
element.disable = 'true';
}
},

/**
* 使表單的第一個非 hidden 型別而且處於可用狀態的元素獲得焦點
*/
focusFirstElement: function(form) {
form = $(form);
var elements = Form.getElements(form);
for (var i = 0; i < elements.length; i++) {
var element = elements[i];
if (element.type != 'hidden' && !element.disabled) {
Field.activate(element);
break;
}
}
},

/*
* 重置表單
*/
reset: function(form) {
$(form).reset();
}
}

/**
* 表單元素工具類
*/
Form.Element = {
/**
* 返回表單元素的值先序列化再進行 URL 編碼後的值
*/
serialize: function(element) {
element = $(element);
var method = element.tagName.toLowerCase();
var parameter = Form.Element.Serializers[method](element);

if (parameter)
return encodeURIComponent(parameter[0]) + '=' +
encodeURIComponent(parameter[1]);
},

/**
* 返回表單元素序列化後的值
*/
getValue: function(element) {
element = $(element);
var method = element.tagName.toLowerCase();
var parameter = Form.Element.Serializers[method](element);

if (parameter)
return parameter[1];
}
}

/**
* prototype 的所謂序列化其實就是將表單的名字和值組合成一個陣列
*/
Form.Element.Serializers = {
input: function(element) {
switch (element.type.toLowerCase()) {
case 'hidden':
case 'password':
case 'text':
return Form.Element.Serializers.textarea(element);
case 'checkbox':
case 'radio':
return Form.Element.Serializers.inputSelector(element);
}
return false;
},

inputSelector: function(element) {
if (element.checked)
return [element.name, element.value];
},

textarea: function(element) {
return [element.name, element.value];
},

/**
* 看樣子，也不支援多選框(select-multiple)
*/
select: function(element) {
var index = element.selectedIndex;
var value = element.options[index].value || element.options[index].text;
return [element.name, (index >= 0) ? value : ''];
}
}

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

/**
* Form.Element.getValue 也許會經常用到，所以做了一個快捷引用
*/
var $F = Form.Element.getValue;

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

/**
* Abstract.TimedObserver 也沒有用 Class.create() 來建立，和Ajax.Base 意圖應該一樣
* Abstract.TimedObserver 顧名思義，是套用Observer設計模式來跟蹤指定表單元素，
* 當表單元素的值發生變化的時候，就執行回撥函式
*
* 我想　Observer 與註冊onchange事件相似，不同點在於 onchange 事件是在元素失去焦點的時候才激發。
* 同樣的與 onpropertychange 事件也相似，不過它只關注表單元素的值的變化，而且提供timeout的控制。
*
* 除此之外，Observer 的好處大概就在與更物件導向，另外可以動態的更換回撥函式，這就比註冊事件要靈活一些。
* Observer 應該可以勝任動態資料校驗，或者多個關聯下拉選項列表的連動等等
*
*/
Abstract.TimedObserver = function() {}

/**
* 這個設計和 PeriodicalExecuter 一樣，bind 方法是實現的核心
*/
Abstract.TimedObserver.prototype = {
initialize: function(element, frequency, callback) {
this.frequency = frequency;
this.element = $(element);
this.callback = callback;

this.lastValue = this.getValue();
this.registerCallback();
},

registerCallback: function() {
setTimeout(this.onTimerEvent.bind(this), this.frequency * 1000);
},

onTimerEvent: function() {
var value = this.getValue();
if (this.lastValue != value) {
this.callback(this.element, value);
this.lastValue = value;
}

this.registerCallback();
}
}

/**
* Form.Element.Observer 和 Form.Observer 其實是一樣的
* 注意 Form.Observer 並不是用來跟蹤整個表單的，我想大概只是為了減少書寫(這是Ruby的一個設計原則)
*/
Form.Element.Observer = Class.create();
Form.Element.Observer.prototype = (new Abstract.TimedObserver()).extend({
getValue: function() {
return Form.Element.getValue(this.element);
}
});

Form.Observer = Class.create();
Form.Observer.prototype = (new Abstract.TimedObserver()).extend({
getValue: function() {
return Form.serialize(this.element);
}
});

/**
* 根據 class attribute 的名字得到物件陣列，支援 multiple class
*
*/
document.getElementsByClassName = function(className) {
var children = document.getElementsByTagName('*') || document.all;
var elements = new Array();

for (var i = 0; i < children.length; i++) {
var child = children[i];
var classNames = child.className.split(' ');
for (var j = 0; j < classNames.length; j++) {
if (classNames[j] == className) {
elements.push(child);
break;
}
}
}

return elements;
}

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

/**
* Element 就象一個 java 的工具類，主要用來 隱藏/顯示/銷除 物件，以及獲取物件的簡單屬性。
*
*/
var Element = {
toggle: function() {
for (var i = 0; i < arguments.length; i++) {
var element = $(arguments[i]);
element.style.display =
(element.style.display == 'none' ? '' : 'none');
}
},

hide: function() {
for (var i = 0; i < arguments.length; i++) {
var element = $(arguments[i]);
element.style.display = 'none';
}
},

show: function() {
for (var i = 0; i < arguments.length; i++) {
var element = $(arguments[i]);
element.style.display = '';
}
},

remove: function(element) {
element = $(element);
element.parentNode.removeChild(element);
},

getHeight: function(element) {
element = $(element);
return element.offsetHeight;
}
}

/**
* 為 Element.toggle 做了一個符號連線，大概是相容性的考慮
*/
var Toggle = new Object();
Toggle.display = Element.toggle;
/*--------------------------------------------------------------------------*/

/**
* 動態插入內容的實現，MS的Jscript實現中物件有一個 insertAdjacentHTML 方法()
* 這裡算是一個物件形式的封裝。
*/
Abstract.Insertion = function(adjacency) {
this.adjacency = adjacency;
}

Abstract.Insertion.prototype = {
initialize: function(element, content) {
this.element = $(element);
this.content = content;

if (this.adjacency && this.element.insertAdjacentHTML) {
this.element.insertAdjacentHTML(this.adjacency, this.content);
} else {
/**
* gecko 不支援 insertAdjacentHTML 方法，但可以用如下程式碼代替
*/
this.range = this.element.ownerDocument.createRange();
/**
* 如果定義了 initializeRange 方法，則實行，這裡相當與定義了一個抽象的 initializeRange 方法
*/
if (this.initializeRange) this.initializeRange();
this.fragment = this.range.createContextualFragment(this.content);

/**
* insertContent 也是一個抽象方法，子類必須實現
*/
this.insertContent();
}
}
}

/**
* prototype 加深了我的體會，就是寫js 如何去遵循　Don’t Repeat Yourself (DRY) 原則
* 上文中 Abstract.Insertion 算是一個抽象類，定義了名為　initializeRange 的一個抽象方法
* var Insertion = new Object()　建立一個名稱空間
* Insertion.Before|Top|Bottom|After 就象是四個java中的四個靜態內部類，而它們分別繼承於Abstract.Insertion，並實現了initializeRange方法。
*/
var Insertion = new Object();

Insertion.Before = Class.create();
Insertion.Before.prototype = (new Abstract.Insertion('beforeBegin')).extend({
initializeRange: function() {
this.range.setStartBefore(this.element);
},

/**
* 將內容插入到指定節點的前面, 與指定節點同級
*/
insertContent: function() {
this.element.parentNode.insertBefore(this.fragment, this.element);
}
});

Insertion.Top = Class.create();
Insertion.Top.prototype = (new Abstract.Insertion('afterBegin')).extend({
initializeRange: function() {
this.range.selectNodeContents(this.element);
this.range.collapse(true);
},

/**
* 將內容插入到指定節點的第一個子節點前，於是內容變為該節點的第一個子節點
*/
insertContent: function() {
this.element.insertBefore(this.fragment, this.element.firstChild);
}
});

Insertion.Bottom = Class.create();
Insertion.Bottom.prototype = (new Abstract.Insertion('beforeEnd')).extend({
initializeRange: function() {
this.range.selectNodeContents(this.element);
this.range.collapse(this.element);
},

/**
* 將內容插入到指定節點的最後，於是內容變為該節點的最後一個子節點
*/
insertContent: function() {
this.element.appendChild(this.fragment);
}
});

Insertion.After = Class.create();
Insertion.After.prototype = (new Abstract.Insertion('afterEnd')).extend({
initializeRange: function() {
this.range.setStartAfter(this.element);
},

/**
* 將內容插入到指定節點的後面, 與指定節點同級
*/
insertContent: function() {
this.element.parentNode.insertBefore(this.fragment,
this.element.nextSibling);
}
});

/* 這是包含錯誤的原版本
if (!Function.prototype.apply) {
// Based on code from
Function.prototype.apply = function(object, parameters) {
var parameterStrings = new Array();
if (!object) object = window;
if (!parameters) parameters = new Array();

for (var i = 0; i < parameters.length; i++)
parameterStrings[i] = 'x[' + i + ']'; //Error 1

object.__apply__ = this;
var result = eval('obj.__apply__(' + //Error 2
parameterStrings[i].join(', ') + ')');
object.__apply__ = null;

return result;
}
}
*/

if (!Function.prototype.apply) {
Function.prototype.apply = function(object, parameters) {
var parameterStrings = new Array();
if (!object) object = window;
if (!parameters) parameters = new Array();

for (var i = 0; i < parameters.length; i++)
parameterStrings[i] = 'parameters[' + i + ']';

object.__apply__ = this;
var result = eval('object.__apply__(' + parameterStrings.join(', ') + ')');
object.__apply__ = null;

return result;
}
}

Effect 的一個子類

Effect.Blink = Class.create();
Effect.Blink.prototype = {
initialize: function(element, frequency) {
this.element = $(element);
this.frequency = frequency?frequency:1000;
this.element.effect_blink = this;
this.blink();
},

blink: function() {
if (this.timer) clearTimeout(this.timer);
try {
this.element.style.visibility = this.element.style.visibility == 'hidden'?'visible':'hidden';
} catch (e) {}
this.timer = setTimeout(this.blink.bind(this), this.frequency);
}
};