Frame (jvppeteer 3.4.0 API)

java.lang.Object
- com.ruiyun.jvppeteer.api.core.EventEmitter<FrameEvents>
- - com.ruiyun.jvppeteer.api.core.Frame

直接已知子类:: BidiFrame, CdpFrame

public abstract class Frame
extends EventEmitter<FrameEvents>

字段概要

字段
限定符和类型	字段和说明
`protected Accessibility`	`accessibility`
`protected ElementHandle`	`document`
`boolean`	`hasStartedLoading`
`protected String`	`id`
`protected String`	`name`
`protected String`	`parentId`

从类继承的字段 com.ruiyun.jvppeteer.api.core.EventEmitter
LOGGER

构造器概要

构造器
构造器和说明

Frame()

构造器
构造器和说明
`Frame()`

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`ElementHandle`	`$(String selector)` 查询框架中与给定选择器匹配的第一个元素。
`List<ElementHandle>`	`$$(String selector)` 查询框架中与给定选择器匹配的所有元素。
`Object`	`$$eval(String selector, String pptrFunction, List<Object> args)` 对与框架中给定选择器匹配的元素数组运行给定 JS 函数。
`Object`	`$eval(String selector, String pptrFunction, List<Object> args)` 对与框架中给定选择器匹配的第一个元素运行给定 JS 函数。
`abstract Accessibility`	`accessibility()`
`ElementHandle`	`addScriptTag(FrameAddScriptTagOptions options)` 在当前文档中添加一个脚本标签。
`ElementHandle`	`addStyleTag(FrameAddStyleTagOptions options)` 向文档头部添加样式标签该方法用于在HTML文档的头部内插入一个新的样式标签。
`abstract <FrameType extends Frame> List<FrameType>`	`childFrames()` 子框架数组。
`void`	`clearDocumentHandle()` 用来清理已经被释放的 Document 句柄
`void`	`click(String selector, ClickOptions options)` 单击找到的第一个与 selector 匹配的元素。
`abstract CDPSession`	`client()` 当前框架的客户端
`String`	`content()` 框架的完整 HTML 内容，包括 DOCTYPE。
`abstract boolean`	`detached()` Is`true` if the frame has been detached.
`boolean`	`disposed()`
`ElementHandle`	`document()` 返回当前框架的 Document 对象
`Object`	`evaluate(String pptrFunction)` 行为与 Page.evaluate() 相同，只是它在此框架的上下文中运行。
`Object`	`evaluate(String pptrFunction, EvaluateType type, List<Object> args)` 行为与 Page.evaluate() 相同，只是它在此框架的上下文中运行。
`Object`	`evaluate(String pptrFunction, List<Object> args)` 行为与 Page.evaluate() 相同，只是它在此框架的上下文中运行。
`JSHandle`	`evaluateHandle(String pptrFunction, List<Object> args)` 行为与 Page.evaluateHandle() 相同，只是它在此框架的上下文中运行。
`static List<JSHandle>`	`fastTransposeIteratorHandle(JSHandle iterator, int size)`
`void`	`focus(String selector)` 聚焦与 selector 匹配的第一个元素。
`ElementHandle`	`frameElement()` 返回与此框架相关联的元素
`abstract Response`	`goTo(String url, GoToOptions options)` 将框架或页面导航到给定的 url。
`void`	`hover(String selector)` 将指针悬停在与 selector 匹配的第一个元素的中心上
`String`	`id()`
`abstract Realm`	`isolatedRealm()`
`abstract Realm`	`mainRealm()`
`String`	`name()` 框架的名字
`abstract Page`	`page()` 与框架关联的页面。
`abstract Frame`	`parentFrame()` 父框架（如果有）。
`String`	`parentId()`
`List<String>`	`select(String selector, List<String> values)` 在第一个 select 元素上选择与 selector 匹配的一组值。
`abstract void`	`setContent(String html, WaitForOptions options)` 设置框架的内容
`void`	`setFrameContent(String content)` 设置框架的内容
`void`	`tap(String selector)` 点击与 selector 匹配的第一个元素。
`String`	`title()` 框架的标题。
`static List<JSHandle>`	`transposeIterableHandle(JSHandle list)`
`static List<JSHandle>`	`transposeIteratorHandle(JSHandle iterator)`
`void`	`type(String selector, String text, long delay)` 为文本中的每个字符发送 keydown、keypress/input 和 keyup 事件。
`abstract String`	`url()` 框架的 url
`abstract DeviceRequestPrompt`	`waitForDevicePrompt(int timeout)` 此方法通常与从 api（如 WebBluetooth）触发 devicerequest 的操作结合使用。
`JSHandle`	`waitForFunction(String pptrFunction, WaitForSelectorOptions options, EvaluateType type, Object... args)` 等待 pptrFunction 执行完成
`abstract Response`	`waitForNavigation(WaitForOptions options, Runnable navigateRunner)` 等到导航完成
`ElementHandle`	`waitForSelector(String selector, WaitForSelectorOptions options)` 等待直到指定的选择器匹配的元素满足某些条件（可见、隐藏或存在）.

从类继承的方法 com.ruiyun.jvppeteer.api.core.EventEmitter
disposeSymbol, emit, listenerCount, off, on, once, removeAllListeners, removeListener

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

- 字段详细资料
  - id
```
protected volatile String id
```
  - parentId
```
protected volatile String parentId
```
  - accessibility
```
protected Accessibility accessibility
```
  - hasStartedLoading
```
public volatile boolean hasStartedLoading
```
  - name
```
protected volatile String name
```
  - document
```
protected ElementHandle document
```
- 构造器详细资料
  - Frame
```
public Frame()
```
- 方法详细资料
  - page
```
public abstract Page page()
```
    与框架关联的页面。
    
    返回:
    
    与框架关联的页面。
  - goTo
```
public abstract Response goTo(String url,
                              GoToOptions options)
```
    将框架或页面导航到给定的 url。
    
    参数:
    
    url - 将框架导航到的 URL。URL 应包含方案，例如 https://
    
    options - 可选的配置等待行为的选项。
    
    返回:
    
    waitForResult = true 返回页面导航的响应，如果存在多个重定向，导航将使用最后一个重定向的响应进行解析。否则返回 null
  - waitForNavigation
```
public abstract Response waitForNavigation(WaitForOptions options,
                                           Runnable navigateRunner)
```
    等到导航完成
    
    参数:
    
    options - 可选的等待导航选项
    
    navigateRunner - 一个需要的执行的步骤
    
    返回:
    
    导航的响应
  - client
```
public abstract CDPSession client()
```
    当前框架的客户端
    
    返回:
    
    客户端
  - accessibility
```
public abstract Accessibility accessibility()
```
  - mainRealm
```
public abstract Realm mainRealm()
```
  - isolatedRealm
```
public abstract Realm isolatedRealm()
```
  - document
```
public ElementHandle document()
                       throws com.fasterxml.jackson.core.JsonProcessingException
```
    返回当前框架的 Document 对象
    
    返回:
    
    当前框架的 Document 对象
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - 执行 JS 函数异常
  - clearDocumentHandle
```
public void clearDocumentHandle()
```
    用来清理已经被释放的 Document 句柄
  - frameElement
```
public ElementHandle frameElement()
                           throws com.fasterxml.jackson.core.JsonProcessingException
```
    返回与此框架相关联的元素
    
    返回:
    
    与此框架相关联的元素
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - JS 函数执行异常
  - evaluateHandle
```
public JSHandle evaluateHandle(String pptrFunction,
                               List<Object> args)
                        throws com.fasterxml.jackson.core.JsonProcessingException
```
    行为与 Page.evaluateHandle() 相同，只是它在此框架的上下文中运行。
    详情请参阅 Page.evaluateHandle()。
    
    参数:
    
    pptrFunction - 给定的 JS 函数
    
    args - JS 函数的参数
    
    返回:
    
    pptrFunction 执行的结果
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - JS 函数执行异常
  - evaluate
```
public Object evaluate(String pptrFunction,
                       EvaluateType type,
                       List<Object> args)
                throws com.fasterxml.jackson.core.JsonProcessingException
```
    行为与 Page.evaluate() 相同，只是它在此框架的上下文中运行。
    详情请参阅 Page.evaluate()。
    
    参数:
    
    pptrFunction - 给定的 JS 函数
    
    type - 指定了 pptrFunction 的类型
    
    args - pptrFunction 的参数
    
    返回:
    
    pptrFunction 的执行结果
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - JS 函数执行异常
  - evaluate
```
public Object evaluate(String pptrFunction)
                throws com.fasterxml.jackson.core.JsonProcessingException
```
    行为与 Page.evaluate() 相同，只是它在此框架的上下文中运行。
    详情请参阅 Page.evaluate()。
    
    参数:
    
    pptrFunction - 给定的 JS 函数
    
    返回:
    
    pptrFunction 的执行结果
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - JS 函数执行异常
  - evaluate
```
public Object evaluate(String pptrFunction,
                       List<Object> args)
                throws com.fasterxml.jackson.core.JsonProcessingException
```
    行为与 Page.evaluate() 相同，只是它在此框架的上下文中运行。
    详情请参阅 Page.evaluate()。
    
    参数:
    
    pptrFunction - 给定的 JS 函数
    
    args - pptrFunction 的参数
    
    返回:
    
    pptrFunction 的执行结果
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - JS 函数执行异常
  - $
```
public ElementHandle $(String selector)
                throws com.fasterxml.jackson.core.JsonProcessingException
```
    查询框架中与给定选择器匹配的第一个元素。
    
    参数:
    
    selector - 选择器
    
    返回:
    
    与给定选择器匹配的第一个元素
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - JS 函数执行异常
  - $$
```
public List<ElementHandle> $$(String selector)
                       throws com.fasterxml.jackson.core.JsonProcessingException
```
    查询框架中与给定选择器匹配的所有元素。
    
    参数:
    
    selector - 选择器
    
    返回:
    
    与给定选择器匹配的所有元素
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - JS 函数执行异常
  - $eval
```
public Object $eval(String selector,
                    String pptrFunction,
                    List<Object> args)
             throws com.fasterxml.jackson.core.JsonProcessingException
```
    对与框架中给定选择器匹配的第一个元素运行给定 JS 函数。
    如果给定的函数返回一个 Promise，那么此方法将等待直到 Promise 解析。
    
    参数:
    
    selector - 选择器
    
    pptrFunction - 给定 JS 函数
    
    args - pptrFunction 的参数
    
    返回:
    
    pptrFunction 运行的结果
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - JS 函数执行异常
  - $$eval
```
public Object $$eval(String selector,
                     String pptrFunction,
                     List<Object> args)
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    对与框架中给定选择器匹配的元素数组运行给定 JS 函数。
    如果给定的函数返回一个 Promise，那么此方法将等待直到 Promise 解析。
    
    参数:
    
    selector - 选择器
    
    pptrFunction - 给定 JS 函数
    
    args - pptrFunction 的参数
    
    返回:
    
    pptrFunction 运行的结果
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - JS 函数执行异常
  - waitForSelector
```
public ElementHandle waitForSelector(String selector,
                                     WaitForSelectorOptions options)
                              throws com.fasterxml.jackson.core.JsonProcessingException
```
    等待直到指定的选择器匹配的元素满足某些条件（可见、隐藏或存在）.
    
    参数:
    
    selector - 选择器字符串，用于选择目标元素.
    
    options - 包含等待条件的选项，如元素可见或隐藏.
    
    返回:
    
    返回匹配选择器的目标元素的句柄.
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException
  - waitForFunction
```
public JSHandle waitForFunction(String pptrFunction,
                                WaitForSelectorOptions options,
                                EvaluateType type,
                                Object... args)
                         throws ExecutionException,
                                InterruptedException,
                                TimeoutException
```
    等待 pptrFunction 执行完成
    
    参数:
    
    pptrFunction - 等待的函数
    
    options - 可选配置
    
    args - pptrFunction 的参数
    
    返回:
    
    pptrFunction 执行的结果
    
    抛出:
    
    ExecutionException
    
    InterruptedException
    
    TimeoutException
  - content
```
public String content()
               throws com.fasterxml.jackson.core.JsonProcessingException,
                      EvaluateException
```
    框架的完整 HTML 内容，包括 DOCTYPE。
    
    返回:
    
    框架的完整 HTML 内容，包括 DOCTYPE。
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - JS 函数执行异常
  - setContent
```
public abstract void setContent(String html,
                                WaitForOptions options)
                         throws com.fasterxml.jackson.core.JsonProcessingException,
                                InterruptedException,
                                ExecutionException
```
    设置框架的内容
    
    参数:
    
    html - 要分配给页面的 HTML 标记。
    
    options - （可选的）用于配置超时前多长时间以及何时认为内容设置成功的选项。
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - JS 函数执行异常
    
    InterruptedException
    
    ExecutionException
  - setFrameContent
```
public void setFrameContent(String content)
                     throws com.fasterxml.jackson.core.JsonProcessingException
```
    设置框架的内容
    
    参数:
    
    content - 要分配给页面的 HTML 标记。
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - JS 函数执行异常
  - name
```
public String name()
```
    框架的名字
    
    返回:
    
    框架的名字
  - url
```
public abstract String url()
```
    框架的 url
    
    返回:
    
    框架的 url
  - parentFrame
```
public abstract Frame parentFrame()
```
    父框架（如果有）。分离框架和主框架返回 null。
    
    返回:
    
    父框架
  - childFrames
```
public abstract <FrameType extends Frame> List<FrameType> childFrames()
```
    子框架数组。
    
    返回:
    
    子框架数组。
  - detached
```
public abstract boolean detached()
```
    Is`true` if the frame has been detached. Otherwise, `false`.
    
    返回:
    
    true or false
  - disposed
```
public boolean disposed()
```
  - addScriptTag
```
public ElementHandle addScriptTag(FrameAddScriptTagOptions options)
                           throws IOException,
                                  EvaluateException
```
    在当前文档中添加一个脚本标签。
    此方法使用提供的选项创建一个脚本标签，可以是通过URL、文件路径或直接通过内容来加载脚本。它支持异步执行，并处理脚本加载的生命周期事件，如'load'和'error'。
    
    参数:
    
    options - 脚本标签的选项，包括URL、路径或内容等。
    
    返回:
    
    返回新创建的脚本元素的句柄。
    
    抛出:
    
    IOException - 当读取脚本文件时发生IO错误。
    
    EvaluateException - 当脚本执行失败时抛出。
  - addStyleTag
```
public ElementHandle addStyleTag(FrameAddStyleTagOptions options)
                          throws IOException,
                                 EvaluateException
```
    向文档头部添加样式标签
    该方法用于在HTML文档的头部内插入一个新的样式标签。它支持通过URL链接到外部样式表，或者直接包含样式内容。当提供样式文件的路径时，将读取该文件的内容并作为内联样式添加。
    
    参数:
    
    options - 样式标签的配置选项，包括url、path或content属性
    
    返回:
    
    插入的样式元素的句柄
    
    抛出:
    
    IOException - 当读取样式文件时可能抛出的IO异常
    
    EvaluateException - 当在页面上执行JavaScript时发生错误时抛出的异常
  - click
```
public void click(String selector,
                  ClickOptions options)
           throws com.fasterxml.jackson.core.JsonProcessingException,
                  EvaluateException
```
    单击找到的第一个与 selector 匹配的元素。
    
    参数:
    
    selector - 选择器
    
    options - （可选的）配置
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - JS 函数执行异常
  - focus
```
public void focus(String selector)
           throws com.fasterxml.jackson.core.JsonProcessingException,
                  EvaluateException
```
    聚焦与 selector 匹配的第一个元素。
    
    参数:
    
    selector - 选择器
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - JS 函数执行异常
  - hover
```
public void hover(String selector)
           throws com.fasterxml.jackson.core.JsonProcessingException,
                  EvaluateException
```
    将指针悬停在与 selector 匹配的第一个元素的中心上
    
    参数:
    
    selector - 选择器
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化异常
    
    EvaluateException - JS 函数执行异常
  - select
```
public List<String> select(String selector,
                           List<String> values)
                    throws com.fasterxml.jackson.core.JsonProcessingException,
                           EvaluateException
```
    在第一个 select 元素上选择与 selector 匹配的一组值。
    
    参数:
    
    selector - 选择器
    
    values - 要选择的值的数组。如果

类 Frame

字段概要

从类继承的字段 com.ruiyun.jvppeteer.api.core.EventEmitter

构造器概要

方法概要

从类继承的方法 com.ruiyun.jvppeteer.api.core.EventEmitter

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

字段详细资料

id

parentId

accessibility

hasStartedLoading

name

document

构造器详细资料

Frame

方法详细资料

page

goTo

waitForNavigation

client

accessibility

mainRealm

isolatedRealm

document

clearDocumentHandle

frameElement

evaluateHandle

evaluate

evaluate

evaluate

$

$$

$eval

$$eval

waitForSelector

waitForFunction

content

setContent

setFrameContent

name

url

parentFrame

childFrames

detached

disposed

addScriptTag

addStyleTag

click

focus

hover

select