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;
16
17 import java.io.Serializable;
18
19 /**
20 * A handler for JavaScript window.prompt(). Prompts are triggered when the JavaScript
21 * method Window.prompt() is called.
22 *
23 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
24 * @author Ahmed Ashour
25 * @author Ronald Brill
26 */
27 public interface PromptHandler extends Serializable {
28
29 /**
30 * Handle a call to Window.prompt() for the given page.
31 * @param page the page on which the prompt occurred
32 * @param message the message in the prompt
33 * @param defaultValue the default value in the prompt
34 * @return the value typed in or {@code null} if the user pressed {@code cancel}
35 */
36 String handlePrompt(Page page, String message, String defaultValue);
37 }