001: /*
002: * Copyright (c) 2002-2008 Gargoyle Software Inc. All rights reserved.
003: *
004: * Redistribution and use in source and binary forms, with or without
005: * modification, are permitted provided that the following conditions are met:
006: *
007: * 1. Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: * 2. Redistributions in binary form must reproduce the above copyright notice,
010: * this list of conditions and the following disclaimer in the documentation
011: * and/or other materials provided with the distribution.
012: * 3. The end-user documentation included with the redistribution, if any, must
013: * include the following acknowledgment:
014: *
015: * "This product includes software developed by Gargoyle Software Inc.
016: * (http://www.GargoyleSoftware.com/)."
017: *
018: * Alternately, this acknowledgment may appear in the software itself, if
019: * and wherever such third-party acknowledgments normally appear.
020: * 4. The name "Gargoyle Software" must not be used to endorse or promote
021: * products derived from this software without prior written permission.
022: * For written permission, please contact info@GargoyleSoftware.com.
023: * 5. Products derived from this software may not be called "HtmlUnit", nor may
024: * "HtmlUnit" appear in their name, without prior written permission of
025: * Gargoyle Software Inc.
026: *
027: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
028: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
029: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
030: * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
031: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
032: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
033: * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
034: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
035: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
036: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
037: */
038: package com.gargoylesoftware.htmlunit.html;
039:
040: import com.gargoylesoftware.htmlunit.StringWebResponse;
041: import com.gargoylesoftware.htmlunit.WebWindow;
042: import com.gargoylesoftware.htmlunit.WebWindowImpl;
043:
044: /**
045: * The web window for a frame or iframe.
046: *
047: * @version $Revision: 2132 $
048: * @author Brad Clarke
049: */
050: public class FrameWindow extends WebWindowImpl {
051: private final BaseFrame frame_;
052:
053: /**
054: * Create an instance for a given frame
055: */
056: FrameWindow(final BaseFrame frame) {
057: super (frame.getPage().getWebClient());
058: frame_ = frame;
059: final WebWindowImpl parent = (WebWindowImpl) getParentWindow();
060: parent.addChildWindow(this );
061: }
062:
063: /**
064: * {@inheritDoc}
065: * A FrameWindow shares it's name with it's containing frame.
066: */
067: public String getName() {
068: return frame_.getNameAttribute();
069: }
070:
071: /**
072: * {@inheritDoc}
073: * A FrameWindow shares it's name with it's containing frame.
074: */
075: public void setName(final String name) {
076: frame_.setNameAttribute(name);
077: }
078:
079: /**
080: * {@inheritDoc}
081: */
082: public WebWindow getParentWindow() {
083: return frame_.getPage().getEnclosingWindow();
084: }
085:
086: /**
087: * {@inheritDoc}
088: */
089: public WebWindow getTopWindow() {
090: return getParentWindow().getTopWindow();
091: }
092:
093: /**
094: * {@inheritDoc}
095: */
096: protected boolean isJavaScriptInitializationNeeded() {
097: return this .getScriptObject() == null
098: || !(getEnclosedPage().getWebResponse() instanceof StringWebResponse);
099: // TODO: find a better way to distinguish content written by document.open(),...
100: }
101:
102: /**
103: * Return the html page in which the <frame> or <iframe> tag is contained
104: * for this frame window.
105: * This is a facility method for <code>(HtmlPage) (getParentWindow().getEnclosedPage())</code>.
106: * @return the page in the parent window.
107: */
108: public HtmlPage getEnclosingPage() {
109: return frame_.getPage();
110: }
111:
112: /**
113: * Gets the DOM node of the (i)frame containing this window.
114: * @return the dom node
115: */
116: public BaseFrame getFrameElement() {
117: return frame_;
118: }
119:
120: /**
121: * Gives a basic representation for debugging purposes
122: * @return a basic representation
123: */
124: public String toString() {
125: return "FrameWindow[name=\"" + getName() + "\"]";
126: }
127: }
|