DIV CSS 佈局教程網

DWR util.js 學習筆記:常用工具函式整理
編輯:AJAX基礎知識     

DWR 除了遠端呼叫能力之外,還附帶一支 util.js。這支檔案收錄了一批實用的客戶端工具函式,用來在頁面中操作 DOM 與表單。它並不依賴 DWR 的核心,可以單獨抽出去用在任何專案裡——光是這一點就值得認識一下。

函式總覽

  1. $():取得頁面元素
  2. addOptions / removeAllOptions:初始化下拉選單
  3. addRows / removeAllRows:填滿表格
  4. getText:取得 option 的文字
  5. getValue / getValues:取得表單單值與多值
  6. setValue / setValues:設定表單單值與多值
  7. onReturn、selectRange
  8. toDescriptiveString、useLoadingMessage

1. $():最省字元的选择器

IE5.0 不支援。它基本上就是 document.getElementById 的簡寫:

var name = $("name");

2. 操作 select 下拉選單

若希望在更新選項時保留原本選中的值,標準寫法是先取值、清空、重新填入,再把值寫回:

var sel = DWRUtil.getValue(id);
DWRUtil.removeAllOptions(id);
DWRUtil.addOptions(id, ...);
DWRUtil.setValue(id, sel);

想加一個「--請選擇--」的提示選項,直接 DWRUtil.addOptions(id, ["--請選擇--"]); 即可。

addOptions() 共有五種用法:

  • 單純陣列:DWRUtil.addOptions("demo1", array);
  • 元素為 bean 的陣列:需指定顯示用的 property 與對應的值,例如 DWRUtil.addOptions("demo2", array, 'id', 'name');,其中 id 對應 option 的 value,name 對應顯示文字。
  • 進階物件陣列:寫法同上,資料直接以字面形式給定,如 [{name:'Africa', id:'AF'}, ...], 'id', 'name'。
  • Map:若伺服器回傳 Map,直接 DWRUtil.addOptions("demo3", map);,key 對應 value、value 對應顯示文字。
  • 清單編輯:這個函式不只適用於 select,也能用來填滿 <ul> 與 <ol> 這類元素。

3. addRows / removeAllRows:填表格

兩個函式:DWRUtil.addRows() 產生資料列,DWRUtil.removeAllRows(id) 清除指定 id 的表格內容。

DWRUtil.addRows(id, array, cellfuncs, [options]);
  • id:對應 table 的 id,更適合指向 tbody(建議直接使用 tbody)
  • array:伺服器端回傳的資料,如 List、Map
  • cellfuncs:一組函式,用返回值填充各欄
  • options:設定表格樣式,內部提供 rowCreator 與 cellCreator 兩個函式

以下範例示範如何在最後兩欄動態產生「刪除」與「編輯」按鈕,並自訂列與儲存格的樣式:

function userList(data) {
    var cellfuncs = [
        function(data) { return data.id; },
        function(data) { return data.userName; },
        function(data) { return data.userTrueName; },
        function(data) { return data.birthday; },
        function(data) {
            var idd = data.id;
            var delButton = document.createElement("<INPUT TYPE='button' onclick='delPerson(" + idd + ")'>");
            delButton.setAttribute("id", "delete");
            delButton.setAttribute("value", "delete");
            return delButton;
        },
        function(data) {
            var idd = data.id;
            var editButton = document.createElement("<INPUT TYPE='button' onclick='editPerson(" + idd + ")'>");
            editButton.setAttribute("name", "edit");
            editButton.setAttribute("value", "edit");
            return editButton;
        }
    ];

    DWRUtil.removeAllRows('tabId');
    DWRUtil.addRows('tabId', data, cellfuncs, {
        rowCreator: function(options) {
            var row = document.createElement("tr");
            var index = options.rowIndex * 50;
            row.setAttribute("id", options.rowData.id);
            row.style.color = "rgb(" + index + ",0,0)";
            return row;
        },
        cellCreator: function(options) {
            var td = document.createElement("td");
            td.style.backgroundColor = "menu";
            td.style.fontWeight = "bold";
            td.style.align = "center";
            return td;
        }
    });

    document.getElementById("bt").style.display = "none";
}

4. getText:取得 option 的文字而非值

這個函式專門用來拿 select 中被選中選項的文字內容,其他元素不適用:

<select id="select">
  <option value="1">蘋果</option>
  <option value="2" selected>香蕉</option>
  <option value="3">鴨梨</option>
</select>

DWRUtil.getText("select");   // 回傳 "香蕉"

5. getValue:取得表單值

幾乎所有表單元件都能吃:textarea、select、text input、password input、form button 乃至自製的 fancy button,呼叫 DWRUtil.getValue(id) 都會回傳對應的值。

6. getValues:一次取多個值

批量取得頁面表單值,組合成 name/value 形式的物件:

DWRUtil.getValues({textarea:null, select:null, text:null, password:null, button:null})
// 回傳 {textarea:1111, select:4444, text:2222, password:3333, button:5555}

7. onReturn:攔住 Enter 鍵

避免使用者在文字框按 Enter 就直接送出表單:

<input type="text" onkeypress="DWRUtil.onReturn(event, submitFunction)" />
<input type="button" onclick="submitFunction()" />

8. selectRange:選取輸入框中的一段文字

DWRUtil.selectRange("sel-test", 2, 15);
// 012345678901234567890 → 選中段 "2345678901234"

9、10. setValue 與 setValues

DWRUtil.setValue(id, value);

DWRUtil.setValues({
    name: "fzfx88",
    password: "1234567890"
});

11. toDescriptiveString:帶層級的除錯輸出

第一個參數為要除錯的物件,第二個參數為展開層級:

  • 0:單行輸出
  • 1:多行輸出,但不深入子物件
  • 2:多行輸出,深入子物件的第二層

12. useLoadingMessage:等待提示

function searchUser() {
    var loadinfo = "loading.....";
    try {
        regUser.queryAllUser(userList);
        DWRUtil.useLoadingMessage(loadinfo);
    } catch (e) {
    }
}

整體看來,util.js 的價值在於把「填下拉選單」、「填表格」、「批次讀寫表單」這幾件在 Ajax 應用裡反覆出現的瑣事,收斂成一行函式呼叫。即使完全不用 DWR 的遠端能力,單獨引這支檔案也能讓前端程式碼乾淨不少。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved