dom.core.Entity

Package	dom.core
Class	public class Entity
Inheritance	Entity Node Object

Introduced in:	DOM 1 Core
Modified in:	DOM 3 Core

This interface represents a known entity, either parsed or unparsed, in an XML document. Note that this models the entity itself not the entity declaration.

The nodeName attribute that is inherited from Node contains the name of the entity.

Note: An Entity node does not have any parent.

Note: If the entity contains an unbound namespace prefix, the namespaceURI of the corresponding node in the Entity node subtree is null. The same is true for EntityReference nodes that refer to this entity, when they are created using the createEntityReference method of the Document interface.

Note (Mozilla): This is not implemented in Mozilla

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		DOM 1 Core attributes : NamedNodeMap [read-only] Returns an unordered collection of Attr nodes.	Node
		Non-Standard baseName : DOMString [read-only] Returns the base name for the name qualified with the namespace.	Node
		DOM 3 Core baseURI : DOMString [read-only] The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.	Node
		DOM 1 Core childNodes : NodeList [read-only] Returns an ordered collection of node objects that are children of the current element.	Node
		Non-Standard dataType : * Specifies the data type for this node.	Node
		Non-Standard definition : Node [read-only] Returns the definition of the node in the document type definition (DTD) or schema.	Node
		DOM 1 Core firstChild : Node [read-only] Returns the node's first child in the tree, or null if the node is childless.	Node
		DOM 3 Core inputEncoding : DOMString [read-only] An attribute specifying the encoding used for this entity at the time of parsing, when it is an external parsed entity.	Entity
		DOM 1 Core lastChild : Node [read-only] Returns the last child of a node.	Node
		DOM 2 Core localName : DOMString [read-only] Returns the local part of the qualified name of this node.	Node
		DOM 2 Core namespaceURI : DOMString [read-only] The namespace URI of the node, or null if it is unspecified (read-only).	Node
		DOM 1 Core nextSibling : Node [read-only] Returns the node immediately following the specified one in its parent's childNodes list, or null if the specified node is the last node in that list.	Node
		DOM 1 Core nodeName : DOMString [read-only] Returns the name of the current node as a string.	Node
		Non-Standard nodePrincipal : nsIPrincipal [read-only] Returns the nsIPrincipal object representing current security context of the node.	Node
		DOM 1 Core nodeType : Number [read-only] Returns an integer code representing the type of the node.	Node
		Non-Standard nodeTypedValue : * Contains the node value expressed in its defined data type.	Node
		Non-Standard nodeTypeString : DOMString [read-only] Returns the node type in string form.	Node
		DOM 1 Core nodeValue : DOMString Returns or sets the value of the current node.	Node
		DOM 1 Core notationName : DOMString [read-only] For unparsed entities, the name of the notation for the entity.	Entity
		DOM 1 Core ownerDocument : Document [read-only] The Document object associated with this node.	Node
		DOM 1 Core parentNode : Node [read-only] Returns the parent of the specified node in the DOM tree.	Node
		Non-Standard parsed : Boolean [read-only] Indicates the parsed status of the node and child nodes.	Node
		DOM 2 Core prefix : DOMString Returns the namespace prefix of the specified node, or null if no prefix is specified.	Node
		DOM 1 Core previousSibling : Node [read-only] Returns the node immediately preceding the specified one in its parent's childNodes list, null if the specified node is the first in that list.	Node
		DOM 1 Core publicId : DOMString [read-only] The public identifier associated with the entity if specified, and null otherwise.	Entity
		Non-Standard specified : Boolean [read-only] Indicates whether the node (usually an attribute) is explicitly specified or derived from a default value in the document type definition (DTD) or schema.	Node
		DOM 1 Core systemId : DOMString [read-only] The system identifier associated with the entity if specified, and null otherwise.	Entity
		Non-Standard text : DOMString Represents the text content of the node or the concatenated text representing the node and its descendants.	Node
		DOM 3 Core textContent : DOMString Gets or sets the text content of a node and its descendants.	Node
		Non-Standard xml : DOMString [read-only] Contains the XML representation of the node and all its descendants.	Node
		DOM 3 Core xmlEncoding : DOMString [read-only] An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity.	Entity
		DOM 3 Core xmlVersion : DOMString [read-only] An attribute specifying, as part of the text declaration, the version number of this entity, when it is an external parsed entity.	Entity

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		DOM 2 Events addEventListener(type:DOMString, listener:EventListener, useCapture:Boolean):void Associates a function with a particular event and binds the event to the current node.	Node
		DOM 3 Events addEventListenerNS(namespaceURI:DOMString, type:DOMString, listener:EventListener, useCapture:Boolean):void Registers an event listener, depending on the useCapture parameter, on the capture phase of the DOM event flow or its target and bubbling phases.	Node
		DOM 1 Core appendChild(element:Node):Node Adds a node to the end of the list of children of a specified parent node.	Node
		DOM 1 Core cloneNode(cloneChildren:Boolean):Node Returns a duplicate of the current node.	Node
		DOM 3 Core compareDocumentPosition(other:Node):Number Compares the position of the current node against another node in any other document.	Node
		DOM 2 Events dispatchEvent(evt:Event):Boolean Dispatches an event to fire on a node artificially.	Node
		DOM 3 Core getFeature(feature:DOMString, version:DOMString):DOMObject This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in DOM Features.	Node
		DOM 3 Core getUserData(key:DOMString):DOMUserData Retrieves the object associated to a key on a this node.	Node
		DOM 2 Core hasAttributes():Boolean Returns a boolean value of true or false, indicating if the current element has any attributes or not.	Node
		DOM 1 Core hasChildNodes():Boolean Returns a value that indicates whether the object has children.	Node
		DOM 1 Core insertBefore(newNode:Node, childNode:Node):Node Inserts the specified node before a reference element as a child of the current node.	Node
		DOM 3 Core isDefaultNamespace(namespaceURI:DOMString):Boolean Returns true if the namespace is the default namespace on the given node or false if not.	Node
		DOM 3 Core isEqualNode(arg:Node):Boolean Tests whether two nodes are equal.	Node
		DOM 3 Core isSameNode(other:Node):Boolean Returns whether this node is the same node as the given one.	Node
		DOM 2 Core isSupported(feature:DOMString, version:DOMString):Boolean Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.	Node
		DOM 3 Core lookupNamespaceURI(prefix:DOMString):DOMString Takes a prefix and returns the namespaceURI associated with it on the given node if found (and null if not).	Node
		DOM 3 Core lookupPrefix(namespaceURI:DOMString):DOMString Returns the prefix for a given namespaceURI if present, and null if not.	Node
		DOM 1 Core normalize():void Puts the specified node and all of its subtree into a "normalized" form.	Node
		DOM 1 Core removeChild(node:Node):Node Removes a child node from the object.	Node
		DOM 2 Events removeEventListener(type:DOMString, listener:EventListener, useCapture:Boolean):void Removes an event listener.	Node
		DOM 3 Events removeEventListenerNS(namespaceURI:DOMString, type:DOMString, listener:EventListener, useCapture:Boolean):void Removes an event listener.	Node
		DOM 1 Core replaceChild(newNode:Node, childNode:Node):Node Replaces an existing child element with a new child element.	Node
		Non-Standard selectNodes(queryString:DOMString):NodeList Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as IXMLDOMNodeList.	Node
		Non-Standard selectSingleNode(queryString:DOMString):Node Applies the specified pattern-matching operation to this node's context and returns the first matching node.	Node
		DOM 3 Core setUserData(key:DOMString, data:DOMUserData, handler:UserDataHandler):DOMUserData Associate an object to a key on this node.	Node
		Non-Standard transformNode(styleSheet:Node):DOMString Processes this node and its children using the supplied Extensible Stylesheet Language Transformations (XSLT) style sheet and returns the resulting transformation.	Node
		Non-Standard transformNodeToObject(styleSheet:Node, outputObject:*):void Processes this node and its children using the supplied Extensible Stylesheet Language Transformations (XSLT) style sheet and returns the resulting transformation.	Node

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		DOM 1 Core ATTRIBUTE_NODE : Number = 2 [static] The node is an Attr.	Node
		DOM 1 Core CDATA_SECTION_NODE : Number = 4 [static] The node is a CDATASection.	Node
		DOM 1 Core COMMENT_NODE : Number = 8 [static] The node is a Comment.	Node
		DOM 1 Core DOCUMENT_FRAGMENT_NODE : Number = 11 [static] The node is a DocumentFragment.	Node
		DOM 1 Core DOCUMENT_NODE : Number = 9 [static] The node is a Document.	Node
		DOM 3 Core DOCUMENT_POSITION_CONTAINED_BY : Number = 16 [static] The node is contained by the reference node.	Node
		DOM 3 Core DOCUMENT_POSITION_CONTAINS : Number = 8 [static] The node contains the reference node.	Node
		DOM 3 Core DOCUMENT_POSITION_DISCONNECTED : Number = 1 [static] The two nodes are disconnected.	Node
		DOM 3 Core DOCUMENT_POSITION_FOLLOWING : Number = 4 [static] The node follows the reference node.	Node
		DOM 3 Core DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC : Number = 32 [static] The determination of preceding versus following is implementation-specific.	Node
		DOM 3 Core DOCUMENT_POSITION_PRECEDING : Number = 2 [static] The second node precedes the reference node.	Node
		DOM 1 Core DOCUMENT_TYPE_NODE : Number = 10 [static] The node is a DocumentType.	Node
		DOM 1 Core ELEMENT_NODE : Number = 1 [static] The node is an Element.	Node
		DOM 1 Core ENTITY_NODE : Number = 6 [static] The node is an Entity.	Node
		DOM 1 Core ENTITY_REFERENCE_NODE : Number = 5 [static] The node is an EntityReference.	Node
		DOM 1 Core NOTATION_NODE : Number = 12 [static] The node is a Notation.	Node
		DOM 1 Core PROCESSING_INSTRUCTION_NODE : Number = 7 [static] The node is a ProcessingInstruction.	Node
		DOM 1 Core TEXT_NODE : Number = 3 [static] The node is a Text node.	Node

Property Detail

DOM 3 Core inputEncoding

property

inputEncoding:DOMString [read-only]

Introduced in:

DOM 3 Core

An attribute specifying the encoding used for this entity at the time of parsing, when it is an external parsed entity. This is null if it an entity from the internal subset or if it is not known.

Implementation
public function get inputEncoding():DOMString

DOM 1 Core notationName

property

notationName:DOMString [read-only]

Introduced in:

DOM 1 Core

For unparsed entities, the name of the notation for the entity. For parsed entities, this is null.

Implementation
public function get notationName():DOMString

DOM 1 Core publicId

property

publicId:DOMString [read-only]

Introduced in:

DOM 1 Core

The public identifier associated with the entity if specified, and null otherwise.

Implementation
public function get publicId():DOMString

DOM 1 Core systemId

property

systemId:DOMString [read-only]

Introduced in:

DOM 1 Core

The system identifier associated with the entity if specified, and null otherwise. This may be an absolute URI or not.

Implementation
public function get systemId():DOMString

DOM 3 Core xmlEncoding

property

xmlEncoding:DOMString [read-only]

Introduced in:

DOM 3 Core

An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity. This is null otherwise.

Implementation
public function get xmlEncoding():DOMString

DOM 3 Core xmlVersion

property

xmlVersion:DOMString [read-only]

Introduced in:

DOM 3 Core

An attribute specifying, as part of the text declaration, the version number of this entity, when it is an external parsed entity. This is null otherwise.

Implementation
public function get xmlVersion():DOMString

Mon Aug 17 2009, 10:08 AM -04:00

DOM Reference Manual		All Packages \| All Classes \| Index \| Frames No Frames
Entity	Properties \| Methods \| Constants