SOW API规范是SOW提供给开发者所有Javascript API的接口,其包括如下几部分:
·Widget API:直接操作和使用Widget本身的一些API
·Data API:操作数据请求的API
·Element API:便于操作和管理对象的API
·Controls API:辅助进行页面布局和控制的API
·Other API:其他的一些辅助性的API
注意:为了保证Widget之间的相互影响及安全, API规范禁止直接操作window、document及其直接子对象
下面将对这些API进行详细的描述:
Widget API
SOW Widget API(以下简称Widget API)是提供给开发者,可以直接操作Widget进行各种处理的接口,第三方开发的Widget将直接构建在此API接口之上。
开发者可以通过widget对象使用Widget API,widget对象是一个SOW Widget类的实例,其提供的相关属性、方法和事件如下:属性
|
名称 |
类型 |
说明 |
|
body |
HtmlElement |
widget内容显示区域的容器对象 |
|
lang |
String |
用户客户端的语言(保留关键词,暂不支持) |
|
locale |
String |
用户客户端的locale(保留关键词,暂不支持) |
方法
|
名称 |
说明 |
|
addBody(content) |
把content添加到widget.body对象(内容区)的最后边,如果content为String类型,那就将其放入一个div对象中,添加到body对象中。 |
|
createElement(tagName) |
通过tagName创建一个新的Dom对象 |
|
getValue(name) |
此方法取得Widget Preferences中的参数设置值 |
|
log(string) |
输出string到控制台 |
|
openURL(string) |
用指定的地址打开一个新窗口 |
|
setAutoRefresh(delay) |
设置Widget自动刷新的频率,delay刷新间隔时间,以秒为单位 |
|
setBody(content) |
设置widget.body对象(内容区)的内容,content必须为一段有效的xhtml片段,其将替代原来widget.body中的内容 |
|
setSearchResultCount(count) |
(保留关键词,暂时不支持) |
|
setTitle(title) |
设置widget的标题,只能是无格式的字符串,不支持xhtml标签 |
|
setUnreadCount(count) |
(保留关键词,暂时不支持) |
|
setValue(name, value) |
此方法可以设置Widget Preferences中的参数值 |
