第七章 RJS Reference
第六節 A Look Ahead(前瞻)
從 Expense Tracker 這個範例可以發現,用 Rails 與 RJS 模板來實作複雜的 Ajax 功能幾乎輕而易舉。Expense Tracker 只是稍稍展露了可能性的一角。RJS Reference 這一節提供了使用範例,幫助你掌握 RJS 的各個環節,運用到自己的專案中。祝你玩得開心!
這個參考章節涵蓋了由 JavaScriptGenerator 支援的所有方法,以及 JavaScriptElementProxy 與 JavaScriptCollectionProxy 類別。在本節結束時,還有一份隨 Rails 1.1 附上的 Scriptaculous 視覺效果清單。
第一節 JavaScriptGenerator
以下是 JavaScriptGenerator 提供的所有公開方法清單,這些方法可在你 RJS 模板內的 page 物件上呼叫。
由於 RJS 的一切都在生成 JavaScript,了解幕後生成了什麼很有幫助。理解被生成的 JavaScript,能讓除錯更容易,也能建立更複雜的應用程式。某些時候,你的 RJS 程式碼可能變得太複雜,或遇到無法用 RJS 優雅完成的任務;如果你了解 RJS 如何生成 JavaScript,就能輕易把程式碼移植進 JavaScript 函式庫,並用 RJS 存取你新的 JavaScript 物件與方法。
因此,以下所有定義,我都把方法生成的 JavaScript 放在 Ruby 程式碼之後:Ruby 程式碼以註解 # Ruby code 標記,JavaScript 則以 // Generated JavaScript 標記。
1、<<(Javascript) 給頁面寫入原生 JavaScript。
2、[](id) 為指定 id 的 DOM 元素傳回一個 JavaScriptElementProxy。方法可在傳回的元素上呼叫,多個方法呼叫也能串接在一起。
# Ruby 程式碼
page['header'].show
// 生成的 JavaScript 程式碼
$("header").show();
# Ruby code
page['header'].first.second
// Generated JavaScript
$("header").first().second();
3、assign(variable, value) 指派一個值給特定的 JavaScript 變數。若有 to_JSon 方法,Ruby 物件會透過呼叫它自動轉換為 JavaScript 物件。
# Ruby code
page.assign 'name', { :first => "Cody", :last => "Fauser" }
// Generated JavaScript
name = { "first": "Cody", "last": "Fauser" };
4、alert(message) 用提供的訊息顯示一個 JavaScript 警告對話框。
# Ruby code
page.alert 'An error occurred while processing your request'
// Generated JavaScript
alert("An error occurred while processing your request");
5、call(function, arg, ...) 呼叫一個 JavaScript 函數並傳入零或多個參數。
# Ruby code
page.call 'displayError', 'An error occurred', 'Critical'
// Generated JavaScript
displayError("An error occurred", "Critical");
你也可以在自訂物件上呼叫方法,只要指定變數名與方法呼叫即可。
# Ruby code
page.call 'inventory.showTotal'
// Generated JavaScript
inventory.showTotal();
6、delay(seconds = 1) 在延遲指定秒數之後執行區塊內的程式碼。
# Ruby code
page.delay(5) do
page.visual_effect :highlight, 'navigation'
end
// Generated JavaScript
setTimeout(function() {
new Effect.Highlight("navigation", {});
}, 5000);
7、draggable(id, options = {}) 使由 id 指定的 DOM 元素可以拖放。
# Ruby code
page.draggable('photo', :revert => true)
// Generated JavaScript
new Draggable('photo', {revert: true});
8、drop_receiving(id, options = {}) 讓由 id 指定的 DOM 元素可以接收拖放的元素。可拖放元素由 RJS 的 draggable 方法或 Scriptaculous 輔助方法 draggable_element() 建立。
# Ruby code
page.drop_receiving('photo', :url => { :action => 'add' })
// Generated JavaScript
Droppables.add("photo", {onDrop:function(element){new Ajax.Request('/hello_world/add', {asynchronous:true, evalScripts:true, parameters:'id=' + encodeURIComponent(element.id)})}});
9、hide(id, ...) 隱藏一個或多個 DOM 元素,以 DOM id 指定。
# Ruby code
page.hide('first', 'second')
// Generated JavaScript
Element.hide("first", "second");
10、insert_Html(position, id, *options_for_render) 把 HTML 插入到相對於元素的位置。可用的位置有::before(插入到元素之前)、:after(插入到元素之後)、:top(插入到元素現有內容的頂部)、:bottom(插入到元素現有內容的底部)。
# Ruby code
page.insert_Html(:bottom, 'products', '<li>Refrigerator</li>')
// Generated JavaScript
new Insertion.Bottom("products", "<li>Refrigerator</li>");
11、redirect_to(location) 把瀏覽器重定向到指定位置。redirect_to() 會把位置傳給 url_for(),因此你平常用在 url_for() 內的任何參數,都能用在 redirect_to() 內。
# Ruby code
page.redirect_to('https://www.google.com')
// Generated JavaScript
window.location.href = "https://www.google.com";
# Ruby code
page.redirect_to(:controller => 'inventory', :action => 'list')
// Generated JavaScript
window.location.href = "https://localhost:3000/inventory/list";