org.kde.koala
Class HTMLDocument

java.lang.Object
  extended by org.kde.koala.Node
      extended by org.kde.koala.Document
          extended by org.kde.koala.HTMLDocument
All Implemented Interfaces:
org.kde.qt.QtSupport

public class HTMLDocument
extends Document

An HTMLDocument is the root of the HTML hierarchy and holds the entire content. Beside 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: \li alinkColor \li background \li bgColor \li fgColor \li linkColor \li vlinkColor


Constructor Summary
  HTMLDocument()
           
protected HTMLDocument(java.lang.Class dummy)
           
  HTMLDocument(HTMLDocument other)
           
  HTMLDocument(KHTMLView parent)
          The parent is the widget the document should render itself in.
  HTMLDocument(Node other)
           
 
Method Summary
 HTMLCollection all()
          Not part of the DOM A collection of all the IMG, OBJECT, AREA, A, forms and anchor elements of a document.
 HTMLCollection anchors()
          A collection of all the anchor ( A ) elements in a document with a value for the name attribute.
 HTMLCollection applets()
          A collection of all the OBJECT elements that include applets and APPLET ( deprecated ) elements in a document.
 HTMLElement body()
          The element that contains the content for the document.
 void close()
          Closes a document stream opened by open() and forces rendering.
 java.lang.String completeURL(java.lang.String url)
          not part of the DOM converts the given (potentially relative) URL in a full-qualified one, using the baseURL / document URL for the missing parts.
 java.lang.String cookie()
          The cookies associated with this document.
 java.lang.String domain()
          The domain name of the server that served the document, or a null string if the server cannot be identified by a domain name.
 HTMLCollection forms()
          A collection of all the forms of a document.
 java.util.ArrayList getElementsByName(java.lang.String elementName)
          Returns the (possibly empty) collection of elements whose name value is given by elementName .
 HTMLCollection images()
          A collection of all the IMG elements in a document.
 java.lang.String lastModified()
          Not part of the DOM The date the document was last modified.
 HTMLCollection layers()
          A collection of all the layers of a document.
 HTMLCollection links()
          A collection of all AREA elements and anchor ( A ) elements in a document with a value for the href attribute.
 void open()
          Note.
 java.lang.String referrer()
          Returns the URI of the page that linked to this page.
 void setBody(HTMLElement arg1)
          see body
 void setCookie(java.lang.String arg1)
          see cookie
 void setTitle(java.lang.String arg1)
          see title
 java.lang.String title()
          The title of a document as specified by the TITLE element in the head of the document.
 java.lang.String URL()
          The absolute URI of the document.
 void write(java.lang.String text)
          Write a string of text to a document stream opened by open() .
 void writeln(java.lang.String text)
          Write a string of text followed by a newline character to a document stream opened by open() .
 
Methods inherited from class org.kde.koala.Document
abort, addStyleSheet, async, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createEvent, createNodeIterator, createProcessingInstruction, createRange, createTextNode, createTreeWalker, defaultView, designMode, doctype, documentElement, getElementById, getElementsByTagName, getElementsByTagNameNS, getOverrideStyle, implementation, importNode, isHTMLDocument, load, loadXML, preferredStylesheetSet, removeStyleSheet, selectedStylesheetSet, setAsync, setDesignMode, setSelectedStylesheetSet, styleSheets, toString, updateRendering, view
 
Methods inherited from class org.kde.koala.Node
addEventListener, appendChild, applyChanges, attributes, childNodes, cloneNode, dispatchEvent, elementId, firstChild, getRect, hasAttributes, hasChildNodes, index, insertBefore, isNull, isSupported, lastChild, localName, namespaceURI, nextSibling, nodeName, nodeType, nodeValue, normalize, op_equals, op_not_equals, ownerDocument, parentNode, prefix, previousSibling, removeChild, removeEventListener, replaceChild, setNodeValue, setPrefix
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

HTMLDocument

protected HTMLDocument(java.lang.Class dummy)

HTMLDocument

public HTMLDocument()

HTMLDocument

public HTMLDocument(KHTMLView parent)
The parent is the widget the document should render itself in. Rendering information (like sizes, etc...) is only created if parent != 0


HTMLDocument

public HTMLDocument(HTMLDocument other)

HTMLDocument

public HTMLDocument(Node other)
Method Detail

title

public java.lang.String title()
The title of a document as specified by the TITLE element in the head of the document.


setTitle

public void setTitle(java.lang.String arg1)
see title


referrer

public java.lang.String referrer()
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).


domain

public java.lang.String domain()
The domain name of the server that served the document, or a null string if the server cannot be identified by a domain name.


URL

public java.lang.String URL()
The absolute URI of the document.


body

public HTMLElement body()
The element that contains the content for the document. In documents with BODY contents, returns the BODY element, and in frameset documents, this returns the outermost FRAMESET element.


setBody

public void setBody(HTMLElement arg1)
see body


images

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


applets

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


links

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


forms

public HTMLCollection forms()
A collection of all the forms of a document.


layers

public HTMLCollection layers()
A collection of all the layers of a document.


anchors

public HTMLCollection anchors()
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.


cookie

public java.lang.String cookie()
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 .


setCookie

public void setCookie(java.lang.String arg1)
see cookie


open

public void open()
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.


close

public void close()
Closes a document stream opened by open() and forces rendering.


write

public void write(java.lang.String text)
Write a string of text to a document stream opened by open() . The text is parsed into the document's structure model.

Parameters:
text - The string to be parsed into some structure in the document structure model.

writeln

public void writeln(java.lang.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.

Parameters:
text - The string to be parsed into some structure in the document structure model.

getElementsByName

public java.util.ArrayList getElementsByName(java.lang.String elementName)
Returns the (possibly empty) collection of elements whose name value is given by elementName .

Parameters:
elementName - The name attribute value for an element.
Returns:
The matching elements.

completeURL

public java.lang.String completeURL(java.lang.String url)
not part of the DOM converts the given (potentially relative) URL in a full-qualified one, using the baseURL / document URL for the missing parts.

Overrides:
completeURL in class Document

lastModified

public java.lang.String lastModified()
Not part of the DOM The date the document was last modified.


all

public HTMLCollection all()
Not part of the DOM A collection of all the IMG, OBJECT, AREA, A, forms and anchor elements of a document.