286N/A/*
286N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
286N/A *
286N/A * This code is free software; you can redistribute it and/or modify it
286N/A * under the terms of the GNU General Public License version 2 only, as
286N/A * published by the Free Software Foundation. Oracle designates this
286N/A * particular file as subject to the "Classpath" exception as provided
286N/A * by Oracle in the LICENSE file that accompanied this code.
286N/A *
286N/A * This code is distributed in the hope that it will be useful, but WITHOUT
286N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
286N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
286N/A * version 2 for more details (a copy is included in the LICENSE file that
286N/A * accompanied this code).
286N/A *
286N/A * You should have received a copy of the GNU General Public License version
286N/A * 2 along with this work; if not, write to the Free Software Foundation,
286N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
286N/A *
286N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
286N/A * or visit www.oracle.com if you need additional information or have any
286N/A * questions.
286N/A */
286N/A
286N/A/*
286N/A * This file is available under and governed by the GNU General Public
286N/A * License version 2 only, as published by the Free Software Foundation.
286N/A * However, the following notice accompanied the original version of this
286N/A * file and, per its terms, should not be removed:
286N/A *
286N/A * Copyright (c) 2000 World Wide Web Consortium,
286N/A * (Massachusetts Institute of Technology, Institut National de
286N/A * Recherche en Informatique et en Automatique, Keio University). All
286N/A * Rights Reserved. This program is distributed under the W3C's Software
286N/A * Intellectual Property License. This program is distributed in the
286N/A * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
286N/A * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
286N/A * PURPOSE. See W3C License http://www.w3.org/Consortium/Legal/ for more
286N/A * details.
286N/A */
286N/A
286N/Apackage org.w3c.dom.html;
286N/A
286N/Aimport org.w3c.dom.Document;
286N/Aimport org.w3c.dom.NodeList;
286N/A
286N/A/**
286N/A * An <code>HTMLDocument</code> is the root of the HTML hierarchy and holds
286N/A * the entire content. Besides providing access to the hierarchy, it also
286N/A * provides some convenience methods for accessing certain sets of
286N/A * information from the document.
286N/A * <p> The following properties have been deprecated in favor of the
286N/A * corresponding ones for the <code>BODY</code> element: alinkColor background
286N/A * bgColor fgColor linkColor vlinkColor In DOM Level 2, the method
286N/A * <code>getElementById</code> is inherited from the <code>Document</code>
286N/A * interface where it was moved.
286N/A * <p>See also the <a href='http://www.w3.org/TR/2000/CR-DOM-Level-2-20000510'>Document Object Model (DOM) Level 2 Specification</a>.
286N/A */
286N/Apublic interface HTMLDocument extends Document {
286N/A /**
286N/A * The title of a document as specified by the <code>TITLE</code> element
286N/A * in the head of the document.
286N/A */
286N/A public String getTitle();
286N/A public void setTitle(String title);
286N/A
286N/A /**
286N/A * Returns the URI of the page that linked to this page. The value is an
286N/A * empty string if the user navigated to the page directly (not through a
286N/A * link, but, for example, via a bookmark).
286N/A */
286N/A public String getReferrer();
286N/A
286N/A /**
286N/A * The domain name of the server that served the document, or
286N/A * <code>null</code> if the server cannot be identified by a domain name.
286N/A */
286N/A public String getDomain();
286N/A
286N/A /**
286N/A * The complete URI of the document.
286N/A */
286N/A public String getURL();
286N/A
286N/A /**
286N/A * The element that contains the content for the document. In documents
286N/A * with <code>BODY</code> contents, returns the <code>BODY</code>
286N/A * element. In frameset documents, this returns the outermost
286N/A * <code>FRAMESET</code> element.
286N/A */
286N/A public HTMLElement getBody();
286N/A public void setBody(HTMLElement body);
286N/A
286N/A /**
286N/A * A collection of all the <code>IMG</code> elements in a document. The
286N/A * behavior is limited to <code>IMG</code> elements for backwards
286N/A * compatibility.
286N/A */
286N/A public HTMLCollection getImages();
286N/A
286N/A /**
286N/A * A collection of all the <code>OBJECT</code> elements that include
286N/A * applets and <code>APPLET</code> ( deprecated ) elements in a document.
286N/A */
286N/A public HTMLCollection getApplets();
286N/A
286N/A /**
286N/A * A collection of all <code>AREA</code> elements and anchor (
286N/A * <code>A</code> ) elements in a document with a value for the
286N/A * <code>href</code> attribute.
286N/A */
286N/A public HTMLCollection getLinks();
286N/A
286N/A /**
286N/A * A collection of all the forms of a document.
286N/A */
286N/A public HTMLCollection getForms();
286N/A
286N/A /**
286N/A * A collection of all the anchor (<code>A</code> ) elements in a document
286N/A * with a value for the <code>name</code> attribute. Note. For reasons
286N/A * of backwards compatibility, the returned set of anchors only contains
286N/A * those anchors created with the <code>name</code> attribute, not those
286N/A * created with the <code>id</code> attribute.
286N/A */
286N/A public HTMLCollection getAnchors();
286N/A
286N/A /**
286N/A * The cookies associated with this document. If there are none, the
286N/A * value is an empty string. Otherwise, the value is a string: a
286N/A * semicolon-delimited list of "name, value" pairs for all the cookies
286N/A * associated with the page. For example,
286N/A * <code>name=value;expires=date</code> .
286N/A */
286N/A public String getCookie();
286N/A public void setCookie(String cookie);
286N/A
286N/A /**
286N/A * Note. This method and the ones following allow a user to add to or
286N/A * replace the structure model of a document using strings of unparsed
286N/A * HTML. At the time of writing alternate methods for providing similar
286N/A * functionality for both HTML and XML documents were being considered.
286N/A * The following methods may be deprecated at some point in the future in
286N/A * favor of a more general-purpose mechanism.
286N/A * <br> Open a document stream for writing. If a document exists in the
286N/A * target, this method clears it.
286N/A */
286N/A public void open();
286N/A
286N/A /**
286N/A * Closes a document stream opened by <code>open()</code> and forces
286N/A * rendering.
286N/A */
286N/A public void close();
286N/A
286N/A /**
286N/A * Write a string of text to a document stream opened by
286N/A * <code>open()</code> . The text is parsed into the document's structure
286N/A * model.
286N/A * @param text The string to be parsed into some structure in the
286N/A * document structure model.
286N/A */
286N/A public void write(String text);
286N/A
286N/A /**
286N/A * Write a string of text followed by a newline character to a document
286N/A * stream opened by <code>open()</code> . The text is parsed into the
286N/A * document's structure model.
286N/A * @param text The string to be parsed into some structure in the
286N/A * document structure model.
286N/A */
286N/A public void writeln(String text);
286N/A
286N/A /**
286N/A * Returns the (possibly empty) collection of elements whose
286N/A * <code>name</code> value is given by <code>elementName</code> .
286N/A * @param elementName The <code>name</code> attribute value for an
286N/A * element.
286N/A * @return The matching elements.
286N/A */
286N/A public NodeList getElementsByName(String elementName);
286N/A
286N/A}