WebWindow


1   /*
2    * Copyright (c) 2002, 2005 Gargoyle Software Inc. All rights reserved.
3    *
4    * Redistribution and use in source and binary forms, with or without
5    * modification, are permitted provided that the following conditions are met:
6    *
7    * 1. Redistributions of source code must retain the above copyright notice,
8    *    this list of conditions and the following disclaimer.
9    * 2. Redistributions in binary form must reproduce the above copyright notice,
10   *    this list of conditions and the following disclaimer in the documentation
11   *    and/or other materials provided with the distribution.
12   * 3. The end-user documentation included with the redistribution, if any, must
13   *    include the following acknowledgment:
14   *
15   *       "This product includes software developed by Gargoyle Software Inc.
16   *        (http://www.GargoyleSoftware.com/)."
17   *
18   *    Alternately, this acknowledgment may appear in the software itself, if
19   *    and wherever such third-party acknowledgments normally appear.
20   * 4. The name "Gargoyle Software" must not be used to endorse or promote
21   *    products derived from this software without prior written permission.
22   *    For written permission, please contact info@GargoyleSoftware.com.
23   * 5. Products derived from this software may not be called "HtmlUnit", nor may
24   *    "HtmlUnit" appear in their name, without prior written permission of
25   *    Gargoyle Software Inc.
26   *
27   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
28   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
29   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
30   * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
31   * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
33   * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34   * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35   * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
36   * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37   */
38  package com.gargoylesoftware.htmlunit;
39  
40  
41  /**
42   *  An interface that represents one window in a browser.  It could be a top level window
43   *  or a frame.
44   *
45   * @version  $Revision: 100 $
46   * @author  <a HREF="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
47   * @author  David K. Taylor
48   * @author David D. Kilzer
49   */
50  public interface WebWindow {
51  
52      /**
53       * Return the name of this window.
54       *
55       * @return The name of this window.
56       */
57      String   getName();
58  
59  
60      /**
61       * Set the name of this window.
62       *
63       * @param name The new window name.
64       */
65      void setName( final String   name );
66  
67  
68      /**
69       * Return the currently loaded page or null if no page has been loaded.
70       *
71       * @return The currently loaded page or null if no page has been loaded.
72       */
73      Page getEnclosedPage();
74  
75  
76      /**
77       * Set the currently loaded page.
78       *
79       * @param page The new page or null if there is no page (ie empty window)
80       */
81      void setEnclosedPage( final Page page );
82  
83  
84      /**
85       * Return the window that contains this window.  If this is a top
86       * level window, then return this window.
87       *
88       * @return The parent window or this window if there is no parent.
89       */
90      WebWindow getParentWindow();
91  
92  
93      /**
94       * Return the top level window that contains this window.  If this
95       * is a top level window, then return this window.
96       *
97       * @return The top level window that contains this window or this
98       * window if there is no parent.
99       */
100     WebWindow getTopWindow();
101 
102 
103     /**
104      * Return the web client that "owns" this window.
105      *
106      * @return The web client or null if this window has been closed.
107      */
108     WebClient getWebClient();
109 
110 
111     /**
112      * Internal use only - subject to change without notice.<p>
113      * Set the javascript object that corresponds to this element.  This is not guarenteed
114      * to be set even if there is a javascript object for this html element.
115      * @param scriptObject The javascript object.
116      */
117     void setScriptObject( final Object   scriptObject );
118 
119 
120     /**
121      * Internal use only - subject to change without notice.<p>
122      * Return the javascript object that corresponds to this element.
123      * @return The javascript object that corresponsd to this element.
124      */
125     Object   getScriptObject();
126 }
127 
128
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags