webview
Webview模塊管理應用窗口界面,實現多窗口的邏輯控制管理操作。通過plus.webview可獲取應用界面管理對象。
方法:
- all: 獲取所有Webview窗口
- close: 關閉Webview窗口
- create: 創建新的Webview窗口
- currentWebview: 獲取當前窗口的WebviewObject對象
- getDisplayWebview: 獲取屏幕所有可視的Webview窗口
- getWebviewById: 查找指定標識的WebviewObject窗口
- getLaunchWebview: 獲取應用首頁WebviewObject窗口對象
- getSecondWebview: 獲取應用第二個首頁WebviewObject窗口對象
- getTopWebview: 獲取應用顯示棧頂的WebviewObject窗口對象
- hide: 隱藏Webview窗口
- open: 創建並打開Webview窗口
- show: 顯示Webview窗口
- startAnimation: Webview窗口組合動畫
- defaultHardwareAccelerated: 獲取Webview默認是否開啓硬件加速
對象:
- AnimationTypeShow: 一組用於定義頁面或控件顯示動畫效果
- AnimationTypeClose: 一組用於定義頁面或控件關閉的動畫效果
- WebviewObject: Webview窗口對象,用於操作加載HTML頁面的窗口
- WebviewAnimationOptions: Webview窗口動畫參數
- WebviewAnimationStyles: Webview窗口動畫樣式
- WebviewBounceStyle: Webview窗口回彈樣式
- WebviewContentAnimationOptions: Webview窗口內容動畫參數
- WebviewDock: 原生控件在窗口中停靠的方式
- WebviewDragEvent: Webview窗口滑動事件數據
- WebviewDragOptions: 窗口手勢操作參數
- WebviewDragOtherViewOptions: 手勢操作關聯對象參數
- WebviewDrawOptions: 截屏繪製操作參數
- WebviewNavigationbarStyles: 窗口導航欄控件樣式
- WebviewSplitLineStyles: 窗口導航欄控件分割線樣式
- WebviewBackButtonStyles: 窗口導航欄控件返回鍵樣式
- WebviewEvent: Webview窗口事件
- WebviewExtraOptions: JSON對象,原生窗口擴展參數
- WebviewPosition: 原生控件在窗口中顯示的位置
- WebviewRefreshStyles: Webview窗口下拉刷新樣式
- WebviewRenderedEventOptions: Webview窗口rendered事件參數
- WebviewStatusbarStyles: JSON對象,Webview窗口的系統狀態欄區域樣式
- WebviewStyles: JSON對象,Webview窗口對象的樣式
- WebviewTransform: 一組用於定義頁面或控件變形的屬性
- WebviewTransition: 一組用於定義頁面或控件轉換效果的屬性
- WebviewOverrideResourceOptions: 攔截Webview窗口資源請求的參數
- WebviewOverrideUrlOptions: 攔截Webview窗口URL請求的屬性
- WebviewListenResourceOptions: 監聽Webview窗口資源加載的屬性
回調方法:
- BounceEventCallback: Webview窗口回彈事件的回調函數
- EventCallback: Webview窗口事件的回調函數
- PopGestureCallback: Webview窗口側滑事件的回調函數
- HistoryQueryCallback: 歷史記錄查詢的回調函數
- ListenResourceLoadingCallback: Webview窗口加載資源事件的回調函數
- OverrideUrlLoadingCallback: Webview窗口攔截URL鏈接跳轉的回調函數
- TitleUpdateCallback: Webview窗口加載頁面標題更新的回調函數
- WebviewAnimationCallback: Webview窗口組合動畫回調函數
- WebviewDragCallback: Webview窗口滑屏操作事件回調函數
- SuccessCallback: Webview窗口操作成功回調函數
- ErrorCallback: Webview窗口操作失敗回調函數
權限:
5+功能模塊(permissions)
{
// …
“permissions”:{
// …
“Webview”: {
“description”: “窗口管理”
}
}
}
AnimationTypeShow
一組用於定義頁面或控件顯示動畫效果
常量:
-
auto
: _(String 類型 )_自動選擇動畫效果自動選擇動畫效果,使用上次顯示窗口設置的動畫效果,如果是第一次顯示則默認動畫效果“none”。
-
none
: _(String 類型 )_無動畫效果立即顯示頁面,無任何動畫效果,頁面顯示默認的動畫效果。 此效果忽略動畫時間參數,立即顯示。 對應關閉動畫"none"。
-
slide-in-right
: _(String 類型 )_從右側橫向滑動效果頁面從屏幕右側外向內橫向滑動顯示。 對應關閉動畫"slide-out-right"。
-
slide-in-left
: _(String 類型 )_從左側橫向滑動效果頁面從屏幕左側向右橫向滑動顯示。 對應關閉動畫"slide-out-left"。
-
slide-in-top
: _(String 類型 )_從上側豎向滑動效果頁面從屏幕上側向下豎向滑動顯示。 對應關閉動畫"slide-out-top"。
-
slide-in-bottom
: _(String 類型 )_從下側豎向滑動效果頁面從屏幕下側向上豎向滑動顯示。 對應關閉動畫"slide-out-bottom"。
-
fade-in
: _(String 類型 )_從透明到不透明逐漸顯示效果頁面從完全透明到不透明逐漸顯示。 對應關閉動畫"fade-out"。
-
zoom-out
: _(String 類型 )_從小到大逐漸放大顯示效果頁面在屏幕中間從小到大逐漸放大顯示。 對應關閉動畫"zoom-in"。
-
zoom-fade-out
: _(String 類型 )_從小到大逐漸放大並且從透明到不透明逐漸顯示效果頁面在屏幕中間從小到大逐漸放大並且從透明到不透明逐漸顯示。 對應關閉動畫"zoom-fade-in"。
-
pop-in
: _(String 類型 )_從右側平移入棧動畫效果頁面從屏幕右側滑入顯示,同時上一個頁面帶陰影效果從屏幕左側滑出隱藏。 對應關閉動畫"pop-out"。
AnimationTypeClose
一組用於定義頁面或控件關閉的動畫效果
常量:
-
auto
: _(String 類型 )_自動選擇動畫效果自動選擇顯示窗口相對於的動畫效果。
-
none
: _(String 類型 )_無動畫立即關閉頁面,無任何動畫效果。 此效果忽略動畫時間參數,立即關閉。
-
slide-out-right
: _(String 類型 )_橫向向右側滑出屏幕動畫頁面從屏幕中橫向向右側滑動到屏幕外關閉。
-
slide-out-left
: _(String 類型 )_橫向向左側滑出屏幕動畫頁面從屏幕中橫向向左側滑動到屏幕外關閉。
-
slide-out-top
: _(String 類型 )_豎向向上側滑出屏幕動畫頁面從屏幕中豎向向上側滑動到屏幕外關閉。
-
slide-out-bottom
: _(String 類型 )_豎向向下側滑出屏幕動畫頁面從屏幕中豎向向下側滑動到屏幕外關閉。
-
fade-out
: _(String 類型 )_從不透明到透明逐漸隱藏動畫頁面從不透明到透明逐漸隱藏關閉。
-
zoom-in
: _(String 類型 )_從大逐漸縮小關閉動畫頁面逐漸向頁面中心縮小關閉。
-
zoom-fade-in
: _(String 類型 )_從大逐漸縮小並且從不透明到透明逐漸隱藏關閉動畫頁面逐漸向頁面中心縮小並且從不透明到透明逐漸隱藏關閉。
-
pop-out
: _(String 類型 )_從右側平移出棧動畫效果頁面從屏幕右側滑出消失,同時上一個頁面帶陰影效果從屏幕左側滑入顯示。
WebviewObject
Webview窗口對象,用於操作加載HTML頁面的窗口
屬性:
- id: Webview窗口的標識
方法:
- addEventListener: 添加事件監聽器
- append: 在Webview窗口中添加子窗口
- appendJsFile: 添加Webview窗口預加載js文件
- animate: Webview窗口內容動畫
- back: 後退到上次加載的頁面
- beginPullToRefresh: 開始Webview窗口的下拉刷新
- canBack: 查詢Webview窗口是否可後退
- canForward: 查詢Webview窗口是否可前進
- checkRenderedContent: 檢測Webview窗口是否渲染完成
- children: 獲取Webview窗口的所有子Webview窗口
- clear: 清空原生Webview窗口加載的內容
- close: 關閉Webview窗口
- drag: 設置Webview窗口的滑屏操作手勢
- draw: 截屏繪製
- endPullToRefresh: 結束Webview窗口的下拉刷新
- evalJS: 在Webview窗口中執行JS腳本
- forward: 前進到上次加載的頁面
- getNavigationbar: 獲取Webview窗口的導航欄控件對象
- getStyle: 獲取Webview窗口的樣式
- getTitle: 獲取Webview窗口加載HTML頁面的標題
- getURL: 獲取Webview窗口加載HTML頁面的地址
- hide: 隱藏Webview窗口
- interceptTouchEvent: 是否攔截Webview窗口的觸屏事件
- isHardwareAccelerated: 查詢Webview窗口是否開啓硬件加速
- isVisible: 查詢Webview窗口是否可見
- listenResourceLoading: 監聽頁面開始加載資源
- loadData: 加載新HTML數據
- loadURL: 加載新URL頁面
- nativeInstanceObject: 獲取Webview窗口對象的原生(Native.JS)實例對象
- opened: 獲取在當前Webview窗口中創建的所有窗口
- opener: 獲取當前Webview窗口的創建者
- overrideResourceRequest: 攔截Webview窗口的資源加載
- overrideUrlLoading: 攔截Webview窗口的URL請求
- parent: 獲取當前Webview窗口的父窗口
- reload: 重新加載Webview窗口顯示的HTML頁面
- resetBounce: 重置Webview窗口的回彈位置
- restore: 恢復Webview控件顯示內容
- remove: 移除子Webview窗口
- removeEventListener: 移除Webview窗口事件監聽器
- removeFromParent: 從父窗口中移除
- setBounce: 設置Webview窗口的回彈效果
- setBlockNetworkImage: 設置Webview窗口是否阻塞加載頁面中使用的網絡圖片
- setContentVisible: 設置HTML內容是否可見
- setPullToRefresh: 設置Webview窗口的下拉刷新效果
- setRenderedEventOptions: 設置Webview窗口rendered事件參數
- setStyle: 設置Webview窗口的樣式
- setJsFile: 設置預加載的JS文件
- setCssFile: 設置預加載的CSS文件
- setCssText: 設置預加載的CSS內容
- setVisible: 設置Webview窗口是否可見
- setFixBottom: 設置Webview窗口底部修復區域高度
- show: 顯示Webview窗口
- showBehind: 在指定Webview窗口後顯示
- stop: 停止加載HTML頁面內容
事件:
- onclose: Webview窗口關閉事件
- onerror: Webview窗口錯誤事件
- onloaded: Webview窗口頁面加載完成事件
- onloading: Webview窗口頁面開始加載事件
WebviewAnimationOptions
Webview窗口動畫參數
interface WebviewAnimationOptions {
attribute WebviewObject view;
attribute WebviewAnimationStyles styles;
attribute String action;
}
說明:
用於指定動畫目標窗口,起始位置、目標位置等信息。
屬性:
-
view
: _(WebviewObject 類型 )_執行動畫的窗口對象可取值Webview窗口對象、Webview窗口的id(String類型)、原生View窗口對象(plus.nativeObj.View)。
-
styles
: _(WebviewAnimationStyles 類型 )_動畫樣式用於指定動畫窗口的起始位置,目標位置等。
-
action
: _(String 類型 )_窗口動畫完成後的行爲可取值: “none” - 動畫完成後不做任何操作; “hide” - 動畫完成後隱藏窗口; “close” - 動畫完成後關閉窗口。 默認值爲"none"。
WebviewAnimationStyles
Webview窗口動畫樣式
interface WebviewAnimationStyles {
attribute String fromLeft;
attribute String toLeft;
}
說明:
用於指定動畫窗口的起始位置、目標位置等信息。
屬性:
-
fromLeft
: _(String 類型 )_畫窗口的起始左側位置支持百分比、像素值,默認值爲當前窗口的位置。
-
toLeft
: _(String 類型 )_畫窗口的目標左側位置持百分比、像素值。 注意:如果設置的位置與起始位置一直,則無動畫效果。
WebviewBounceStyle
Webview窗口回彈樣式
屬性:
-
position
: _(JSON 類型 )_Webview窗口支持回彈效果的方向可通過此參數設置開啓Webview哪個方向支持回彈效果。 支持以下屬性: top:表示窗口頂部支持回彈效果; left:表示窗口左側支持回彈效果; right:表示窗口右側支持回彈效果; bottom:表示窗口底部支持回彈效果。 目前僅支持top屬性 屬性值:用於指定可拖拽的範圍,可取百分比,如"10%";像素值,如"100px";自動計算值,如"auto";無回彈效果值,如"none";
-
changeoffset
: _(JSON 類型 )_Webview窗口回彈時停靠的位置開啓窗口回彈效果後,當窗口中展現的內容滾動到頭(頂部或底部)時,再拖拽時窗口整體內容將跟隨移動,拖拽過程中將觸發"dragBounce"事件,鬆開後自動回彈到停靠位置。 支持以下屬性: top:表示窗口頂部回彈時停靠的位置。 屬性值:用於指定窗口回彈的位置,可取百分比,如"5%";像素值,如"100px";自動計算值,如"auto",默認爲可拖拽的範圍值的一半;
-
slideoffset
: _(JSON 類型 )_Webview窗口側滑時停靠的位置開啓窗口回彈效果後,當窗口中展現的內容滾動到頭(左側或右側)時,在拖拽時窗口整體內容將跟隨移動,鬆開後自動停靠的側滑位置,並觸發"slideBounce"事件。 支持以下屬性: left:表示窗口左側側滑的位置; right:表示窗口右側側滑的位置。 屬性值:用於指定滑動後停靠的距離,可取百分比(left/right相對於窗口的寬度,top/bottom相對於窗口的高度),如"30%";像素值,如"100px";自動計算值,爲可拖拽範圍,如"auto"。
-
offset
: _(JSON 類型 )_Webview窗口拖拽偏移的位置開啓窗口回彈效果後,可以通過此屬性值來主動設置拖拽的偏移位置,與手動操作拖拽至此偏移位置鬆開後的邏輯一致。 支持以下屬性: top:表示窗口頂部偏移的位置; left:表示窗口左側偏移的位置; right:表示窗口右側偏移的位置; bottom:表示窗口底部偏移的位置。 屬性值:用於指定偏移的位置,可取百分比,如"5%";像素值,如"100px";有效值範圍爲0到position屬性定義的位置。
-
preventTouchEvent
: _(Boolean 類型 )_Webview窗口是否阻止touch事件傳遞給DOM元素設置爲
true
表示阻止touch事件,設置爲false
表示不阻止touch事件。當開啓側滑功能(左側滑和右側滑)時默認值爲true
,否則爲false
。
WebviewContentAnimationOptions
Webview窗口內容動畫參數
interface WebviewAnimationOptions {
attribute String type;
attribute Number duration;
attribute Number frames;
attribute Rect region;
}
說明:
指定動畫的類型、持續時間等信息。
屬性:
-
type
: _(String 類型 )_動畫類型可取值:“shrink” - 從上到下分塊收縮清除窗口動畫。
-
duration
: _(Number 類型 )_動畫持續時間單位爲毫秒,默認值爲200ms。
-
frames
: _(Number 類型 )_動畫幀數必須爲大於0的整數,默認值爲12。
-
region
: _(json 類型 )_動畫作用區域支持以下屬性: top - 區域距離控件頂部的偏移量,屬性值可取像素值(如"100px"),百分比(如"10%",相對於控件的高度),默認值爲’0px’; bottom - 區域距離控件底部的偏移量,屬性值可取像素值(如"100px"),百分比(如"10%",相對於控件的高度),默認值爲’0px’; left - 區域距離控件左側的偏移量,屬性值可取像素值(如"100px"),百分比(如"10%",相對於控件的寬度),默認值爲’0px’; right - 區域距離控件右側的偏移量,屬性值可取像素值(如"100px"),百分比(如"10%",相對於控件的寬度),默認值爲’0px’。 如“{top:‘44px’,bottom:‘48px’}”。
WebviewDock
原生控件在窗口中停靠的方式
常量:
-
top
: _(String 類型 )_控件停靠則頁面頂部 -
bottom
: _(String 類型 )_控件停靠在頁面底部 -
right
: _(String 類型 )_控件停靠在頁面右側 -
left
: _(String 類型 )_控件停靠在頁面左側
WebviewDragEvent
Webview窗口滑動事件數據
屬性:
-
direction
: _(String 類型 )_手勢類型可取值: “rtl” - 從右向左滑動手勢; “left” - 向左滑動手勢,與rtl一致; “ltr” - 從左向右滑動手勢; “right” - 向右滑動手勢,與ltr一致。
-
type
: _(String 類型 )_窗口滑動類型可取值: “start” - 表示開始滑動操作; “move” - 表示正在滑動; “end” - 表示滑動操作結束。
-
result
: _(String 類型 )_窗口滑動結果可取值: “true” - 表示滑動操作成功; “false” - 表示滑動操作失敗(恢復到滑動前的狀態); “undefined” - 無狀態值(當type值爲"end"時返回此值)。
-
id
: _(String 類型 )_當前操作窗口標識當type值爲"start"/"move"時,保存當前操作窗口(或View控件)的標識; 當type值爲"end"時保存滑動操作後顯示窗口(或View控件)的標識(即result值爲"true"則認爲關聯窗口顯示,result值爲false則認爲主窗口顯示)。
-
otherId
: _(String 類型 )_關聯窗口標識滑動操作關聯窗口(或View控件)的標識。
-
targetId
: _(String 類型 )_主窗口標識滑動操作主窗口(或View控件)的標識。
-
progress
: _(Number 類型 )_滑動進度滑動進度位置信息,取值範圍爲0-100,如20表示滑動了總距離的20%: 當type值爲"start"時progress值爲0; 當type值爲"end"時如果result爲true則progress值爲0,如果result爲false則progress值爲100; 當type值爲"move"時,保存當前滑動的進度信息(注:多次觸發move事件)。
WebviewDragOptions
窗口手勢操作參數
屬性:
-
callbackStep
: _(Number 類型 )_滑屏操作回調事件觸發步長用於設置滑屏回調事件觸發頻率,取值範圍爲1-100,值越小觸發頻率越高,值越大觸發頻率越小,默認值爲20。 如設置值爲20,則表示滑屏操作移動距離超過可移動範圍的20%則觸發一次回調事件,可通過回調函數參數(WebviewDragEvent)的progress屬性獲取。 注意:觸發頻率過大會影響效率,開發者需謹慎設置此值。
-
direction
: _(String 類型 )_設置的手勢類型可取值: 可取值: “rtl” - 從右向左滑動手勢; “left” - 向左滑動手勢,與rtl一致; “ltr” - 從左向右滑動手勢; “right” - 向右滑動手勢,與ltr一致。
-
moveMode
: _(String 類型 )_滑動手勢模式可取值: “followFinger” - 當前Webview窗口跟隨手指滑動; “silent” - 當前Webview窗口不跟隨手指滑動; “bounce” - 當前Webview窗口自動回彈(鬆手後窗口恢復到拖動前的位置),通常可通過設置此模式來實現Tab項無法繼續滑動切換自動回彈效果。
WebviewDragOtherViewOptions
手勢操作關聯對象參數
屬性:
-
view
: _(String 類型 )_手勢關聯對象可取值Webview窗口的id(String類型)、Webview窗口對象、原生View窗口對象(plus.nativeObj.View)。
-
moveMode
: _(String 類型 )_滑動模式可取值: “follow” - 同步跟隨主Webview窗口滑動; “silent” - 不跟隨主Webview窗口滑動。
WebviewDrawOptions
截屏繪製操作參數
屬性:
-
bit
: _(String 類型 )_截屏圖片的位深可取值: “RGB565” - RGB565彩色模式,一個像素佔兩個字節; “ARGB” - ARGB彩色模式,保存透明度信息。
-
check
: _(Boolean 類型 )_是否檢測截屏圖片是否爲空白可取值: true - 表示檢測到截屏到空白圖片時認爲操作失敗(觸發錯誤回調函數); false - 表示不檢測,即使爲空白圖片仍然返回成功。 默認值爲false。
-
clip
: _(plus.nativeObj 類型 )_設置截屏區域相對於Webview窗口的區域信息,默認值爲{top:‘0px’,left:‘0px’,width:‘100%’,height:‘100%’}。
-
checkKeyboard
: _(Boolean 類型 )_是否檢測當前是否彈出軟鍵盤可取值: true - 表示檢測到彈出軟鍵盤是認爲截屏操作失敗(觸發錯誤回調函數); false - 表示不檢測軟鍵盤狀態,直接截屏。 默認值爲false。
WebviewNavigationbarStyles
窗口導航欄控件樣式
說明:
導航欄控件固定高度爲44px,可通過Webview窗口對象的getNavigationbar方法獲取導航欄原生控件對象動態繪製內容。
屬性:
-
backButton
: _(WebviewBackButtonStyles 類型 )_導航控件的返回鍵樣式設置此屬性則在導航欄控件中左側顯示返回鍵,可配置返回鍵顏色。 設置此屬性值爲undefined或null則隱藏返回鍵。 默認不顯示返回鍵。
-
backgroundColor
: _(String 類型 )_導航欄控件的背景顏色顏色值格式爲"#RRGGBB",如"#FF0000"表示爲紅色背景,默認值爲"#1B1A1F"。
-
titleColor
: _(String 類型 )_導航欄控件的標題顏色顏色值格式爲"#RRGGBB",如"#FF0000"表示標題文字爲紅色,默認值爲"#FFFFFF"。
-
titleText
: _(String 類型 )_導航欄控件的標題內容在導航欄控件居中(水平和垂直)顯示,左右邊距爲88px,如果文本過長則尾部裁剪顯示。 當不設置titleText屬性或屬性值爲undefined/null時,使用當前Webview窗口加載頁面的標題,並自動同步更新頁面的標題。
-
titleSize
: _(String 類型 )_導航欄控件的標題字體大小字體大小單位爲像素,如"20px"表示字體大小爲20像素,默認值爲17像素。
-
splitLine
: _(WebviewSplitLineStyles 類型 )_導航欄控件底部分割線設置此屬性則在導航欄控件底部顯示分割線,可配置顏色值及高度。 設置此屬性值爲undefined或null則隱藏分割線。 默認不顯示底部分割線。
WebviewSplitLineStyles
窗口導航欄控件分割線樣式
說明:
顯示在導航欄控件底部。
屬性:
-
color
: _(String 類型 )_底部分割線顏色可取值: “#RRGGBB"格式字符串,如”#FF0000"表示繪製紅色分割線; “rgba(R,G,B,A)”,其中R/G/B分別代表紅色值/綠色值/藍色值,正整數類型,取值範圍爲0-255,A爲透明度,浮點數類型,取值範圍爲0-1(0爲全透明,1爲不透明),如"rgba(255,0,0,0.5)",表示紅色半透明。 默認值爲無色(白色全透明)。
-
height
: _(String 類型 )_底部分割線高度可取值:像素值,如"1px"表示1像素高;百分比,如"1%",相對於導航欄控件的高度。 默認值爲"1px"。
WebviewBackButtonStyles
窗口導航欄控件返回鍵樣式
說明:
顯示在導航欄控件右側,點擊後觸發"backButton"事件(與點擊物理返回鍵邏輯一致)。
屬性:
-
color
: _(String 類型 )_返回鍵顏色可取值: “#RRGGBB"格式字符串,如”#FF0000"表示繪製紅色返回鍵; “rgba(R,G,B,A)”,其中R/G/B分別代表紅色值/綠色值/藍色值,正整數類型,取值範圍爲0-255,A爲透明度,浮點數類型,取值範圍爲0-1(0爲全透明,1爲不透明),如"rgba(255,0,0,0.5)",表示紅色半透明。 默認值爲窗口導航欄控件標題顏色。
-
colorPressed
: _(String 類型 )_返回鍵按下狀態的顏色可取值: “#RRGGBB"格式字符串,如”#FF0000"表示繪製紅色返回鍵; “rgba(R,G,B,A)”,其中R/G/B分別代表紅色值/綠色值/藍色值,正整數類型,取值範圍爲0-255,A爲透明度,浮點數類型,取值範圍爲0-1(0爲全透明,1爲不透明),如"rgba(255,0,0,0.5)",表示紅色半透明。 默認值爲color屬性值自動調整透明度爲0.3。
WebviewEvent
Webview窗口事件
常量:
-
close
: _(String 類型 )_Webview窗口關閉事件通過WebviewObject對象的addEventListener方法添加事件監聽函數,當Webview窗口關閉時觸發此事件,回調函數類型爲EventCallback。
-
“dragBounce”: _(String 類型 )_Webview窗口回彈事件
通過WebviewObject對象的setBounce方法開啓回彈效果設置頂部下拉回彈changeoffset屬性後,當用戶向下拖拽窗口時觸發發此事件,回調函數類型爲BounceEventCallback。
-
slideBounce
: _(String 類型 )_Webview窗口回彈事件通過WebviewObject對象的setBounce方法開啓回彈效果設置左右側側滑slideoffset屬性後,當用戶向左右側拖拽窗口側滑時觸發發此事件,回調函數類型爲BounceEventCallback。
-
error
: _(String 類型 )_Webview窗口加載錯誤事件通過WebviewObject對象的addEventListener方法添加事件監聽函數,當Webview窗口加載錯誤時觸發此事件,回調函數類型爲EventCallback。
-
hide
: _(String 類型 )_Webview窗口隱藏事件通過WebviewObject對象的addEventListener方法添加事件監聽函數,當Webview窗口隱藏(窗口動畫完成後)時觸發此事件,回調函數類型爲EventCallback。
-
loading
: _(String 類型 )_Webview窗口頁面開始加載事件通過WebviewObject對象的addEventListener方法添加事件監聽函數,當Webview窗口開始加載新頁面時觸發此事件,回調函數類型爲EventCallback。
-
loaded
: _(String 類型 )_Webview窗口頁面加載完成事件通過WebviewObject對象的addEventListener方法添加事件監聽函數,當Webview窗口頁面加載完成時觸發此事件,回調函數類型爲EventCallback。
-
maskClick
: _(String 類型 )_Webview窗口顯示遮罩層時點擊事件通過WebviewObject對象的addEventListener方法添加事件監聽函數,當Webview窗口通過mask屬性設置顯示遮罩層並且點擊時觸發此事件,回調函數類型爲EventCallback。
-
“rendering”: _(String 類型 )_Webview窗口開始渲染事件
通過WebviewObject對象的addEventListener方法添加事件監聽函數,當Webview窗口開始渲染內容時觸發此事件,回調函數類型爲EventCallback。
-
rendered
: _(String 類型 )_Webview窗口渲染完成事件通過WebviewObject對象的addEventListener方法添加事件監聽函數,當Webview窗口渲染完成時觸發此事件,回調函數類型爲EventCallback。
-
show
: _(String 類型 )_Webview窗口顯示事件通過WebviewObject對象的addEventListener方法添加事件監聽函數,當Webview窗口顯示(窗口動畫完成後)時觸發此事件,回調函數類型爲EventCallback。
-
titleUpdate
: _(String 類型 )_Webview加載頁面標題更新事件通過WebviewObject對象的addEventListener方法添加事件監聽函數,當Webview窗口加載新頁面更新標題時觸發此事件,回調函數類型爲SuccessCallback。 注意:此事件會先於loaded事件觸發,通常在加載網絡頁面時通過此事件可更快獲取到頁面的標題。
-
touchstart
: _(String 類型 )_Webview窗口接收到觸屏事件通過WebviewObject對象的addEventListener方法添加事件監聽函數,當用戶操作按下到Webview窗口時觸發此事件,回調函數類型爲SuccessCallback。 注意:每按下屏幕觸發一次此事件。
-
popGesture
: _(String 類型 )_Webview窗口側滑返回事件通過WebviewObject對象的addEventListener方法添加事件監聽函數,當Webview窗口側滑返回時觸發此事件,回調函數類型爲PopGestureCallback。
-
progressChanged
: _(String 類型 )_Webview窗口加載進度變化事件通過WebviewObject對象的addEventListener方法添加事件監聽函數,當Webview窗口加載頁面進度變化時觸發此事件。 回調函數原型爲void PorgressCandedCallback(Event e),可通過e.progress獲取窗口加載進度,取值範圍爲0-100。
WebviewExtraOptions
JSON對象,原生窗口擴展參數
屬性:
-
acceleration
: _(String 類型 )_窗口動畫加速開啓窗口動畫加速功能可優化窗口動畫效果,提升動畫流程度,可避免部分設備上打開(關閉)窗口閃屏的問題。 可取值: “auto” - 自動優化窗口動畫; “none” - 關閉窗口動畫加速功能; “capture” - 使用截屏方式加速窗口動畫。 默認值爲"auto"。
-
capture
: _(Bitmap 類型 )_窗口動畫加速時使用的圖片當使用截屏方式加速窗口動畫時,可設置已經創建好的截屏圖片,此時不會進行實時截屏操作,加速窗口動畫響應時間,提升用戶體驗。 如果未指定截屏圖片,則實時截取當前Webview窗口對象的圖片進行動畫操作。 如果窗口未使用截屏方式加速動畫,則忽略此參數。
-
otherCapture
: _(Bitmap 類型 )_關聯窗口動畫使用的圖片當使用截屏方式加速窗口動畫時,可設置已經創建好的截屏圖片,此時不會進行實時截屏操作,加速關聯窗口動畫響應時間,提升用戶體驗。 如果未指定截屏圖片,則實時截取關聯Webview窗口對象的圖片進行動畫操作。 如果窗口未使用截屏方式加速動畫,則忽略此參數。
WebviewPosition
原生控件在窗口中顯示的位置
常量:
-
static
: _(String 類型 )_控件在頁面中正常定位,如果頁面存在滾動條則隨窗口內容滾動 -
absolute
: _(String 類型 )_控件在頁面中絕對定位,如果頁面存在滾動條不隨窗口內容滾動 -
dock
: _(String 類型 )_控件在頁面中停靠,停靠的位置通過dock屬性進行定義
WebviewRefreshStyles
Webview窗口下拉刷新樣式
屬性:
-
support
: _(Boolean 類型 )_是否開啓Webview窗口的下拉刷新功能true表示開啓窗口的下拉刷新功能; false表示關閉窗口的下拉刷新功能。
-
color
: _(String 類型 )_下拉刷新控件顏色顏色值格式爲"#RRGGBB",如"#FF0000"爲設置下拉屬性控件爲紅色,默認值爲"#2BD009"。 注意:僅"circle"樣式下拉刷新支持此屬性。
-
style
: _(String 類型 )_下拉刷新樣式用於定義下拉刷新風格樣式,可取值: “default” - 目前已實現的經典樣式; “circle” - 新增下拉圓圈樣式。 默認值爲"default"。
-
height
: _(String 類型 )_窗口的下拉刷新控件高度支持百分比,如"10%";像素值,如"50px"。
-
range
: _(String 類型 )_窗口可下拉拖拽的範圍支持百分比,如"10%";像素值,如"50px"。
-
offset
: _(String 類型 )_下拉刷新控件的起始位置僅對"circle"樣式下拉刷新控件有效,用於定義刷新控件下拉時的起始位置。 相對於Webview的頂部偏移量,支持百分比,如"10%";像素值,如"50px"。 默認值爲"0px"。
-
contentdown
: _(JSON 類型 )_在下拉可刷新狀態時顯示的內容支持以下屬性: caption:在下拉可刷新狀態時下拉刷新控件上顯示的標題內容。
-
contentover
: _(JSON 類型 )_在釋放可刷新狀態時顯示的內容支持以下屬性: caption:在釋放可刷新狀態時下拉刷新控件上顯示的標題內容。
-
contentrefresh
: _(JSON 類型 )_在正在刷新狀態時顯示的內容支持以下屬性: caption:在正在刷新狀態時下拉刷新控件上顯示的標題內容。
WebviewRenderedEventOptions
Webview窗口rendered事件參數
屬性:
-
type
: _(String 類型 )_判斷窗口渲染完成類型可取值: “top”-從頂部向下偏移22px橫線截屏檢測渲染是否完成; “bottom”-從底部向上偏移25px橫線檢測渲染是否完成; “center”-從中間橫線檢測渲染是否完成; “auto"爲全屏檢測(左、中、右三條豎線)。 默認值爲"auto”。
-
interval
: _(Number 類型 )_判斷窗口渲染完成間隔時間單位爲ms(毫秒),默認值爲150ms。
WebviewStatusbarStyles
JSON對象,Webview窗口的系統狀態欄區域樣式
說明:
僅在應用設置爲沉浸式狀態欄樣式下有效,非沉浸式狀態欄樣式下忽略此屬性。
屬性:
-
background
: _(String 類型 )_系統狀態欄區域背景顏色顏色值格式爲"#RRGGBB",如"#FF0000"表示爲紅色背景。 默認值爲應用manifest.json中plus->statusbar->background屬性配置的值,如果未配置此屬性值,則使用系統默認狀態欄的背景顏色。
WebviewStyles
JSON對象,Webview窗口對象的樣式
屬性:
-
cachemode
: _(String 類型 )_窗口的緩存模式可取值: “default” - 根據cache-control決定是否使用緩存數據,如果存在緩存並且沒有過期則使用本地緩存資源,否則從網絡獲取; “cacheElseNetwork” - 只要存在緩存(即使過期)數據則使用,否則從網絡獲取; “noCache” - 不使用緩存數據,全部從網絡獲取; “cacheOnly” - 僅使用緩存數據,不從網絡獲取(注:如果沒有緩存數據則會導致加載失敗)。 默認使用"default"。
-
background
: _(String 類型 )_窗口的背景顏色窗口空白區域的背景模式,設置background爲顏色值(參考CSS Color Names,可取值/十六進制值/rgb值/rgba值),窗口爲獨佔模式顯示(佔整個屏幕區域); 設置background爲“transparent”,則表示窗口背景透明,爲非獨佔模式。
-
blockNetworkImage
: _(Boolean 類型 )_是否阻塞網絡圖片的加載布爾類型,true表示阻塞,false表示不阻塞,默認值爲false。 阻塞後Webview窗口將不加載頁面中使用的所有網絡圖片,可通過Webview窗口對象的setBlockNetWorkImage()方法動態修改此狀態。
-
bottom
: _(String 類型 )_窗口垂直向上的偏移量支持百分比、像素值,默認值無值(根據top和height屬性值來自動計算)。 當同時設置了top和height值時,忽略此屬性值; 當未設置height值時,可通過top和bottom屬性值來確定窗口的高度。
-
bounce
: _(String 類型 )_窗口遇到邊框是否有反彈效果可取值:none表示沒有反彈效果;vertical表示垂直方向有反彈效果;horizontal表示水平方向有反彈效果;all表示垂直和水平方向都有反彈效果。
-
bounceBackground
: _(String 類型 )_窗口回彈效果區域的背景窗口回彈效果區域背景可支持顏色值或圖片: 顏色值格式爲"#RRGGBB",如"#FFFFFF"爲設置白色背景; 背景圖爲"url(%image path%)",如"url(./icon.png)"爲設置icon.png爲背景圖,圖片採用平鋪模式繪製。
-
decelerationRate: _(Number 類型 )_窗口內容停止滑動的減速度
當Webview加載的內容超過其高度時,可以拖拽滑動內容,decelerationRate屬性控制手指鬆開後頁面滑動的速度。 設置值越大手指鬆開後的滑動速度越快(滑動距離越長),其值域範圍爲0.0-1.0,默認值爲0.989。
-
dock
: _(WebviewDock 類型 )_窗口的停靠方式當Webview窗口添加到另外一個窗口中時,停靠方式纔會生效,採用停靠方式添加會導致原Webview窗口自動調整其大小避免其內容被子窗口蓋住。 可取值:“top”,控件停靠則頁面頂部;“bottom”,控件停靠在頁面底部;“right”,控件停靠在頁面右側;“left”,控件停靠在頁面左側。
-
errorPage
: _(String 類型 )_窗口加載錯誤時跳轉的頁面地址當Webview窗口無法加載指定的url地址時(如本地頁面不存在,或者無法訪問的網絡地址),此時會自動跳轉到指定的錯誤頁面地址(僅支持本地頁面地址)。 設置爲“none”則關閉跳轉到錯誤頁面功能,此時頁面顯示Webview默認的錯誤頁面內容。默認使用5+ Runtime內置的錯誤頁面。
-
geolocation
: _(Number 類型 )_攔截替換原生定位接口當Webview加載的內容超過其高度時,可以拖拽滑動內容,decelerationRate屬性控制手指鬆開後頁面滑動的速度。 設置值越大手指鬆開後的滑動速度越快(滑動距離越長),其值域範圍爲0.0-1.0,默認值爲0.989。
-
hardwareAccelerated
: _(Boolean 類型 )_窗口是否開啓硬件加速布爾類型,true表示開啓硬件加速,false表示不開啓硬件加速,默認情況5+ Runtime會根據設備實際支持情況自動選擇是否開啓硬件加速,可以通過plus.webview.defaultHardwareAccelerated()方法獲取默認Webview是否開啓硬件加速。 由於不同設備對硬件加速的支持情況存在差異,開啓硬件加速能加速HTML頁面的渲染,但也會消耗更多的系統資源,從而導致在部分設備上可能出現閃屏、發虛、分塊渲染等問題,因此在特定設備的特定頁面如果出現以上問題需要手動設置關閉硬件加速來避免。
-
height
: _(String 類型 )_窗口的高度支持百分比、像素值,默認爲100%。 當未設置height屬性值時,優先通過top和bottom屬性值來計算窗口的高度。
-
kernel
: _(String 類型 )_窗口使用的內核可取值: “WKWebview” - 在iOS8.0及以上系統使用WKWebview內核,低版本下仍然使用UIWebview內核; “UIWebview” - 在所有版本上都使用UIWebview內核。 默認值爲“UIWebview”。 使用UKWebview內核會有更好的性能,但在功能上有些限制,目前已知的問題有: 1. 不支持設置cookie,即plus.navigator.setCookie() API無法使用; 2. 本地的HTML頁面中的XHR不支持跨域訪問,需使用plus.net.XMLHttpRequest來替換; 3. 不支持使用WebSQL,需使用indexDB來替換; 4. 不支持js原生混淆功能,需使用前端js混淆來替換。
-
left
: _(String 類型 )_窗口水平向右的偏移量支持百分比、像素值,默認值爲0px。 未設置left屬性值時,優先通過right和width屬性值來計算窗口的left位置。
-
margin
: _(String 類型 )_窗口的邊距用於定位窗口的位置,支持auto,auto表示居中。若設置了left、right、top、bottom則對應的邊距值失效。
-
mask
: _(String 類型 )_窗口的遮罩用於設置Webview窗口的遮罩層樣式,遮罩層會覆蓋Webview中所有內容,包括子webview,並且截獲webview的所有觸屏事件,此時Webview窗口的點擊操作會觸發maskClick事件。 字符串類型,可取值: rgba格式字符串,定義純色遮罩層樣式,如"rgba(0,0,0,0.5)",表示黑色半透明; “none”,表示不使用遮罩層; 默認值爲"none",即無遮罩層。
-
navigationbar
: _(WebviewNavigationbarStyles 類型 )_定義窗口創建導航欄控件設置此屬性值則表明創建導航欄控件,並可通過其屬性值設置背景顏色、文本內容、文本顏色等。
-
opacity
: _(Number 類型 )_窗口的不透明度0爲全透明,1爲不透明,默認值爲1,即不透明。
-
popGesture
: _(String 類型 )_窗口的側滑返回功能可取值"none":無側滑返回功能;“close”:側滑返回關閉Webview窗口;“hide”:側滑返回隱藏webview窗口。
-
render
: _(String 類型 )_窗口渲染模式支持以下屬性值: “onscreen” - Webview窗口在屏幕區可見時渲染,不可見時不進行渲染,此時能減少內存使用量; “always” - Webview在任何時候都渲染,在內存較大的設備上使用,被遮擋的窗口在此中模式下顯示的時候會有更流暢的效果。 默認值爲"onscreen"。 僅Android平臺支持。
-
right
: _(String 類型 )_窗口水平向左的偏移量支持百分比、像素值,默認無值(根據left和width屬性值來自動計算)。 當設置了left和width值時,忽略此屬性值; 當未設置width值時,可通過left和bottom屬性值來確定窗口的寬度。
-
scalable
: _(Boolean 類型 )_窗口是否可縮放窗口設置爲可縮放(scalable:true)時,用戶可通過雙指操作放大或縮小頁面,此時html頁面可通過meta節點設置“name=“viewport” content=“user-scalable=no””來限制頁面不可縮放。 窗口設置爲不可縮放(scalable:false)時,用戶不可通過雙指操作放大或縮小頁面,即使頁面中的meta節點也無法開啓可縮放功能。 默認值爲false,即不可縮放。
-
scrollIndicator
: _(String 類型 )_窗口是否顯示滾動條用於控制窗口滾動條樣式,可取值: “all”:垂直和水平滾動條都顯示; “vertical”:僅顯示垂直滾動條; “horizontal”:僅顯示水平滾動條; “none”:垂直和水平滾動條都不顯示。 默認值爲"all",即垂直和水平滾動條都顯示。 注意:顯示滾動條的前提條件是窗口中的內容超過窗口顯示的寬或高。
-
scrollsToTop
: _(Boolean 類型 )_點擊設備的狀態欄時是否滾動返回至頂部true表示點擊設備的狀態欄可以滾動返回至頂部,false表示點擊設備的狀態欄不可以,默認值爲true。 此功能僅iOS平臺支持,在iPhone上有且只有一個Webview窗口的scrollsToTop屬性值爲true時才生效,所以在顯示和關閉Webview窗口時需動態更新所有Webview的scrollsToTop值,已確保此功能生效。
-
softinputMode
: _(String 類型 )_彈出系統軟鍵盤模式可選值:“adjustPan”- 彈出軟鍵盤時Webview窗口自動上移,以保證當前輸入框可見;“adjustResize”- 自動調整Webview窗口大小(屏幕區域減去軟鍵盤區域),同時自動滾動Webview保證輸入框可見。 默認值爲“adjustPan”。
-
statusbar
: _(WebviewStatusbarStyles 類型 )_窗口狀態欄樣式僅在應用設置爲沉浸式狀態欄樣式下有效,設置此屬性後將自動保留系統狀態欄區域不被Webview窗口占用(即Webview窗口非沉浸式樣式顯示)。
-
top
: _(String 類型 )_窗口垂直向下的偏移量支持百分比、像素值,默認值爲0px。 未設置top屬性值時,優先通過bottom和height屬性值來計算窗口的top位置。
-
transition
: _(WebviewTransition 類型 )_窗口定義窗口變換的動畫效果 -
transform
: _(WebviewTransform 類型 )_窗口定義窗口變形效果 -
position
: _(WebviewPosition 類型 )_Webview窗口的排版位置當Webview窗口添加到另外一個窗口中時,排版位置纔會生效,排版位置決定子窗口在父窗口中的定位方式。 可取值:“static”,控件在頁面中正常定位,如果頁面存在滾動條則隨窗口內容滾動;“absolute”,控件在頁面中絕對定位,如果頁面存在滾動條不隨窗口內容滾動;“dock”,控件在頁面中停靠,停靠的位置由dock屬性值決定。 默認值爲"absolute"。
-
videoFullscreen
: _(String 類型 )_視頻全屏播放時的顯示方向可取值: “auto”: 自動適配,如果當前頁面豎屏,則豎屏顯示;如果當前頁面橫盤顯示,則橫屏;如果當前頁面自動感應,則自動感應橫豎屏切換。 “portrait-primary”: 豎屏正方向; “portrait-secondary”: 豎屏反方向,屏幕正方向按順時針旋轉180°; “landscape-primary”: 橫屏正方向,屏幕正方向按順時針旋轉90°; “landscape-secondary”: 橫屏方向,屏幕正方向按順時針旋轉270°; “landscape”: 橫屏正方向或反方向,根據設備重力感應器自動調整; 默認值爲“auto”。
-
width
: _(String 類型 )_窗口的寬度支持百分比、像素值,默認爲100%。未設置width屬性值時,可同時設置left和right屬性值改變窗口的默認寬度。
-
zindex
: _(Number 類型 )_窗口的堆疊順序值擁有更高堆疊順序的窗口總是會處於堆疊順序較低的窗口的前面,擁有相同堆疊順序的窗口後調用show方法則在前面。
WebviewTransform
一組用於定義頁面或控件變形的屬性
WebviewTransition
一組用於定義頁面或控件轉換效果的屬性
屬性:
-
property
: _(String 類型 )_產生變換效果的屬性默認值爲"all",暫不支持其它值。
-
duration
: _(String 類型 )_變換持續的時間默認值爲0,即無動畫效果。
-
timingfunction
: _(String 類型 )_窗口變換效果可取值: “linear”:勻速變化,勻速動畫效果; “ease-in”:勻加速變化,逐漸變快的動畫效果; “ease-out”:勻減速變化,逐漸變慢的動畫效果; “ease-in-out”:先加速後減速變化,先變快後變慢的動畫效果。 默認值爲"ease-in-out"。
WebviewOverrideResourceOptions
攔截Webview窗口資源請求的參數
屬性:
-
match
: _(String 類型 )_區配需要攔截請求資源的URL地址支持正則表達式,默認值爲空字符串(即不攔截)。
-
redirect
: _(String 類型 )_攔截重定向的資源地址僅支持本地資源地址,如"_www"、"_doc"、"_downloads"、"_documents"等開頭的路徑。
-
mime
: _(String 類型 )_重定向的資源數據類型RFC2045/RFC2046/RFC2047/RFC2048/RFC2049規範中定義的數據類型。 如普通文本(text/plain)、PNG圖像(image/png)、GIF圖形(image/gif)、JPEG圖形(image/jpeg)。 如果未指定mime類型,則根據重定向資源路徑自動區配。
-
encoding
: _(String 類型 )_重定向的資源數據編碼如未設置,則使用默認值"UTF-8"。
-
header
: _(JSON 類型 )_設置重定向資源數據的http頭數據可設置標註http頭數據(如Content-type),也可設置自定義數據。 通常可通過此屬性來設置攔截資源的緩存策略(如Cache-control)。
WebviewOverrideUrlOptions
攔截Webview窗口URL請求的屬性
屬性:
-
effect
: _(String 類型 )_攔截URL請求生效時機可取值: “instant” - 表示立即生效,即調用overrideUrlLoading方法後立即生效; “touchstart” - 表示用戶操作Webview窗口(觸發touchstart事件)後生效,如果用戶沒有操作Webview窗口則不對URL請求操作進行攔截處理。 默認值爲"instant"。
-
mode
: _(String 類型 )_攔截模式可取值: "allow"表示滿足match屬性定義的條件時不攔截url繼續加載,不滿足match屬性定義的條件時攔截url跳轉並觸發callback回調; “reject"表示滿足match屬性定義的提交時攔截url跳轉並觸發callback回調,不滿足match屬性定義的條件時不攔截url繼續加載。 默認值爲"reject”。
-
match
: _(String 類型 )_區配是否需要處理的URL請求支持正則表達式,默認值爲對所有URL地址生效(相當於正則表達式“.*”)。 如果mode值爲"allow"則允許區配的URL請求跳轉,mode值爲"reject"則攔截區配的URL請求。
-
exclude
: _(String 類型 )_排除攔截處理請求類型不攔截處理指定類型的URL請求,直接使用系統默認處理邏輯。 可取值: "none"表示不排除任何URL請求(即攔截處理所有URL請求); “redirect"表示排除攔截處理301/302跳轉的請求(謹慎使用,非a標籤的href觸發的URL請求可能會誤判斷爲302跳轉)。 默認值爲"none”。
WebviewListenResourceOptions
監聽Webview窗口資源加載的屬性
屬性:
-
match
: _(String 類型 )_區配是否需要處理的URL資源支持正則表達式,默認值爲對所有URL資源請求生效(相當於正則表達式“.*”)。 如果Webview加載的資源區配條件,則觸發回調事件。
BounceEventCallback
Webview窗口回彈事件的回調函數
void onEvent( Event event ){
// Event handled code.
}
參數:
event
: ( Event ) 必選 Webview窗口回彈事件觸發時事件數據
Event對象包含以下屬性: status - 表示回彈位置狀態,設置頂部下拉回彈changeoffset屬性後可取值:"beforeChangeOffset"表示可繼續拖拽,此時鬆開拖拽窗口會回彈到其初始位置; "afterChangeOffset"表示回彈可停靠,此時鬆開拖拽窗口會回彈到停靠位置; "dragEndAfterChangeOffset"表示已進鬆開拖拽,並且窗口回彈到停靠位置。 設置左右側側滑slideoffset屬性後可取值:"beforeSlide"表示未側滑狀態;"afterSlide"表示已側滑狀態。 offset - 表示回彈方向,可取值:"left"表示左側滑動,"right"表示右側滑動,"top"表示上側下拉滑動。 target - 保存觸發回彈此事件的Webview窗口對象。
返回值:
void : 無
EventCallback
Webview窗口事件的回調函數
void onEvent(Event event){
// Event handled code.
}
參數:
event
: ( Event ) 必選 Webview窗口事件觸發時事件數據
Event對象包含以下屬性: target:保存觸發此事件的Webview窗口對象; progress:保存窗口頁面加載進度,僅"progressChanged"事件時有此屬性。
返回值:
void : 無
PopGestureCallback
Webview窗口側滑事件的回調函數
void onEvent( PopGestureEvent event ){
// Event handled code.
}
參數:
event
: ( PopGestureEvent ) 必選 Webview窗口事件觸發時事件數據
PopGestureEvent對象包含以下屬性: target:保存側滑操作的Webview窗口對象。 type:保存側滑事件類型,"start"表示開始側滑返回,用戶按下滑動時觸發; “end”表示結束側滑返回,用戶鬆手時觸發; “move"表示側滑返回動作結束,用戶移動側滑時觸發。 result:保存操作結果,僅在e.type爲end時有效,boolean類型, true表示側滑返回執行,false表示側滑返回取消;否則爲undefined。 progress:保存側滑位置,Number類型,可帶小數點,範圍爲0-100。
返回值:
void : 無
HistoryQueryCallback
歷史記錄查詢的回調函數
void onHistoryQuery( Event event ) {
// Event handled code.
var canBack = event.canBack;
var canForward = event.canForward;
}
參數:
event
: ( Event ) 必選 查詢Webview窗口歷史記錄操作事件數據
可通過event的canBack屬性獲取Webview窗口是否可後退,通過event的canForward屬性獲取Webview窗口是否可前進。
返回值:
void : 無
ListenResourceLoadingCallback
Webview窗口加載資源事件的回調函數
void onLoadingResource( Event event ) {
// Event handled code.
var url = event.url;
}
參數:
event
: ( Event ) 必選 Webview窗口加載資源事件數據
可通過event的url屬性獲取要加載的資源URL地址。
返回值:
void : 無
OverrideUrlLoadingCallback
Webview窗口攔截URL鏈接跳轉的回調函數
void onOverride( Event event ) {
// Event handled code.
var url = event.url;
}
參數:
event
: ( Event ) 必選 Webview窗口攔截URL跳轉事件數據
可通過event的url屬性獲取攔截的URL地址。
返回值:
void : 無
TitleUpdateCallback
Webview窗口加載頁面標題更新的回調函數
void onQuery( Event event ) {
// Event handled code.
}
參數:
event
: ( Event ) 必選 Webview窗口加載頁面標題更新事件數據
可通過event的title屬性獲取Webview窗口的標題。
返回值:
void : 無
WebviewAnimationCallback
Webview窗口組合動畫回調函數
void onAnimationFinished( Event event ) {
// Event handled code.
}
參數:
event
: ( Event ) 必選 Webview窗口動畫完成事件數據
可通過event的id屬性獲取對應Webview窗口的標識,如果操作的窗口未設置id,則返回空字符串; 可通過event的target屬性獲取對應Webview窗口對象。
返回值:
void : 無
WebviewDragCallback
Webview窗口滑屏操作事件回調函數
void onDrag( Event event ) {
// Event handled code.
}
說明:
在窗口開始滑動、滑動過程、滑動結束時觸發,其中滑動過程中會觸發多次,滑動過程中觸發次數由WebviewDragOptions對象的callbackStep決定。
參數:
event
: ( WebviewDragEvent ) 必選 Webview窗口滑動操作事件數據
返回值:
void : 無
SuccessCallback
Webview窗口操作成功回調函數
void onSuccess(){
// Success code.
}
說明:
Webview窗口業務操作成功後觸發回調函數。
參數:
無
返回值:
void : 無
ErrorCallback
Webview窗口操作失敗回調函數
void onError(error){
// Handle the error
var code = error.code; // 錯誤編碼
var message = error.message; // 錯誤描述信息
}
參數:
error
: ( Exception ) 可選 Webview窗口操作錯誤信息
可通過error.code(Number類型)獲取錯誤編碼; 可通過error.message(String類型)獲取錯誤描述信息。
返回值:
void : 無