XULDocument

This object is available to unprivileged JavaScript. It implements the following interfaces:

Constants

short DOCUMENT_POSITION_DISCONNECTED = 1
short DOCUMENT_POSITION_PRECEDING = 2
short DOCUMENT_POSITION_FOLLOWING = 4
short DOCUMENT_POSITION_CONTAINS = 8
short DOCUMENT_POSITION_CONTAINED_BY = 16
short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 32
The nsIDOMNode interface is the primary datatype for the entire Document Object Model. It represents a single node in the document tree.

For more information on this interface please see http://www.w3.org/TR/DOM-Level-2-Core/

short ELEMENT_NODE = 1
short ATTRIBUTE_NODE = 2
short TEXT_NODE = 3
short CDATA_SECTION_NODE = 4
short ENTITY_REFERENCE_NODE = 5
short ENTITY_NODE = 6
short PROCESSING_INSTRUCTION_NODE = 7
short COMMENT_NODE = 8
short DOCUMENT_NODE = 9
short DOCUMENT_TYPE_NODE = 10
short DOCUMENT_FRAGMENT_NODE = 11
short NOTATION_NODE = 12

Properties

readonly NamedNodeMap attributes

readonly String baseURI

readonly String characterSet

readonly NodeList childNodes

readonly XULCommandDispatcher commandDispatcher

readonly String contentType

readonly AbstractView defaultView

The nsIDOMDocumentView interface is a datatype for a document that supports views in the Document Object Model.

For more information on this interface please see http://www.w3.org/TR/DOM-Level-2-Views

String dir

readonly DocumentType doctype

The nsIDOMDocument 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 nsIDOMDocument interface also contains the factory methods needed to create these objects.

For more information on this interface please see http://www.w3.org/TR/DOM-Level-2-Core/

readonly Element documentElement

String documentURI

readonly nsIDOMDOMConfiguration domConfig

readonly Node firstChild

readonly PRInt32 height

readonly DOMImplementation implementation

readonly String inputEncoding

readonly Node lastChild

readonly String lastModified

readonly String localName

readonly Location location

readonly String namespaceURI

readonly Node nextSibling

readonly String nodeName

readonly short nodeType

String nodeValue

readonly Document ownerDocument

readonly Node parentNode

Node popupNode

String prefix

readonly Node previousSibling

readonly String referrer

boolean strictErrorChecking

readonly StyleSheetList styleSheets

String textContent

String title

Node tooltipNode

readonly PRInt32 width

readonly String xmlEncoding

boolean xmlStandalone

String xmlVersion


Methods

void addBinding ( Element elt , String bindingURL ) void addBroadcastListenerFor ( Element broadcaster , Element observer , String attr ) void addEventListener ( String type , EventListener listener , boolean useCapture ) Node adoptNode ( Node source ) Node appendChild ( Node newChild ) Node cloneNode ( boolean deep ) short compareDocumentPosition ( Node other ) Attr createAttribute ( String name ) Attr createAttributeNS ( String namespaceURI , String qualifiedName ) CDATASection createCDATASection ( String data ) Comment createComment ( String data ) DocumentFragment createDocumentFragment ( ) Element createElement ( String tagName ) Element createElementNS ( String namespaceURI , String qualifiedName ) EntityReference createEntityReference ( String name ) Event createEvent ( String eventType ) XPathExpression createExpression ( String expression , XPathNSResolver resolver ) NodeIterator createNodeIterator ( Node root , int whatToShow , NodeFilter filter , boolean entityReferenceExpansion ) XPathNSResolver createNSResolver ( Node nodeResolver ) ProcessingInstruction createProcessingInstruction ( String target , String data ) Range createRange ( ) Text createTextNode ( String data ) TreeWalker createTreeWalker ( Node root , int whatToShow , NodeFilter filter , boolean entityReferenceExpansion ) boolean dispatchEvent ( Event evt ) nsISupports evaluate ( String expression , Node contextNode , XPathNSResolver resolver , short type , nsISupports result ) Element getAnonymousElementByAttribute ( Element elt , String attrName , String attrValue ) NodeList getAnonymousNodes ( Element elt ) Element getBindingParent ( Node node ) BoxObject getBoxObjectFor ( Element elt ) Element getElementById ( String elementId ) NodeList getElementsByAttribute ( String name , String value ) NodeList getElementsByTagName ( String tagname ) NodeList getElementsByTagNameNS ( String namespaceURI , String localName ) nsISupports getFeature ( String feature , String version ) nsIVariant getUserData ( String key ) boolean hasAttributes ( ) boolean hasChildNodes ( ) Node importNode ( Node importedNode , boolean deep ) Node insertBefore ( Node newChild , Node refChild ) boolean isDefaultNamespace ( String namespaceURI ) boolean isEqualNode ( Node arg ) boolean isSameNode ( Node other ) boolean isSupported ( String feature , String version ) Document loadBindingDocument ( String documentURL ) void loadOverlay ( String url , nsIObserver observer ) String lookupNamespaceURI ( String prefix ) String lookupPrefix ( String namespaceURI ) void normalize ( ) void normalizeDocument ( ) void persist ( String id , String attr ) void removeBinding ( Element elt , String bindingURL ) void removeBroadcastListenerFor ( Element broadcaster , Element observer , String attr ) Node removeChild ( Node oldChild ) void removeEventListener ( String type , EventListener listener , boolean useCapture ) Node renameNode ( Node node , String namespaceURI , String qualifiedName ) Node replaceChild ( Node newChild , Node oldChild ) void setBoxObjectFor ( Element elt , BoxObject boxObject ) nsIVariant setUserData ( String key , nsIVariant data , nsIDOMUserDataHandler handler )

void addBinding ( Element elt , String bindingURL )

Arguments:
elt
bindingURL

void addBroadcastListenerFor ( Element broadcaster , Element observer , String attr )

Arguments:
broadcaster
observer
attr

void addEventListener ( String type , EventListener listener , boolean useCapture )

This method allows the registration of event listeners on the event target. If an EventListener is added to an EventTarget while it is processing an event, it will not be triggered by the current actions but may be triggered during a later stage of event flow, such as the bubbling phase.

If multiple identical EventListeners are registered on the same EventTarget with the same parameters the duplicate instances are discarded. They do not cause the EventListener to be called twice and since they are discarded they do not need to be removed with the removeEventListener method.

Arguments:
type: The event type for which the user is registering
listener: The listener parameter takes an interface implemented by the user which contains the methods to be called when the event occurs.
useCapture: If true, useCapture indicates that the user wishes to initiate capture. After initiating capture, all events of the specified type will be dispatched to the registered EventListener before being dispatched to any EventTargets beneath them in the tree. Events which are bubbling upward through the tree will not trigger an EventListener designated to use capture.

Node adoptNode ( Node source )

Arguments:
source

Node appendChild ( Node newChild )

Arguments:
newChild

Node cloneNode ( boolean deep )

Arguments:
deep

short compareDocumentPosition ( Node other )

Arguments:
other

Attr createAttribute ( String name )

Arguments:
name

Attr createAttributeNS ( String namespaceURI , String qualifiedName )

Arguments:
namespaceURI
qualifiedName

CDATASection createCDATASection ( String data )

Arguments:
data

Comment createComment ( String data )

Arguments:
data

DocumentFragment createDocumentFragment ( )


Element createElement ( String tagName )

Arguments:
tagName

Element createElementNS ( String namespaceURI , String qualifiedName )

Arguments:
namespaceURI
qualifiedName

EntityReference createEntityReference ( String name )

Arguments:
name

Event createEvent ( String eventType )

Arguments:
eventType

XPathExpression createExpression ( String expression , XPathNSResolver resolver )

Arguments:
expression
resolver

NodeIterator createNodeIterator ( Node root , int whatToShow , NodeFilter filter , boolean entityReferenceExpansion )

Arguments:
root
whatToShow
filter
entityReferenceExpansion

XPathNSResolver createNSResolver ( Node nodeResolver )

Arguments:
nodeResolver

ProcessingInstruction createProcessingInstruction ( String target , String data )

Arguments:
target
data

Range createRange ( )


Text createTextNode ( String data )

Arguments:
data

TreeWalker createTreeWalker ( Node root , int whatToShow , NodeFilter filter , boolean entityReferenceExpansion )

Arguments:
root
whatToShow
filter
entityReferenceExpansion

boolean dispatchEvent ( Event evt )

This method allows the dispatch of events into the implementations event model. Events dispatched in this manner will have the same capturing and bubbling behavior as events dispatched directly by the implementation. The target of the event is the EventTarget on which dispatchEvent is called.

Arguments:
evt: Specifies the event type, behavior, and contextual information to be used in processing the event.
Returns:
Indicates whether any of the listeners which handled the event called preventDefault. If preventDefault was called the value is false, else the value is true.

nsISupports evaluate ( String expression , Node contextNode , XPathNSResolver resolver , short type , nsISupports result )

Arguments:
expression
contextNode
resolver
type
result

Element getAnonymousElementByAttribute ( Element elt , String attrName , String attrValue )

Arguments:
elt
attrName
attrValue

NodeList getAnonymousNodes ( Element elt )

Arguments:
elt

Element getBindingParent ( Node node )

Arguments:
node

BoxObject getBoxObjectFor ( Element elt )

Arguments:
elt

Element getElementById ( String elementId )

Arguments:
elementId

NodeList getElementsByAttribute ( String name , String value )

Arguments:
name
value

NodeList getElementsByTagName ( String tagname )

Arguments:
tagname

NodeList getElementsByTagNameNS ( String namespaceURI , String localName )

Arguments:
namespaceURI
localName

nsISupports getFeature ( String feature , String version )

Arguments:
feature
version

nsIVariant getUserData ( String key )

Arguments:
key

boolean hasAttributes ( )


boolean hasChildNodes ( )


Node importNode ( Node importedNode , boolean deep )

Arguments:
importedNode
deep

Node insertBefore ( Node newChild , Node refChild )

Arguments:
newChild
refChild

boolean isDefaultNamespace ( String namespaceURI )

Arguments:
namespaceURI

boolean isEqualNode ( Node arg )

Arguments:
arg

boolean isSameNode ( Node other )

Arguments:
other

boolean isSupported ( String feature , String version )

Arguments:
feature
version

Document loadBindingDocument ( String documentURL )

Arguments:
documentURL

void loadOverlay ( String url , nsIObserver observer )

Loads a XUL overlay and merges it with the current document, notifying an observer when the merge is complete.

NOTICE: In the 2.0 timeframe this API will change such that the implementation will fire a DOMXULOverlayMerged event upon merge completion rather than notifying an observer. Do not rely on this API's behavior _not_ to change because it will! - Ben Goodger (8/23/2005)

Arguments:
url: The URL of the overlay to load and merge
observer: An object implementing nsIObserver that will be notified with a message of topic "xul-overlay-merged" when the merge is complete. The subject parameter of |observe| will QI to a nsIURI - the URI of the merged overlay. This parameter is optional and may be null.

String lookupNamespaceURI ( String prefix )

Arguments:
prefix

String lookupPrefix ( String namespaceURI )

Arguments:
namespaceURI

void normalize ( )


void normalizeDocument ( )


void persist ( String id , String attr )

Arguments:
id
attr

void removeBinding ( Element elt , String bindingURL )

Arguments:
elt
bindingURL

void removeBroadcastListenerFor ( Element broadcaster , Element observer , String attr )

Arguments:
broadcaster
observer
attr

Node removeChild ( Node oldChild )

Arguments:
oldChild

void removeEventListener ( String type , EventListener listener , boolean useCapture )

This method allows the removal of event listeners from the event target. If an EventListener is removed from an EventTarget while it is processing an event, it will not be triggered by the current actions. EventListeners can never be invoked after being removed. Calling removeEventListener with arguments which do not identify any currently registered EventListener on the EventTarget has no effect.

Arguments:
type: Specifies the event type of the EventListener being removed.
listener: The EventListener parameter indicates the EventListener to be removed.
useCapture: Specifies whether the EventListener being removed was registered as a capturing listener or not. If a listener was registered twice, one with capture and one without, each must be removed separately. Removal of a capturing listener does not affect a non-capturing version of the same listener, and vice versa.

Node renameNode ( Node node , String namespaceURI , String qualifiedName )

Arguments:
node
namespaceURI
qualifiedName

Node replaceChild ( Node newChild , Node oldChild )

Arguments:
newChild
oldChild

void setBoxObjectFor ( Element elt , BoxObject boxObject )

Arguments:
elt
boxObject

nsIVariant setUserData ( String key , nsIVariant data , nsIDOMUserDataHandler handler )

Arguments:
key
data
handler

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
March 28, 2005, 8:11 pm surkov at dc dot baikal dot ru
Argument "whatToShow" of createTreeWalker() and createNodeIterator() methods is constant defined in NodeFilter object:

SHOW_ALL = -1
SHOW_ELEMENT = 1
SHOW_ATTRIBUTE = 2
SHOW_TEXT = 4
SHOW_CDATA_SECTION = 8
SHOW_ENTITY_REFERENCE = 16
SHOW_ENTITY = 32
SHOW_PROCESSING_INSTRUCTION = 64
SHOW_COMMENT = 128
SHOW_DOCUMENT = 256
SHOW_DOCUMENT_TYPE = 512
SHOW_DOCUMENT_FRAGMENT = 1024
SHOW_NOTATION = 2048

Copyright © 1999 - 2005 XULPlanet.com