KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > gargoylesoftware > htmlunit > javascript > host > Frame


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.javascript.host;
39
40 import org.mozilla.javascript.Function;
41
42 import com.gargoylesoftware.htmlunit.html.BaseFrame;
43
44 /**
45  * A JavaScript object for a frame and iframe.
46  *
47  * @version $Revision: 100 $
48  * @author Marc Guillemot
49  * @author Chris Erskine
50  */
51 public class Frame extends HTMLElement {
52     private static final long serialVersionUID = 3761121622400448304L;
53
54     /**
55      * Create an instance. A default constructor is required for all javascript objects.
56      */
57     public Frame() { }
58
59
60     /**
61      * Javascript constructor. This must be declared in every javascript file because
62      * the rhino engine won't walk up the hierarchy looking for constructors.
63      */
64     public final void jsConstructor() {
65     }
66
67
68     /**
69      * Return the value of url loaded in the frame
70      * @return The value of this attribute.
71      */
72     public String JavaDoc jsxGet_src() {
73         return getFrame().getSrcAttribute();
74     }
75
76
77     /**
78      * Returns the document the frame contains, if any
79      * @return <code>null</code> if no document is contained
80      * @see <a HREF="http://www.mozilla.org/docs/dom/domref/dom_frame_ref4.html">
81      * Gecko DOM Reference</a>
82      */
83     public Document jsxGet_contentDocument() {
84         return ((Window) getFrame().getEnclosedWindow().getScriptObject()).jsxGet_document();
85     }
86
87     /**
88      * Set the value of the source of the contained frame.
89      * @param src The new value.
90      */
91     public void jsxSet_src(final String JavaDoc src) {
92         getFrame().setSrcAttribute(src);
93     }
94
95     private BaseFrame getFrame() {
96         return (BaseFrame) getHtmlElementOrDie();
97     }
98
99
100     /**
101      * Set the onload event handler for this element.
102      * @param eventHandler the new handler
103      */
104     public void jsxSet_onload(final Function eventHandler) {
105         getHtmlElementOrDie().setEventHandler("onload", eventHandler);
106     }
107
108
109     /**
110      * Get the onload event handler for this element.
111      * @return <code>org.mozilla.javascript.Function</code>
112      */
113     public Function jsxGet_onload() {
114         return getHtmlElementOrDie().getEventHandler("onload");
115     }
116 }
117
Popular Tags