org.w3c.dom.html.HTMLDocument Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dragome-js-jre Show documentation
Dragome SDK module: js-jre
There is a newer version: 0.96-beta4
/*
 * 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 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.
 *  The following properties have been deprecated in favor of the
 * corresponding ones for the BODY element: alinkColor background
 *  bgColor fgColor linkColor vlinkColor In DOM Level 2, the method
 * getElementById is inherited from the Document
 * interface where it was moved.
 * See also the Document Object Model (DOM) Level 2 Specification.
 */
public interface HTMLDocument extends Document
{
	/**
	 *  The title of a document as specified by the 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
	 * 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 BODY contents, returns the BODY
	 * element. In frameset documents, this returns the outermost
	 * FRAMESET element.
	 */
	public HTMLElement getBody();
	public void setBody(HTMLElement body);

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

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

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

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

	/**
	 *  A collection of all the anchor (A ) elements in a document
	 *  with a value for the name attribute. Note. For reasons
	 * of backwards compatibility, the returned set of anchors only contains
	 * those anchors created with the name  attribute, not those
	 * created with the 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,
	 * 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.
	 * 
 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 open() and forces
	 * rendering.
	 */
	public void close();

	/**
	 *  Write a string of text to a document stream opened by
	 * 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 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
	 * name value is given by elementName .
	 * @param elementName  The name attribute value for an
	 *   element.
	 * @return  The matching elements.
	 */
	public NodeList getElementsByName(String elementName);

}