UZModule

java.lang.Object
- com.uzmap.pkg.uzcore.uzmodule.UZModule

```
public abstract class UZModule
extends java.lang.Object
```
APICloud模块扩展机制中，所有扩展模块的基类。
Java类通过继承该类，并在module.json中配置声明，实现Java对象绑定映射至Javascript对象。详细的模块开发流程请参考《模块开发指南》。

module.json配置示例
```
 {
  name:'moduleName',
  class:'com.yonbuilder.modules.AnyModule'
 }
 
```
其中，name用于声明该模块开放给Javascript的对象名；class用于声明该继承自UZModule的类所在的路径。
Javascript中通过：
```
 var module = api.require('moduleName');
 
```
引用该模块对象

如何映射一个异步接口给Javascript

在该类下定义public类型，jsmethod前缀的void类型函数，并接收UZModuleContext类型参数，将操作结果通过success 或者error回调。
示例代码：
```
 public void jsmethod_funAbc(UZModuleContext moduleContext){
        //TODO
        moduleContext.success(ret, true);
 }
 
```
其中，jsmethod用于声明该函数将作为接口开放给javascript；funAbc用于声明开放给Javascript的接口名。
Javascript通过：
```
 var module = api.require('moduleName');
 module.funAbc({param}, callback);
 
```
使用该异步接口

如何映射一个同步接口给Javascript

在该类下定义public类型，jsmethod前缀sync后缀的return类型函数，接收UZModuleContext类型参数，并同步返回经ModuleResult包装过的数据。
示例代码：
```
 public ModuleResult jsmethod_funAbc_sync(UZModuleContext moduleContext){
        //TODO
        return new ModuleResult(data);
 }
 
```
其中，jsmethod用于声明该函数将作为接口开放给Javascript；funAbc用于声明开放给Javascript的接口名；sync用于声明该函数以同步的方式开放。
Javascript通过：
```
 var module = api.require('moduleName');
 var ret = module.funAbc({param});
 //TODO like: ret.value
 
```
使用该接口，同步获取结果。

注意：
同步接口通过非主线程桥接至Java，如果您的接口中有UI操作，请通过Handler(Looper.getMainLooper())或者runOnUiThread在主线程中执行。

构造器概要

构造器
构造器和说明
`UZModule()` 构造函数，空实现即可，引擎在初始化该代理类时主动调用该函数。
`UZModule(UZWebView webView)` 构造函数，空实现即可，引擎在初始化该代理类时主动调用该函数。

方法概要

方法
限定符和类型	方法和说明
`void`	`execScript(java.lang.String winName, java.lang.String frameName, java.lang.String script)` 向Html5页面执行一段Javascript脚本
`void`	`finishApplication()` 请求结束运行当前应用
`Activity`	`getContext()` 获取当前模块运行所在的Activity
`java.lang.String`	`getFeatureValue(java.lang.String featureName, java.lang.String paramName)` 获取当前应用widget的config文件中feature字段的值
`java.lang.String`	`getSecureValue(java.lang.String key)` 获取当前应用widget的key.xml文件中字段的值。
`UZWidgetInfo`	`getWidgetInfo()` 获取当前模块运行所在的widget信息
`boolean`	`inImmerseState()` 当前app是否处于"沉浸式"效果下。
`void`	`insertViewToCurWindow(View child, RelativeLayout.LayoutParams parms)` 插入一个Android的View到当前Html5页面所在的window
`void`	`insertViewToCurWindow(View child, ViewGroup.LayoutParams parms, java.lang.String frameName)` 插入一个Android的View到当前Html5页面所在的window
`void`	`insertViewToCurWindow(View child, ViewGroup.LayoutParams parms, java.lang.String frameName, boolean fixed)` 插入一个Android的View到当前Html5页面所在的window
`void`	`insertViewToCurWindow(View child, ViewGroup.LayoutParams parms, java.lang.String frameName, boolean fixed, boolean needVerScroll)` 插入一个Android的View到当前Html5页面所在的window
`java.lang.String`	`makeAbsUrl(java.lang.String link)` 基于当前Html5页面的绝对Url将某相对Url转换为绝对Url.
`java.lang.String`	`makeRealPath(java.lang.String path)` 将一个任意协议的路径，如标准的content://，res://，以及APICloud扩展的widget://，fs://，cache://转换为系统可识别的真实路径如： path: fs://abc/samples.txt 转换后的结果类似于：/sdcard/uzmap/appid/abc/samples.txt的本地SD卡中路径
`void`	`onActivityResult(int requestCode, int resultCode, Intent data)` 通过UZModule.startActivityForResult启动的目标Activity在结束运行后，结果将通过该函数回调。
`protected void`	`onClean()` 当Html5页面初始化加载，或者即将被销毁时，将回调该函数。
`boolean`	`openWidgetById(java.lang.String widgetId)` 根据widget的ID启动一个子widget到当前屏幕
`void`	`removeViewFromCurWindow(View child)` 从当前Html5页面所在window移除一个Android的View
`boolean`	`runOnUiThread(java.lang.Runnable action)` 在主线程中执行一个操作
`boolean`	`runOnUiThreadDelay(java.lang.Runnable action, int delayMillis)` 在指定时间后的主线程中执行一个操作
`void`	`startActivity(Intent intent)` 从模块内部发起一个startActivity
`void`	`startActivityForResult(Intent intent, int requestCode)` 从模块内部发起一个startActivityForResult 如果您的模块中需要启动其他Activity，并且获取结果，请务必调用该函数发起startActivityForResult，并且重写本对象下的onActivityResult函数获取结果

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - UZModule
```
public UZModule()
```
    构造函数，空实现即可，引擎在初始化该代理类时主动调用该函数。不建议在构造函数中做其他操作。
  - UZModule
```
public UZModule(UZWebView webView)
```
    构造函数，空实现即可，引擎在初始化该代理类时主动调用该函数。不建议在构造函数中做其他操作。
    
    参数:
    
    webView -
- 方法详细资料
  - getContext
```
public final Activity getContext()
```
    获取当前模块运行所在的Activity
    
    返回:
  - getWidgetInfo
```
public final UZWidgetInfo getWidgetInfo()
```
    获取当前模块运行所在的widget信息
    
    返回:
  - getFeatureValue
```
public java.lang.String getFeatureValue(java.lang.String featureName,
                               java.lang.String paramName)
```
    获取当前应用widget的config文件中feature字段的值
    
    参数:
    
    featureName - feature名，即为模块名
    
    paramName - 欲获取的参数键
    
    返回:
    
    参数值
  - getSecureValue
```
public java.lang.String getSecureValue(java.lang.String key)
```
    获取当前应用widget的key.xml文件中字段的值。 key.xml文件位于widget/res目录下，为开发人员自定义字段的标准XML格式文件，APICloud云编译时会自动将该文件进行加密处理
    
    参数:
    
    key - 欲获取的参数键
    
    返回:
    
    参数值
  - runOnUiThread
```
public final boolean runOnUiThread(java.lang.Runnable action)
```
    在主线程中执行一个操作
    
    参数:
    
    action -
    
    返回:
  - runOnUiThreadDelay
```
public final boolean runOnUiThreadDelay(java.lang.Runnable action,
                         int delayMillis)
```
    在指定时间后的主线程中执行一个操作
    
    参数:
    
    action -
    
    delayMillis -
    
    返回:
  - startActivityForResult
```
public final void startActivityForResult(Intent intent,
                          int requestCode)
```
    从模块内部发起一个startActivityForResult 如果您的模块中需要启动其他Activity，并且获取结果，请务必调用该函数发起startActivityForResult，并且重写本对象下的onActivityResult函数获取结果
  - startActivity
```
public final void startActivity(Intent intent)
```
    从模块内部发起一个startActivity
  - finishApplication
```
public final void finishApplication()
```
    请求结束运行当前应用
  - inImmerseState
```
public final boolean inImmerseState()
```
    当前app是否处于"沉浸式"效果下。
    如果开发者在config中配置了支持"沉浸式"效果，并且当前设备系统版本也支持"沉浸式效果"，该接口将返回true，其他情况返回false
    你的模块如果是UI类型的，则需要根据该接口做"沉浸式"效果的适应，比如设置你的模块最外层View的topMargin为[25 * density]
  - insertViewToCurWindow
```
public final void insertViewToCurWindow(View child,
                         RelativeLayout.LayoutParams parms)
```
    插入一个Android的View到当前Html5页面所在的window
    
    参数:
    
    child -
    
    parms -
  - insertViewToCurWindow
```
public final void insertViewToCurWindow(View child,
                         ViewGroup.LayoutParams parms,
                         java.lang.String frameName)
```
    插入一个Android的View到当前Html5页面所在的window
    
    参数:
    
    child -
    
    parms -
    
    frameName -
  - insertViewToCurWindow
```
public final void insertViewToCurWindow(View child,
                         ViewGroup.LayoutParams parms,
                         java.lang.String frameName,
                         boolean fixed)
```
    插入一个Android的View到当前Html5页面所在的window
    
    参数:
    
    child -
    
    parms -
    
    frameName -
    
    fixed -
  - insertViewToCurWindow
```
public final void insertViewToCurWindow(View child,
                         ViewGroup.LayoutParams parms,
                         java.lang.String frameName,
                         boolean fixed,
                         boolean needVerScroll)
```
    插入一个Android的View到当前Html5页面所在的window
    
    参数:
    
    child -
    
    parms -
    
    frameName -
    
    fixed -
    
    needVerScroll -
  - removeViewFromCurWindow
```
public final void removeViewFromCurWindow(View child)
```
    从当前Html5页面所在window移除一个Android的View
    
    参数:
    
    child -
  - openWidgetById
```
public final boolean openWidgetById(java.lang.String widgetId)
```
    根据widget的ID启动一个子widget到当前屏幕
    
    参数:
    
    widgetId -
    
    返回:
  - execScript
```
public final void execScript(java.lang.String winName,
              java.lang.String frameName,
              java.lang.String script)
```
    向Html5页面执行一段Javascript脚本
    
    参数:
    
    winName - winName所在window的名称，传""或者null则为当前调用该API所在的window
    
    frameName - Html5页面所在frame的名称
    
    script - 脚本
  - makeAbsUrl
```
public final java.lang.String makeAbsUrl(java.lang.String link)
```
    基于当前Html5页面的绝对Url将某相对Url转换为绝对Url.
    如：
    当前Html5页面URL: http://developer.yonyou.com/index.html
    link: /abc/lmn/samples.html
    运算结果将得到：http://developer.yonyou.com/abc/lmn/samples.html
    
    参数:
    
    link - 相对Url，如：../samples.html
    
    返回:
    
    绝对路径
  - makeRealPath
```
public final java.lang.String makeRealPath(java.lang.String path)
```
    将一个任意协议的路径，如标准的content://，res://，以及APICloud扩展的widget://，fs://，cache://转换为系统可识别的真实路径如：
    path: fs://abc/samples.txt
    转换后的结果类似于：/sdcard/uzmap/appid/abc/samples.txt的本地SD卡中路径
    
    参数:
    
    path - 任意协议的路径，如：fs://abc/samples.txt
    
    返回:
    
    真实的路径
  - onActivityResult
```
public void onActivityResult(int requestCode,
                    int resultCode,
                    Intent data)
```
    通过UZModule.startActivityForResult启动的目标Activity在结束运行后，结果将通过该函数回调。
    
    参数:
    
    requestCode -
    
    resultCode -
    
    data -
  - onClean
```
protected void onClean()
```
    当Html5页面初始化加载，或者即将被销毁时，将回调该函数。如果您的模块在Html5页面销毁时有资源需要释放，请务必重写该函数实现资源清理的逻辑

类 UZModule

module.json配置示例

如何映射一个异步接口给Javascript

如何映射一个同步接口给Javascript

注意：

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

UZModule

UZModule

方法详细资料

getContext

getWidgetInfo

getFeatureValue

getSecureValue

runOnUiThread

runOnUiThreadDelay

startActivityForResult

startActivity

finishApplication

inImmerseState

insertViewToCurWindow

insertViewToCurWindow

insertViewToCurWindow

insertViewToCurWindow

removeViewFromCurWindow

openWidgetById

execScript

makeAbsUrl

makeRealPath

onActivityResult

onClean