cat.inspiracio.html

Class HTMLDocumentImp

java.lang.Object

org.apache.xerces.dom.NodeImpl

org.apache.xerces.dom.ChildNode

org.apache.xerces.dom.ParentNode

org.apache.xerces.dom.CoreDocumentImpl

org.apache.xerces.dom.DocumentImpl

cat.inspiracio.html.HTMLDocumentImp

All Implemented Interfaces:

ScriptMap<HTMLElement>, Serializable, Cloneable, Document, DocumentEvent, EventTarget, org.w3c.dom.html.HTMLDocument, Node, NodeList, org.w3c.dom.ranges.DocumentRange, org.w3c.dom.traversal.DocumentTraversal

Direct Known Subclasses:

Document

public class HTMLDocumentImp
extends org.apache.xerces.dom.DocumentImpl
implements HTMLDocument, Serializable

The class is public only so that we can extend it.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.xerces.dom.DocumentImpl

eventListeners, iteratorReferenceQueue, iterators, mutationEvents, rangeReferenceQueue, ranges

Fields inherited from class org.apache.xerces.dom.CoreDocumentImpl

actualEncoding, allowGrammarAccess, changes, docElement, docType, encoding, errorChecking, fDocumentURI, identifiers, standalone, userData, version, xmlVersionChanged

Fields inherited from class org.apache.xerces.dom.ParentNode

firstChild, fNodeListCache, ownerDocument

Fields inherited from class org.apache.xerces.dom.ChildNode

nextSibling, previousSibling

Fields inherited from class org.apache.xerces.dom.NodeImpl

DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HTMLDocumentImp() Protected: outside this package, only subclasses can instantiate.

Method Summary

Modifier and Type	Method and Description
Node	appendChild(Node newChild) First adopts the new child, then appends it.
HTMLDocumentImp	cloneNode(boolean deep)
void	close()
protected void	copy(HTMLDocumentImp from, boolean deep) Copy fields from a document to this document.
Attr	createAttribute(String name)
<T extends HTMLElement> T	createElement(Class<T> c) Create an element of this class.
HTMLElement	createElement(String tag) Overrides org.apache.html.dom.HTMLDocumentImpl#createElement(java.lang.String)
Element	createElementNS(String namespaceURI, String qualifiedName) The HTML5 parser calls here, and this method delegates to createElement(tag) so that we really get an HTMLElement.
Element	createElementNS(String namespaceURI, String qualifiedName, String localpart)
void	deleter(String name) Deletes a named element.
boolean	execCommand(String commandId)
boolean	execCommand(String commandId, boolean showId)
boolean	execCommand(String commandId, boolean showId, String value)
HTMLElement	get(String name) Gets an element by name.
Element	getActiveElement()
org.w3c.dom.html.HTMLCollection	getAnchors() Not implemented.
org.w3c.dom.html.HTMLCollection	getApplets() Not implemented.
HTMLBodyElement	getBody() Returns null if there is no body.
String	getCookie()
WindowProxy	getDefaultView()
String	getDesignMode()
String	getDir()
HTMLHtmlElement	getDocumentElement() Returns null if there is no html element yet.
String	getDomain()
HTMLElement	getElementById(String id)
HTMLElement	getElementByTagName(String tag) Convenience: gets the first element with that tag, or null if there are none.
HTMLCollection<HTMLElement>	getElementsByName(String name)
NodeList	getElementsByTagName(String tag)
NodeList	getElementsByTagNameNS(String namespace, String key)
HTMLCollection<HTMLEmbedElement>	getEmbeds()
HTMLCollection<HTMLFormElement>	getForms()
HTMLHeadElement	getHead() Returns null if there is no head element yet.
HTMLHtmlElement	getHtml() Returns null if there is no html element yet.
HTMLCollection<HTMLImageElement>	getImages()
String	getLastModified()
HTMLCollection<HTMLElement>	getLinks() a-elements with href and area-elements with href, in tree order
Location	getLocation() Just returns the last location that was set.
EventHandler	getOnreadystatechange() Not implemented.
HTMLCollection<HTMLEmbedElement>	getPlugins()
DocumentReadyState	getReadyState() Not implemented.
String	getReferrer()
HTMLCollection<HTMLScriptElement>	getScripts()
String	getTitle() Gets the text within the first title element within head element, or null.
String	getURL() Not implemented.
boolean	has(String name) Has the document got an element with this name?
boolean	hasFocus()
Node	insertBefore(Node newChild, Node refChild) First adopts the new child, then inserts it.
void	open() Not implemented.
HTMLDocument	open(String type) Not implemented.
HTMLDocument	open(String type, String replace) Not implemented.
WindowProxy	open(String url, String name, String features) Not implemented.
WindowProxy	open(String url, String name, String features, boolean replace) Not implemented.
boolean	queryCommandEnabled(String commandId)
boolean	queryCommandIndeterm(String commandId)
boolean	queryCommandState(String commandId)
boolean	queryCommandSupported(String commandId)
String	queryCommandValue(String commandId)
void	set(String name, HTMLElement element) Not in spec.
void	set(String name, int value) Not in spec.
void	setBody(HTMLBodyElement newBody)
void	setBody(org.w3c.dom.html.HTMLElement body) Not implemented.
void	setCookie(String c)
void	setDesignMode(String mode)
void	setDir(String dir)
void	setDomain(String d)
void	setLastModified(Date d)
void	setLocation(String l) Just sets the location, does not navigate.
void	setOnreadystatechange(EventHandler h) Not implemented.
void	setReferrer(String url)
void	setTitle(String newTitle) Looks for html/head/title, and sets its text body.
String	toString() Formats the whole element.
void	write(String... text)
void	write(String text) Not implemented.
void	writeln(String... text)
void	writeln(String text) Not implemented.

Methods inherited from class org.apache.xerces.dom.DocumentImpl

addEventListener, copyEventListeners, createEvent, createNodeIterator, createNodeIterator, createRange, createTreeWalker, createTreeWalker, dispatchAggregateEvents, dispatchAggregateEvents, dispatchEvent, dispatchEventToSubtree, dispatchingEventToSubtree, getEventListeners, getImplementation, removeEventListener, saveEnclosingAttr, setEventListeners

Methods inherited from class org.apache.xerces.dom.CoreDocumentImpl

abort, adoptNode, callUserDataHandlers, canRenameElements, changed, changes, checkDOMNSErr, checkNamespaceWF, checkQName, clearIdentifiers, clone, cloneNode, createAttributeNS, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createDocumentType, createElementDefinition, createEntity, createEntityReference, createNotation, createProcessingInstruction, createTextNode, getAsync, getBaseURI, getDoctype, getDocumentURI, getDomConfig, getEncoding, getErrorChecking, getFeature, getIdentifier, getIdentifiers, getInputEncoding, getNodeName, getNodeNumber, getNodeNumber, getNodeType, getOwnerDocument, getStandalone, getStrictErrorChecking, getTextContent, getUserData, getUserData, getUserDataRecord, getVersion, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, isKidOK, isValidQName, isXMLName, load, loadXML, normalizeDocument, putIdentifier, removeChild, removeIdentifier, renameNode, replaceChild, saveXML, setAsync, setDocumentURI, setEncoding, setErrorChecking, setInputEncoding, setStandalone, setStrictErrorChecking, setTextContent, setUserData, setUserData, setVersion, setXmlEncoding, setXmlStandalone, setXmlVersion, undeferChildren

Methods inherited from class org.apache.xerces.dom.ParentNode

getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, hasChildNodes, isEqualNode, item, normalize, setOwnerDocument, setReadOnly, synchronizeChildren

Methods inherited from class org.apache.xerces.dom.ChildNode

getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.apache.xerces.dom.NodeImpl

addEventListener, compareDocumentPosition, compareTreePosition, dispatchEvent, getAttributes, getContainer, getLocalName, getNamespaceURI, getNodeValue, getPrefix, getReadOnly, getUserData, getUserData, getUserDataRecord, hasAttributes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setPrefix, setUserData, setUserData, synchronizeData

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Document

adoptNode, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getDocumentURI, getDomConfig, getImplementation, getInputEncoding, getStrictErrorChecking, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, normalizeDocument, renameNode, setDocumentURI, setStrictErrorChecking, setXmlStandalone, setXmlVersion

Methods inherited from interface org.w3c.dom.Node

compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Constructor Detail

HTMLDocumentImp

protected HTMLDocumentImp()

Protected: outside this package, only subclasses can instantiate. Starts off with no elements at all.

Method Detail

insertBefore

public Node insertBefore(Node newChild,
                         Node refChild)
                  throws DOMException

First adopts the new child, then inserts it. I do this so that we can insert elements that were created with a different owner document or no owner document, such as from "new Image()" in javascript.

Specified by:

insertBefore in interface Node

Overrides:

insertBefore in class org.apache.xerces.dom.CoreDocumentImpl

Parameters:

newChild - the new child

refChild - If null, inserts at end.

Throws:

DOMException

See Also:

NodeImpl.appendChild(org.w3c.dom.Node)

appendChild

public Node appendChild(Node newChild)
                 throws DOMException

First adopts the new child, then appends it. I do this so that we can insert elements that were created with a different owner document or no owner document, such as from "new Image()" in javascript.

Specified by:

appendChild in interface Node

Overrides:

appendChild in class org.apache.xerces.dom.NodeImpl

Parameters:

newChild - the new child

Throws:

DOMException

See Also:

NodeImpl.appendChild(org.w3c.dom.Node)

getDocumentElement

public HTMLHtmlElement getDocumentElement()

Returns null if there is no html element yet. Does not create elements.

Specified by:

getDocumentElement in interface Document

Overrides:

getDocumentElement in class org.apache.xerces.dom.CoreDocumentImpl

getHtml

public HTMLHtmlElement getHtml()

Returns null if there is no html element yet. Does not create elements.

getHead

public HTMLHeadElement getHead()

Returns null if there is no head element yet. Does not create elements.

getTitle

public String getTitle()

Gets the text within the first title element within head element, or null. Does not create elements.

Specified by:

getTitle in interface org.w3c.dom.html.HTMLDocument

setTitle

public void setTitle(String newTitle)

Looks for html/head/title, and sets its text body. If there is no html element, adds one. If there is no html/head element, adds one. If there is no title element in html/head, adds one.

Specified by:

setTitle in interface org.w3c.dom.html.HTMLDocument

getBody

public HTMLBodyElement getBody()

Returns null if there is no body.

Specified by:

getBody in interface org.w3c.dom.html.HTMLDocument

setBody

public void setBody(HTMLBodyElement newBody)

getImages

public HTMLCollection<HTMLImageElement> getImages()

Specified by:

getImages in interface org.w3c.dom.html.HTMLDocument

getLinks

public HTMLCollection<HTMLElement> getLinks()

a-elements with href and area-elements with href, in tree order

Specified by:

getLinks in interface org.w3c.dom.html.HTMLDocument

getForms

public HTMLCollection<HTMLFormElement> getForms()

Specified by:

getForms in interface org.w3c.dom.html.HTMLDocument

createAttribute

public Attr createAttribute(String name)
                     throws DOMException

Specified by:

createAttribute in interface Document

Overrides:

createAttribute in class org.apache.xerces.dom.CoreDocumentImpl

Throws:

DOMException

createElementNS

public Element createElementNS(String namespaceURI,
                               String qualifiedName,
                               String localpart)
                        throws DOMException

Overrides:

createElementNS in class org.apache.xerces.dom.CoreDocumentImpl

Throws:

DOMException

createElementNS

public Element createElementNS(String namespaceURI,
                               String qualifiedName)

The HTML5 parser calls here, and this method delegates to createElement(tag) so that we really get an HTMLElement.

Specified by:

createElementNS in interface Document

Overrides:

createElementNS in class org.apache.xerces.dom.CoreDocumentImpl

Parameters:

namespaceURI - The HTML parser calls with "http://www.w3.org/1999/xhtml" but that's not what we want.

qualifiedName - Like "html"

createElement

public HTMLElement createElement(String tag)
                          throws DOMException

Overrides org.apache.html.dom.HTMLDocumentImpl#createElement(java.lang.String)

Specified by:

createElement in interface Document

Overrides:

createElement in class org.apache.xerces.dom.CoreDocumentImpl

Throws:

DOMException

createElement

public <T extends HTMLElement> T createElement(Class<T> c)

Create an element of this class. Convenience during java programming: the return type is exact. Not implemented for all element classes. Some element classes are used to several tags, for those this method does not work.

Type Parameters:

T - A subinterface of HTMLElement that represents one html element

Parameters:

c - The class object

Returns:

A fresh instance of the element

Throws:

NotImplementedException - Not (yet) implemented for this interface.

toString

public String toString()

Formats the whole element. Not efficient.

Overrides:

toString in class org.apache.xerces.dom.NodeImpl

getElementById

public HTMLElement getElementById(String id)

Specified by:

getElementById in interface Document

Overrides:

getElementById in class org.apache.xerces.dom.CoreDocumentImpl

getElementByTagName

public HTMLElement getElementByTagName(String tag)

Convenience: gets the first element with that tag, or null if there are none.

Parameters:

tag - the tag

Returns:

the first element with this tag or null

getElementsByTagName

public final NodeList getElementsByTagName(String tag)

Specified by:

getElementsByTagName in interface Document

Overrides:

getElementsByTagName in class org.apache.xerces.dom.CoreDocumentImpl

Parameters:

tag - Will be treated as lower-case.

getElementsByTagNameNS

public final NodeList getElementsByTagNameNS(String namespace,
                                             String key)

Specified by:

getElementsByTagNameNS in interface Document

Overrides:

getElementsByTagNameNS in class org.apache.xerces.dom.CoreDocumentImpl

Parameters:

key - will be converted to lower-case

cloneNode

public HTMLDocumentImp cloneNode(boolean deep)

Specified by:

cloneNode in interface Node

Overrides:

cloneNode in class org.apache.xerces.dom.DocumentImpl

copy

protected void copy(HTMLDocumentImp from,
                    boolean deep)

Copy fields from a document to this document. Protected visibility for subclasses.

Parameters:

from - the source document

deep - whether to copy descendants too

getLocation

public Location getLocation()

Just returns the last location that was set.

Returns:

the location or null

setLocation

public void setLocation(String l)

Just sets the location, does not navigate.

Parameters:

l - the location

getLastModified

public String getLastModified()

setLastModified

public void setLastModified(Date d)

getDir

public String getDir()

setDir

public void setDir(String dir)

getEmbeds

public HTMLCollection<HTMLEmbedElement> getEmbeds()

getPlugins

public HTMLCollection<HTMLEmbedElement> getPlugins()

getScripts

public HTMLCollection<HTMLScriptElement> getScripts()

setDomain

public void setDomain(String d)

getDomain

public String getDomain()

Specified by:

getDomain in interface org.w3c.dom.html.HTMLDocument

getReadyState

public DocumentReadyState getReadyState()

Not implemented. Makes no sense on server.

getReferrer

public String getReferrer()

Specified by:

getReferrer in interface org.w3c.dom.html.HTMLDocument

setReferrer

public void setReferrer(String url)

getCookie

public String getCookie()

Specified by:

getCookie in interface org.w3c.dom.html.HTMLDocument

setCookie

public void setCookie(String c)

Specified by:

setCookie in interface org.w3c.dom.html.HTMLDocument

get

public HTMLElement get(String name)

Gets an element by name.

Specified by:

get in interface ScriptMap<HTMLElement>

Parameters:

name - Name of the property

Returns:

T or null

has

public boolean has(String name)

Has the document got an element with this name?

Specified by:

has in interface ScriptMap<HTMLElement>

Parameters:

name - Name of the property

Returns:

Is there an element at this key?

set

public void set(String name,
                HTMLElement element)

Not in spec. Not implemented.

Specified by:

set in interface ScriptMap<HTMLElement>

Parameters:

name - Name of the property

element - Value of the property

set

public void set(String name,
                int value)

Not in spec. Not implemented.

Specified by:

set in interface ScriptMap<HTMLElement>

deleter

public void deleter(String name)

Deletes a named element. Not in spec.

Specified by:

deleter in interface ScriptMap<HTMLElement>

Parameters:

name - Name of the property

open

public HTMLDocument open(String type)

Description copied from interface: HTMLDocument

Not implemented. Document open(optional DOMString type = "text/html", optional DOMString replace = "");

Parameters:

type - "text/html"

Returns:

the document

open

public HTMLDocument open(String type,
                         String replace)

Description copied from interface: HTMLDocument

Not implemented. Document open(optional DOMString type = "text/html", optional DOMString replace = "");

Parameters:

type - "text/html"

replace - the string to replace with

Returns:

the document

open

public WindowProxy open(String url,
                        String name,
                        String features)

Description copied from interface: HTMLDocument

Not implemented. Opens a new window. WindowProxy open(DOMString url, DOMString name, DOMString features, optional boolean replace = false);

Parameters:

url - the URL

name - the name

features - the features

Returns:

the window proxy

open

public WindowProxy open(String url,
                        String name,
                        String features,
                        boolean replace)

Description copied from interface: HTMLDocument

Not implemented. Opens a new window. WindowProxy open(DOMString url, DOMString name, DOMString features, optional boolean replace = false);

Parameters:

url - the url

name - the name

features - the features

replace - whether to replace

Returns:

the window proxy

write

public void write(String... text)

writeln

public void writeln(String... text)

close

public void close()

Specified by:

close in interface org.w3c.dom.html.HTMLDocument

getDefaultView

public WindowProxy getDefaultView()

getActiveElement

public Element getActiveElement()

hasFocus

public boolean hasFocus()

getDesignMode

public String getDesignMode()

setDesignMode

public void setDesignMode(String mode)

execCommand

public boolean execCommand(String commandId)

execCommand

public boolean execCommand(String commandId,
                           boolean showId)

execCommand

public boolean execCommand(String commandId,
                           boolean showId,
                           String value)

queryCommandEnabled

public boolean queryCommandEnabled(String commandId)

queryCommandIndeterm

public boolean queryCommandIndeterm(String commandId)

queryCommandState

public boolean queryCommandState(String commandId)

queryCommandSupported

public boolean queryCommandSupported(String commandId)

queryCommandValue

public String queryCommandValue(String commandId)

getURL

public String getURL()

Not implemented.

Specified by:

getURL in interface org.w3c.dom.html.HTMLDocument

setBody

public void setBody(org.w3c.dom.html.HTMLElement body)

Not implemented.

Specified by:

setBody in interface org.w3c.dom.html.HTMLDocument

getApplets

public org.w3c.dom.html.HTMLCollection getApplets()

Not implemented.

Specified by:

getApplets in interface org.w3c.dom.html.HTMLDocument

getAnchors

public org.w3c.dom.html.HTMLCollection getAnchors()

Not implemented.

Specified by:

getAnchors in interface org.w3c.dom.html.HTMLDocument

open

public void open()

Not implemented.

Specified by:

open in interface org.w3c.dom.html.HTMLDocument

write

public void write(String text)

Not implemented.

Specified by:

write in interface org.w3c.dom.html.HTMLDocument

writeln

public void writeln(String text)

Not implemented.

Specified by:

writeln in interface org.w3c.dom.html.HTMLDocument

getElementsByName

public HTMLCollection<HTMLElement> getElementsByName(String name)

Specified by:

getElementsByName in interface org.w3c.dom.html.HTMLDocument

getOnreadystatechange

public EventHandler getOnreadystatechange()

Not implemented.

setOnreadystatechange

public void setOnreadystatechange(EventHandler h)

Not implemented.