cat.inspiracio.html

Class HTMLElementImp

java.lang.Object

org.apache.xerces.dom.NodeImpl

org.apache.xerces.dom.ChildNode

org.apache.xerces.dom.ParentNode

org.apache.xerces.dom.ElementImpl

cat.inspiracio.html.HTMLElementImp

All Implemented Interfaces:

ScriptMap<String>, Serializable, Cloneable, Element, ElementTraversal, EventTarget, org.w3c.dom.html.HTMLElement, Node, NodeList, TypeInfo

Direct Known Subclasses:

HTMLAudioElementImp, HTMLImageElementImp, HTMLMetaElementImp, HTMLOptionElementImp

public class HTMLElementImp
extends org.apache.xerces.dom.ElementImpl
implements HTMLElement

Implementation class for html elements. You can make a new html element by extending this class.

See Also:

Serialized Form

Field Summary

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

attributes, name

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

Fields inherited from interface org.w3c.dom.TypeInfo

DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HTMLElementImp(HTMLDocumentImp owner, String tag) Make a new HTML element.

Method Summary

Modifier and Type	Method and Description
Node	appendChild(Node newChild) First adopts the new child, then appends it.
void	blur() Does nothing.
protected String	capitalize(String value) Convenience method used to capitalise a one-off attribute value before it is returned.
void	click() Does nothing.
HTMLElement	cloneNode(boolean deep)
protected <T extends HTMLElement> T	createElement(Class<T> c) Factory method for convenience: Creates an element of this interface.
protected HTMLElement	createElement(String tag) Factory method for convenience
void	deleter(String key) Deletes the element at this key.
void	focus() Does nothing.
String	get(String key) If there is an element at this key, return it.
String	getAccessKey()
String	getAccessKeyLabel() On the server, we don't assign access keys.
protected double	getAttribute(String key, double def)
protected int	getAttribute(String key, int def) Tries to read an attribute as int, else returns default value.
protected String	getAttribute(String key, String def) Tries to read an attribute as String, else returns default value.
protected boolean	getAttributeBoolean(String key) Boolean attributes in HTML: If the attribute has any value, it is considered true.
protected double	getAttributeDouble(String key) Returns 0.0 if the attribute cannot be parsed as double.
protected int	getAttributeInt(String key) Returns 0 if the attribute cannot be parsed as int.
protected long	getAttributeLong(String key) Returns 0 if the attribute cannot be parsed as long.
Attr	getAttributeNodeNS(String namespace, String key)
String	getAttributeNS(String namespace, String key)
HTMLCollection<HTMLElement>	getChildElements() Convenience: get all children that are elements.
NodeList	getChildNodes() Explicit implementation of getChildNodes() to avoid problems with overriding the getLength() method hidden in the super class.
String	getClassName()
String	getContentEditable() Not implemented.
DOMStringMap	getDataset() Spec
String	getDir()
protected HTMLElement	getElementById(String id) Convenience for subclass implementations
protected HTMLElement	getElementByTagName(String tag) Convenience: returns the first child element with this tag, or null.
HTMLCollection<HTMLElement>	getElementsByTagName(String tag)
NodeList	getElementsByTagNameNS(String namespace, String tag)
protected HTMLFormElement	getForm() Convenience method returns the form in which this form element is contained.
boolean	getHidden()
String	getId()
String	getLang()
String	getName()
HTMLDocument	getOwnerDocument()
boolean	getSpellcheck() Not implemented.
String	getStyle()
int	getTabIndex()
String	getTagName() Always lowercase
protected String	getText() Convenience: concatenates the text of all Text children of this element, ignoring comment and data.
String	getTitle()
boolean	getTranslate() Not implemented.
boolean	has(String key)
Node	insertBefore(Node newChild, Node refChild) First adopts the new child, then inserts it.
boolean	isContentEditable() Not implemented.
protected boolean	isInDocument() Is this element inside a document? The only document that it can be in is its owner document.
void	prepend(HTMLElement element) Add an element as first child.
protected void	remove() Removes the element from its parent.
void	set(String key, int value)
void	set(String key, String value) Set the element at this key.
void	setAccessKey(String key)
protected void	setAttribute(String key, boolean b) Boolean attributes in HTML: True: set the attribute using the key also as value.
protected void	setAttribute(String key, double d) Sets attribute to a number, formatting the number without trailing zeros.
protected void	setAttribute(String key, int i)
protected void	setAttribute(String key, long i)
void	setClassName(String className)
void	setContentEditable(String s) Not implemented.
void	setDir(String dir)
void	setHidden(boolean h)
void	setId(String id)
void	setLang(String lang)
void	setName(String n)
void	setSpellcheck(boolean b) Not implemented.
void	setStyle(String style)
void	setTabIndex(int t)
void	setTitle(String title)
void	setTranslate(boolean t)
String	toString() Formats the whole element.
protected String	yesNo(boolean b) Converts true to "yes" and false to "no".

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

getAttribute, getAttributeNode, getAttributes, getBaseURI, getChildElementCount, getDefaultAttributes, getFirstElementChild, getLastElementChild, getNextElementSibling, getNodeName, getNodeType, getPreviousElementSibling, getSchemaTypeInfo, getTypeName, getTypeNamespace, getXercesAttribute, getXMLBaseAttribute, hasAttribute, hasAttributeNS, hasAttributes, isDerivedFrom, isEqualNode, normalize, reconcileDefaultAttributes, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setOwnerDocument, setReadOnly, setupDefaultAttributes, setXercesAttributeNode, synchronizeData

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

getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getTextContent, hasChildNodes, item, removeChild, replaceChild, setTextContent, synchronizeChildren

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

getNextSibling, getParentNode, getPreviousSibling

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

addEventListener, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getContainer, getFeature, getLocalName, getNamespaceURI, getNodeNumber, getNodeValue, getPrefix, getReadOnly, getUserData, getUserData, getUserDataRecord, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setPrefix, setUserData, setUserData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.Element

getAttribute, getAttributeNode, getSchemaTypeInfo, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface org.w3c.dom.Node

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

Constructor Detail

HTMLElementImp

protected HTMLElementImp(HTMLDocumentImp owner,
                         String tag)

Make a new HTML element.

Parameters:

owner - The document

tag - The tag name. Not case-sensitive. Will be converted to lower-case.

Method Detail

cloneNode

public HTMLElement cloneNode(boolean deep)

Specified by:

cloneNode in interface Node

Overrides:

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

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

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)

getChildNodes

public NodeList getChildNodes()

Explicit implementation of getChildNodes() to avoid problems with overriding the getLength() method hidden in the super class. The problem is that the superclass ParentNode overrides getChildNodes(){return this;}. That is good for performance, but also means that no subclass can use the method names of the two NodeList methods (item(Node) and getLength()) for any different meaning. At least HTMLSelectElement and HTMLFormElement want to do that. Confusion that comes from optimisation. In order to avoid this confusion, here I override getChildNodes() so that it returns a fresh object.

Specified by:

getChildNodes in interface Node

Overrides:

getChildNodes in class org.apache.xerces.dom.ParentNode

getChildElements

public HTMLCollection<HTMLElement> getChildElements()

Description copied from interface: HTMLElement

Convenience: get all children that are elements.

Returns:

all elements

remove

protected void remove()

Removes the element from its parent. Spec

getElementById

protected HTMLElement getElementById(String id)

Convenience for subclass implementations

Parameters:

id - of the element to get

Returns:

the element or null

getStyle

public String getStyle()

setStyle

public void setStyle(String style)

getForm

protected HTMLFormElement getForm()

Convenience method returns the form in which this form element is contained. This method is exposed for form elements through the DOM API, but other elements have no access to it through the API.

Returns:

the form or null

getText

protected String getText()

Convenience: concatenates the text of all Text children of this element, ignoring comment and data. Used in script element and others.

Returns:

the text

prepend

public void prepend(HTMLElement element)

Add an element as first child.

Parameters:

element - the element

getId

public String getId()

Specified by:

getId in interface org.w3c.dom.html.HTMLElement

setId

public void setId(String id)

Specified by:

setId in interface org.w3c.dom.html.HTMLElement

getName

public String getName()

setName

public void setName(String n)

getTitle

public String getTitle()

Specified by:

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

setTitle

public void setTitle(String title)

Specified by:

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

getLang

public String getLang()

Specified by:

getLang in interface org.w3c.dom.html.HTMLElement

setLang

public void setLang(String lang)

Specified by:

setLang in interface org.w3c.dom.html.HTMLElement

getOwnerDocument

public HTMLDocument getOwnerDocument()

Specified by:

getOwnerDocument in interface Node

Overrides:

getOwnerDocument in class org.apache.xerces.dom.ParentNode

isInDocument

protected boolean isInDocument()

Is this element inside a document? The only document that it can be in is its owner document.

Returns:

Is this element inside a document?

getDir

public String getDir()

Specified by:

getDir in interface org.w3c.dom.html.HTMLElement

setDir

public void setDir(String dir)

Specified by:

setDir in interface org.w3c.dom.html.HTMLElement

getClassName

public String getClassName()

Specified by:

getClassName in interface org.w3c.dom.html.HTMLElement

setClassName

public void setClassName(String className)

Specified by:

setClassName in interface org.w3c.dom.html.HTMLElement

getTranslate

public boolean getTranslate()

Not implemented.

setTranslate

public void setTranslate(boolean t)

getDataset

public DOMStringMap getDataset()

Spec

getHidden

public boolean getHidden()

setHidden

public void setHidden(boolean h)

getTabIndex

public int getTabIndex()

setTabIndex

public void setTabIndex(int t)

getAccessKey

public String getAccessKey()

setAccessKey

public void setAccessKey(String key)

getAccessKeyLabel

public String getAccessKeyLabel()

On the server, we don't assign access keys. A browser can do that. Returns "".

getContentEditable

public String getContentEditable()

Not implemented.

setContentEditable

public void setContentEditable(String s)

Not implemented.

isContentEditable

public boolean isContentEditable()

Not implemented.

getSpellcheck

public boolean getSpellcheck()

Not implemented.

setSpellcheck

public void setSpellcheck(boolean b)

Not implemented.

blur

public void blur()

Does nothing.

focus

public void focus()

Does nothing.

click

public void click()

Does nothing.

getAttributeNodeNS

public Attr getAttributeNodeNS(String namespace,
                               String key)

Specified by:

getAttributeNodeNS in interface Element

Overrides:

getAttributeNodeNS in class org.apache.xerces.dom.ElementImpl

Parameters:

namespace - the namespace

key - case-sensitive

getAttribute

protected String getAttribute(String key,
                              String def)

Tries to read an attribute as String, else returns default value.

Parameters:

key - the key

def - The default value.

Returns:

attribute value

getAttributeNS

public String getAttributeNS(String namespace,
                             String key)

Specified by:

getAttributeNS in interface Element

Overrides:

getAttributeNS in class org.apache.xerces.dom.ElementImpl

Parameters:

namespace - the namespace

key - case-sensitive

getElementsByTagName

public HTMLCollection<HTMLElement> getElementsByTagName(String tag)

Specified by:

getElementsByTagName in interface Element

Overrides:

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

Parameters:

tag - Will be made lower-case

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespace,
                                       String tag)

Specified by:

getElementsByTagNameNS in interface Element

Overrides:

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

Parameters:

tag - Will be made lower-case

getTagName

public String getTagName()

Always lowercase

Specified by:

getTagName in interface Element

Overrides:

getTagName in class org.apache.xerces.dom.ElementImpl

capitalize

protected String capitalize(String value)

Convenience method used to capitalise a one-off attribute value before it is returned. For example, the align values "LEFT" and "left" will both return as "Left".

Parameters:

value - The value of the attribute

Returns:

The capitalised value

yesNo

protected String yesNo(boolean b)

Converts true to "yes" and false to "no".

Parameters:

b - the boolean

Returns:

"true" or "false"

getAttributeBoolean

protected boolean getAttributeBoolean(String key)

Boolean attributes in HTML: If the attribute has any value, it is considered true.

Parameters:

key - the key

Returns:

true or false

setAttribute

protected void setAttribute(String key,
                            boolean b)

Boolean attributes in HTML: True: set the attribute using the key also as value. False: remove the attribute.

Parameters:

key - the key

b - true or false

getAttributeInt

protected int getAttributeInt(String key)

Returns 0 if the attribute cannot be parsed as int.

Parameters:

key - the key

Returns:

the attribute value as int

getAttribute

protected int getAttribute(String key,
                           int def)

Tries to read an attribute as int, else returns default value.

Parameters:

key - the key

def - The default value, often 0 or 1.

Returns:

the attribute values as int

setAttribute

protected void setAttribute(String key,
                            int i)

getAttributeDouble

protected double getAttributeDouble(String key)

Returns 0.0 if the attribute cannot be parsed as double.

Parameters:

key - the key

Returns:

the attribute value as double

getAttribute

protected double getAttribute(String key,
                              double def)

setAttribute

protected void setAttribute(String key,
                            double d)

Sets attribute to a number, formatting the number without trailing zeros.

Parameters:

key - the key

d - the double

getAttributeLong

protected long getAttributeLong(String key)

Returns 0 if the attribute cannot be parsed as long.

Parameters:

key - the key

Returns:

the attribute value as long

setAttribute

protected void setAttribute(String key,
                            long i)

toString

public String toString()

Formats the whole element. Not efficient.

Overrides:

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

Returns:

element and descendants as html string

createElement

protected HTMLElement createElement(String tag)

Factory method for convenience

Parameters:

tag - make an element with this tag

Returns:

new element

createElement

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

Factory method for convenience: Creates an element of this interface. Saves having to cast the result to the interface.

Type Parameters:

T - type of the new element

Parameters:

c - Interface like HTMLTableCaptionElement

Returns:

the new element

Throws:

NotImplementedException - Not implemented for this interface, maybe because the interface applies to several tag names and therefore the call is ambiguous.

getElementByTagName

protected HTMLElement getElementByTagName(String tag)

Convenience: returns the first child element with this tag, or null.

Parameters:

tag - looking for elements with this tag

Returns:

the first one or null

has

public boolean has(String key)

Specified by:

has in interface ScriptMap<String>

Parameters:

key - Name of the property

Returns:

Is there an element at this key?

get

public String get(String key)

Description copied from interface: ScriptMap

If there is an element at this key, return it. Otherwise return null.

Specified by:

get in interface ScriptMap<String>

Parameters:

key - Name of the property

Returns:

T or null

set

public void set(String key,
                String value)

Description copied from interface: ScriptMap

Set the element at this key. May substitute the element that was previously at this index. (The method could have been called "put".)

Specified by:

set in interface ScriptMap<String>

Parameters:

key - Name of the property

value - Value of the property

set

public void set(String key,
                int value)

Specified by:

set in interface ScriptMap<String>

deleter

public void deleter(String key)

Description copied from interface: ScriptMap

Deletes the element at this key. (Not called "delete" because that is reserved word in JS.)

Specified by:

deleter in interface ScriptMap<String>

Parameters:

key - Name of the property