Class ElementHandleImpl
- All Implemented Interfaces:
ElementHandle,JSHandle
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.microsoft.playwright.ElementHandle
ElementHandle.CheckOptions, ElementHandle.ClickOptions, ElementHandle.DblclickOptions, ElementHandle.FillOptions, ElementHandle.HoverOptions, ElementHandle.InputValueOptions, ElementHandle.PressOptions, ElementHandle.ScreenshotOptions, ElementHandle.ScrollIntoViewIfNeededOptions, ElementHandle.SelectOptionOptions, ElementHandle.SelectTextOptions, ElementHandle.SetCheckedOptions, ElementHandle.SetInputFilesOptions, ElementHandle.TapOptions, ElementHandle.TypeOptions, ElementHandle.UncheckOptions, ElementHandle.WaitForElementStateOptions, ElementHandle.WaitForSelectorOptions -
Field Summary
Fields inherited from class com.microsoft.playwright.impl.ChannelOwner
connection, guid, initializer, type -
Constructor Summary
ConstructorsConstructorDescriptionElementHandleImpl(ChannelOwner parent, String type, String guid, com.google.gson.JsonObject initializer) -
Method Summary
Modifier and TypeMethodDescriptionReturns eithernullor the object handle itself, if the object handle is an instance ofElementHandle.This method returns the bounding box of the element, ornullif the element is not visible.voidcheck(ElementHandle.CheckOptions options) This method checks the element by performing the following steps: Ensure that element is a checkbox or a radio input.private voidcheckImpl(ElementHandle.CheckOptions options) voidclick(ElementHandle.ClickOptions options) This method clicks the element by performing the following steps: Wait for actionability checks on the element, unlessforceoption is set. Scroll the element into view if needed. UsePage.mouse()to click in the center of the element, or the specifiedposition. Wait for initiated navigations to either succeed or fail, unlessnoWaitAfteroption is set.private voidclickImpl(ElementHandle.ClickOptions options) Returns the content frame for element handles referencing iframe nodes, ornullotherwiseprivate Framevoiddblclick(ElementHandle.DblclickOptions options) This method double clicks the element by performing the following steps: Wait for actionability checks on the element, unlessforceoption is set. Scroll the element into view if needed. UsePage.mouse()to double click in the center of the element, or the specifiedposition. Wait for initiated navigations to either succeed or fail, unlessnoWaitAfteroption is set.private voidvoiddispatchEvent(String type, Object eventInit) The snippet below dispatches theclickevent on the element.evalOnSelector(String selector, String pageFunction, Object arg) Returns the return value ofexpression.evalOnSelectorAll(String selector, String pageFunction, Object arg) Returns the return value ofexpression.voidfill(String value, ElementHandle.FillOptions options) This method waits for actionability checks, focuses the element, fills it and triggers aninputevent after filling.private voidfillImpl(String value, ElementHandle.FillOptions options) voidfocus()Calls focus on the element.getAttribute(String name) Returns element attribute value.voidhover(ElementHandle.HoverOptions options) This method hovers over the element by performing the following steps: Wait for actionability checks on the element, unlessforceoption is set. Scroll the element into view if needed. UsePage.mouse()to hover over the center of the element, or the specifiedposition. Wait for initiated navigations to either succeed or fail, unlessnoWaitAfteroption is set.private voidhoverImpl(ElementHandle.HoverOptions options) Returns theelement.innerHTML.Returns theelement.innerText.Returnsinput.valuefor the selected<input>or<textarea>or<select>element.private StringbooleanReturns whether the element is checked.booleanReturns whether the element is disabled, the opposite of enabled.booleanReturns whether the element is editable.booleanReturns whether the element is enabled.booleanisHidden()Returns whether the element is hidden, the opposite of visible.booleanReturns whether the element is visible.Returns the frame containing the given element.voidpress(String key, ElementHandle.PressOptions options) Focuses the element, and then usesKeyboard.down()andKeyboard.up().private voidpressImpl(String key, ElementHandle.PressOptions options) querySelector(String selector) The method finds an element matching the specified selector in theElementHandle's subtree.querySelectorAll(String selector) The method finds all elements matching the specified selector in theElementHandles subtree.byte[]This method captures a screenshot of the page, clipped to the size and position of this particular element.private byte[]voidThis method waits for actionability checks, then tries to scroll element into view, unless it is completely visible as defined by IntersectionObserver'sratio.private voidselectOption(com.google.gson.JsonObject params) selectOption(ElementHandle[] values, ElementHandle.SelectOptionOptions options) This method waits for actionability checks, waits until all specified options are present in the<select>element and selects these options.selectOption(ElementHandle value, ElementHandle.SelectOptionOptions options) This method waits for actionability checks, waits until all specified options are present in the<select>element and selects these options.selectOption(SelectOption[] values, ElementHandle.SelectOptionOptions options) This method waits for actionability checks, waits until all specified options are present in the<select>element and selects these options.selectOption(SelectOption value, ElementHandle.SelectOptionOptions options) This method waits for actionability checks, waits until all specified options are present in the<select>element and selects these options.selectOption(String[] values, ElementHandle.SelectOptionOptions options) This method waits for actionability checks, waits until all specified options are present in the<select>element and selects these options.selectOption(String value, ElementHandle.SelectOptionOptions options) This method waits for actionability checks, waits until all specified options are present in the<select>element and selects these options.voidThis method waits for actionability checks, then focuses the element and selects all its text content.private voidvoidsetChecked(boolean checked, ElementHandle.SetCheckedOptions options) This method checks or unchecks an element by performing the following steps: Ensure that element is a checkbox or a radio input.voidsetInputFiles(FilePayload[] files, ElementHandle.SetInputFilesOptions options) Sets the value of the file input to these file paths or files.voidsetInputFiles(FilePayload files, ElementHandle.SetInputFilesOptions options) Sets the value of the file input to these file paths or files.voidsetInputFiles(Path[] files, ElementHandle.SetInputFilesOptions options) Sets the value of the file input to these file paths or files.voidsetInputFiles(Path files, ElementHandle.SetInputFilesOptions options) Sets the value of the file input to these file paths or files.(package private) voidsetInputFilesImpl(FilePayload[] files, ElementHandle.SetInputFilesOptions options) (package private) voidsetInputFilesImpl(Path[] files, ElementHandle.SetInputFilesOptions options) voidtap(ElementHandle.TapOptions options) This method taps the element by performing the following steps: Wait for actionability checks on the element, unlessforceoption is set. Scroll the element into view if needed. UsePage.touchscreen()to tap the center of the element, or the specifiedposition. Wait for initiated navigations to either succeed or fail, unlessnoWaitAfteroption is set.private voidtapImpl(ElementHandle.TapOptions options) Returns thenode.textContent.private Stringprivate static StringtoProtocol(ElementState state) voidtype(String text, ElementHandle.TypeOptions options) private voidtypeImpl(String text, ElementHandle.TypeOptions options) voiduncheck(ElementHandle.UncheckOptions options) This method checks the element by performing the following steps: Ensure that element is a checkbox or a radio input.private voiduncheckImpl(ElementHandle.UncheckOptions options) voidwaitForElementState(ElementState state, ElementHandle.WaitForElementStateOptions options) Returns when the element satisfies thestate.private voidwaitForSelector(String selector, ElementHandle.WaitForSelectorOptions options) Returns element specified by selector when it satisfiesstateoption.private ElementHandlewaitForSelectorImpl(String selector, ElementHandle.WaitForSelectorOptions options) Methods inherited from class com.microsoft.playwright.impl.JSHandleImpl
dispose, evaluate, evaluateHandle, getProperties, getProperty, handleEvent, jsonValue, toStringMethods inherited from class com.microsoft.playwright.impl.ChannelOwner
adopt, disposeChannelOwner, runUntil, sendMessage, sendMessage, sendMessageAsync, toProtocolRef, withLogging, withWaitLoggingMethods inherited from class com.microsoft.playwright.impl.LoggingSupport
logApi, logApiIfEnabled, logWithTimestamp, withLoggingMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.microsoft.playwright.ElementHandle
check, click, dblclick, dispatchEvent, evalOnSelector, evalOnSelectorAll, fill, hover, inputValue, press, screenshot, scrollIntoViewIfNeeded, selectOption, selectOption, selectOption, selectOption, selectOption, selectOption, selectText, setChecked, setInputFiles, setInputFiles, setInputFiles, setInputFiles, tap, type, uncheck, waitForElementState, waitForSelectorMethods inherited from interface com.microsoft.playwright.JSHandle
dispose, evaluate, evaluate, evaluateHandle, evaluateHandle, getProperties, getProperty, jsonValue
-
Constructor Details
-
ElementHandleImpl
ElementHandleImpl(ChannelOwner parent, String type, String guid, com.google.gson.JsonObject initializer)
-
-
Method Details
-
asElement
Description copied from interface:JSHandleReturns eithernullor the object handle itself, if the object handle is an instance ofElementHandle.- Specified by:
asElementin interfaceJSHandle- Overrides:
asElementin classJSHandleImpl
-
querySelector
Description copied from interface:ElementHandleThe method finds an element matching the specified selector in theElementHandle's subtree. If no elements match the selector, returnsnull.- Specified by:
querySelectorin interfaceElementHandle- Parameters:
selector- A selector to query for.
-
querySelectorAll
Description copied from interface:ElementHandleThe method finds all elements matching the specified selector in theElementHandles subtree. If no elements match the selector, returns empty array.- Specified by:
querySelectorAllin interfaceElementHandle- Parameters:
selector- A selector to query for.
-
evalOnSelector
Description copied from interface:ElementHandleReturns the return value ofexpression.The method finds an element matching the specified selector in the
ElementHandles subtree and passes it as a first argument toexpression. If no elements match the selector, the method throws an error.If
expressionreturns a Promise, thenElementHandle.evalOnSelector()would wait for the promise to resolve and return its value.**Usage**
ElementHandle tweetHandle = page.querySelector(".tweet"); assertEquals("100", tweetHandle.evalOnSelector(".like", "node => node.innerText")); assertEquals("10", tweetHandle.evalOnSelector(".retweets", "node => node.innerText"));- Specified by:
evalOnSelectorin interfaceElementHandle- Parameters:
selector- A selector to query for.pageFunction- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.arg- Optional argument to pass toexpression.
-
evalOnSelectorAll
Description copied from interface:ElementHandleReturns the return value ofexpression.The method finds all elements matching the specified selector in the
ElementHandle's subtree and passes an array of matched elements as a first argument toexpression.If
expressionreturns a Promise, thenElementHandle.evalOnSelectorAll()would wait for the promise to resolve and return its value.**Usage**
ElementHandle feedHandle = page.querySelector(".feed"); assertEquals(Arrays.asList("Hello!", "Hi!"), feedHandle.evalOnSelectorAll(".tweet", "nodes => nodes.map(n => n.innerText)"));- Specified by:
evalOnSelectorAllin interfaceElementHandle- Parameters:
selector- A selector to query for.pageFunction- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.arg- Optional argument to pass toexpression.
-
boundingBox
Description copied from interface:ElementHandleThis method returns the bounding box of the element, ornullif the element is not visible. The bounding box is calculated relative to the main frame viewport - which is usually the same as the browser window.Scrolling affects the returned bounding box, similarly to Element.getBoundingClientRect. That means
xand/orymay be negative.Elements from child frames return the bounding box relative to the main frame, unlike the Element.getBoundingClientRect.
Assuming the page is static, it is safe to use bounding box coordinates to perform input. For example, the following snippet should click the center of the element.
**Usage**
BoundingBox box = elementHandle.boundingBox(); page.mouse().click(box.x + box.width / 2, box.y + box.height / 2);- Specified by:
boundingBoxin interfaceElementHandle
-
check
Description copied from interface:ElementHandleThis method checks the element by performing the following steps:- Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already checked, this method returns immediately.
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.mouse()to click in the center of the element. - Wait for initiated navigations to either succeed or fail, unless
noWaitAfteroption is set. - Ensure that the element is now checked. If not, this method throws.
If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified
timeout, this method throws aTimeoutError. Passing zero timeout disables this.- Specified by:
checkin interfaceElementHandle
-
checkImpl
-
click
Description copied from interface:ElementHandleThis method clicks the element by performing the following steps:- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.mouse()to click in the center of the element, or the specifiedposition. - Wait for initiated navigations to either succeed or fail, unless
noWaitAfteroption is set.
If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified
timeout, this method throws aTimeoutError. Passing zero timeout disables this.- Specified by:
clickin interfaceElementHandle
- Wait for actionability checks on the element, unless
-
clickImpl
-
contentFrame
Description copied from interface:ElementHandleReturns the content frame for element handles referencing iframe nodes, ornullotherwise- Specified by:
contentFramein interfaceElementHandle
-
contentFrameImpl
-
dblclick
Description copied from interface:ElementHandleThis method double clicks the element by performing the following steps:- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.mouse()to double click in the center of the element, or the specifiedposition. - Wait for initiated navigations to either succeed or fail, unless
noWaitAfteroption is set. Note that if the first click of thedblclick()triggers a navigation event, this method will throw.
If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified
timeout, this method throws aTimeoutError. Passing zero timeout disables this.NOTE:
elementHandle.dblclick()dispatches twoclickevents and a singledblclickevent.- Specified by:
dblclickin interfaceElementHandle
- Wait for actionability checks on the element, unless
-
dblclickImpl
-
dispatchEvent
Description copied from interface:ElementHandleThe snippet below dispatches theclickevent on the element. Regardless of the visibility state of the element,clickis dispatched. This is equivalent to calling element.click().**Usage**
elementHandle.dispatchEvent("click");Under the hood, it creates an instance of an event based on the given
type, initializes it witheventInitproperties and dispatches it on the element. Events arecomposed,cancelableand bubble by default.Since
eventInitis event-specific, please refer to the events documentation for the lists of initial properties:You can also specify
JSHandleas the property value if you want live objects to be passed into the event:// Note you can only create DataTransfer in Chromium and Firefox JSHandle dataTransfer = page.evaluateHandle("() => new DataTransfer()"); Map<String, Object> arg = new HashMap<>(); arg.put("dataTransfer", dataTransfer); elementHandle.dispatchEvent("dragstart", arg);- Specified by:
dispatchEventin interfaceElementHandle- Parameters:
type- DOM event type:"click","dragstart", etc.eventInit- Optional event-specific initialization properties.
-
fill
Description copied from interface:ElementHandleThis method waits for actionability checks, focuses the element, fills it and triggers aninputevent after filling. Note that you can pass an empty string to clear the input field.If the target element is not an
<input>,<textarea>or[contenteditable]element, this method throws an error. However, if the element is inside the<label>element that has an associated control, the control will be filled instead.To send fine-grained keyboard events, use
Locator.pressSequentially().- Specified by:
fillin interfaceElementHandle- Parameters:
value- Value to set for the<input>,<textarea>or[contenteditable]element.
-
fillImpl
-
focus
public void focus()Description copied from interface:ElementHandleCalls focus on the element.- Specified by:
focusin interfaceElementHandle
-
getAttribute
Description copied from interface:ElementHandleReturns element attribute value.- Specified by:
getAttributein interfaceElementHandle- Parameters:
name- Attribute name to get the value for.
-
hover
Description copied from interface:ElementHandleThis method hovers over the element by performing the following steps:- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.mouse()to hover over the center of the element, or the specifiedposition. - Wait for initiated navigations to either succeed or fail, unless
noWaitAfteroption is set.
If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified
timeout, this method throws aTimeoutError. Passing zero timeout disables this.- Specified by:
hoverin interfaceElementHandle
- Wait for actionability checks on the element, unless
-
hoverImpl
-
innerHTML
Description copied from interface:ElementHandleReturns theelement.innerHTML.- Specified by:
innerHTMLin interfaceElementHandle
-
innerText
Description copied from interface:ElementHandleReturns theelement.innerText.- Specified by:
innerTextin interfaceElementHandle
-
inputValue
Description copied from interface:ElementHandleReturnsinput.valuefor the selected<input>or<textarea>or<select>element.Throws for non-input elements. However, if the element is inside the
<label>element that has an associated control, returns the value of the control.- Specified by:
inputValuein interfaceElementHandle
-
inputValueImpl
-
isChecked
public boolean isChecked()Description copied from interface:ElementHandleReturns whether the element is checked. Throws if the element is not a checkbox or radio input.- Specified by:
isCheckedin interfaceElementHandle
-
isDisabled
public boolean isDisabled()Description copied from interface:ElementHandleReturns whether the element is disabled, the opposite of enabled.- Specified by:
isDisabledin interfaceElementHandle
-
isEditable
public boolean isEditable()Description copied from interface:ElementHandleReturns whether the element is editable.- Specified by:
isEditablein interfaceElementHandle
-
isEnabled
public boolean isEnabled()Description copied from interface:ElementHandleReturns whether the element is enabled.- Specified by:
isEnabledin interfaceElementHandle
-
isHidden
public boolean isHidden()Description copied from interface:ElementHandleReturns whether the element is hidden, the opposite of visible.- Specified by:
isHiddenin interfaceElementHandle
-
isVisible
public boolean isVisible()Description copied from interface:ElementHandleReturns whether the element is visible.- Specified by:
isVisiblein interfaceElementHandle
-
ownerFrame
Description copied from interface:ElementHandleReturns the frame containing the given element.- Specified by:
ownerFramein interfaceElementHandle
-
press
Description copied from interface:ElementHandleFocuses the element, and then usesKeyboard.down()andKeyboard.up().keycan specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of thekeyvalues can be found here. Examples of the keys are:F1-F12,Digit0-Digit9,KeyA-KeyZ,Backquote,Minus,Equal,Backslash,Backspace,Tab,Delete,Escape,ArrowDown,End,Enter,Home,Insert,PageDown,PageUp,ArrowRight,ArrowUp, etc.Following modification shortcuts are also supported:
Shift,Control,Alt,Meta,ShiftLeft.Holding down
Shiftwill type the text that corresponds to thekeyin the upper case.If
keyis a single character, it is case-sensitive, so the valuesaandAwill generate different respective texts.Shortcuts such as
key: "Control+o"orkey: "Control+Shift+T"are supported as well. When specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.- Specified by:
pressin interfaceElementHandle- Parameters:
key- Name of the key to press or a character to generate, such asArrowLeftora.
-
pressImpl
-
screenshot
Description copied from interface:ElementHandleThis method captures a screenshot of the page, clipped to the size and position of this particular element. If the element is covered by other elements, it will not be actually visible on the screenshot. If the element is a scrollable container, only the currently scrolled content will be visible on the screenshot.This method waits for the actionability checks, then scrolls element into view before taking a screenshot. If the element is detached from DOM, the method throws an error.
Returns the buffer with the captured screenshot.
- Specified by:
screenshotin interfaceElementHandle
-
screenshotImpl
-
scrollIntoViewIfNeeded
Description copied from interface:ElementHandleThis method waits for actionability checks, then tries to scroll element into view, unless it is completely visible as defined by IntersectionObserver'sratio.Throws when
elementHandledoes not point to an element connected to a Document or a ShadowRoot.- Specified by:
scrollIntoViewIfNeededin interfaceElementHandle
-
selectOption
Description copied from interface:ElementHandleThis method waits for actionability checks, waits until all specified options are present in the<select>element and selects these options.If the target element is not a
<select>element, this method throws an error. However, if the element is inside the<label>element that has an associated control, the control will be used instead.Returns the array of option values that have been successfully selected.
Triggers a
changeandinputevent once all the provided options have been selected.**Usage**
// Single selection matching the value or label handle.selectOption("blue"); // single selection matching the label handle.selectOption(new SelectOption().setLabel("Blue")); // multiple selection handle.selectOption(new String[] {"red", "green", "blue"});- Specified by:
selectOptionin interfaceElementHandle- Parameters:
value- Options to select. If the<select>has themultipleattribute, all matching options are selected, otherwise only the first option matching one of the passed options is selected. String values are matching both values and labels. Option is considered matching if all specified properties match.
-
selectOption
Description copied from interface:ElementHandleThis method waits for actionability checks, waits until all specified options are present in the<select>element and selects these options.If the target element is not a
<select>element, this method throws an error. However, if the element is inside the<label>element that has an associated control, the control will be used instead.Returns the array of option values that have been successfully selected.
Triggers a
changeandinputevent once all the provided options have been selected.**Usage**
// Single selection matching the value or label handle.selectOption("blue"); // single selection matching the label handle.selectOption(new SelectOption().setLabel("Blue")); // multiple selection handle.selectOption(new String[] {"red", "green", "blue"});- Specified by:
selectOptionin interfaceElementHandle- Parameters:
value- Options to select. If the<select>has themultipleattribute, all matching options are selected, otherwise only the first option matching one of the passed options is selected. String values are matching both values and labels. Option is considered matching if all specified properties match.
-
selectOption
Description copied from interface:ElementHandleThis method waits for actionability checks, waits until all specified options are present in the<select>element and selects these options.If the target element is not a
<select>element, this method throws an error. However, if the element is inside the<label>element that has an associated control, the control will be used instead.Returns the array of option values that have been successfully selected.
Triggers a
changeandinputevent once all the provided options have been selected.**Usage**
// Single selection matching the value or label handle.selectOption("blue"); // single selection matching the label handle.selectOption(new SelectOption().setLabel("Blue")); // multiple selection handle.selectOption(new String[] {"red", "green", "blue"});- Specified by:
selectOptionin interfaceElementHandle- Parameters:
values- Options to select. If the<select>has themultipleattribute, all matching options are selected, otherwise only the first option matching one of the passed options is selected. String values are matching both values and labels. Option is considered matching if all specified properties match.
-
selectOption
Description copied from interface:ElementHandleThis method waits for actionability checks, waits until all specified options are present in the<select>element and selects these options.If the target element is not a
<select>element, this method throws an error. However, if the element is inside the<label>element that has an associated control, the control will be used instead.Returns the array of option values that have been successfully selected.
Triggers a
changeandinputevent once all the provided options have been selected.**Usage**
// Single selection matching the value or label handle.selectOption("blue"); // single selection matching the label handle.selectOption(new SelectOption().setLabel("Blue")); // multiple selection handle.selectOption(new String[] {"red", "green", "blue"});- Specified by:
selectOptionin interfaceElementHandle- Parameters:
value- Options to select. If the<select>has themultipleattribute, all matching options are selected, otherwise only the first option matching one of the passed options is selected. String values are matching both values and labels. Option is considered matching if all specified properties match.
-
scrollIntoViewIfNeededImpl
-
selectOption
Description copied from interface:ElementHandleThis method waits for actionability checks, waits until all specified options are present in the<select>element and selects these options.If the target element is not a
<select>element, this method throws an error. However, if the element is inside the<label>element that has an associated control, the control will be used instead.Returns the array of option values that have been successfully selected.
Triggers a
changeandinputevent once all the provided options have been selected.**Usage**
// Single selection matching the value or label handle.selectOption("blue"); // single selection matching the label handle.selectOption(new SelectOption().setLabel("Blue")); // multiple selection handle.selectOption(new String[] {"red", "green", "blue"});- Specified by:
selectOptionin interfaceElementHandle- Parameters:
values- Options to select. If the<select>has themultipleattribute, all matching options are selected, otherwise only the first option matching one of the passed options is selected. String values are matching both values and labels. Option is considered matching if all specified properties match.
-
selectOption
Description copied from interface:ElementHandleThis method waits for actionability checks, waits until all specified options are present in the<select>element and selects these options.If the target element is not a
<select>element, this method throws an error. However, if the element is inside the<label>element that has an associated control, the control will be used instead.Returns the array of option values that have been successfully selected.
Triggers a
changeandinputevent once all the provided options have been selected.**Usage**
// Single selection matching the value or label handle.selectOption("blue"); // single selection matching the label handle.selectOption(new SelectOption().setLabel("Blue")); // multiple selection handle.selectOption(new String[] {"red", "green", "blue"});- Specified by:
selectOptionin interfaceElementHandle- Parameters:
values- Options to select. If the<select>has themultipleattribute, all matching options are selected, otherwise only the first option matching one of the passed options is selected. String values are matching both values and labels. Option is considered matching if all specified properties match.
-
selectOption
-
selectText
Description copied from interface:ElementHandleThis method waits for actionability checks, then focuses the element and selects all its text content.If the element is inside the
<label>element that has an associated control, focuses and selects text in the control instead.- Specified by:
selectTextin interfaceElementHandle
-
setChecked
Description copied from interface:ElementHandleThis method checks or unchecks an element by performing the following steps:- Ensure that element is a checkbox or a radio input. If not, this method throws.
- If the element already has the right checked state, this method returns immediately.
- Wait for actionability checks on the matched element,
unless
forceoption is set. If the element is detached during the checks, the whole action is retried. - Scroll the element into view if needed.
- Use
Page.mouse()to click in the center of the element. - Wait for initiated navigations to either succeed or fail, unless
noWaitAfteroption is set. - Ensure that the element is now checked or unchecked. If not, this method throws.
When all steps combined have not finished during the specified
timeout, this method throws aTimeoutError. Passing zero timeout disables this.- Specified by:
setCheckedin interfaceElementHandle- Parameters:
checked- Whether to check or uncheck the checkbox.
-
setInputFiles
Description copied from interface:ElementHandleSets the value of the file input to these file paths or files. If some of thefilePathsare relative paths, then they are resolved relative to the current working directory. For empty array, clears the selected files.This method expects
ElementHandleto point to an input element. However, if the element is inside the<label>element that has an associated control, targets the control instead.- Specified by:
setInputFilesin interfaceElementHandle
-
selectTextImpl
-
setInputFiles
Description copied from interface:ElementHandleSets the value of the file input to these file paths or files. If some of thefilePathsare relative paths, then they are resolved relative to the current working directory. For empty array, clears the selected files.This method expects
ElementHandleto point to an input element. However, if the element is inside the<label>element that has an associated control, targets the control instead.- Specified by:
setInputFilesin interfaceElementHandle
-
setInputFilesImpl
-
setInputFiles
Description copied from interface:ElementHandleSets the value of the file input to these file paths or files. If some of thefilePathsare relative paths, then they are resolved relative to the current working directory. For empty array, clears the selected files.This method expects
ElementHandleto point to an input element. However, if the element is inside the<label>element that has an associated control, targets the control instead.- Specified by:
setInputFilesin interfaceElementHandle
-
setInputFiles
Description copied from interface:ElementHandleSets the value of the file input to these file paths or files. If some of thefilePathsare relative paths, then they are resolved relative to the current working directory. For empty array, clears the selected files.This method expects
ElementHandleto point to an input element. However, if the element is inside the<label>element that has an associated control, targets the control instead.- Specified by:
setInputFilesin interfaceElementHandle
-
setInputFilesImpl
-
tap
Description copied from interface:ElementHandleThis method taps the element by performing the following steps:- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.touchscreen()to tap the center of the element, or the specifiedposition. - Wait for initiated navigations to either succeed or fail, unless
noWaitAfteroption is set.
If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified
timeout, this method throws aTimeoutError. Passing zero timeout disables this.NOTE:
elementHandle.tap()requires that thehasTouchoption of the browser context be set to true.- Specified by:
tapin interfaceElementHandle
- Wait for actionability checks on the element, unless
-
tapImpl
-
textContent
Description copied from interface:ElementHandleReturns thenode.textContent.- Specified by:
textContentin interfaceElementHandle
-
textContentImpl
-
type
- Specified by:
typein interfaceElementHandle- Parameters:
text- A text to type into a focused element.
-
typeImpl
-
uncheck
Description copied from interface:ElementHandleThis method checks the element by performing the following steps:- Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already unchecked, this method returns immediately.
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.mouse()to click in the center of the element. - Wait for initiated navigations to either succeed or fail, unless
noWaitAfteroption is set. - Ensure that the element is now unchecked. If not, this method throws.
If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified
timeout, this method throws aTimeoutError. Passing zero timeout disables this.- Specified by:
uncheckin interfaceElementHandle
-
uncheckImpl
-
waitForElementState
public void waitForElementState(ElementState state, ElementHandle.WaitForElementStateOptions options) Description copied from interface:ElementHandleReturns when the element satisfies thestate.Depending on the
stateparameter, this method waits for one of the actionability checks to pass. This method throws when the element is detached while waiting, unless waiting for the"hidden"state.-
"visible"Wait until the element is visible. -
"hidden"Wait until the element is not visible or not attached. Note that waiting for hidden does not throw when the element detaches. -
"stable"Wait until the element is both visible and stable. -
"enabled"Wait until the element is enabled. -
"disabled"Wait until the element is not enabled. -
"editable"Wait until the element is editable.
If the element does not satisfy the condition for the
timeoutmilliseconds, this method will throw.- Specified by:
waitForElementStatein interfaceElementHandle- Parameters:
state- A state to wait for, see below for more details.
-
-
waitForElementStateImpl
private void waitForElementStateImpl(ElementState state, ElementHandle.WaitForElementStateOptions options) -
toProtocol
-
waitForSelector
Description copied from interface:ElementHandleReturns element specified by selector when it satisfiesstateoption. Returnsnullif waiting forhiddenordetached.Wait for the
selectorrelative to the element handle to satisfystateoption (either appear/disappear from dom, or become visible/hidden). If at the moment of calling the methodselectoralready satisfies the condition, the method will return immediately. If the selector doesn't satisfy the condition for thetimeoutmilliseconds, the function will throw.**Usage**
page.setContent("<div><span></span></div>"); ElementHandle div = page.querySelector("div"); // Waiting for the "span" selector relative to the div. ElementHandle span = div.waitForSelector("span", new ElementHandle.WaitForSelectorOptions() .setState(WaitForSelectorState.ATTACHED));NOTE: This method does not work across navigations, use
Page.waitForSelector()instead.- Specified by:
waitForSelectorin interfaceElementHandle- Parameters:
selector- A selector to query for.
-
waitForSelectorImpl
private ElementHandle waitForSelectorImpl(String selector, ElementHandle.WaitForSelectorOptions options)
-