這份程式碼把表單提交、連結請求、按鈕導航等常見互動,全部收斂成一套可重複使用的通用元件。只要給 DOM 掛上對應的 class 與自訂屬性,就能自動獲得驗證、遮罩、導向與錯誤提示等行為。以下依功能拆解說明。
腳本開頭用 "use strict" 進入嚴格模式,並定義兩個全域開關:ajaxSynchronized 控制請求是否序列化(預設同步,透過 blockUI 遮罩畫面),ajaxAutoUnblock 則決定遮罩是否自動解除。
ajax_action_button 會讀取按鈕上的 pre_script,以 eval 執行前置檢查,回傳 false 就中止;接著把按鈕的 value 當成 btn_action 塞進表單的 data 中,供後端判斷使用者按了哪顆鈕。
ajax_update_post_data 負責維護表單的額外欄位,傳入 undefined 的 value 等同刪除該鍵。
bool_checkbox 解決了「取消勾選的 checkbox 不會被序列化」這個老問題:勾選時不帶值,取消時補上一個 f。spin_number、date_input、time_picker 則分別初始化數字微調器、日期與時間選擇器,並允許透過 HTML 屬性覆寫 interval、min、max、step 等設定。
ajax_form_post 是核心。它先跑前置腳本、清空錯誤提示區,然後序列化表單、併入 btn_action 與 post_data,以 POST 送出。回應處理分幾個分支:
成功時,若 btn_action 為 reqonly 則只彈出提示並等待使用者點擊;若有 returi 屬性就跳轉;有 reload 就重整;其餘情況直接顯示提示訊息。
失敗時,會把後端回傳的欄位錯誤對應回畫面:隱藏欄位透過 hidden-id 找到可見的參照欄位,多選 checkbox 則以 name[] 的形式歸位,最後呼叫驗證器的 invalidate() 讓錯誤顯示在正確位置。
ajax_post_form_hidden 為每個隱藏欄位綁定 change 監聽,讓參照欄位變動時自動清除錯誤。validate_hidden_id 與 data_equals_validate 則註冊成自訂驗證規則,前者檢查隱藏值是否為空,後者比對兩個欄位是否一致(例如密碼確認)。
ajax_link_req 支援 confirm 二次確認、hint 錯誤顯示位置、success 回呼函式,以及 returi/reload 導向。btn_nav 只做單純的 href 跳轉;btn_req 則是 GET 版的請求按鈕,具備相同的導向能力。ajax_checkbox 攔截預設行為,改以 URL 送出 1/0 狀態。
picklistinit 與 picklistchange 實作了逐層展開的樹狀選單:選到葉節點時把值寫入隱藏欄位並顯示成功圖示,選到非葉節點則動態生成下一層 SELECT。lookup_new 開啟彈窗挑選資料,parent_lookup 則負責把彈窗選回的 id 與顯示文字寫回 opener 視窗,並觸發 change 事件與 after_script。
genericUpload 封裝了 fileupload 外掛,可透過 endpoint/sid/complete 屬性自訂上傳位址、工作階段與完成回呼。advance_validate 與 advance_inputs 是一組 validator effect,負責在欄位後方動態插入錯誤容器、逐行填入訊息,驗證通過後再收起並清除 colError 樣式。
checkall 提供全選/取消全選(可搭配 refname 或 refclass),readonlyCheck 與 readonlySelect 則用來把 checkbox 與 select 鎖成唯讀狀態。
最後在 $(document).ready 中統一掛上 ajaxStart/ajaxStop/ajaxError 的遮罩邏輯,並用一個全域 click 事件作為「點一下解除遮罩」的保險,同時處理 blockUI 中暫存的 returi。接著註冊 validator 的 advanced effect 與自訂規則,最後逐一初始化各類元件:表單、數字框、日期、時間、連結、按鈕、lookup、checkbox、tooltip 與 overlay,並完成多語系字串本土化。
/**
* Generic Form processing js
* @author Anthony.chen
*/
"use strict";
var ajaxSynchronized = true; // 所有 ajax 請求預設序列化
var ajaxAutoUnblock = true; // 遮罩預設自動解除
// 按鈕:把 btn_action 塞進表單,並可先跑 pre_script
var ajax_action_button = function (e){
var btn = $(this);
var pre_script;
if (pre_script = btn.attr("pre_script")) {
var ret = eval(pre_script);
if (ret == false) { return false; }
}
var btn_action = btn.attr('value');
if (btn_action) {
$(this).closest('form').data('btn_action', { name: 'btn_action', value: btn_action });
}
};
// 維護表單的額外欄位
var ajax_update_post_data = function (formEle, k, v){
var form = $(formEle);
var post_data = form.data('post_data');
if (post_data == undefined) { post_data = {}; }
if (v == undefined) { delete post_data[k]; } else { post_data[k] = v; }
form.data('post_data', post_data);
return true;
};
// 布林 checkbox:取消勾選時補送 'f'
var bool_checkbox = function (){
var ipt = $(this);
var formEle = ipt.closest("form");
var _check = ipt.prop("checked");
if (_check) {
ajax_update_post_data(formEle, ipt.attr('name'));
} else {
ajax_update_post_data(formEle, ipt.attr('name'), 'f');
}
};
// 數字微調器
var spin_number = function (){
var spin = $(this);
var config = { lock: true, imageBasePath: '{webpath}/css/images/spin/', btnClass: 'spin_btn' };
var interval = spin.attr('interval');
config.interval = interval ? interval : 1;
var min = spin.attr('min'); if (min) { config.min = min; }
var max = spin.attr('max'); if (max) { config.max = max; }
spin.spin(config);
return true;
};
// 日期輸入
var date_input = function (){
var ipt = $(this);
var config = { offset: [4, 0], selectors: true, lang: '{lang}', firstDay: 1, format: 'yyyy-mm-dd' };
var min = ipt.attr('min'); if (min) { config.min = min; }
ipt.dateinput(config);
return true;
};
// 時間選擇
var time_picker = function (){
var ipt = $(this);
var config = {};
var step = ipt.attr("step"); if (step) { config.step = step; }
ipt.timePicker(config);
return true;
};
// 表單送出
var ajax_form_post = function (e){
var form = $(this);
var pre_script;
if (pre_script = form.attr("pre_script")) {
if (eval(pre_script) == false) { return false; }
}
var errHint = form.find(".formError").first();
if (errHint.size() == 0) { errHint = $("#pageError"); }
errHint.text('').hide();
if (!e.isDefaultPrevented()) {
$.blockUI({ message: "{__('L_PROCESSING')}" });
var formArray = form.serializeArray();
var btn_action_data, btn_action;
if (btn_action_data = form.data('btn_action')) {
formArray.push(btn_action_data);
form.removeData('btn_action');
btn_action = btn_action_data.value;
} else { btn_action = ''; }
var post_data;
if (post_data = form.data('post_data')) {
for (var k in post_data) { formArray.push({ name: k, value: post_data[k] }); }
form.removeData('post_data');
}
$.post(form.attr('action'), formArray, function (json){
if ($(window).data('blockUI.isBlocked') == 1) { $.unblockUI(); }
if (json.code === true) {
var returi = "";
var retData = json.data ? json.data : "{__('L_PROCESSED')}!";
if (btn_action == 'reqonly') {
if (returi = form.attr('returi')) {
$(window).data('blockUI.returi', returi);
ajaxAutoUnblock = false;
}
$.blockUI({ message: retData });
$(".blockUI").addClass("blockwarn");
} else if (returi = form.attr('returi')) {
window.location = returi;
} else if (form.attr('reload') != undefined) {
window.location.reload();
} else {
$.blockUI({ message: retData });
$.unblockUI();
}
} else {
if (typeof (json.data.errmsg) == 'string') {
errHint.html(json.data).show();
} else {
errHint.html("{Html::text(__('E_FORM'))}").show();
for (var p in json.data) {
var msg = json.data[p];
// 隱藏欄位:把錯誤導向可見的參照欄位
var ele = form.find("[type=hidden][name=" + p + "]");
if (ele.length) {
var refid = ele.attr("id");
var refname = form.find("[hidden-id=" + refid + "]").attr("name");
json.data[refname] = msg;
}
// 多選 checkbox
var ele2 = form.find("[type=checkbox][name='" + p + "[]']");
if (ele2.length) { json.data[p + '[]'] = msg; }
}
form.data("validator").invalidate(json.data);
}
}
}, 'json');
e.preventDefault();
} else {
errHint.html("{Html::text(__('E_FORM'))}").show();
}
};
// 隱藏欄位的錯誤重置
var ajax_post_form_hidden = function (){
var form = $(this);
form.find("[hidden-id]").each(function (){
var input = $(this);
var hinput = input;
input.change(function (){
var rinput = $("[hidden-id=" + hinput.attr("id") + "]").first();
form.data('validator').reset(rinput);
});
});
};
var validate_hidden_id = function (input) {
var field = $("#" + input.attr("hidden-id"));
var msg = field.attr('msg') || "{__('E_NOT_EMPTY')}";
return field.val() ? true : msg;
};
var data_equals_validate = function (input) {
var name = input.attr("data-equals");
var field = this.getInputs().filter("[name=" + name + "]");
return input.val() == field.val() ? true : [name];
};
// 連結請求
var ajax_link_req = function (){
var l = $(this);
var hint = l.attr('hint');
var errHint;
if (hint) { errHint = $(l.attr('hint')); errHint.text('').hide(); }
if (l.attr('confirm') && !confirm(l.attr('confirm'))) { return false; }
$.blockUI({ message: "{__('L_PROCESSING')}" });
var pre_script;
if (pre_script = l.attr("pre_script")) { if (eval(pre_script) == false) { return false; } }
if (l.attr('block') != undefined) { ajaxAutoUnblock = false; }
$.get(l.attr('href'), function (json){
if (json.code == true) {
var retData = json.data ? json.data : "{__('L_PROCESSED')}!";
var successFunc = l.attr('success');
if (successFunc) { l.each(window[successFunc]); }
if (l.attr('value') == 'reqonly') {
alert(retData);
} else if (l.attr('returi')) {
window.location = l.attr('returi');
} else if (l.attr('reload') != undefined) {
window.location.reload();
} else {
$.blockUI({ message: retData });
$(".blockUI").addClass("blockwarn");
}
} else {
if (hint) { errHint.text(json.data).show(); } else { alert(json.data); }
}
}, 'json');
return false;
};
// 按鈕跳轉
var btn_nav = function (){
var href = $(this).attr("href");
if (href) { window.location = href; } else { alert("Href not set"); }
return false;
};
// 按鈕 GET 請求
var btn_req = function (){
var input = $(this);
var href = input.attr("href");
var hint = input.attr('hint');
var errHint;
if (hint) {
errHint = $(hint).first();
if (errHint.size() == 0) { errHint = $("#pageError"); }
errHint.text('').hide();
}
if (input.attr('block') != undefined) { ajaxAutoUnblock = false; }
$.get(href, function (json){
if (json.code == true) {
if (input.attr('returi')) {
window.location = input.attr('returi');
} else if (input.attr("reload") != undefined) {
window.location.reload();
} else {
var retData = json.data ? json.data : "{__('L_PROCESSED')}!";
$.blockUI({ message: retData });
}
} else {
if (hint) { $.unblockUI(); errHint.html(json.data.errmsg).show(); }
else { $.blockUI({ message: json.data.errmsg }); $(".blockUI").addClass("blockwarn"); }
}
}, 'json');
return false;
};
// Ajax checkbox
var ajax_checkbox = function (){
event.preventDefault();
var action = $(this);
var _check = action.prop("checked");
var op = _check ? "1" : "0";
$.get(action.attr('url') + op, function (json){
if (json.code == true) { action.prop("checked", _check); return true; }
return false;
}, 'json');
};
// 樹狀下拉初始化
var picklistinit = function (){
var _select = $(this);
var _hidden_id = _select.attr('hidden-id');
var _un = _select.attr('un');
var _lovchildren = _select.data('lovtree').c;
var _rowvalue = _select.data('rowvalue');
$("<OPTION>").append("{__('L_SELECT')}").appendTo(_select);
for (var _kid in _lovchildren) {
var _lov = _lovchildren[_kid]['lov'];
$("<OPTION>").val(_lov.lov_id).append(_lov.v)
.attr('k', _lov.id).attr('is_leaf', _lov.is_leaf).appendTo(_select);
}
_select.change(picklistchange);
if (_rowvalue) {
_select.find("[value=" + _rowvalue[0] + "]").prop("selected", true);
_select.change();
}
return true;
};
// 樹狀下拉換層
var picklistchange = function (){
var _select = $(this);
var _hidden_id = _select.attr('hidden-id');
var _un = _select.attr('un');
var _lovtree = _select.data('lovtree');
var _rowvalue = _select.data('rowvalue');
_select.nextAll().remove();
var _selected = _select.find(':selected');
if (_selected.attr('is_leaf') == "{DB::T}") {
$("#" + _hidden_id).val(_select.val());
_select.after("<img src='/s.gif' class='sprite_global successimg'/>");
} else {
var _k = _selected.attr('k');
if (_lovtree.c[_k].c == undefined) { return false; }
var _c_lovtree = _lovtree.c[_k];
var _c_select = $('<SELECT>').data('lovtree', _c_lovtree)
.data('rowvalue', _rowvalue)
.attr('hidden-id', _hidden_id).attr('un', _un)
.attr('name', _un + '_' + _k);
$("<OPTION>").append("{__('L_SELECT')}").appendTo(_c_select);
for (var _kid in _c_lovtree.c) {
var _lov = _c_lovtree.c[_kid]['lov'];
$("<OPTION>").val(_lov.lov_id).append(_lov.v)
.attr('k', _lov.id).attr('is_leaf', _lov.is_leaf).appendTo(_c_select);
}
_select.after(_c_select);
_c_select.change(picklistchange);
if (_rowvalue) {
_c_select.find("[value=" + _rowvalue[_k] + "]").prop("selected", true);
_c_select.change();
}
}
};
// 開啟 lookup 彈窗
var lookup_new = function (){
var lookup = $(this);
var pre_script;
if (pre_script = lookup.attr("pre_script")) { if (eval(pre_script) == false) { return false; } }
var url = lookup.attr("url");
if (!url) { alert('url not set'); return false; }
var height = lookup.attr('h') || 600;
var width = lookup.attr('w') || 800;
window.open(url, "pselect", "scrollbars=yes,menubar=no,height=" + height + ",width=" + width + ",resizable=yes,toolbar=no,location=no,status=no");
return false;
};
// 回寫父視窗
var parent_lookup = function (){
var lookup = $(this);
var pid = opener.$("#" + lookup.attr('pid'));
if (!pid.length) { alert(lookup.attr('pid') + " not found"); return false; }
var pname = opener.$("#" + lookup.attr('pname'));
if (!pname.length) { alert(lookup.attr('pname') + " not found"); return false; }
var aft_script;
if (aft_script = lookup.attr('aft_script')) { window.eval(aft_script); }
pid.val($(this).attr("refid"));
pid.change();
pname.val($(this).attr("refvalue"));
pname.change();
if (aft_script = pname.attr('aft_script')) { opener.window.eval(aft_script); }
if (aft_script = pid.attr('aft_script')) { opener.window.eval(aft_script); }
window.close();
};
// 上傳
var uploadComplete = function (e, data) {
var _fileUpload = $(this);
if (_fileUpload.attr('reload') != undefined) { window.location.reload(); }
};
var genericUpload = function (dom){
var endpointurl = $(this).attr('endpoint');
var sid = $(this).attr("sid");
var completeFunc = $(this).attr('complete') || 'uploadComplete';
$(this).fileupload({
url: endpointurl, autoUpload: true, dataType: 'json',
formData: [{ 'sessionid': sid }], paramName: 'Filedata'
}).bind('fileuploaddone', window[completeFunc]);
};
// 進階驗證:錯誤顯示
var advance_validate = function (errors, event) {
var conf = this.getConf();
$.each(errors, function (index, error) {
var input = error.input;
input.addClass(conf.errorClass);
var msg = input.data("msg.el");
if (!msg) {
msg = $(conf.message).addClass(conf.messageClass).appendTo(input.parent());
input.data("msg.el", msg);
}
msg.css({ visibility: 'hidden' }).find("span").remove();
$.each(error.messages, function (i, m) {
$("<span/>").html(m).appendTo(msg);
});
msg.css({ visibility: 'visible' }).fadeIn(conf.speed);
msg.parent().addClass("colError");
});
};
var advance_inputs = function (inputs) {
var conf = this.getConf();
inputs.removeClass(conf.errorClass).each(function () {
var msg = $(this).data("msg.el");
if (msg) { msg.hide(); msg.parent().removeClass("colError"); }
});
if ($(".colError").size() == 0) {
var errHint = $(this).find(".formError").first();
if (errHint.size() == 0) { errHint = $("#pageError"); }
errHint.text('').hide();
}
};
// 全選
var checkall = function () {
var check = $(this);
var refname = check.attr('refname');
if (refname) { $("input[name*='" + refname + "']").prop("checked", check.prop("checked")); }
var refclass = check.attr('refclass');
if (refclass) { $("input." + refclass).prop("checked", check.prop("checked")); }
};
var readonlyCheck = function (e) { e.preventDefault(); return false; };
var readonlySelect = function () { $(this).prop("disabled", true); };
$(document).ready(function () {
$(document).ajaxStart(function () {
$("#pageError").text('').hide();
$(".formError").text('').hide();
if (ajaxSynchronized) { $.blockUI({ message: "{__('L_PROCESSING')}" }); }
});
$(document).ajaxStop(function () {
if (ajaxSynchronized && $(window).data('blockUI.isBlocked') == 1) {
if (ajaxAutoUnblock) { $.unblockUI(); } else { ajaxAutoUnblock = true; }
} else {
ajaxAutoUnblock = true; ajaxSynchronized = true;
}
});
$(document).ajaxError(function (event, request, settings) {
alert('Ajax Request Error! URL=' + settings.url);
if (ajaxSynchronized && $(window).data('blockUI.isBlocked') == 1) {
if (ajaxAutoUnblock) { $.unblockUI(); } else { ajaxAutoUnblock = true; }
} else { ajaxAutoUnblock = true; ajaxSynchronized = true; }
});
// 點一下強制解除遮罩
$(document).click(function () {
if ($(window).data('blockUI.isBlocked') == 1) {
$.unblockUI();
var returi = $(window).data('blockUI.returi');
if (returi) { window.location = returi; }
}
});
$.tools.validator.addEffect("advanced", advance_validate, advance_inputs);
$.tools.validator.fn("[data-equals]", { "{lang}": "{__('E_NOTEQUAL')}" }, data_equals_validate);
$.tools.validator.fn("[hidden-id]", validate_hidden_id);
$(".ajax_form_post").validator({ lang: '{lang}', effect: 'advanced' }).submit(ajax_form_post);
$(".ajax_form_post").each(ajax_post_form_hidden);
$(".spin_number").each(spin_number);
$(".date_input").each(date_input);
$(".time_picker").each(time_picker);
$('.ajax_link_req').click(ajax_link_req);
$(".require_validate").validator({ lang: '{lang}', effect: 'advanced' });
$(".btn_nav").click(btn_nav);
$(".btn_req").click(btn_req);
$("button.btn_action").click(ajax_action_button);
$(".lookup_new").click(lookup_new);
$(".parent_lookup").click(parent_lookup);
$(".ajax_checkbox").click(ajax_checkbox);
$(".bool_checkbox").click(bool_checkbox);
$(".checkall").click(checkall);
$("img[rel]").overlay();
$("input[tip]").tooltip({ position: "center right" });
$.tools.validator.localize("{lang}", {
'*': "{__('E_ALL')}",
':email': "{__('E_EMAIL')}",
':number': "{__('E_DECIMAL')}",
':url': "{__('E_URL')}",
'[max]': "{__('E_MAX_LENGTH')}",
'[min]': "{__('E_MIN_LENGTH')}",
'[required]': "{__('E_NOT_EMPTY')}"
});
});
整份腳本的價值在於「約定優於配置」:標記好 class 與屬性,其餘交給通用元件處理,表單、連結、按鈕三條路徑的行為與錯誤呈現方式因此保持一致。