GenericDocument (Apache Batik Javadoc)

java.lang.Object
- org.apache.batik.dom.AbstractNode
- - org.apache.batik.dom.AbstractParentNode
  - - org.apache.batik.dom.AbstractDocument
    - - org.apache.batik.dom.GenericDocument

All Implemented Interfaces:

java.io.Serializable, NodeEventTarget, ExtendedNode, NodeXBL, XBLManagerData, Localizable, org.w3c.dom.Document, DocumentEvent, EventTarget, org.w3c.dom.Node, org.w3c.dom.traversal.DocumentTraversal
```
public class GenericDocument
extends AbstractDocument
```
This class implements the Document, DocumentEvent.

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.batik.dom.AbstractDocument
  AbstractDocument.DocumentConfiguration, AbstractDocument.DocumentError, AbstractDocument.IdSoftRef, AbstractDocument.XPathExpr, AbstractDocument.XPathNodeNSResolver
- Nested classes/interfaces inherited from class org.apache.batik.dom.AbstractParentNode
  AbstractParentNode.ChildNodes, AbstractParentNode.ElementsByTagName, AbstractParentNode.ElementsByTagNameNS

Field Summary

Fields
Modifier and Type Field and Description

protected static java.lang.String ATTR_ID
Local name for 'id' attributes.

protected boolean readonly
Is this document immutable?
- Fields inherited from class org.apache.batik.dom.AbstractDocument
  documentEventSupport, documentURI, domConfig, elementsById, elementsByTagNames, elementsByTagNamesNS, eventsEnabled, implementation, inputEncoding, localizableSupport, RESOURCES, strictErrorChecking, traversalSupport, xblManager, xmlEncoding, xmlStandalone, xmlVersion
- Fields inherited from class org.apache.batik.dom.AbstractParentNode
  childNodes
- Fields inherited from class org.apache.batik.dom.AbstractNode
  DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, EMPTY_NODE_LIST, eventSupport, managerData, ownerDocument, userData, userDataHandlers
- 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
Modifier and Type	Field and Description
`protected static java.lang.String`	`ATTR_ID` Local name for 'id' attributes.
`protected boolean`	`readonly` Is this document immutable?

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GenericDocument()` Creates a new uninitialized document.
	`GenericDocument(org.w3c.dom.DocumentType dt, org.w3c.dom.DOMImplementation impl)` Creates a new uninitialized document.

Method Summary

Methods
Modifier and Type	Method and Description
`org.w3c.dom.Attr`	`createAttribute(java.lang.String name)` DOM: Implements `Document.createAttribute(String)`.
`org.w3c.dom.Attr`	`createAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName)` DOM: Implements `Document.createAttributeNS(String,String)`.
`org.w3c.dom.CDATASection`	`createCDATASection(java.lang.String data)` DOM: Implements `Document.createCDATASection(String)`.
`org.w3c.dom.Comment`	`createComment(java.lang.String data)` DOM: Implements `Document.createComment(String)`.
`org.w3c.dom.DocumentFragment`	`createDocumentFragment()` DOM: Implements `Document.createDocumentFragment()`.
`org.w3c.dom.Element`	`createElement(java.lang.String tagName)` DOM: Implements `Document.createElement(String)`.
`org.w3c.dom.Element`	`createElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName)` DOM: Implements `Document.createElementNS(String,String)`.
`org.w3c.dom.EntityReference`	`createEntityReference(java.lang.String name)` DOM: Implements `Document.createEntityReference(String)`.
`org.w3c.dom.ProcessingInstruction`	`createProcessingInstruction(java.lang.String target, java.lang.String data)` DOM: Implements `Document.createProcessingInstruction(String,String)`.
`org.w3c.dom.Text`	`createTextNode(java.lang.String data)` DOM: Implements `Document.createTextNode(String)`.
`boolean`	`isId(org.w3c.dom.Attr node)` Returns true if the given Attr node represents an 'id' for this document.
`boolean`	`isReadonly()` Tests whether this node is readonly.
`protected org.w3c.dom.Node`	`newNode()` Returns a new uninitialized instance of this object's class.
`void`	`setReadonly(boolean v)` Sets this node readonly attribute.

Methods inherited from class org.apache.batik.dom.AbstractDocument
addIdEntry, adoptNode, adoptNode1, canDispatch, checkChars, checkChildType, checkName, cloneNode, copyInto, createDOMError, createEvent, createExpression, createNodeIterator, createNSResolver, createTreeWalker, createXPathException, deepCopyInto, deepExport, detachNodeIterator, evaluate, export, formatMessage, getChildElementById, getCurrentDocument, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getEventsEnabled, getImplementation, getInputEncoding, getLocale, getNodeName, getNodeType, getRoot, getStrictErrorChecking, getXblBoundElement, getXblChildNodes, getXblDefinitions, getXblFirstChild, getXblFirstElementChild, getXblLastChild, getXblLastElementChild, getXBLManager, getXblNextElementSibling, getXblNextSibling, getXblParentNode, getXblPreviousElementSibling, getXblPreviousSibling, getXblScopedChildNodes, getXblShadowTree, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, importNode, nodeToBeRemoved, normalizeDocument, normalizeDocument, putElementsByTagName, putElementsByTagNameNS, removeIdEntry, renameNode, setDoctype, setDocumentInputEncoding, setDocumentURI, setDocumentXmlEncoding, setEventsEnabled, setLocale, setStrictErrorChecking, setTextContent, setXBLManager, setXmlStandalone, setXmlVersion, splitCdata, updateIdEntry

Methods inherited from class org.apache.batik.dom.AbstractParentNode
appendChild, checkAndRemove, deepExport, fireDOMNodeInsertedEvent, fireDOMNodeInsertedIntoDocumentEvent, fireDOMNodeRemovedEvent, fireDOMNodeRemovedFromDocumentEvent, fireDOMSubtreeModifiedEvent, getChildNodes, getElementsByTagName, getElementsByTagNameNS, getFirstChild, getLastChild, getTextContent, hasChildNodes, insertBefore, nodeAdded, normalize, removeChild, replaceChild

Methods inherited from class org.apache.batik.dom.AbstractNode
addEventListener, addEventListenerNS, compareDocumentPosition, compareNamedNodeMaps, compareStrings, createDOMException, dispatchEvent, export, fireDOMCharacterDataModifiedEvent, fireUserDataHandlers, getAttributes, getBaseURI, getBaseURI, getCascadedXMLBase, getEventSupport, getFeature, getLocalName, getManagerData, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getParentNodeEventTarget, getPrefix, getPreviousSibling, getUserData, hasAttributes, hasEventListenerNS, initializeEventSupport, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespacePrefix, lookupNamespaceURI, lookupPrefix, removeEventListener, removeEventListenerNS, setManagerData, setNextSibling, setNodeName, setNodeValue, setOwnerDocument, setParentNode, setPrefix, setPreviousSibling, setSpecified, setUserData, willTriggerNS

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.w3c.dom.Document
getElementsByTagName, getElementsByTagNameNS

Methods inherited from interface org.w3c.dom.Node
appendChild, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setUserData

Field Detail
- ATTR_ID
```
protected static final java.lang.String ATTR_ID
```
  Local name for 'id' attributes.
  
  See Also:
  Constant Field Values
- readonly
```
protected boolean readonly
```
  Is this document immutable?

Constructor Detail

GenericDocument
```
protected GenericDocument()
```
Creates a new uninitialized document.

GenericDocument

public GenericDocument(org.w3c.dom.DocumentType dt,
               org.w3c.dom.DOMImplementation impl)

Creates a new uninitialized document.

Method Detail

isReadonly
```
public boolean isReadonly()
```
Tests whether this node is readonly.

setReadonly
```
public void setReadonly(boolean v)
```
Sets this node readonly attribute.

isId
```
public boolean isId(org.w3c.dom.Attr node)
```
Returns true if the given Attr node represents an 'id' for this document.

Specified by:

isId in class AbstractDocument

createElement

public org.w3c.dom.Element createElement(java.lang.String tagName)
                                  throws org.w3c.dom.DOMException

DOM: Implements Document.createElement(String).

Throws:: org.w3c.dom.DOMException

createDocumentFragment
```
public org.w3c.dom.DocumentFragment createDocumentFragment()
```
DOM: Implements Document.createDocumentFragment().

createTextNode

public org.w3c.dom.Text createTextNode(java.lang.String data)

DOM: Implements Document.createTextNode(String).

createComment

public org.w3c.dom.Comment createComment(java.lang.String data)

DOM: Implements Document.createComment(String).

createCDATASection

public org.w3c.dom.CDATASection createCDATASection(java.lang.String data)
                                            throws org.w3c.dom.DOMException

DOM: Implements Document.createCDATASection(String).

Throws:: org.w3c.dom.DOMException

createProcessingInstruction

public org.w3c.dom.ProcessingInstruction createProcessingInstruction(java.lang.String target,
                                                            java.lang.String data)
                                                              throws org.w3c.dom.DOMException

DOM: Implements Document.createProcessingInstruction(String,String).

Returns:: a StyleSheetProcessingInstruction if target is "xml-stylesheet" or a GenericProcessingInstruction otherwise.
Throws:: org.w3c.dom.DOMException

createAttribute

public org.w3c.dom.Attr createAttribute(java.lang.String name)
                                 throws org.w3c.dom.DOMException

DOM: Implements Document.createAttribute(String).

Throws:: org.w3c.dom.DOMException

createEntityReference

public org.w3c.dom.EntityReference createEntityReference(java.lang.String name)
                                                  throws org.w3c.dom.DOMException

DOM: Implements Document.createEntityReference(String).

Throws:: org.w3c.dom.DOMException

createElementNS

public org.w3c.dom.Element createElementNS(java.lang.String namespaceURI,
                                  java.lang.String qualifiedName)
                                    throws org.w3c.dom.DOMException

DOM: Implements Document.createElementNS(String,String).

Throws:: org.w3c.dom.DOMException

createAttributeNS

public org.w3c.dom.Attr createAttributeNS(java.lang.String namespaceURI,
                                 java.lang.String qualifiedName)
                                   throws org.w3c.dom.DOMException

DOM: Implements Document.createAttributeNS(String,String).

Throws:: org.w3c.dom.DOMException

newNode
```
protected org.w3c.dom.Node newNode()
```
Returns a new uninitialized instance of this object's class.

Specified by:

newNode in class AbstractNode

Class GenericDocument

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.batik.dom.AbstractDocument

Nested classes/interfaces inherited from class org.apache.batik.dom.AbstractParentNode

Field Summary

Fields inherited from class org.apache.batik.dom.AbstractDocument

Fields inherited from class org.apache.batik.dom.AbstractParentNode

Fields inherited from class org.apache.batik.dom.AbstractNode

Fields inherited from interface org.w3c.dom.Node

Constructor Summary

Method Summary

Methods inherited from class org.apache.batik.dom.AbstractDocument

Methods inherited from class org.apache.batik.dom.AbstractParentNode

Methods inherited from class org.apache.batik.dom.AbstractNode

Methods inherited from class java.lang.Object

Methods inherited from interface org.w3c.dom.Document

Methods inherited from interface org.w3c.dom.Node

Field Detail

ATTR_ID

readonly

Constructor Detail

GenericDocument

GenericDocument

Method Detail

isReadonly

setReadonly

isId

createElement

createDocumentFragment

createTextNode

createComment

createCDATASection

createProcessingInstruction

createAttribute

createEntityReference

createElementNS

createAttributeNS

newNode