本文详细介绍了Prototype.js库的主要功能，包括JavaScript类的扩展方法、DOM操作、事件处理、AJAX交互等，并提供了丰富的示例。
Table 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>
Table 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 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>
这个对象提供一定间隔时间上重复调用一个方法的逻辑。
Prototype 没有太重要的作用，只是声明了该程序包的版本 。
在这个程序包中 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
这个对象被用作其他提供AJAX功能的类的根对象。
这个类是其他在Ajax对象中定义的类的基类。
Table 13. Ajax.Base 类
| 方法 | 类别 | 参数 | 描述 |
|---|---|---|---|
| setOptions(options) | instance | options: AJAX 选项 | 设定AJAX操作想要的选项。 |
| responseIsSuccess() | instance | (none) | 返回 true 如果AJAX操作成功,否则为 false 。 |
| responseIsFailure() | instance | (none) | 与 responseIsSuccess() 相反。 |
继承自 Ajax.Base
封装 AJAX 操作
Table 14. Ajax.Request 类
| 属性 | 类型 | 类别 | 描述 |
|---|---|---|---|
| Events | Array | static | 在AJAX操作中所有可能报告的事件/状态的列表。这个列表包括: 'Uninitialized', 'Loading', 'Loaded', 'Interactive', 和 'Complete'。 |
| transport | XMLHttpRequest | instance | 携带AJAX操作的 XMLHttpRequest 对象。 |
Table 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请求状态改变的时候被这个对象自己调用。 |
AJAX操作中一个重要的部分就是 options 参数。 本质上没有options类。任何对象都可以被传入，只要带有需要的属性。通常会只为了AJAX调用创建匿名类。
Table 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，将避免访问频率变慢。 |
继承自 Ajax.Request
当请求的url返回一段HTML而你想把它直接放置到页面中一个特定的元素的时候被用到。 如果url的返回<script> 的块并且想在接收到时就执行它的时候也可以使用该对象。含有脚本的时候使用 evalScripts 选项。
Table 17. Ajax.Updater 类
| 属性 | 类型 | 类别 | 描述 |
|---|---|---|---|
| ScriptFragment | String | static | 可以判断是否为脚本的正则表达式。 |
| containers | Object | instance | 这个对象包含两个属性:AJAX请求成功执行的时候用到 containers.success , 否则的话用到 containers.failure 。 |
Table 18. Ajax.Updater 类
| 方法 | 类别 | 参数 | 描述 |
|---|---|---|---|
| [ctor](container, url, options) | constructor | container:可以是元素的id, 也可以是元素自己, 或者可以是带有2个属性的对象 - object.success AJAX请求成功的时候用到的元素(或者id) 否则用到object.failure 中设定的元素(或id) ,url: 请求的url, options: AJAX 选项 | 创建一个用给定的选项请求给定的url的一个实例。 |
| updateContent() | instance | (none) | 这个方法通常不会被外部调用。 当响应到达的时候，被这个对象自己调用。 它会用HTML更新适当的元素或者调用在 insertion 选项中传入的方法-这个方法将被传入两个参数， 被更新的元素和响应文本。 |
继承自 Ajax.Base
这个类重复生成并使用 Ajax.Updater 对象来刷新页面中的一个元素。或者执行 Ajax.Updater 可以执行的其它任务。更多信息参照 Ajax.Updater 参考 。
Table 19. Ajax.PeriodicalUpdater 类
| 属性 | 类型 | 类别 | 描述 |
|---|---|---|---|
| container | Object | instance | 这个值将直接传入Ajax.Updater的构造方法。 |
| url | String | instance | 这个值将直接传入Ajax.Updater的构造方法。 |
| frequency | Number | instance | 两次刷新之间的间隔 (不是频率) ，以秒为单位。 默认2秒。 This 当调用 Ajax.Updater 对象的时候，这个数将和当前的 decay 相乘。 |
| decay | Number | instance | 重负执行任务的时候保持的衰败水平。 |
| updater | Ajax.Updater | instance | 最后一次使用的 Ajax.Updater 对象 |
| timer | Object | instance | 通知对象该下一次更新时用到的JavaScript 计时器。 |
Table 20. Ajax.PeriodicalUpdater 类
| 方法 | 类别 | 参数 | 描述 |
|---|---|---|---|
| [ctor](container, url, options) | constructor | container:可以是元素的id, 也可以是元素自己, 或者可以是带有2个属性的对象 - object.success AJAX请求成功的时候用到的元素(或者id) 否则用到object.failure 中设定的元素(或id) ,url: 请求的url, options: AJAX 选项 | 创建一个用给定的选项请求给定的url的一个实例。 |
| start() | instance | (none) | 这个方法通常不会被外部调用。 对象为了开始周期性执行任务的时候调用的方法。 |
| stop() | instance | (none) | 这个方法通常不会被外部调用。 对象为了停止周期性执行任务的时候调用的方法。 |
| updateComplete() | instance | (none) | 这个方法通常不会被外部调用。 被当前的 Ajax.Updater 使用，当一次请求结束的时候，它被用作计划下一次请求。 |
| onTimerEvent() | instance | (none) | 这个方法通常不会被外部调用。当到下一次更新时被内部调用。 |
这个对象提供在操作DOM中元素时使用的功能性方法。
Table 21. Element 对象
| 方法 | 类别 | 参数 | 描述 |
|---|---|---|---|
| toggle(elem1 [, elem2 [, elem3 [...]]]) | constructor | elemN: 元素对象或id | 切换每一个传入元素的可视性。 |
| hide(elem1 [, elem2 [, elem3 [...]]]) | instance | elemN: 元素对象或id | 用设定它的 style.display 为 'none'来隐藏每个传入的元素。 |
| show(elem1 [, elem2 [, Slem3 [...]]]) | instance | elemN: 元素对象或id | 用设定它的 style.display 为 ''来显示每个传入的元素。 |
| remove(element) | instance | element: 元素对象或id | 从document对象中删除指定的元素。 |
| getHeight(element) | instance | element: 元素对象或id | 返回元素的 offsetHeight 。 |
| addClassName( element, className) | instance | element: 元素对象或id, className: CSS类名 | 向元素的类名中加入给定的类名。 |
| hasClassName( element, className) | instance | element: 元素对象或id, className: CSS类名 | 返回 true 如果元素的类名中含有给定的类名 |
| removeClassName( element, className) | instance | element: 元素对象或id, className: CSS类名 | 从元素的类名中删除给定的类名。 |
| cleanWhitespace( element ) | instance | element: 元素对象或id | 删除该元素的所有只含有空格的子节点。 |
这个类被用作其他提供动态内容插入功能的类的基类，它像一个抽象类一样被使用。
在给定元素开始标记的前面插入HTML。
Table 24. Insertion.Before 类
| 方法 | 类别 | 参数 | 描述 |
|---|---|---|---|
| [ctor](element, content) | constructor | element: 元素对象或id, content: 被插入的HTML | 继承自 Abstract.Insertion. 创建一个可以帮助插入动态内容的对象。 |
下面的代码
<br>Hello, <span id="person" style="color:red;">Wiggum. How's it going?</span>
<script> new Insertion.Before('person', 'Chief '); </script>
将把 HTML 变为
<br>Hello, Chief <span id="person" style="color:red;">Wiggum. How's it going?</span>
在给定元素第一个子节点位置插入 HTML。内容将位于元素的开始标记的紧后面。
Table 25. Insertion.Top 类
| 方法 | 类别 | 参数 | 描述 |
|---|---|---|---|
| [ctor](element, content) | constructor | element: 元素对象或id, content: 被插入的HTML | 继承自 Abstract.Insertion. 创建一个可以帮助插入动态内容的对象。 |
下面的代码
<br>Hello, <span id="person" style="color:red;">Wiggum. How's it going?</span>
<script> new Insertion.Top('person', 'Mr. '); </script>
将把 HTML 变为
<br>Hello, <span id="person" style="color:red;">Mr. Wiggum. How's it going?</span>
在给定元素最后一个子节点位置插入 HTML。内容将位于元素的结束标记的紧前面。
Table 26. Insertion.Bottom 类
| 方法 | 类别 | 参数 | 描述 |
|---|---|---|---|
| [ctor](element, content) | constructor | element: 元素对象或id, content: 被插入的HTML | 继承自 Abstract.Insertion. 创建一个可以帮助插入动态内容的对象。 |
下面的代码
<br>Hello, <span id="person" style="color:red;">Wiggum. How's it going?</span>
<script> new Insertion.Bottom('person', " What's up?"); </script>
将把 HTML 变为
<br>Hello, <span id="person" style="color:red;">Wiggum. How's it going? What's up?</span>
在给定元素结束标记的后面插入HTML。
Table 27. Insertion.After 类
| 方法 | 类别 | 参数 | 描述 |
|---|---|---|---|
| [ctor](element, content) | constructor | element: 元素对象或id, content: 被插入的HTML | 继承自 Abstract.Insertion. 创建一个可以帮助插入动态内容的对象。 |
下面的代码
<br>Hello, <span id="person" style="color:red;">Wiggum. How's it going?</span>
<script> new Insertion.After('person', ' Are you there?'); </script>
将把 HTML 变为
<br>Hello, <span id="person" style="color:red;">Wiggum. How's it going?</span> Are you there?
这个对象提供操作表单中的输入项目的功能性方法。
Table 28. Field 对象
| 方法 | 类别 | 参数 | 描述 |
|---|---|---|---|
| clear(field1 [, field2 [, field3 [...]]]) | instance | fieldN: 元素对象或id | 清除传入表单中项目元素的值。 |
| present(field1 [, field2 [, field3 [...]]]) | instance | fieldN: 元素对象或id | 只有在所有的表单项目都不为空时返回 true 。 |
| focus(field) | instance | fieldN: 元素对象或id | 移动焦点到给定的表单项目。 |
| select(field) | instance | fieldN: 元素对象或id | 选择支持项目值选择的表单项目的值。 |
| activate(field) | instance | fieldN: 元素对象或id | 移动焦点并且选择支持项目值选择的表单项目的值。 |
这个对象提供操作表单和他们的输入项目的功能性方法。
Table 29. Form 对象
| 方法 | 类别 | 参数 | 描述 |
|---|---|---|---|
| serialize(form) | instance | form: 表单元素或id | 返回url参数格式的项目名和值的列表， 如'field1=value1&field2=value2&field3=value3'。 |
| getElements(form) | instance | form: 表单元素或id | 返回包含所有在表单中输入项目的 Array 对象。 |
| getInputs(form [, typeName [, name]]) | instance | form: 表单元素或id, typeName: 输入项目的类型, name: 输入项目的名称 | 返回一个 Array 包含所有在表单中的 <input> 元素。 另外， 这个列表可以对元素的类型或名字属性进行过滤。 |
| disable(form) | instance | form: 表单元素或id | 使表单中的所有输入项目无效。 |
| enable(form) | instance | form: 表单元素或id | 使表单中的所有输入项目有效。 |
| focusFirstElement(form) | instance | form: 表单元素或id | 激活第一个表单中可视的，有效的输入项目。 |
| reset(form) | instance | form: 表单元素或id | 重置表单。和调用表单对象的 reset() 方法一样。 |
这个对象提供表单对象中的可视和非可视元素的功能性方法。
这个对象提供了内部使用的用来协助解析出表单元素的当前值功能性方法。
Table 31. Form.Element.Serializers 对象
| 方法 | 类别 | 参数 | 描述 |
|---|---|---|---|
| inputSelector(element) | instance | element: 一个带有checked属性的表单元素或id， 如 radio 或 checkbox。 | 返回带有元素名称和值的 Array , 如 ['elementName', 'elementValue'] |
| textarea(element) | instance | element: 一个带有value属性的表单元素或id， 如 textbox, button 或 password 项目。 | 返回带有元素名称和值的 Array , 如 ['elementName', 'elementValue'] |
| select(element) | instance | element: 一个<select> 元素对象或id。 | 返回带有元素名称和所有被选择的选项的值或文本的 Array , 如 ['elementName', 'selOpt1 selOpt4 selOpt9'] |
这个类是用于其它监听一个元素的值(或者任何类中涉及的属性)变化的类的基类，这个类像一个抽象类一样被使用。
子类可以被创建来监听如输入项目值，或style属性，或表格的行数，或者其他任何对跟踪变化相关的东西。
子类必须实现这个方法来决定什么才是被监听的元素的当前值。
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
