View Javadoc
1   /*
2    * Copyright (c) 2002-2025 Gargoyle Software Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * https://www.apache.org/licenses/LICENSE-2.0
8    *
9    * Unless required by applicable law or agreed to in writing, software
10   * distributed under the License is distributed on an "AS IS" BASIS,
11   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12   * See the License for the specific language governing permissions and
13   * limitations under the License.
14   */
15  package org.htmlunit.html;
16  
17  /**
18   * An interface to allow the user to specify which element to return for the javascript
19   * {@code document.elementFromPoint()}.
20   * <p>
21   * This is needed since calculating the element location is outside the current scope of HtmlUnit.
22   * @author Ahmed Ashour
23   */
24  public interface ElementFromPointHandler {
25  
26      /**
27       * Returns the element for the specified x coordinate and the specified y coordinate.
28       * The current implementation always returns the &lt;body&gt; element.
29       *
30       * @param htmlPage the page
31       * @param x the x offset, in pixels
32       * @param y the y offset, in pixels
33       * @return the element for the specified x coordinate and the specified y coordinate
34       */
35      HtmlElement getElementFromPoint(HtmlPage htmlPage, int x, int y);
36  }