public interface

IX5WebViewExtension

com.tencent.smtt.export.external.extension.interfaces.IX5WebViewExtension

Class Overview

X5 WebView 扩展类

Summary

Public Methods
abstract void active()
将webview设置未active状态
abstract void copyText()
将选择的内容拷贝剪切板
abstract void cutText(CharSequence text)
将选择的内容放到剪切板，如果选择的内容为可编辑的输入框此时会执行剪切操作
abstract void deactive()
将webview设置未deactive状态
abstract boolean drawPreReadBaseLayer(Canvas canvas, boolean ignoreTitleHeight)
绘制预读页面到canvas
abstract void enterSelectionMode(boolean isSelectAll)
进入选择复制模式，内核会根据当前点击位置自动选择附近的文本
abstract void focusAndPopupIM(String elementId)
将elementId对应的输入框获取焦点并弹出输入法
abstract int getCurrentHistoryItemIndex()
获取当前页面在历史记录中的序号
abstract String getFocusCandidateText()
获取当前焦点所在的输入框的内容
abstract int getScrollX()
Return the scrolled left position of this view.
abstract int getScrollY()
Return the scrolled top position of this view.
abstract String getSelectionText()
获取选择的文本内容
abstract IX5WebSettingsExtension getSettingsExtension()
获取IX5WebSettingsExtension
abstract IX5WebChromeClientExtension getWebChromeClientExtension()
获取设置的IX5WebChromeClientExtension
abstract IX5WebViewClientExtension getWebViewClientExtension()
获取设置的IX5WebViewClientExtension
abstract boolean inputNodeIsPasswordType()
当前输入框是否是密码框
abstract boolean inputNodeIsPhoneType()
当前点击元素是否是phone类型
abstract boolean isActive()
获取webview是否处于active状态
abstract boolean isHorizontalScrollBarEnabled()
水平滚动是否可用
abstract boolean isPreReadCanGoForward()
预读页面是否可以前进，在页面预读完成后该接口将返回true
abstract boolean isSelectionMode()
当前是否在选择模式
abstract boolean isVerticalScrollBarEnabled()
竖直滚动是否可用
abstract void leaveSelectionMode()
退出选择模式
abstract void loadDataWithBaseURLWithHeaders(String baseUrl, String data, String mimeType, String encoding, String historyUrl, Map<String, String> Headers)
加载data数据
abstract void loaddataWithHeaders(String data, String mimeType, String encoding, Map<String, String> Headers)
加载data数据
abstract void pasteText(CharSequence text)
将文本粘贴到输入框的光标位置或者选择的区域
abstract void pauseAudio()
暂停页面中正在播放的音频
abstract void playAudio()
恢复被暂停的音频播放
abstract void pruneMemoryCache()
触发内核进行内存回收
abstract void reloadCustomMetaData()
用于重新加载一次自定义Meta数据，用于前进，后退,多窗口切换的时候调用。 调用该接口后页面获取meta元素后将会再次回调onAllMetaDataFinished(IX5WebViewExtension, HashMap)接口
abstract void removeHistoryItem(int index)
删除历史记录中对应序号的页面
abstract void replaceAllInputText(String replace)
将输入框中选择的内容替换为新内容
abstract boolean requestFocusForInputNode(int direction)
使对应位置的输入框获取焦点 输入框在获取焦点后会回调 onSetButtonStatus(boolean, boolean)接口通知前一个和后一个输入框是否可获取焦点
abstract void scrollBy(int dx, int dy)
将webview滚动对应高度，该接口调用将会触发onScrollChanged以及页面重绘
abstract void scrollTo(int x, int y)
让webview滚动到对应位置，该接口调用将会触发onScrollChanged以及页面重绘
abstract int seletionStatus()
获取当前选择状态
abstract void sendRememberMsg(String schemePlusHost, String username, String password, String nameElement, String passwordElement)
保存密码,当setSavePassword(boolean)设置为true时， 如果需要保存密码内核会回调onSavePassword(ValueCallback, String, String, String, String, String, boolean)进行密码保存， 当app处理完后调用该接口进行密码保存处理， 如果app在onSavePassword(ValueCallback, String, String, String, String, String, boolean)处理时不返回true默认内核会弹出提示让用户进行密码保存
abstract void setAudioAutoPlayNotify(boolean enable)
音频自动播放通知 如果设置为true，当有自动播放的音频时会回调 notifyAutoAudioPlay(String, JsResult)
abstract void setHorizontalScrollBarEnabled(boolean enabled)
水平滚动条控制
abstract void setLongPressTextExtensionMenu(int longPressTextExtensionMenu)
设置长按菜单显示的菜单类型
abstract void setScrollBarDefaultDelayBeforeFade(int delay)
滚动条多久开始执行渐隐消失
abstract void setScrollBarFadeDuration(int duration)
滚动条渐隐消失的时间长度
abstract void setScrollListener(IX5ScrollListener listener)
设置页面滚动监听器
abstract void setSelectListener(ISelectionInterface istener)
设置选择状态监听器
abstract void setVerticalScrollBarEnabled(boolean enabled)
竖直滚动条控制
abstract void setVerticalTrackDrawable(Drawable verticalTrackDrawable)
竖直快速滑块图片设置
abstract void setWebBackForwardListClient(IX5WebBackForwardListClient client)
设置页面前进后退监听器
abstract void setWebChromeClientExtension(IX5WebChromeClientExtension client)
设置IX5WebChromeClientExtension
abstract void setWebViewClientExtension(IX5WebViewClientExtension client)
设置IX5WebViewClientExtension
abstract void showImage(int viewX, int viewY)
无图模式下显示对应位置的图片
abstract void snapshotVisible(Canvas canvas, boolean drawCursor, boolean drawScrollbars, boolean drawTitleBar, boolean drawWithBuffer)
截取视口内容
abstract void snapshotVisible(Bitmap bitmap, boolean drawCursor, boolean drawScrollbars, boolean drawTitleBar, boolean drawWithBuffer, float scaleX, float scaleY, Runnable callback)
截取视口内容
abstract void snapshotWholePage(Canvas canvas, boolean drawScrollbars, boolean drawTitleBar)
截取整个页面内容
abstract void snapshotWholePage(Canvas canvas, boolean drawScrollbars, boolean drawTitleBar, Runnable callback)
截取整个页面内容

Public Methods

public abstract void active ()

将webview设置未active状态

public abstract void copyText ()

将选择的内容拷贝剪切板

public abstract void cutText (CharSequence text)

将选择的内容放到剪切板，如果选择的内容为可编辑的输入框此时会执行剪切操作

Parameters
text 文本内容(该参数未被使用，可不设置)

public abstract void deactive ()

将webview设置未deactive状态

public abstract boolean drawPreReadBaseLayer (Canvas canvas, boolean ignoreTitleHeight)

绘制预读页面到canvas

Parameters
canvas 绘制的canvas
ignoreTitleHeight 忽略地址栏高度（保留暂未使用）

public abstract void enterSelectionMode (boolean isSelectAll)

进入选择复制模式，内核会根据当前点击位置自动选择附近的文本

Parameters
isSelectAll 是否是全选模式

public abstract void focusAndPopupIM (String elementId)

将elementId对应的输入框获取焦点并弹出输入法

Parameters
elementId 输入框Id

public abstract int getCurrentHistoryItemIndex ()

获取当前页面在历史记录中的序号

Returns
  • 页面在历史记录中的序号

public abstract String getFocusCandidateText ()

获取当前焦点所在的输入框的内容

Returns
  • 无焦点或焦点所在元素非输入框时返回null

public abstract int getScrollX ()

Return the scrolled left position of this view. This is the left edge of the displayed part of your view. You do not need to draw any pixels farther left, since those are outside of the frame of your view on screen.

Returns
  • The left edge of the displayed part of your view, in pixels.

public abstract int getScrollY ()

Return the scrolled top position of this view. This is the top edge of the displayed part of your view. You do not need to draw any pixels above it, since those are outside of the frame of your view on screen.

Returns
  • The top edge of the displayed part of your view, in pixels.

public abstract String getSelectionText ()

获取选择的文本内容

Returns
  • 选择的文本内容

public abstract IX5WebSettingsExtension getSettingsExtension ()

获取IX5WebSettingsExtension

Returns
  • 返回IX5WebSettingsExtension

public abstract IX5WebChromeClientExtension getWebChromeClientExtension ()

获取设置的IX5WebChromeClientExtension

Returns
  • 返回设置的IX5WebChromeClientExtension

public abstract IX5WebViewClientExtension getWebViewClientExtension ()

获取设置的IX5WebViewClientExtension

Returns
  • 返回设置的IX5WebViewClientExtension

public abstract boolean inputNodeIsPasswordType ()

当前输入框是否是密码框

Returns
  • true 是密码框，false 非密码框

public abstract boolean inputNodeIsPhoneType ()

当前点击元素是否是phone类型

Returns
  • true 是phone类型，false 非phone类型

public abstract boolean isActive ()

获取webview是否处于active状态

Returns
  • true 当前webview处于active状态

public abstract boolean isHorizontalScrollBarEnabled ()

水平滚动是否可用

Returns
  • true 可用，false 不可用

public abstract boolean isPreReadCanGoForward ()

预读页面是否可以前进，在页面预读完成后该接口将返回true

Returns
  • true: 预读页面是否可以前进

public abstract boolean isSelectionMode ()

当前是否在选择模式

Returns
  • true 在选择模式，false 不在选择模式

public abstract boolean isVerticalScrollBarEnabled ()

竖直滚动是否可用

Returns
  • true 可用，false 不可用

public abstract void leaveSelectionMode ()

退出选择模式

public abstract void loadDataWithBaseURLWithHeaders (String baseUrl, String data, String mimeType, String encoding, String historyUrl, Map<String, String> Headers)

加载data数据

Parameters
baseUrl 页面的baseUrl
data data数据
mimeType 数据类型
encoding 数据编码
historyUrl historyUrl
Headers 头信息

public abstract void loaddataWithHeaders (String data, String mimeType, String encoding, Map<String, String> Headers)

加载data数据

Parameters
data data数据
mimeType 数据类型
encoding 数据编码
Headers 头信息

public abstract void pasteText (CharSequence text)

将文本粘贴到输入框的光标位置或者选择的区域

Parameters
text 要粘贴的文本

public abstract void pauseAudio ()

暂停页面中正在播放的音频

public abstract void playAudio ()

恢复被暂停的音频播放

public abstract void pruneMemoryCache ()

触发内核进行内存回收

public abstract void reloadCustomMetaData ()

用于重新加载一次自定义Meta数据，用于前进，后退,多窗口切换的时候调用。 调用该接口后页面获取meta元素后将会再次回调onAllMetaDataFinished(IX5WebViewExtension, HashMap)接口

public abstract void removeHistoryItem (int index)

删除历史记录中对应序号的页面

Parameters
index 历史记录中对应序号

public abstract void replaceAllInputText (String replace)

将输入框中选择的内容替换为新内容

Parameters
replace 要替换内容的新文本

public abstract boolean requestFocusForInputNode (int direction)

使对应位置的输入框获取焦点 输入框在获取焦点后会回调 onSetButtonStatus(boolean, boolean)接口通知前一个和后一个输入框是否可获取焦点

Parameters
direction 一般情况下为-1（上一个输入框），1（下一个输入框）

public abstract void scrollBy (int dx, int dy)

将webview滚动对应高度，该接口调用将会触发onScrollChanged以及页面重绘

Parameters
dx x方向的滚动距离
dy y方向的滚动距离

public abstract void scrollTo (int x, int y)

让webview滚动到对应位置，该接口调用将会触发onScrollChanged以及页面重绘

Parameters
x x坐标
y y坐标

public abstract int seletionStatus ()

获取当前选择状态

Returns

public abstract void sendRememberMsg (String schemePlusHost, String username, String password, String nameElement, String passwordElement)

保存密码,当setSavePassword(boolean)设置为true时， 如果需要保存密码内核会回调onSavePassword(ValueCallback, String, String, String, String, String, boolean)进行密码保存， 当app处理完后调用该接口进行密码保存处理， 如果app在onSavePassword(ValueCallback, String, String, String, String, String, boolean)处理时不返回true默认内核会弹出提示让用户进行密码保存

Parameters
schemePlusHost 域名
username 用户名
password 密码
nameElement 用户名元素id
passwordElement 密码元素id

public abstract void setAudioAutoPlayNotify (boolean enable)

音频自动播放通知 如果设置为true，当有自动播放的音频时会回调 notifyAutoAudioPlay(String, JsResult)

Parameters
enable true 开启通知，false 不开启通知，默认不开启

public abstract void setHorizontalScrollBarEnabled (boolean enabled)

水平滚动条控制

Parameters
enabled true 启用水平滚动条，false 禁用水平滚动条

public abstract void setLongPressTextExtensionMenu (int longPressTextExtensionMenu)

设置长按菜单显示的菜单类型

Parameters
longPressTextExtensionMenu 长按菜单类型, 具体可以参考WebView中的如下菜单标识

public static final int USER_SETTINGS_SEARCH = 1; 搜索

public static final int USER_SETTINGS_TRANSLATE = 1 << 3; 翻译

public static final int USER_SETTINGS_COPY = 1 << 4; 复制

public static final int USER_SETTINGS_OPEN_IN_BROWSER = 1 << 5; 浏览器打开

public abstract void setScrollBarDefaultDelayBeforeFade (int delay)

滚动条多久开始执行渐隐消失

Parameters
delay 时间长度

public abstract void setScrollBarFadeDuration (int duration)

滚动条渐隐消失的时间长度

Parameters
duration 滚动条渐隐消失的时间长度

public abstract void setScrollListener (IX5ScrollListener listener)

设置页面滚动监听器

Parameters
listener 监听器

public abstract void setSelectListener (ISelectionInterface istener)

设置选择状态监听器

Parameters
istener 监听器

public abstract void setVerticalScrollBarEnabled (boolean enabled)

竖直滚动条控制

Parameters
enabled true 启用竖直滚动条，false 禁用竖直滚动条

public abstract void setVerticalTrackDrawable (Drawable verticalTrackDrawable)

竖直快速滑块图片设置

Parameters
verticalTrackDrawable 竖直滑块图片

public abstract void setWebBackForwardListClient (IX5WebBackForwardListClient client)

设置页面前进后退监听器

Parameters
client 前进后退监听器

public abstract void setWebChromeClientExtension (IX5WebChromeClientExtension client)

设置IX5WebChromeClientExtension

Parameters
client 要设置的IX5WebChromeClientExtension

public abstract void setWebViewClientExtension (IX5WebViewClientExtension client)

设置IX5WebViewClientExtension

Parameters
client 要设置的IX5WebViewClientExtension

public abstract void showImage (int viewX, int viewY)

无图模式下显示对应位置的图片

Parameters
viewX x坐标
viewY y坐标

public abstract void snapshotVisible (Canvas canvas, boolean drawCursor, boolean drawScrollbars, boolean drawTitleBar, boolean drawWithBuffer)

截取视口内容

Parameters
canvas 要绘制内容的canvas
drawCursor 是否绘制光标(保留暂未使用)
drawScrollbars 是否绘制滚动条(保留暂未使用)
drawTitleBar 是否绘制地址栏(保留暂未使用)
drawWithBuffer drawWithBuffer(保留暂未使用)

public abstract void snapshotVisible (Bitmap bitmap, boolean drawCursor, boolean drawScrollbars, boolean drawTitleBar, boolean drawWithBuffer, float scaleX, float scaleY, Runnable callback)

截取视口内容

Parameters
bitmap 要绘制内容的bitmap
drawCursor 是否绘制光标(保留暂未使用)
drawScrollbars 是否绘制滚动条(保留暂未使用)
drawTitleBar 是否绘制地址栏(保留暂未使用)
drawWithBuffer 该参数暂未使用(保留暂未使用)
scaleX x方向上的缩放比例
scaleY y方向上的缩放比例
callback 完成绘制回调

public abstract void snapshotWholePage (Canvas canvas, boolean drawScrollbars, boolean drawTitleBar)

截取整个页面内容

Parameters
canvas 要绘制内容的canvas
drawScrollbars 是否绘制光标(保留暂未使用)
drawTitleBar 是否绘制地址栏(保留暂未使用)

public abstract void snapshotWholePage (Canvas canvas, boolean drawScrollbars, boolean drawTitleBar, Runnable callback)

截取整个页面内容

Parameters
canvas 要绘制内容的canvas
drawScrollbars 是否绘制光标(保留暂未使用)
drawTitleBar 是否绘制地址栏(保留暂未使用)
callback 完成绘制回调