org.kde.koala

Class HTMLDocument

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

UNKNOWN: An HTMLDocument is the root of the HTML hierarchy and holds the entire content.

Constructor Summary
protected HTMLDocument(Class dummy)
HTMLDocument()
HTMLDocument(KHTMLView parent)
The parent is the widget the document should render itself in.
HTMLDocument(HTMLDocument other)
HTMLDocument(Node other)
Method Summary
HTMLCollectionall()
Not part of the DOM A collection of all the IMG, OBJECT, AREA, A, forms and anchor elements of a document.
HTMLCollectionanchors()
A collection of all the anchor ( A ) elements in a document with a value for the name attribute.
HTMLCollectionapplets()
A collection of all the OBJECT elements that include applets and APPLET ( deprecated ) elements in a document.
HTMLElementbody()
The element that contains the content for the document.
voidclose()
Closes a document stream opened by open() and forces rendering.
StringcompleteURL(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.
Stringcookie()
The cookies associated with this document.
Stringdomain()
The domain name of the server that served the document, or a null string if the server cannot be identified by a domain name.
HTMLCollectionforms()
A collection of all the forms of a document.
ArrayListgetElementsByName(String elementName)
Returns the (possibly empty) collection of elements whose name value is given by elementName .
HTMLCollectionimages()
A collection of all the IMG elements in a document.
StringlastModified()
Not part of the DOM The date the document was last modified.
HTMLCollectionlayers()
A collection of all the layers of a document.
HTMLCollectionlinks()
A collection of all AREA elements and anchor ( A ) elements in a document with a value for the href attribute.
voidopen()
Note.
Stringreferrer()
Returns the URI of the page that linked to this page.
voidsetBody(HTMLElement arg1)
see body
voidsetCookie(String arg1)
see cookie
voidsetTitle(String arg1)
see title
Stringtitle()
The title of a document as specified by the TITLE element in the head of the document.
StringURL()
The absolute URI of the document.
voidwrite(String text)
Write a string of text to a document stream opened by open() .
voidwriteln(String text)
Write a string of text followed by a newline character to a document stream opened by open() .

Constructor Detail

HTMLDocument

protected HTMLDocument(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

UNKNOWN: The parent is the widget the document should render itself in.

HTMLDocument

public HTMLDocument(HTMLDocument other)

HTMLDocument

public HTMLDocument(Node other)

Method Detail

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.

UNKNOWN: Not part of the DOM

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.

UNKNOWN: A collection of all the anchor ( A ) elements in a document with a value for the name attribute.

applets

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

UNKNOWN: A collection of all the OBJECT elements that include applets and APPLET ( deprecated ) elements in a 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.

UNKNOWN: The element that contains the content for the document.

close

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

UNKNOWN: Closes a document stream opened by open() and forces rendering.

completeURL

public String completeURL(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.

UNKNOWN: not part of the DOM

cookie

public 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 .

UNKNOWN: The cookies associated with this document.

domain

public 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.

UNKNOWN: The domain name of the server that served the document, or a null string if the server cannot be identified by a domain name.

forms

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

UNKNOWN: A collection of all the forms of a document.

getElementsByName

public ArrayList getElementsByName(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.

UNKNOWN: Returns the (possibly empty) collection of elements whose name value is given by elementName .

images

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

UNKNOWN: A collection of all the IMG elements in a document.

lastModified

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

UNKNOWN: Not part of the DOM

layers

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

UNKNOWN: A collection of all the layers of 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.

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

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.

UNKNOWN: Note.

referrer

public 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).

UNKNOWN: Returns the URI of the page that linked to this page.

setBody

public void setBody(HTMLElement arg1)
see body

UNKNOWN: see body

setCookie

public void setCookie(String arg1)
see cookie

UNKNOWN: see cookie

setTitle

public void setTitle(String arg1)
see title

UNKNOWN: see title

title

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

UNKNOWN: The title of a document as specified by the TITLE element in the head of the document.

URL

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

UNKNOWN: The absolute URI of the document.

write

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

UNKNOWN: Write a string of text to a document stream opened by open() .

writeln

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

UNKNOWN: Write a string of text followed by a newline character to a document stream opened by open() .