WindowCloseListener


1   /*
2    * Copyright 2007 Google Inc.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
5    * use this file except in compliance with the License. You may obtain a copy of
6    * the License at
7    * 
8    * http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations under
14   * the License.
15   */
16  package com.google.gwt.user.client;
17  
18  /**
19   * Implement this interface to receive closing events from the browser window.
20   * 
21   * @see com.google.gwt.user.client.Window#addWindowCloseListener(WindowCloseListener)
22   */
23  public interface WindowCloseListener extends java.util.EventListener   {
24  
25    /**
26     * Fired just before the browser window closes or navigates to a different
27     * site. No user-interface may be displayed during shutdown.
28     * 
29     * @return non-<code>null</code> to present a confirmation dialog that asks
30     *         the user whether or not she wishes to navigate away from the page.
31     *         The string returned will be displayed in the close confirmation
32     *         dialog box. If multiple listeners return messages, the first will
33     *         be displayed; all others will be ignored.
34     */
35    String   onWindowClosing();
36  
37    /**
38     * Fired after the browser window closes or navigates to a different site.
39     * This event cannot be cancelled, and is used mainly to clean up application
40     * state and/or save state to the server.
41     */
42    void onWindowClosed();
43  }
44

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags