JavaScript API Reference
Buffalo对象
Buffalo(gateway, async, events)
参数名称 | 参数类型 | 是否必须 | 默认 |
---|---|---|---|
gateway | string | 是 | 无 |
async | boolean | 否 | true |
events | 对象 | 否 | 默认 |
构造器方法,提供创建的Buffalo对象的方法。一般使用方法(进行异步调用):
var buffalo = new Buffalo("/bfapp/buffalo");
同步调用:
var buffalo = new Buffalo("/bfapp/buffalo", false);
remoteCall(service, params, callback)
参数名称 | 参数类型 | 是否必须 | 默认 | |
---|---|---|---|---|
service | string | 是 | 无 | |
params | Array | 是 | 无 | |
callback | function | 是 | 无 |
进行远程调用,并且将返回值传递给回调方法并执行。
buffalo.remoteCall("helloService.hello", ['Michael'], function(reply) { alert(reply.getResult()); })
或者
buffalo.remoteCall("helloService.hello", ['Michael'], myfunc); function myfunc(reply) { alert(reply.getResult()); }
setEvents(events)
参数名称 | 参数类型 | 是否必须 | 默认 events | 对象 | 是 | 无
用来自定义事件的方法。
buffalo.setEvents({onLoading:myloading}}) function myloading(state) { if (state) {window.status = "loading..."; } else {window.status = "load completed."; } }
一般来说,可能不会这么用,而采用这样的方法:
buffalo.events["onLoading"] = myloading;
bindReply(service, params, elementId)
参数名称 | 参数类型 | 是否必须 | 默认 | |
---|---|---|---|---|
service | string | 是 | 无 | |
params | Array | 是 | 无 | |
elementId | string | 是 | 无 |
进行远程调用,并且将调用结果绑定到指定为elementId的元素上。
例,调用simpleService的获取省份列表的远程方法,并将结果绑定到id为select_province的select上:
buffalo.bindReply("simpleService.provincesNames",[],"select_province");
switchView(viewName)
参数名称 | 描述 | 参数类型 | 是否必须 | 默认 |
---|---|---|---|---|
viewName | 页面路径 | string | 是 | 无 |
访问viewName指定的页面,并加载到id为body的div中。这个操作将会将这个url加入到浏览器的历史中,使得浏览器前进后退有效。
switchPart(viewName, partId, addToHistory)
参数名称 | 描述 | 参数类型 | 是否必须 | 默认 |
---|---|---|---|---|
viewName | 要切换的页面路径 | string | 是 | 无 |
partId | 要替换到的div id | string | 是 | 无 |
addToHistory | 是否加入到浏览器历史 | boolean | 否 | 是 |
switchView提供了通用的页面切换机制,然而在页面内部,可能希望能够自定义每一个部分都可以切换。switchPart提供支持。它将会访问viewName指定的路径,并替换掉partId指定的div。如果addToHistory为真,那么这个操作将会加入到历史中,使得浏览器后退按钮可用。