Package com.microsoft.playwright.impl

Class ElementHandleImpl

    • Constructor Detail

      • ElementHandleImpl

        ElementHandleImpl​(ChannelOwner parent,
                  java.lang.String type,
                  java.lang.String guid,
                  com.google.gson.JsonObject initializer)

    • Method Detail

      • querySelector

        public ElementHandle querySelector​(java.lang.String selector)
        Description copied from interface: ElementHandle
        The method finds an element matching the specified selector in the ElementHandle's subtree. If no elements match the selector, returns null.
        Specified by:
        querySelector in interface ElementHandle
        Parameters:
        selector - A selector to query for.

      • querySelectorAll

        public java.util.List<ElementHandle> querySelectorAll​(java.lang.String selector)
        Description copied from interface: ElementHandle
        The method finds all elements matching the specified selector in the ElementHandles subtree. If no elements match the selector, returns empty array.
        Specified by:
        querySelectorAll in interface ElementHandle
        Parameters:
        selector - A selector to query for.

      • evalOnSelector

        public java.lang.Object evalOnSelector​(java.lang.String selector,
                                       java.lang.String pageFunction,
                                       java.lang.Object arg)
        Description copied from interface: ElementHandle
        Returns the return value of expression.

        The method finds an element matching the specified selector in the ElementHandles subtree and passes it as a first argument to expression. If no elements match the selector, the method throws an error.

        If expression returns a Promise, then ElementHandle.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:
        evalOnSelector in interface ElementHandle
        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 to expression.

      • evalOnSelectorAll

        public java.lang.Object evalOnSelectorAll​(java.lang.String selector,
                                          java.lang.String pageFunction,
                                          java.lang.Object arg)
        Description copied from interface: ElementHandle
        Returns the return value of expression.

        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 to expression.

        If expression returns a Promise, then ElementHandle.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:
        evalOnSelectorAll in interface ElementHandle
        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 to expression.

      • boundingBox

        public BoundingBox boundingBox()
        Description copied from interface: ElementHandle
        This method returns the bounding box of the element, or null if 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 x and/or y may 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:
        boundingBox in interface ElementHandle

      • check

        public void check​(ElementHandle.CheckOptions options)
        Description copied from interface: ElementHandle
        This method checks the element by performing the following steps:
        1. 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.
        2. Wait for actionability checks on the element, unless force option is set.
        3. Scroll the element into view if needed.
        4. Use Page.mouse() to click in the center of the element.
        5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
        6. 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 a TimeoutError. Passing zero timeout disables this.

        Specified by:
        check in interface ElementHandle

      • click

        public void click​(ElementHandle.ClickOptions options)
        Description copied from interface: ElementHandle
        This method clicks the element by performing the following steps:
        1. Wait for actionability checks on the element, unless force option is set.
        2. Scroll the element into view if needed.
        3. Use Page.mouse() to click in the center of the element, or the specified position.
        4. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option 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 a TimeoutError. Passing zero timeout disables this.

        Specified by:
        click in interface ElementHandle

      • contentFrame

        public Frame contentFrame()
        Description copied from interface: ElementHandle
        Returns the content frame for element handles referencing iframe nodes, or null otherwise
        Specified by:
        contentFrame in interface ElementHandle

      • contentFrameImpl

        private Frame contentFrameImpl()

      • dblclick

        public void dblclick​(ElementHandle.DblclickOptions options)
        Description copied from interface: ElementHandle
        This method double clicks the element by performing the following steps:
        1. Wait for actionability checks on the element, unless force option is set.
        2. Scroll the element into view if needed.
        3. Use Page.mouse() to double click in the center of the element, or the specified position.
        4. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set. Note that if the first click of the dblclick() 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 a TimeoutError. Passing zero timeout disables this.

        NOTE: elementHandle.dblclick() dispatches two click events and a single dblclick event.

        Specified by:
        dblclick in interface ElementHandle

      • dispatchEvent

        public void dispatchEvent​(java.lang.String type,
                          java.lang.Object eventInit)
        Description copied from interface: ElementHandle
        The snippet below dispatches the click event on the element. Regardless of the visibility state of the element, click is 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 with eventInit properties and dispatches it on the element. Events are composed, cancelable and bubble by default.

        Since eventInit is event-specific, please refer to the events documentation for the lists of initial properties:

        You can also specify JSHandle as 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:
        dispatchEvent in interface ElementHandle
        Parameters:
        type - DOM event type: "click", "dragstart", etc.
        eventInit - Optional event-specific initialization properties.

      • fill

        public void fill​(java.lang.String value,
                 ElementHandle.FillOptions options)
        Description copied from interface: ElementHandle
        This method waits for actionability checks, focuses the element, fills it and triggers an input event 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:
        fill in interface ElementHandle
        Parameters:
        value - Value to set for the <input>, <textarea> or [contenteditable] element.

      • getAttribute

        public java.lang.String getAttribute​(java.lang.String name)
        Description copied from interface: ElementHandle
        Returns element attribute value.
        Specified by:
        getAttribute in interface ElementHandle
        Parameters:
        name - Attribute name to get the value for.

      • hover

        public void hover​(ElementHandle.HoverOptions options)
        Description copied from interface: ElementHandle
        This method hovers over the element by performing the following steps:
        1. Wait for actionability checks on the element, unless force option is set.
        2. Scroll the element into view if needed.
        3. Use Page.mouse() to hover over the center of the element, or the specified position.
        4. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option 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 a TimeoutError. Passing zero timeout disables this.

        Specified by:
        hover in interface ElementHandle

      • innerHTML

        public java.lang.String innerHTML()
        Description copied from interface: ElementHandle
        Returns the element.innerHTML.
        Specified by:
        innerHTML in interface ElementHandle

      • innerText

        public java.lang.String innerText()
        Description copied from interface: ElementHandle
        Returns the element.innerText.
        Specified by:
        innerText in interface ElementHandle

      • inputValue

        public java.lang.String inputValue​(ElementHandle.InputValueOptions options)
        Description copied from interface: ElementHandle
        Returns input.value for 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:
        inputValue in interface ElementHandle

      • isChecked

        public boolean isChecked()
        Description copied from interface: ElementHandle
        Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
        Specified by:
        isChecked in interface ElementHandle

      • press

        public void press​(java.lang.String key,
                  ElementHandle.PressOptions options)
        Description copied from interface: ElementHandle
        Focuses the element, and then uses Keyboard.down() and Keyboard.up().

        key can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the key values 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 Shift will type the text that corresponds to the key in the upper case.

        If key is a single character, it is case-sensitive, so the values a and A will generate different respective texts.

        Shortcuts such as key: "Control+o" or key: "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:
        press in interface ElementHandle
        Parameters:
        key - Name of the key to press or a character to generate, such as ArrowLeft or a.

      • screenshot

        public byte[] screenshot​(ElementHandle.ScreenshotOptions options)
        Description copied from interface: ElementHandle
        This 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:
        screenshot in interface ElementHandle

      • selectOption

        public java.util.List<java.lang.String> selectOption​(java.lang.String value,
                                                     ElementHandle.SelectOptionOptions options)
        Description copied from interface: ElementHandle
        This 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 change and input event 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:
        selectOption in interface ElementHandle
        Parameters:
        value - Options to select. If the <select> has the multiple attribute, 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

        public java.util.List<java.lang.String> selectOption​(ElementHandle value,
                                                     ElementHandle.SelectOptionOptions options)
        Description copied from interface: ElementHandle
        This 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 change and input event 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:
        selectOption in interface ElementHandle
        Parameters:
        value - Options to select. If the <select> has the multiple attribute, 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

        public java.util.List<java.lang.String> selectOption​(java.lang.String[] values,
                                                     ElementHandle.SelectOptionOptions options)
        Description copied from interface: ElementHandle
        This 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 change and input event 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:
        selectOption in interface ElementHandle
        Parameters:
        values - Options to select. If the <select> has the multiple attribute, 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

        public java.util.List<java.lang.String> selectOption​(SelectOption value,
                                                     ElementHandle.SelectOptionOptions options)
        Description copied from interface: ElementHandle
        This 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 change and input event 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:
        selectOption in interface ElementHandle
        Parameters:
        value - Options to select. If the <select> has the multiple attribute, 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

        public java.util.List<java.lang.String> selectOption​(SelectOption[] values,
                                                     ElementHandle.SelectOptionOptions options)
        Description copied from interface: ElementHandle
        This 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 change and input event 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:
        selectOption in interface ElementHandle
        Parameters:
        values - Options to select. If the <select> has the multiple attribute, 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

        public java.util.List<java.lang.String> selectOption​(ElementHandle[] values,
                                                     ElementHandle.SelectOptionOptions options)
        Description copied from interface: ElementHandle
        This 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 change and input event 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:
        selectOption in interface ElementHandle
        Parameters:
        values - Options to select. If the <select> has the multiple attribute, 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

        private java.util.List<java.lang.String> selectOption​(com.google.gson.JsonObject params)

      • setChecked

        public void setChecked​(boolean checked,
                       ElementHandle.SetCheckedOptions options)
        Description copied from interface: ElementHandle
        This method checks or unchecks an element by performing the following steps:
        1. Ensure that element is a checkbox or a radio input. If not, this method throws.
        2. If the element already has the right checked state, this method returns immediately.
        3. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
        4. Scroll the element into view if needed.
        5. Use Page.mouse() to click in the center of the element.
        6. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
        7. 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 a TimeoutError. Passing zero timeout disables this.

        Specified by:
        setChecked in interface ElementHandle
        Parameters:
        checked - Whether to check or uncheck the checkbox.

      • setInputFiles

        public void setInputFiles​(java.nio.file.Path files,
                          ElementHandle.SetInputFilesOptions options)
        Description copied from interface: ElementHandle
        Sets the value of the file input to these file paths or files. If some of the filePaths are relative paths, then they are resolved relative to the current working directory. For empty array, clears the selected files.

        This method expects ElementHandle to 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:
        setInputFiles in interface ElementHandle

      • setInputFiles

        public void setInputFiles​(java.nio.file.Path[] files,
                          ElementHandle.SetInputFilesOptions options)
        Description copied from interface: ElementHandle
        Sets the value of the file input to these file paths or files. If some of the filePaths are relative paths, then they are resolved relative to the current working directory. For empty array, clears the selected files.

        This method expects ElementHandle to 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:
        setInputFiles in interface ElementHandle

      • setInputFiles

        public void setInputFiles​(FilePayload files,
                          ElementHandle.SetInputFilesOptions options)
        Description copied from interface: ElementHandle
        Sets the value of the file input to these file paths or files. If some of the filePaths are relative paths, then they are resolved relative to the current working directory. For empty array, clears the selected files.

        This method expects ElementHandle to 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:
        setInputFiles in interface ElementHandle

      • setInputFiles

        public void setInputFiles​(FilePayload[] files,
                          ElementHandle.SetInputFilesOptions options)
        Description copied from interface: ElementHandle
        Sets the value of the file input to these file paths or files. If some of the filePaths are relative paths, then they are resolved relative to the current working directory. For empty array, clears the selected files.

        This method expects ElementHandle to 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:
        setInputFiles in interface ElementHandle

      • tap

        public void tap​(ElementHandle.TapOptions options)
        Description copied from interface: ElementHandle
        This method taps the element by performing the following steps:
        1. Wait for actionability checks on the element, unless force option is set.
        2. Scroll the element into view if needed.
        3. Use Page.touchscreen() to tap the center of the element, or the specified position.
        4. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option 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 a TimeoutError. Passing zero timeout disables this.

        NOTE: elementHandle.tap() requires that the hasTouch option of the browser context be set to true.

        Specified by:
        tap in interface ElementHandle

      • textContent

        public java.lang.String textContent()
        Description copied from interface: ElementHandle
        Returns the node.textContent.
        Specified by:
        textContent in interface ElementHandle

      • textContentImpl

        private java.lang.String textContentImpl()

      • uncheck

        public void uncheck​(ElementHandle.UncheckOptions options)
        Description copied from interface: ElementHandle
        This method checks the element by performing the following steps:
        1. 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.
        2. Wait for actionability checks on the element, unless force option is set.
        3. Scroll the element into view if needed.
        4. Use Page.mouse() to click in the center of the element.
        5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
        6. 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 a TimeoutError. Passing zero timeout disables this.

        Specified by:
        uncheck in interface ElementHandle

      • waitForElementState

        public void waitForElementState​(ElementState state,
                                ElementHandle.WaitForElementStateOptions options)
        Description copied from interface: ElementHandle
        Returns when the element satisfies the state.

        Depending on the state parameter, 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 timeout milliseconds, this method will throw.

        Specified by:
        waitForElementState in interface ElementHandle
        Parameters:
        state - A state to wait for, see below for more details.

      • toProtocol

        private static java.lang.String toProtocol​(ElementState state)

      • waitForSelector

        public ElementHandle waitForSelector​(java.lang.String selector,
                                     ElementHandle.WaitForSelectorOptions options)
        Description copied from interface: ElementHandle
        Returns element specified by selector when it satisfies state option. Returns null if waiting for hidden or detached.

        Wait for the selector relative to the element handle to satisfy state option (either appear/disappear from dom, or become visible/hidden). If at the moment of calling the method selector already satisfies the condition, the method will return immediately. If the selector doesn't satisfy the condition for the timeout milliseconds, 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:
        waitForSelector in interface ElementHandle
        Parameters:
        selector - A selector to query for.