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;
039:
040: import java.io.IOException;
041:
042: import com.gargoylesoftware.htmlunit.html.DomDocumentFragment;
043: import com.gargoylesoftware.htmlunit.html.DomNode;
044:
045: /**
046: * A basic class to be implemented by {@link HtmlPage} and {@link XmlPage}.
047: *
048: * @version $Revision: 2132 $
049: * @author Ahmed Ashour
050: */
051: public abstract class SgmlPage extends DomNode implements Page {
052:
053: private final WebResponse webResponse_;
054: private WebWindow enclosingWindow_;
055: private final WebClient webClient_;
056:
057: /**
058: * Create an instance of SgmlPage
059: *
060: * @param webResponse The web response that was used to create this page
061: * @param webWindow The window that this page is being loaded into.
062: */
063: public SgmlPage(final WebResponse webResponse,
064: final WebWindow webWindow) {
065: super (null);
066: webResponse_ = webResponse;
067: enclosingWindow_ = webWindow;
068: webClient_ = webWindow.getWebClient();
069: }
070:
071: /**
072: * {@inheritDoc}
073: */
074: public void cleanUp() throws IOException {
075: }
076:
077: /**
078: * {@inheritDoc}
079: */
080: public WebResponse getWebResponse() {
081: return webResponse_;
082: }
083:
084: /**
085: * {@inheritDoc}
086: */
087: public void initialize() throws IOException {
088: }
089:
090: /**
091: * Get the name for the current node.
092: * @return The node name
093: */
094: public String getNodeName() {
095: return "#document";
096: }
097:
098: /**
099: * Get the type of the current node.
100: * @return The node type
101: */
102: public short getNodeType() {
103: return org.w3c.dom.Node.DOCUMENT_NODE;
104: }
105:
106: /**
107: * Return the window that this page is sitting inside.
108: *
109: * @return The enclosing frame or null if this page isn't inside a frame.
110: */
111: public WebWindow getEnclosingWindow() {
112: return enclosingWindow_;
113: }
114:
115: /**
116: * Set the window that contains this page.
117: *
118: * @param window The new frame or null if this page is being removed from a frame.
119: */
120: public void setEnclosingWindow(final WebWindow window) {
121: enclosingWindow_ = window;
122: }
123:
124: /**
125: * Return the WebClient that originally loaded this page
126: *
127: * @return See above
128: */
129: public WebClient getWebClient() {
130: return webClient_;
131: }
132:
133: /**
134: * Creates an empty {@link DomDocumentFragment} object.
135: * @return a newly created {@link DomDocumentFragment}.
136: */
137: public DomDocumentFragment createDomDocumentFragment() {
138: return new DomDocumentFragment(this );
139: }
140:
141: /**
142: * {@inheritDoc}
143: */
144: public Page getNativePage() {
145: return this;
146: }
147:
148: }
|