码实平台移动端SDK手册

全局函数

Class.create   创建一个类 语法 Class.create(parentClass, property, property, ...) 参数 parentClass 可选。Function，这是父类，子类将复制父类所有的属性。 property 可选。Object，子类定义的属性集合，这里可以传多个。 返回值 Function，创建的类 备注 其实JS中是不存在类的，这里做的都是复制。new Function()会先创建一个Object，然后把Function.prototype的属性都复制这个Object，最后返回这个Object。我们在create中做的是把父类和子类新定义的属性都预先加到Function.prototype中。 Object相当于引用类型, 假如属性的值也是Object，复制的只是引用。

Object.extend   把一个对象的属性复制到另一个对象中。 语法 Object.extend(destination, source) 参数 destination 必选。Object，目标对象。 source 必选。Object，源对象。 返回值 没有返回值 备注 JS中Object可以看作是引用类型，复制的时候只是复制引用。

Function.bind   对于给定函数，创建具有与原始函数相同的主体的绑定函数。在绑定功能中,this对象解析为传入的对象。该绑定函数具有指定的初始参数。 语法 function.bind(target, parameter, parameter, ...) 参数 target 必选。Object，可在新函数中为其引用 this 关键字的对象。 parameter 可选。要传递到新函数的参数。 返回值 Function，新的函数

alert   弹出提示框。 语法 alert(text) 参数 text 必选。String，提示信息。 返回值                                                                                              没有返回值

parseJSON   文本转成JSON 语法 parseJSON(text) 参数 text 必选。String，要转的文本。 返回值 Object，转后的JSON。

trim   去掉指定字符串前后空格。 语法 trim(text) 参数 text 必选。String，要处理的文本。 返回值 String，处理后的文本。

dipToPx   dip(device independent pixels，设备独立像素) 转成 px(pixels，像素) 语法 dipToPx(dip) 参数 dip 必选。Number，dip长度。 返回值 Number，px长度。

 

 

Mash5.Context

Context是支撑页面跳转的一系列环境属性和操作

getCurrentTenantCode   获取当前Context的租户Code 语法 context.getCurrentTenantCode() 返回值 String，租户Code

getCurrentTenantName   获取当前Context的租户名称 语法 context.getCurrentTenantName() 返回值 String，租户名称

getCurrentUserId   获取当前用户ID 语法 context.getCurrentUserId() 返回值 String，用户ID

getCurrentUserName   获取当前用户名字 语法 context.getCurrentUserName() 返回值 String，用户名字

getCurrentAppId   获取当前Context的AppId 语法 context.getCurrentAppId() 返回值 String，AppId

getCurrentTaskId   获取当前Context的TaskId 语法 context.getCurrentTaskId() 返回值 String，TaskId

getString   获取Context中的国际化。 语法 context.getString(key) 参数 key 必选。String，国际化的key。 返回值 String，当前设备语言的国际化。

goIntoTask   进入下一个业务 语法 context.goIntoTask(config) 参数 config 必选。Object，业务的信息。 config的属性 id 必选。String，业务的ID data 可选。传入业务的数据。 返回值 没有返回值。

startPage   打开一个页面 语法 context.startPage(config) 参数 config 必选。Object，页面的配置信息。 config的属性 nameSpace 必选。String，页面的命名空间。 data 可选。传入页面的数据。 callback 可选。Function，关闭页面的回调函数。 返回值 没有返回值。

getLibrary   获取类库。 语法 context.getLibrary(config) 参数 config 必选。Object，获取类库的参数集合。 config的属性 nameSpace 必选。String，类库的命名空间。 callback 必选。Function，获取后的回调函数，类库对象[Object]作为参数传入回调函数。 返回值 没有返回值

getResource   获取资源文件。 语法 context.getResource(config) 参数 config 必选。Object，获取资源文件的参数集合。 config的属性 id 必选。String，资源的ID。 path 可选。String，资源的子目录，资源是文件夹时需要文件的子目录。 callback 必选。Function，获取后的回调函数，资源对象[Ti.Filesystem.File]作为参数传入回调函数。 返回值 没有返回值

fire   调用规则。 语法 context.fire(config) 参数 config 必选。Object，调用规则的参数集合。 config的属性 trigger 必选。String，规则的触发器。 data 可选。传入规则处理函数的数据。 返回值 没有返回值

createWidgetByNameSpace   创建一个Widget。 语法 context.createWidgetByNameSpace(config) 参数 config 必选。Object，Widget的配置信息。 config的属性 page 必选。Mash5.Page，Widget的要应用到的页面。 nameSpace 必选。String，Widget的命名空间。 config 可选。Widget的配置参数。 data 可选。Widget的数据参数。 返回值 Mash5.Widget，Widget对象。

getCookie   获取Cookie的管理对象。 语法 context.getCookie() 返回值 Object，Cookie管理对象。 Cookie管理对象的方法： add 参数有(key[String，必选], type[String，可选], data[任意类型])。增加Cookie。 get 参数有(key[String，必选], type[String，可选])。查询Cookie。 remove 参数有(key[String，必选], type[String，可选])。删除Cookie。

 

Mash5.Page

Page是针对当前页面的一系列操作

getContext   获取当前页的Context。 语法 widget.getContext() 返回值 Mash5.Context，当前页的Context

open   打开页面。 语法 page.open(animation) 参数 animation 可选。Boolean，true以动画方式打开，false无动画。默认true。 返回值 没有返回值。

close   关闭页面。 语法 page.close(animation) 参数 animation 可选。Boolean，true以动画方式打开，false无动画。默认true。 返回值 没有返回值。

setBackgroundColor   设置页面背景颜色。 语法 page.setBackgroundColor(color) 参数 color 必选。String，网页格式颜色字符串, 如：#FFFFFF。 返回值 没有返回值。

setBackgroundImage   设置页面背景图片。 语法 page.setBackgroundImage(image) 参数 image 必选。String，一个本地文件路径或URL。 返回值 没有返回值。

setResult   设置页面结果，假如在开启页面的时候设置了callback，当这个页面关闭的时候callback自动执行，result将作为参数传入。setResult必须在关闭页面前调用。 语法 page.setResult(reuslt) 参数 reuslt 必选。任意类型。 返回值 没有返回值。

setKeepScreenOn   设置是否锁定页面，防止无操作自动休眠。 语法 page.setKeepScreenOn(whether) 参数 whether 必选。Boolean，true锁定屏幕，false无操作自动休眠。默认false。 返回值 没有返回值。

setTitle   设置页面导航条标题。 语法 page.setTitle(text) 参数 text 必选。String，导航条上的标题。 返回值 没有返回值。

setNavBackgroundColor   设置页面导航条背景颜色。 语法 page.setNavBackgroundColor(color) 参数 color 必选。String，网页格式颜色字符串, 如：#FFFFFF。 返回值 没有返回值。

setNavOpacity   设置页面导航条透明度。 语法 page.setNavOpacity(opacity) 参数 opacity 必选。Number，取值范围0-1。 返回值 没有返回值。

setLeftNavButton   设置页面导航条左边按钮。 语法 page.setLeftNavButton(config) 参数 config 必选。Object，按钮的配置。 config的属性 style 必选。取值从一下几种中选择 Mash5.UI.NavigationButtonStyle.BACK、 Mash5.UI.NavigationButtonStyle.ADD、 Mash5.UI.NavigationButtonStyle.EDIT、 Mash5.UI.NavigationButtonStyle.OK、 Mash5.UI.NavigationButtonStyle.SETTINGS、 Mash5.UI.NavigationButtonStyle.LIST、 Mash5.UI.NavigationButtonStyle.MORE、 Mash5.UI.NavigationButtonStyle.TEXT、 Mash5.UI.NavigationButtonStyle.REFRESH、 Mash5.UI.NavigationButtonStyle.SHAREICON listener 必选。Function，按钮按下的处理函数。 text 可选。String，当style是Mash5.UI.NavigationButtonStyle.TEXT的时候text为按钮上的文字。 返回值 没有返回值。

setRightNavButton   设置页面导航条右边按钮。 语法 page.setRightNavButton(config) 参数 config 必选。Object，按钮的配置。 config的属性 style 必选。取值从一下几种中选择 Mash5.UI.NavigationButtonStyle.BACK、 Mash5.UI.NavigationButtonStyle.ADD、 Mash5.UI.NavigationButtonStyle.EDIT、 Mash5.UI.NavigationButtonStyle.OK、 Mash5.UI.NavigationButtonStyle.SETTINGS、 Mash5.UI.NavigationButtonStyle.LIST、 Mash5.UI.NavigationButtonStyle.MORE、 Mash5.UI.NavigationButtonStyle.TEXT、 Mash5.UI.NavigationButtonStyle.REFRESH、 Mash5.UI.NavigationButtonStyle.SHAREICON listener 必选。Function，按钮按下的处理函数。 text 可选。String，当style是Mash5.UI.NavigationButtonStyle.TEXT的时候text为按钮上的文字。 返回值 没有返回值。

showLeftNavButton   设置页面导航条左边按钮显示。 语法 page.showLeftNavButton() 返回值 没有返回值。

hideLeftNavButton   设置页面导航条左边按钮隐藏。 语法 page.hideLeftNavButton() 返回值 没有返回值。

showRightNavButton   设置页面导航条右边按钮显示。 语法 page.showRightNavButton() 返回值 没有返回值。

hideRightNavButton   设置页面导航条右边按钮隐藏。 语法 page.hideRightNavButton() 返回值 没有返回值。

addEventListener   给页面添加事件监听 语法 page.addEventListener(eventName, listener, listener, ...) 参数 eventName 必选。String，要监听的事件名称。 listener 必选。Function，事件的处理函数，可以传多个处理函数。 返回值 没有返回值 备注 页面自动触发的事件有open, close, focus, blur。

removeEventListener   删除页面事件监听 语法 page.removeEventListener(eventName, listener, listener, ...) 参数 eventName 必选。String，事件名称。 listener 必选。Function，事件的处理函数，可以传多个处理函数。 返回值 没有返回值 备注 页面自动触发的事件有open, close, focus, blur。

fireEvent   触发页面的事件 语法 page.fireEvent(eventName, parameter, parameter, ...) 参数 eventName 必选。String，事件名称。 parameter 可选。处理函数的参数，可以传多个参数。 返回值 没有返回值 备注 页面自动触发的事件有open, close, focus, blur。

 

 

Mash5.Widget

Widget是页面里嵌入的可以用命名空间复用的UI组件

getContext   获取当前的Context。 语法 widget.getContext() 返回值 Mash5.Context，当前Widget的Context

setContentView   设置Widget的视图。 语法 widget.setContentView(view) 参数 view 必选。Ti.UI.View，视图。 返回值 没有返回值。

getNameSpace   获取Widget的命名空间。 语法 widget.getNameSpace() 返回值 String，当前Widget的命名空间。

getView   获取Widget的根视图，非setContentView的视图。 语法 widget.getView() 返回值 Ti.UI.View，Widget的根视图。

getCurrentPage   获取Widget所属的页面对象。 语法 widget.getCurrentPage() 返回值 Mash5.Page，当前Widget的页面对象。

hide   设置Widget视图隐藏。 语法 widget.hide() 返回值 没有返回值。

show   设置Widget视图显示。 语法 widget.show() 返回值 没有返回值。

addEventListener   给Widget添加事件监听 语法 widget.addEventListener(eventName, listener, listener, ...) 参数 eventName 必选。String，要监听的事件名称。 listener 必选。Function，事件的处理函数，可以传多个处理函数。 返回值 没有返回值 备注 Widget自动触发的事件有open, close, focus, blur，orientationchange。

removeEventListener   删除Widget事件监听 语法 widget.removeEventListener(eventName, listener, listener, ...) 参数 eventName 必选。String，事件名称。 listener 必选。Function，事件的处理函数，可以传多个处理函数。 返回值 没有返回值 备注 Widget自动触发的事件有open, close, focus, blur，orientationchange。

fireEvent   触发Widget的事件 语法 widget.fireEvent(eventName, parameter, parameter, ...) 参数 eventName 必选。String，事件名称。 parameter 可选。处理函数的参数，可以传多个参数。 返回值 没有返回值 备注 Widget自动触发的事件有open, close, focus, blur，orientationchange。