org.kde.koala
Class Document

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

public class Document
extends Node

The Document interface represents the entire HTML or XML document. Conceptually, it is the root of the document tree, and provides the primary access to the document's data. Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of a Document , the Document interface also contains the factory methods needed to create these objects. The Node objects created have a ownerDocument attribute which associates them with the Document within whose context they were created.


Constructor Summary
  Document()
           
  Document(boolean arg1)
          don't create an implementation if false use at own risk
protected Document(java.lang.Class dummy)
           
  Document(Document other)
           
  Document(Node other)
           
 
Method Summary
 void abort()
          Introduced in DOM Level 3 This method is from the DocumentLS interface If the document is currently being loaded as a result of the method load being invoked the loading and parsing is immediately aborted.
 void addStyleSheet(StyleSheet sheet)
          Adds a new style sheet to the list of style sheets.
 boolean async()
          Introduced in DOM Level 3 This method is from the DocumentLS interface Indicates whether the method DocumentLS.load() should be synchronous or asynchronous.
 java.lang.String completeURL(java.lang.String url)
          not part of the DOM completes a given URL
 Attr createAttribute(java.lang.String name)
          Creates an Attr of the given name.
 Attr createAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName)
          Introduced in DOM Level 2 Creates an attribute of the given qualified name and namespace URI.
 CDATASection createCDATASection(java.lang.String data)
          Creates a CDATASection node whose value is the specified string.
 Comment createComment(java.lang.String data)
          Creates a Comment node given the specified string.
 DocumentFragment createDocumentFragment()
          Creates an empty DocumentFragment object.
 Element createElement(java.lang.String tagName)
          Creates an element of the type specified.
 Element createElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName)
          Introduced in DOM Level 2 Creates an element of the given qualified name and namespace URI.
 EntityReference createEntityReference(java.lang.String name)
          Creates an EntityReference object.
 Event createEvent(java.lang.String eventType)
          Introduced in DOM Level 2 This method is from the DocumentEvent interface The createEvent method is used in creating Events when it is either inconvenient or unnecessary for the user to create an Event themselves.
 NodeIterator createNodeIterator(Node root, long whatToShow, NodeFilter filter, boolean entityReferenceExpansion)
          Introduced in DOM Level 2 This method is from the DocumentTraversal interface Create a new NodeIterator over the subtree rooted at the specified node.
 ProcessingInstruction createProcessingInstruction(java.lang.String target, java.lang.String data)
          Creates a ProcessingInstruction node given the specified name and data strings.
 Range createRange()
          Introduced in DOM Level 2 This method is from the DocumentRange interface
 Text createTextNode(java.lang.String data)
          Creates a Text node given the specified string.
 TreeWalker createTreeWalker(Node root, long whatToShow, NodeFilter filter, boolean entityReferenceExpansion)
          Introduced in DOM Level 2 This method is from the DocumentTraversal interface Create a new TreeWalker over the subtree rooted at the specified node.
 AbstractView defaultView()
          Introduced in DOM Level 2 This method is from the DocumentView interface The default AbstractView for this Document, or null if none available.
 boolean designMode()
          not part of the official DOM Documents are read-only by default, but they can be made editable by entering "design mode".
 DocumentType doctype()
          The Document Type Declaration (see DocumentType ) associated with this document.
 Element documentElement()
          This is a convenience attribute that allows direct access to the child node that is the root element of the document.
 Element getElementById(java.lang.String elementId)
          Moved from HTMLDocument in DOM Level 2 Returns the Element whose id is given by elementId.
 java.util.ArrayList getElementsByTagName(java.lang.String tagname)
          No Exceptions.
 java.util.ArrayList getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName)
          Introduced in DOM Level 2 No Exceptions Returns an ArrayList of all the Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of the Document tree.
 CSSStyleDeclaration getOverrideStyle(Element elt, java.lang.String pseudoElt)
          Introduced in DOM Level 2 This method is from the DocumentCSS interface This method is used to retrieve the override style declaration for a specified element and a specified pseudo-element.
 DOMImplementation implementation()
          The DOMImplementation object that handles this document.
 Node importNode(Node importedNode, boolean deep)
          Introduced in DOM Level 2 Imports a node from another document to this document.
 boolean isHTMLDocument()
          not part of the DOM
 void load(java.lang.String uri)
          Introduced in DOM Level 3 This method is from the DocumentLS interface Replaces the content of the document with the result of parsing the given URI.
 void loadXML(java.lang.String source)
          Introduced in DOM Level 3 This method is from the DocumentLS interface Replace the content of the document with the result of parsing the input string, this method is always synchronous.
 java.lang.String preferredStylesheetSet()
          CSS3 mechanism for selecting alternate stylesheets using the DOM.
 void removeStyleSheet(StyleSheet sheet)
          Removes a style sheet to the list of style sheets.
 java.lang.String selectedStylesheetSet()
           
 void setAsync(boolean arg1)
          Introduced in DOM Level 3 This method is from the DocumentLS interface see async
 void setDesignMode(boolean enable)
          not part of the official DOM
 void setSelectedStylesheetSet(java.lang.String aString)
           
 java.util.ArrayList styleSheets()
          Introduced in DOM Level 2 This method is from the DocumentStyle interface A list containing all the style sheets explicitly linked into or embedded in a document.
 java.lang.String toString()
           
 void updateRendering()
          not part of the DOM Updates the rendered display after one or more changes to the DOM structure
 KHTMLView 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

Document

protected Document(java.lang.Class dummy)

Document

public Document()

Document

public Document(boolean arg1)
don't create an implementation if false use at own risk


Document

public Document(Document other)

Document

public Document(Node other)
Method Detail

doctype

public DocumentType doctype()
The Document Type Declaration (see DocumentType ) associated with this document. For HTML documents as well as XML documents without a document type declaration this returns null . The DOM Level 1 does not support editing the Document Type Declaration, therefore docType cannot be altered in any way.


implementation

public DOMImplementation implementation()
The DOMImplementation object that handles this document. A DOM application may use objects from multiple implementations.


documentElement

public Element documentElement()
This is a convenience attribute that allows direct access to the child node that is the root element of the document. For HTML documents, this is the element with the tagName "HTML".


createElement

public Element createElement(java.lang.String tagName)
Creates an element of the type specified. Note that the instance returned implements the Element interface, so attributes can be specified directly on the returned object.

Parameters:
tagName - The name of the element type to instantiate. For XML, this is case-sensitive. For HTML, the tagName parameter may be provided in any case, but it must be mapped to the canonical uppercase form by the DOM implementation.
Returns:
A new Element object.

createElementNS

public Element createElementNS(java.lang.String namespaceURI,
                               java.lang.String qualifiedName)
Introduced in DOM Level 2 Creates an element of the given qualified name and namespace URI.

Parameters:
namespaceURI - The namespace URI of the element to create.
qualifiedName - The qualified name of the element type to instantiate.
Returns:
A new Element object with the following attributes:

createDocumentFragment

public DocumentFragment createDocumentFragment()
Creates an empty DocumentFragment object.

Returns:
A new DocumentFragment .

createTextNode

public Text createTextNode(java.lang.String data)
Creates a Text node given the specified string.

Parameters:
data - The data for the node.
Returns:
The new Text object.

createComment

public Comment createComment(java.lang.String data)
Creates a Comment node given the specified string.

Parameters:
data - The data for the node.
Returns:
The new Comment object.

createCDATASection

public CDATASection createCDATASection(java.lang.String data)
Creates a CDATASection node whose value is the specified string.

Parameters:
data - The data for the CDATASection contents.
Returns:
The new CDATASection object.

createProcessingInstruction

public ProcessingInstruction createProcessingInstruction(java.lang.String target,
                                                         java.lang.String data)
Creates a ProcessingInstruction node given the specified name and data strings.

Parameters:
target - The target part of the processing instruction.
data - The data for the node. NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
Returns:
The new ProcessingInstruction object.

createAttribute

public Attr createAttribute(java.lang.String name)
Creates an Attr of the given name. Note that the Attr instance can then be set on an Element using the setAttribute method.

Parameters:
name - The name of the attribute.
Returns:
A new Attr object.

createAttributeNS

public Attr createAttributeNS(java.lang.String namespaceURI,
                              java.lang.String qualifiedName)
Introduced in DOM Level 2 Creates an attribute of the given qualified name and namespace URI. HTML-only DOM implementations do not need to implement this method.

Parameters:
namespaceURI - The namespace URI of the attribute to create.
qualifiedName - The qualified name of the attribute to instantiate.
Returns:
A new Attr object with the following attributes: Node.nodeName - qualifiedName Node.namespaceURI - namespaceURI Node.prefix - prefix, extracted from qualifiedName, or null if there is no prefix Node.localName - local name, extracted from qualifiedName Attr.name - qualifiedName Node.nodeValue - the empty string

createEntityReference

public EntityReference createEntityReference(java.lang.String name)
Creates an EntityReference object.

Parameters:
name - The name of the entity to reference. NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
Returns:
The new EntityReference object.

getElementById

public Element getElementById(java.lang.String elementId)
Moved from HTMLDocument in DOM Level 2 Returns the Element whose id is given by elementId. If no such element exists, returns null . Behavior is not defined if more than one element has this id .

Parameters:
elementId - The unique id value for an element.
Returns:
The matching element.

getElementsByTagName

public java.util.ArrayList getElementsByTagName(java.lang.String tagname)
No Exceptions. Returns a ArrayList of all the Element 's with a given tag name in the order in which they would be encountered in a preorder traversal of the Document tree.

Parameters:
tagname - The name of the tag to match on. The special value "*" matches all tags.
Returns:
A new NodeList object containing all the matched Element s.

getElementsByTagNameNS

public java.util.ArrayList getElementsByTagNameNS(java.lang.String namespaceURI,
                                                  java.lang.String localName)
Introduced in DOM Level 2 No Exceptions Returns an ArrayList of all the Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of the Document tree.

Parameters:
namespaceURI - The namespace URI of the elements to match on. The special value "*" matches all namespaces.
localName - The local name of the elements to match on. The special value "*" matches all local names.
Returns:
A new NodeList object containing all the matched Elements.

importNode

public Node importNode(Node importedNode,
                       boolean deep)
Introduced in DOM Level 2 Imports a node from another document to this document. The returned node has no parent; (parentNode is null). The source node is not altered or removed from the original document; this method creates a new copy of the source node. For all nodes, importing a node creates a node object owned by the importing document, with attribute values identical to the source node's nodeName and nodeType, plus the attributes related to namespaces (prefix, localName, and namespaceURI). As in the cloneNode operation on a Node, the source node is not altered. Additional information is copied as appropriate to the nodeType, attempting to mirror the behavior expected if a fragment of XML or HTML source was copied from one document to another, recognizing that the two documents may have different DTDs in the XML case. The following list describes the specifics for each type of node. ATTRIBUTE_NODE The ownerElement attribute is set to null and the specified flag is set to true on the generated Attr. The descendants of the source Attr are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Note that the deep parameter has no effect on Attr nodes; they always carry their children with them when imported. DOCUMENT_FRAGMENT_NODE If the deep option was set to true, the descendants of the source element are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Otherwise, this simply generates an empty DocumentFragment. DOCUMENT_NODE Document nodes cannot be imported. DOCUMENT_TYPE_NODE DocumentType nodes cannot be imported. ELEMENT_NODE Specified attribute nodes of the source element are imported, and the generated Attr nodes are attached to the generated Element. Default attributes are not copied, though if the document being imported into defines default attributes for this element name, those are assigned. If the importNode deep parameter was set to true, the descendants of the source element are recursively imported and the resulting nodes reassembled to form the corresponding subtree. ENTITY_NODE Entity nodes can be imported, however in the current release of the DOM the DocumentType is readonly. Ability to add these imported nodes to a DocumentType will be considered for addition to a future release of the DOM. On import, the publicId, systemId, and notationName attributes are copied. If a deep import is requested, the descendants of the the source Entity are recursively imported and the resulting nodes reassembled to form the corresponding subtree. ENTITY_REFERENCE_NODE Only the EntityReference itself is copied, even if a deep import is requested, since the source and destination documents might have defined the entity differently. If the document being imported into provides a definition for this entity name, its value is assigned. NOTATION_NODE Notation nodes can be imported, however in the current release of the DOM the DocumentType is readonly. Ability to add these imported nodes to a DocumentType will be considered for addition to a future release of the DOM. On import, the publicId and systemId attributes are copied. Note that the deep parameter has no effect on Notation nodes since they never have any children. PROCESSING_INSTRUCTION_NODE The imported node copies its target and data values from those of the source node. TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE These three types of nodes inheriting from CharacterData copy their data and length attributes from those of the source node.

Parameters:
importedNode - The node to import.
deep - If true, recursively import the subtree under the specified node; if false, import only the node itself, as explained above. This has no effect on Attr, EntityReference, and Notation nodes.
Returns:
The imported node that belongs to this Document.

isHTMLDocument

public boolean isHTMLDocument()
not part of the DOM


createRange

public Range createRange()
Introduced in DOM Level 2 This method is from the DocumentRange interface

Returns:
Range The initial state of the Range returned from this method is such that both of its boundary-points are positioned at the beginning of the corresponding Document, before any content. The Range returned can only be used to select content associated with this Document, or with DocumentFragments and Attrs for which this Document is the ownerDocument.

createNodeIterator

public NodeIterator createNodeIterator(Node root,
                                       long whatToShow,
                                       NodeFilter filter,
                                       boolean entityReferenceExpansion)
Introduced in DOM Level 2 This method is from the DocumentTraversal interface Create a new NodeIterator over the subtree rooted at the specified node.

Parameters:
root - The node which will be iterated together with its children. The iterator is initially positioned just before this node. The whatToShow flags and the filter, if any, are not considered when setting this position. The root must not be null.
whatToShow - This flag specifies which node types may appear in the logical view of the tree presented by the iterator. See the description of NodeFilter for the set of possible SHOW_ values. These flags can be combined using OR.
filter - The NodeFilter to be used with this NodeIterator, or null to indicate no filter.
entityReferenceExpansion - The value of this flag determines whether entity reference nodes are expanded.
Returns:
NodeIterator The newly created NodeIterator.

createTreeWalker

public TreeWalker createTreeWalker(Node root,
                                   long whatToShow,
                                   NodeFilter filter,
                                   boolean entityReferenceExpansion)
Introduced in DOM Level 2 This method is from the DocumentTraversal interface Create a new TreeWalker over the subtree rooted at the specified node.

Parameters:
root - The node which will serve as the root for the TreeWalker. The whatToShow flags and the NodeFilter are not considered when setting this value; any node type will be accepted as the root. The currentNode of the TreeWalker is initialized to this node, whether or not it is visible. The root functions as a stopping point for traversal methods that look upward in the document structure, such as parentNode and nextNode. The root must not be null.
whatToShow - This flag specifies which node types may appear in the logical view of the tree presented by the tree-walker. See the description of NodeFilter for the set of possible SHOW_ values. These flags can be combined using OR.
filter - The NodeFilter to be used with this TreeWalker, or null to indicate no filter.
entityReferenceExpansion - If this flag is false, the contents of EntityReference nodes are not presented in the logical view.
Returns:
The newly created TreeWalker.

createEvent

public Event createEvent(java.lang.String eventType)
Introduced in DOM Level 2 This method is from the DocumentEvent interface The createEvent method is used in creating Events when it is either inconvenient or unnecessary for the user to create an Event themselves. In cases where the implementation provided Event is insufficient, users may supply their own Event implementations for use with the dispatchEvent method.

Parameters:
eventType - The eventType parameter specifies the type of Event interface to be created. If the Event interface specified is supported by the implementation this method will return a new Event of the interface type requested. If the Event is to be dispatched via the dispatchEvent method the appropriate event init method must be called after creation in order to initialize the Event's values. As an example, a user wishing to synthesize some kind of UIEvent would call createEvent with the parameter "UIEvents". The initUIEvent method could then be called on the newly created UIEvent to set the specific type of UIEvent to be dispatched and set its context information.
Returns:
The newly created EventExceptions

defaultView

public AbstractView defaultView()
Introduced in DOM Level 2 This method is from the DocumentView interface The default AbstractView for this Document, or null if none available.


styleSheets

public java.util.ArrayList styleSheets()
Introduced in DOM Level 2 This method is from the DocumentStyle interface A list containing all the style sheets explicitly linked into or embedded in a document. For HTML documents, this includes external style sheets, included via the HTML LINK element, and inline STYLE elements. In XML, this includes external style sheets, included via style sheet processing instructions (see [XML-StyleSheet]).


preferredStylesheetSet

public java.lang.String preferredStylesheetSet()
CSS3 mechanism for selecting alternate stylesheets using the DOM. Might change without further notice.


selectedStylesheetSet

public java.lang.String selectedStylesheetSet()

setSelectedStylesheetSet

public void setSelectedStylesheetSet(java.lang.String aString)

addStyleSheet

public void addStyleSheet(StyleSheet sheet)
Adds a new style sheet to the list of style sheets. The new style sheet will be applied after all author and implicit style sheets, but before the user style sheet. Create new style sheets with e. g. DOMImplementation.createCSSStyleSheet This is not part of the official DOM.

Parameters:
sheet - style sheet

removeStyleSheet

public void removeStyleSheet(StyleSheet sheet)
Removes a style sheet to the list of style sheets. Only sheets added by addStyleSheet may be removed. This is not part of the official DOM.

Parameters:
sheet - style sheet to remove

view

public KHTMLView view()
Returns:
The KHTML view widget of this document.

getOverrideStyle

public CSSStyleDeclaration getOverrideStyle(Element elt,
                                            java.lang.String pseudoElt)
Introduced in DOM Level 2 This method is from the DocumentCSS interface This method is used to retrieve the override style declaration for a specified element and a specified pseudo-element.

Parameters:
elt - The element whose style is to be modified. This parameter cannot be null.
pseudoElt - The pseudo-element or null if none.
Returns:
The override style declaration.

async

public boolean async()
Introduced in DOM Level 3 This method is from the DocumentLS interface Indicates whether the method DocumentLS.load() should be synchronous or asynchronous. When the async attribute is set to true the load method returns control to the caller before the document has completed loading. The default value of this attribute is true.


setAsync

public void setAsync(boolean arg1)
Introduced in DOM Level 3 This method is from the DocumentLS interface see async


abort

public void abort()
Introduced in DOM Level 3 This method is from the DocumentLS interface If the document is currently being loaded as a result of the method load being invoked the loading and parsing is immediately aborted. The possibly partial result of parsing the document is discarded and the document is cleared.


load

public void load(java.lang.String uri)
Introduced in DOM Level 3 This method is from the DocumentLS interface Replaces the content of the document with the result of parsing the given URI. Invoking this method will either block the caller or return to the caller immediately depending on the value of the async attribute. Once the document is fully loaded a "load" event (as defined in [DOM Level 3 Events], except that the Event.targetNode will be the document, not an element) will be dispatched on the document. If an error occurs, an implementation dependent "error" event will be dispatched on the document. If this method is called on a document that is currently loading, the current load is interrupted and the new URI load is initiated. When invoking this method the parameters used in the DOMParser interface are assumed to have their default values with the exception that the parameters "entities", "normalize-characters", "check-character-normalization" are set to "false". The result of a call to this method is the same the result of a call to DOMParser.parseWithContext with an input stream referencing the URI that was passed to this call, the document as the context node, and the action ACTION_REPLACE_CHILDREN.

Parameters:
uri - of type DOMString The URI reference for the XML file to be loaded. If this is a relative URI, the base URI used by the implementation is implementation dependent.

loadXML

public void loadXML(java.lang.String source)
Introduced in DOM Level 3 This method is from the DocumentLS interface Replace the content of the document with the result of parsing the input string, this method is always synchronous. This method always parses from a DOMString, which means the data is always UTF-16. All other encoding information is ignored. The parameters used in the DOMParser interface are assumed to have their default values when invoking this method. The result of a call to this method is the same as the result of a call to DOMParser.parseWithContext with an input stream containing the string passed to this call, the document as the context node, and the action ACTION_REPLACE_CHILDREN.

Parameters:
source - A string containing an XML document.

designMode

public boolean designMode()
not part of the official DOM Documents are read-only by default, but they can be made editable by entering "design mode".

Returns:
whether this document is in design mode.

setDesignMode

public void setDesignMode(boolean enable)
not part of the official DOM

Parameters:
enable - true to enable design mode, false to disable.
See Also:
designMode()

completeURL

public java.lang.String completeURL(java.lang.String url)
not part of the DOM completes a given URL


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

updateRendering

public void updateRendering()
not part of the DOM Updates the rendered display after one or more changes to the DOM structure