superFile

立即使用

概述

本模块封装了基于腾讯浏览服务Tbs,使用X5Webkit内核,实现文件的展示功能,支持多种文件格式(pdf, word, execl, txt, ppt)。在iOS 端是封装的系统自带的文档预览器。

说明

  • 由于此模块SDK的原因,X5Webkit只会初始化一次,当再次初始化的时候没有回调值,所以初始化操作放在了模块内部。
  • 此模块封装的是腾讯Tbs服务,如果加载文件失败,可以下载腾讯的微信并运行
  • android注意:文件打开,同一时刻只可以打开一个文件
  • android不可以同时添加pdfReader模块一起编译

init

sdk 初始化 (暂仅支持Android)自模块1.0.7后需要调用该方法进行初始化

init(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 描述:未读的@消息。
  • 内部字段:
{
      eventType:'onViewInitFinished'            //字符串;事件类型
                                                  //取值范围:
                                                  // onCoreInitFinished 
                                                  // onViewInitFinished
}

示例代码

var superFile = api.require('superFile');
superFile.init(function(ret){
        alert(JSON.stringify(ret));
});

可用性

android系统

可提供的 1.0.0 及更高版本

open

打开文件

open接口和openView接口的区别是:open接口打开的界面开发者不可以在界面上再做其他的操作,openView打开的界面开发者可以在界面上做其他的操作,比如打开一个frame等

注意:本接口打开的文档阅读器其界面在 iOS 和 Android 平台有差异。

open(params)

params

path:

  • 类型:字符串类型
  • 描述:(必选项) 文件路径 android支持fs或者绝对路径

示例代码

var superFile = api.require('superFile');
superFile.open({path:'fs://1.pdf'});

可用性

iOS,android系统

可提供的 1.0.0 及更高版本

openView

打开文件

open接口和openView接口的区别是:open接口打开的界面开发者不可以在界面上再做其他的操作,openView打开的界面开发者可以在界面上做其他的操作,比如打开一个frame等

openView(params)

path:

  • 类型:字符串类型
  • 描述:(必选项) 文件路径 android支持fs或者绝对路径

rect:

  • 类型:JSON对象
  • 描述:(可选项)模块的位置及尺寸
  • 内部字段:
x: 0,                              //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
y: 0,                              //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
w: 320,                            //(可选项)数字类型;模块的宽度;默认值:默认:'auto'
h: 480                             //(可选项)数字类型;模块的高度;默认值:默认:'auto'

fixedOn:

  • 类型:字符串
  • 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
  • 默认:模块依附于当前 window

fixed:

  • 类型:布尔
  • 描述:(可选项)模块是否随所属 window 或 frame 滚动
  • 默认:true(不随之滚动)

示例代码

var superFile = api.require('superFile');
superFile.openView({path:'fs://1.pdf'});

可用性

iOS,android系统

可提供的 1.0.0 及更高版本

hide

隐藏窗口

hide();

示例代码

var superFile = api.require('superFile');
superFile.hide()

可用性

iOS,android系统

可提供的 1.0.0 及更高版本

show

显示窗口

show();

示例代码

var superFile = api.require('superFile');
superFile.show()

可用性

iOS,android系统

可提供的 1.0.0 及更高版本

close

关闭窗口

close();

示例代码

var superFile = api.require('superFile');
superFile.close()

可用性

iOS,android系统

可提供的 1.0.0 及更高版本