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;
16  
17  import java.io.Serializable;
18  
19  /**
20   * A handler for <code>onbeforeunload</code> events.
21   *
22   * @author Ahmed Ashour
23   * @author Ronald Brill
24   */
25  public interface OnbeforeunloadHandler extends Serializable {
26  
27      /**
28       * Handles an <code>onbeforeunload</code> event for the specified page.
29       * @param page the page on which the event occurred
30       * @param returnValue the event's <code>returnValue</code>
31       * @return {@code true} to accept the event, {@code false} otherwise
32       */
33      boolean handleEvent(Page page, String returnValue);
34  }