prototype.js开发笔记(二)

2.1. JavaScript 类的扩展

prototype.js 包中加入功能的一种途径就是扩展已有的JavaScript 类。

2.2. 对 `Object` 类的扩展

Table 2.1. Object 类的扩展

方法	类别	参数	描述
`extend(destination, source)`	`static`	`destination`: 任何对象, `source`: 任何对象	用从 `source` 到 `destination`复制所有属性和方法的方式来提供一种继承机制。
`extend(object)`	`instance`	`任何对象`	用从传入的 `object` 中复制所有属性和方法的方式来提供一种继承机制。

2.3. 对 `Number` 类的扩展

Table 2.2. Number 类的扩展

方法	类别	参数	描述
`toColorPart()`	`instance`	`(none)`	返回数字的十六进制描述，当在HTML中转换为RGB颜色组件到HTML中使用的颜色。

2.4. 对 `Function` 类的扩展

Table 2.3. 对 Function 类的扩展

方法	类别	参数	描述
`bind(object)`	`instance`	`object`: 拥有这个方法的对象	返回预先绑定在拥有该函数(=方法)的对象上的函数实例，返回的方法将和原来的方法具有相同的参数。
`bindAsEventListener(object)`	`instance`	`object`: 拥有这个方法的对象	返回预先绑定在拥有该函数(=方法)的对象上的函数实例，返回的方法将把当前的事件对象作为它的参数。

让我们看看这些扩展的具体例子。

<input type=checkbox id=myChk value=1> Test?
<script>
    //declaring the class
    var CheckboxWatcher = Class.create();

    //defining the rest of the class implmentation
    CheckboxWatcher.prototype = {

       initialize: function(chkBox, message) {
            this.chkBox = $(chkBox);
            this.message = message;
            //assigning our method to the event
            this.chkBox.onclick = this.showMessage.bindAsEventListener(this);
       },

       showMessage: function(evt) {
          alert(this.message + ' (' + evt.type + ')');
       }
    };


    var watcher = new CheckboxWatcher('myChk', 'Changed');
</script>

2.5. 对 `String` 类的扩展

Table 2.4. String 类的扩展

方法	类别	参数	描述
`stripTags()`	`instance`	`(none)`	返回一个把所有的HTML或XML标记都移除的字符串。
`escapeHTML()`	`instance`	`(none)`	返回一个把所有的HTML标记回避掉的字符串。
`unescapeHTML()`	`instance`	`(none)`	和 `escapeHTML()`相反。

2.6. 对 `document` DOM 对象的扩展

Table 2.5. document DOM 对象的扩展

方法	类别	参数	描述
`getElementsByClassName(className)`	`instance`	`className`: 关联在元素上的CSS类名	返回给定的具有相同的CSS类名的所有元素。

2.7. 对 `Event` 对象的扩展

Table 2.6. Event 对象的扩展

属性	类型	描述
`KEY_BACKSPACE`	`Number`	8: 常量，退格(Backspace)键的代码。
`KEY_TAB`	`Number`	9: 常量，Tab键的代码。
`KEY_RETURN`	`Number`	13: 常量，回车键的代码。
`KEY_ESC`	`Number`	27: 常量， Esc键的代码。
`KEY_LEFT`	`Number`	37: 常量，左箭头键的代码。
`KEY_UP`	`Number`	38: 常量，上箭头键的代码。
`KEY_RIGHT`	`Number`	39: 常量，右箭头键的代码。
`KEY_DOWN`	`Number`	40: 常量，下箭头键的代码。
`KEY_DELETE`	`Number`	46: 常量，删除(Delete)键的代码。
`observers:`	`Array`	缓存的观察者的列表，这个对象内部具体实现的一部分。

Table 2.7. Event 对象的扩展

方法	类别	参数	描述
`element(event)`	`static`	`event`: 事件对象	返回引发这个事件的元素。
`isLeftClick(event)`	`static`	`event`: 事件对象	如果鼠标左键单击返回true。
`pointerX(event)`	`static`	`event`: 事件对象	返回在页面上x坐标。
`pointerY(event)`	`static`	`event`: 事件对象	返回在页面上y坐标。
`stop(event)`	`static`	`event`: 事件对象	用这个方法来中止事件的默认行为来使事件的传播停止。
`findElement(event, tagName)`	`static`	`event`: 事件对象, `tagName`: 指定标记的名字	向 DOM 树的上位查找，找到第一个给定标记名称的元素，从这个元素开始触发事件。
`observe(element, name, observer, useCapture)`	`static`	`element`: 对象或者对象id, `name`: 事件名 (如 'click', 'load', etc), `observer`: 处理这个事件的方法, `useCapture`: 如果true, 在捕捉到事件的阶段处理事件那么如果 false在bubbling 阶段处理。	加入一个处理事件的方法。
`stopObserving(element, name, observer, useCapture)`	`static`	`element`: 对象或者对象id, `name`: 事件名 (如 'click', 'load', etc), `observer`: 处理这个事件的方法, `useCapture`: 如果true, 在捕捉到事件的阶段处理事件那么如果 false在bubbling 阶段处理。	删除一个处理实践的方法。
`_observeAndCache( element, name, observer, useCapture)`	`static`		私有方法，不用管它。
`unloadCache()`	`static`	`(none)`	私有方法，不用管它。清除内存中的多有观察着缓存。

让我们看看怎样用这个对象加入处理 window 对象的load事件的处理方法。

<script>
    Event.observe(window, 'load', showMessage, false);

    function showMessage() {
      alert('Page loaded.');
    }
</script>

2.8. 在 prototype.js中定义的新对象和类

另一个这个程序包帮助你的地方就是提供许多既支持面向对象设计理念又有共通功能的许多对象。

2.9. `PeriodicalExecuter` 对象

这个对象提供一定间隔时间上重复调用一个方法的逻辑。

Table 2.8. PeriodicalExecuter 对象

方法	类别	参数	描述
`[ctor](callback, interval)`	`constructor`	`callback`: 没有参数的方法, `interval`: 秒数	创建这个对象的实例将会重复调用给定的方法。

Table 2.9. PeriodicalExecuter 对象

属性	类型	描述
`callback`	`Function()`	被调用的方法，该方法不会被传入参数。
`frequency`	`Number`	以秒为单位的间隔。
`currentlyExecuting`	`Boolean`	表示这个方法是否正在执行。

2.10. `Prototype` 对象

Prototype 没有太重要的作用，只是声明了该程序包的版本。

Table 2.10. The Prototype object

属性	类型	描述
`Version`	`String`	包的版本。
`emptyFunction`	`Function()`	空方法对象。

2.11. `Class` 对象

在这个程序包中 Class 对象在声明其他的类时候被用到。用这个对象声明类使得新类支持 initialize() 方法，他起构造方法的作用。

看下面的例子

//declaring the class
var MySampleClass = Class.create();
//defining the rest of the class implmentation
MySampleClass.prototype = {

   initialize: function(message) {
        this.message = message;
   },

   showMessage: function(ajaxResponse) {
      alert(this.message);
   }
};

//now, let's instantiate and use one object
var myTalker = new MySampleClass('hi there.');
myTalker.showMessage(); //displays alert

Table 2.11. Class 对象

方法	类别	参数	描述
`create(*)`	`instance`	`(any)`	定义新类的构造方法。

2.12. `Ajax` 对象

这个对象被用作其他提供AJAX功能的类的根对象。

Table 2.12. Ajax 对象

方法	类别	参数	描述
`getTransport()`	`instance`	`(none)`	返回新的`XMLHttpRequest` 对象。

2.13. `Ajax.Base` 类

这个类是其他在Ajax对象中定义的类的基类。

Table 2.13. Ajax.Base 类

方法	类别	参数	描述
`setOptions(options)`	`instance`	`options`: AJAX 选项	设定AJAX操作想要的选项。
`responseIsSuccess()`	`instance`	`(none)`	返回 `true` 如果AJAX操作成功,否则为 `false` 。
`responseIsFailure()`	`instance`	`(none)`	与 `responseIsSuccess()` 相反。

2.14. `Ajax.Request` 类

继承自 Ajax.Base

封装 AJAX 操作

Table 2.14. Ajax.Request 类

属性	类型	类别	描述
`Events`	`Array`	`static`	在AJAX操作中所有可能报告的事件/状态的列表。这个列表包括: `'Uninitialized', 'Loading', 'Loaded', 'Interactive',` 和 `'Complete'`。
`transport`	`XMLHttpRequest`	`instance`	携带AJAX操作的 `XMLHttpRequest` 对象。

Table 2.15. Ajax.Request 类

方法	类别	参数	描述
`[ctor](url, options)`	`constructor`	`url`: 请求的url, `options`: AJAX 选项	创建这个对象的一个实例，它将在给定的选项下请求url。重要：如果选择的url受到浏览器的安全设置，他会一点作用也不起。很多情况下，浏览器不会请求与当前页面不同主机(域名)的url。你最好只使用本地url来避免限制用户配置他们的浏览器(谢谢Clay)
`request(url)`	`instance`	`url`: AJAX 请求的url	这个方法通常不会被外部调用。已经在构造方法中调用了。
`setRequestHeaders()`	`instance`	`(none)`	这个方法通常不会被外部调用。被这个对象自己调用来配置在HTTP请求要发送的HTTP报头。
`onStateChange()`	`instance`	`(none)`	这个方法通常不会被外部调用。当AJAX请求状态改变的时候被这个对象自己调用。
`respondToReadyState(readyState)`	`instance`	`readyState`: 状态数字 (1 到 4)	这个方法通常不会被外部调用。当AJAX请求状态改变的时候被这个对象自己调用。

2.15. `options` 参数对象

AJAX操作中一个重要的部分就是 options 参数。本质上没有options类。任何对象都可以被传入，只要带有需要的属性。通常会只为了AJAX调用创建匿名类。

Table 2.16. options 参数对象

属性	类型	Default	描述
`method`	`Array`	`'post'`	HTTP 请求方式。
`parameters`	`String`	`''`	在HTTP请求中传入的url格式的值列表。
`asynchronous`	`Boolean`	`true`	指定是否做异步 AJAX 请求。
`postBody`	`String`	`undefined`	在HTTP POST的情况下，传入请求体中的内容。
`requestHeaders`	`Array`	`undefined`	和请求一起被传入的HTTP头部列表，这个列表必须含有偶数个项目，任何奇数项目是自定义的头部的名称，接下来的偶数项目使这个头部项目的字符串值。例子:`['my-header1', 'this is the value', 'my-other-header', 'another value']`
`onXXXXXXXX`	`Function(XMLHttpRequest)`	`undefined`	在AJAX请求中，当相应的事件/状态形成的时候调用的自定义方法。例如 `var myOpts = {onComplete: showResponse, onLoaded: registerLoaded};`. 这个方法将被传入一个参数，这个参数是携带AJAX操作的 `XMLHttpRequest`对象。
`onSuccess`	`Function(XMLHttpRequest)`	`undefined`	当AJAX请求成功完成的时候调用的自定义方法。这个方法将被传入一个参数，这个参数是携带AJAX操作的 `XMLHttpRequest`对象。
`onFailure`	`Function(XMLHttpRequest)`	`undefined`	当AJAX请求完成但出现错误的时候调用的自定义方法。这个方法将被传入一个参数，这个参数是携带AJAX操作的 `XMLHttpRequest`对象。
`insertion`	`Function(Object, String)`	`null`	为了把返回的文本注入到一个元素中而执行的方法。这个方法将被传入两个参数，要被更新的对象并且只应用于 `Ajax.Updater` 的响应文本。
`evalScripts`	`Boolean`	`undefined, false`	决定当响应到达的时候是否执行其中的脚本块，只在 `Ajax.Updater` 对象中应用。
`decay`	`Number`	`undefined, 1`	决定当最后一次响应和前一次响应相同时在 `Ajax.PeriodicalUpdater` 对象中的减漫访问的次数，例如，如果设为2，后来的刷新和之前的结果一样，这个对象将等待2个设定的时间间隔进行下一次刷新，如果又一次一样，那么将等待4次，等等。不设定这个只，或者设置为1，将避免访问频率变慢。

Chapter 2. prototype.js参考

2.1. JavaScript 类的扩展

2.2. 对 `Object` 类的扩展

2.3. 对 `Number` 类的扩展

2.4. 对 `Function` 类的扩展

2.5. 对 `String` 类的扩展

2.6. 对 `document` DOM 对象的扩展

2.7. 对 `Event` 对象的扩展

2.8. 在 prototype.js中定义的新对象和类

2.9. `PeriodicalExecuter` 对象

2.10. `Prototype` 对象

2.11. `Class` 对象

2.12. `Ajax` 对象

2.13. `Ajax.Base` 类

2.14. `Ajax.Request` 类

2.15. `options` 参数对象

公告

prototype.js开发笔记(二)

Chapter 2. prototype.js参考

2.1. JavaScript 类的扩展

2.2. 对 Object 类的扩展

2.3. 对 Number 类的扩展

2.4. 对 Function 类的扩展

2.5. 对 String 类的扩展

2.6. 对 document DOM 对象的扩展

2.7. 对 Event 对象的扩展

2.8. 在 prototype.js中定义的新对象和类

2.9. PeriodicalExecuter 对象

2.10. Prototype 对象

2.11. Class 对象

2.12. Ajax 对象

2.13. Ajax.Base 类

2.14. Ajax.Request 类

2.15. options 参数对象

公告

2.2. 对 `Object` 类的扩展

2.3. 对 `Number` 类的扩展

2.4. 对 `Function` 类的扩展

2.5. 对 `String` 类的扩展

2.6. 对 `document` DOM 对象的扩展

2.7. 对 `Event` 对象的扩展

2.9. `PeriodicalExecuter` 对象

2.10. `Prototype` 对象

2.11. `Class` 对象

2.12. `Ajax` 对象

2.13. `Ajax.Base` 类

2.14. `Ajax.Request` 类

2.15. `options` 参数对象