1 /*
2 * Copyright (c) 2002-2026 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 * </p>
23 *
24 * @author Ahmed Ashour
25 * @author Ronald Brill
26 */
27 public interface ElementFromPointHandler {
28
29 /**
30 * Returns the element for the specified x coordinate and the specified y coordinate.
31 * The current implementation always returns the <body> element.
32 *
33 * @param htmlPage the page
34 * @param x the x offset, in pixels
35 * @param y the y offset, in pixels
36 * @return the element for the specified x coordinate and the specified y coordinate
37 */
38 HtmlElement getElementFromPoint(HtmlPage htmlPage, int x, int y);
39 }