Java example source code file (HTMLDocument.java)

This example Java source code file (HTMLDocument.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

document, dom, htmlcollection, htmldocument, htmlelement, nodelist, string

The HTMLDocument.java Java example source code

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/*
 * This file is available under and governed by the GNU General Public
 * License version 2 only, as published by the Free Software Foundation.
 * However, the following notice accompanied the original version of this
 * file and, per its terms, should not be removed:
 *
 * Copyright (c) 2000 World Wide Web Consortium,
 * (Massachusetts Institute of Technology, Institut National de
 * Recherche en Informatique et en Automatique, Keio University). All
 * Rights Reserved. This program is distributed under the W3C's Software
 * Intellectual Property License. This program is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE. See W3C License http://www.w3.org/Consortium/Legal/ for more
 * details.
 */

package org.w3c.dom.html;

import org.w3c.dom.Document;
import org.w3c.dom.NodeList;

/**
 *  An <code>HTMLDocument is the root of the HTML hierarchy and holds
 * the entire content. Besides providing access to the hierarchy, it also
 * provides some convenience methods for accessing certain sets of
 * information from the document.
 * <p> The following properties have been deprecated in favor of the
 * corresponding ones for the <code>BODY element: alinkColor background
 *  bgColor fgColor linkColor vlinkColor In DOM Level 2, the method
 * <code>getElementById is inherited from the Document
 * interface where it was moved.
 * <p>See also the Document Object Model (DOM) Level 2 Specification.
 */
public interface HTMLDocument extends Document {
    /**
     *  The title of a document as specified by the <code>TITLE element
     * in the head of the document.
     */
    public String getTitle();
    public void setTitle(String title);

    /**
     *  Returns the URI  of the page that linked to this page. The value is an
     * empty string if the user navigated to the page directly (not through a
     * link, but, for example, via a bookmark).
     */
    public String getReferrer();

    /**
     *  The domain name of the server that served the document, or
     * <code>null if the server cannot be identified by a domain name.
     */
    public String getDomain();

    /**
     *  The complete URI  of the document.
     */
    public String getURL();

    /**
     *  The element that contains the content for the document. In documents
     * with <code>BODY contents, returns the BODY
     * element. In frameset documents, this returns the outermost
     * <code>FRAMESET element.
     */
    public HTMLElement getBody();
    public void setBody(HTMLElement body);

    /**
     *  A collection of all the <code>IMG elements in a document. The
     * behavior is limited to <code>IMG elements for backwards
     * compatibility.
     */
    public HTMLCollection getImages();

    /**
     *  A collection of all the <code>OBJECT elements that include
     * applets and <code>APPLET ( deprecated ) elements in a document.
     */
    public HTMLCollection getApplets();

    /**
     *  A collection of all <code>AREA elements and anchor (
     * <code>A ) elements in a document with a value for the
     * <code>href attribute.
     */
    public HTMLCollection getLinks();

    /**
     *  A collection of all the forms of a document.
     */
    public HTMLCollection getForms();

    /**
     *  A collection of all the anchor (<code>A ) elements in a document
     *  with a value for the <code>name attribute. Note. For reasons
     * of backwards compatibility, the returned set of anchors only contains
     * those anchors created with the <code>name  attribute, not those
     * created with the <code>id attribute.
     */
    public HTMLCollection getAnchors();

    /**
     *  The cookies associated with this document. If there are none, the
     * value is an empty string. Otherwise, the value is a string: a
     * semicolon-delimited list of "name, value" pairs for all the cookies
     * associated with the page. For example,
     * <code>name=value;expires=date .
     */
    public String getCookie();
    public void setCookie(String cookie);

    /**
     *  Note. This method and the ones following  allow a user to add to or
     * replace the structure model of a document using strings of unparsed
     * HTML. At the time of  writing alternate methods for providing similar
     * functionality for  both HTML and XML documents were being considered.
     * The following methods may be deprecated at some point in the future in
     * favor of a more general-purpose mechanism.
     * <br> Open a document stream for writing. If a document exists in the
     * target, this method clears it.
     */
    public void open();

    /**
     *  Closes a document stream opened by <code>open() and forces
     * rendering.
     */
    public void close();

    /**
     *  Write a string of text to a document stream opened by
     * <code>open() . The text is parsed into the document's structure
     * model.
     * @param text  The string to be parsed into some structure in the
     *   document structure model.
     */
    public void write(String text);

    /**
     *  Write a string of text followed by a newline character to a document
     * stream opened by <code>open() . The text is parsed into the
     * document's structure model.
     * @param text  The string to be parsed into some structure in the
     *   document structure model.
     */
    public void writeln(String text);

    /**
     *  Returns the (possibly empty) collection of elements whose
     * <code>name value is given by elementName .
     * @param elementName  The <code>name attribute value for an
     *   element.
     * @return  The matching elements.
     */
    public NodeList getElementsByName(String elementName);

}