25 October 2001

Appendix C: ECMAScript Language Binding

This appendix contains the complete ECMAScript [ECMAScript] binding for the Level 3 Document Object Model Abstract Schemas and Load and Save definitions.

Prototype Object DOMASException
The DOMASException class has the following constants:
DOMASException.DUPLICATE_NAME_ERR
This constant is of type Number and its value is 1.
DOMASException.TYPE_ERR
This constant is of type Number and its value is 2.
DOMASException.NO_AS_AVAILABLE
This constant is of type Number and its value is 3.
DOMASException.WRONG_MIME_TYPE_ERR
This constant is of type Number and its value is 4.
Object DOMASException
The DOMASException object has the following properties:
code
This property is of type Number.
Object ASModel
ASModel has the all the properties and methods of the ASObject object as well as the properties and methods defined below.
The ASModel object has the following properties:
isNamespaceAware
This read-only property is of type Boolean.
usageLocation
This read-only property is of type Number.
asLocation
This property is of type String.
asHint
This property is of type String.
elementDeclarations
This read-only property is a ASNamedObjectMap object.
attributeDeclarations
This read-only property is a ASNamedObjectMap object.
notationDeclarations
This read-only property is a ASNamedObjectMap object.
entityDeclarations
This read-only property is a ASNamedObjectMap object.
contentModelDeclarations
This read-only property is a ASNamedObjectMap object.
The ASModel object has the following methods:
setASModel(abstractSchema)
This method has no return value.
The abstractSchema parameter is a ASModel object.
getASModels()
This method returns a ASObjectList object.
removeAS(as)
This method has no return value.
The as parameter is a ASModel object.
validate()
This method returns a Boolean.
createASElementDeclaration(namespaceURI, name)
This method returns a ASElementDeclaration object.
The namespaceURI parameter is of type String.
The name parameter is of type String.
This method can raise a DOMException object.
createASAttributeDeclaration(namespaceURI, name)
This method returns a ASAttributeDeclaration object.
The namespaceURI parameter is of type String.
The name parameter is of type String.
This method can raise a DOMException object.
createASNotationDeclaration(namespaceURI, name, systemId, publicId)
This method returns a ASNotationDeclaration object.
The namespaceURI parameter is of type String.
The name parameter is of type String.
The systemId parameter is of type String.
The publicId parameter is of type String.
This method can raise a DOMException object.
createASEntityDeclaration(name)
This method returns a ASEntityDeclaration object.
The name parameter is of type String.
This method can raise a DOMException object.
createASContentModel(minOccurs, maxOccurs, operator)
This method returns a ASContentModel object.
The minOccurs parameter is of type Number.
The maxOccurs parameter is of type Number.
The operator parameter is of type Number.
This method can raise a DOMASException object.
Prototype Object ASObject
The ASObject class has the following constants:
ASObject.AS_ELEMENT_DECLARATION
This constant is of type Number and its value is 1.
ASObject.AS_ATTRIBUTE_DECLARATION
This constant is of type Number and its value is 2.
ASObject.AS_NOTATION_DECLARATION
This constant is of type Number and its value is 3.
ASObject.AS_ENTITY_DECLARATION
This constant is of type Number and its value is 4.
ASObject.AS_CONTENTMODEL
This constant is of type Number and its value is 5.
ASObject.AS_MODEL
This constant is of type Number and its value is 6.
Object ASObject
The ASObject object has the following properties:
asNodeType
This read-only property is of type Number.
ownerASModel
This property is a ASModel object.
nodeName
This property is of type String.
prefix
This property is of type String.
localName
This property is of type String.
namespaceURI
This property is of type String.
The ASObject object has the following methods:
cloneASObject(deep)
This method returns a ASObject object.
The deep parameter is of type Boolean.
Object ASObjectList
The ASObjectList object has the following properties:
length
This read-only property is of type Number.
The ASObjectList object has the following methods:
item(index)
This method returns a ASObject object.
The index parameter is of type Number.
Note: This object can also be dereferenced using square bracket notation (e.g. obj[1]). Dereferencing with an integer index is equivalent to invoking the item method with that index.
Object ASNamedObjectMap
The ASNamedObjectMap object has the following properties:
length
This read-only property is of type Number.
The ASNamedObjectMap object has the following methods:
getNamedItem(name)
This method returns a ASObject object.
The name parameter is of type String.
getNamedItemNS(namespaceURI, localName)
This method returns a ASObject object.
The namespaceURI parameter is of type String.
The localName parameter is of type String.
item(index)
This method returns a ASObject object.
The index parameter is of type Number.
Note: This object can also be dereferenced using square bracket notation (e.g. obj[1]). Dereferencing with an integer index is equivalent to invoking the item method with that index.
removeNamedItem(name)
This method returns a ASObject object.
The name parameter is of type String.
This method can raise a DOMException object.
removeNamedItemNS(namespaceURI, localName)
This method returns a ASObject object.
The namespaceURI parameter is of type String.
The localName parameter is of type String.
This method can raise a DOMException object.
setNamedItem(newASObject)
This method returns a ASObject object.
The newASObject parameter is a ASObject object.
This method can raise a DOMException object.
setNamedItemNS(newASObject)
This method returns a ASObject object.
The newASObject parameter is a ASObject object.
This method can raise a DOMException object.
Prototype Object ASDataType
The ASDataType class has the following constants:
ASDataType.STRING_DATATYPE
This constant is of type Number and its value is 1.
ASDataType.NOTATION_DATATYPE
This constant is of type Number and its value is 10.
ASDataType.ID_DATATYPE
This constant is of type Number and its value is 11.
ASDataType.IDREF_DATATYPE
This constant is of type Number and its value is 12.
ASDataType.IDREFS_DATATYPE
This constant is of type Number and its value is 13.
ASDataType.ENTITY_DATATYPE
This constant is of type Number and its value is 14.
ASDataType.ENTITIES_DATATYPE
This constant is of type Number and its value is 15.
ASDataType.NMTOKEN_DATATYPE
This constant is of type Number and its value is 16.
ASDataType.NMTOKENS_DATATYPE
This constant is of type Number and its value is 17.
ASDataType.BOOLEAN_DATATYPE
This constant is of type Number and its value is 100.
ASDataType.FLOAT_DATATYPE
This constant is of type Number and its value is 101.
ASDataType.DOUBLE_DATATYPE
This constant is of type Number and its value is 102.
ASDataType.DECIMAL_DATATYPE
This constant is of type Number and its value is 103.
ASDataType.HEXBINARY_DATATYPE
This constant is of type Number and its value is 104.
ASDataType.BASE64BINARY_DATATYPE
This constant is of type Number and its value is 105.
ASDataType.ANYURI_DATATYPE
This constant is of type Number and its value is 106.
ASDataType.QNAME_DATATYPE
This constant is of type Number and its value is 107.
ASDataType.DURATION_DATATYPE
This constant is of type Number and its value is 108.
ASDataType.DATETIME_DATATYPE
This constant is of type Number and its value is 109.
ASDataType.DATE_DATATYPE
This constant is of type Number and its value is 110.
ASDataType.TIME_DATATYPE
This constant is of type Number and its value is 111.
ASDataType.GYEARMONTH_DATATYPE
This constant is of type Number and its value is 112.
ASDataType.GYEAR_DATATYPE
This constant is of type Number and its value is 113.
ASDataType.GMONTHDAY_DATATYPE
This constant is of type Number and its value is 114.
ASDataType.GDAY_DATATYPE
This constant is of type Number and its value is 115.
ASDataType.GMONTH_DATATYPE
This constant is of type Number and its value is 116.
ASDataType.INTEGER
This constant is of type Number and its value is 117.
ASDataType.NAME_DATATYPE
This constant is of type Number and its value is 200.
ASDataType.NCNAME_DATATYPE
This constant is of type Number and its value is 201.
ASDataType.NORMALIZEDSTRING_DATATYPE
This constant is of type Number and its value is 202.
ASDataType.TOKEN_DATATYPE
This constant is of type Number and its value is 203.
ASDataType.LANGUAGE_DATATYPE
This constant is of type Number and its value is 204.
ASDataType.NONPOSITIVEINTEGER_DATATYPE
This constant is of type Number and its value is 205.
ASDataType.NEGATIVEINTEGER_DATATYPE
This constant is of type Number and its value is 206.
ASDataType.LONG_DATATYPE
This constant is of type Number and its value is 207.
ASDataType.INT_DATATYPE
This constant is of type Number and its value is 208.
ASDataType.SHORT_DATATYPE
This constant is of type Number and its value is 209.
ASDataType.BYTE_DATATYPE
This constant is of type Number and its value is 210.
ASDataType.NONNEGATIVEINTEGER_DATATYPE
This constant is of type Number and its value is 211.
ASDataType.UNSIGNEDLONG_DATATYPE
This constant is of type Number and its value is 212.
ASDataType.UNSIGNEDINT_DATATYPE
This constant is of type Number and its value is 213.
ASDataType.UNSIGNEDSHORT_DATATYPE
This constant is of type Number and its value is 214.
ASDataType.UNSIGNEDBYTE_DATATYPE
This constant is of type Number and its value is 215.
ASDataType.POSITIVEINTEGER_DATATYPE
This constant is of type Number and its value is 216.
ASDataType.OTHER_SIMPLE_DATATYPE
This constant is of type Number and its value is 1000.
ASDataType.COMPLEX_DATATYPE
This constant is of type Number and its value is 1001.
Object ASDataType
The ASDataType object has the following properties:
dataType
This read-only property is of type Number.
Prototype Object ASElementDeclaration
The ASElementDeclaration class has the following constants:
ASElementDeclaration.EMPTY_CONTENTTYPE
This constant is of type Number and its value is 1.
ASElementDeclaration.ANY_CONTENTTYPE
This constant is of type Number and its value is 2.
ASElementDeclaration.MIXED_CONTENTTYPE
This constant is of type Number and its value is 3.
ASElementDeclaration.ELEMENTS_CONTENTTYPE
This constant is of type Number and its value is 4.
Object ASElementDeclaration
ASElementDeclaration has the all the properties and methods of the ASObject object as well as the properties and methods defined below.
The ASElementDeclaration object has the following properties:
strictMixedContent
This property is of type Boolean.
elementType
This property is a ASDataType object.
isPCDataOnly
This property is of type Boolean.
contentType
This property is of type Number.
systemId
This property is of type String.
asCM
This property is a ASContentModel object.
ASAttributeDecls
This property is a ASNamedObjectMap object.
The ASElementDeclaration object has the following methods:
addASAttributeDecl(attributeDecl)
This method has no return value.
The attributeDecl parameter is a ASAttributeDeclaration object.
removeASAttributeDecl(attributeDecl)
This method returns a ASAttributeDeclaration object.
The attributeDecl parameter is a ASAttributeDeclaration object.
Prototype Object ASContentModel
The ASContentModel class has the following constants:
ASContentModel.AS_UNBOUNDED
This constant is of type Number and its value is MAX_VALUE.
ASContentModel.AS_SEQUENCE
This constant is of type Number and its value is 0.
ASContentModel.AS_CHOICE
This constant is of type Number and its value is 1.
ASContentModel.AS_ALL
This constant is of type Number and its value is 2.
ASContentModel.AS_NONE
This constant is of type Number and its value is 3.
Object ASContentModel
ASContentModel has the all the properties and methods of the ASObject object as well as the properties and methods defined below.
The ASContentModel object has the following properties:
listOperator
This property is of type Number.
minOccurs
This property is of type Number.
maxOccurs
This property is of type Number.
subModels
This property is a ASObjectList object.
The ASContentModel object has the following methods:
removesubModel(oldNode)
This method has no return value.
The oldNode parameter is a ASObject object.
insertsubModel(newNode)
This method has no return value.
The newNode parameter is a ASObject object.
This method can raise a DOMASException object.
appendsubModel(newNode)
This method returns a Number.
The newNode parameter is a ASObject object.
This method can raise a DOMASException object.
Prototype Object ASAttributeDeclaration
The ASAttributeDeclaration class has the following constants:
ASAttributeDeclaration.VALUE_NONE
This constant is of type Number and its value is 0.
ASAttributeDeclaration.VALUE_DEFAULT
This constant is of type Number and its value is 1.
ASAttributeDeclaration.VALUE_FIXED
This constant is of type Number and its value is 2.
Object ASAttributeDeclaration
ASAttributeDeclaration has the all the properties and methods of the ASObject object as well as the properties and methods defined below.
The ASAttributeDeclaration object has the following properties:
dataType
This property is a ASDataType object.
dataValue
This property is of type String.
enumAttr
This property is of type String.
ownerElements
This property is a ASObjectList object.
defaultType
This property is of type Number.
Prototype Object ASEntityDeclaration
The ASEntityDeclaration class has the following constants:
ASEntityDeclaration.INTERNAL_ENTITY
This constant is of type Number and its value is 1.
ASEntityDeclaration.EXTERNAL_ENTITY
This constant is of type Number and its value is 2.
Object ASEntityDeclaration
ASEntityDeclaration has the all the properties and methods of the ASObject object as well as the properties and methods defined below.
The ASEntityDeclaration object has the following properties:
entityType
This property is of type Number.
entityValue
This property is of type String.
systemId
This property is of type String.
publicId
This property is of type String.
Object ASNotationDeclaration
ASNotationDeclaration has the all the properties and methods of the ASObject object as well as the properties and methods defined below.
The ASNotationDeclaration object has the following properties:
systemId
This property is of type String.
publicId
This property is of type String.
Object DocumentAS
The DocumentAS object has the following properties:
activeASModel
This property is a ASModel object.
boundASModels
This property is a ASObjectList object.
The DocumentAS object has the following methods:
getInternalAS()
This method returns a ASModel object.
setInternalAS(as)
This method has no return value.
The as parameter is a ASModel object.
addAS(as)
This method has no return value.
The as parameter is a ASModel object.
removeAS(as)
This method has no return value.
The as parameter is a ASModel object.
getElementDeclaration()
This method returns a ASElementDeclaration object.
This method can raise a DOMException object.
validate()
This method has no return value.
This method can raise a DOMASException object.
Object DOMImplementationAS
The DOMImplementationAS object has the following methods:
createAS(isNamespaceAware)
This method returns a ASModel object.
The isNamespaceAware parameter is of type Boolean.
createDOMASBuilder()
This method returns a DOMASBuilder object.
createDOMASWriter()
This method returns a DOMASWriter object.
Object DocumentEditAS
DocumentEditAS has the all the properties and methods of the NodeEditAS object as well as the properties and methods defined below.
The DocumentEditAS object has the following properties:
continuousValidityChecking
This property is of type Boolean.
Prototype Object NodeEditAS
The NodeEditAS class has the following constants:
NodeEditAS.WF_CHECK
This constant is of type Number and its value is 1.
NodeEditAS.NS_WF_CHECK
This constant is of type Number and its value is 2.
NodeEditAS.PARTIAL_VALIDITY_CHECK
This constant is of type Number and its value is 3.
NodeEditAS.STRICT_VALIDITY_CHECK
This constant is of type Number and its value is 4.
Object NodeEditAS
The NodeEditAS object has the following methods:
canInsertBefore(newChild, refChild)
This method returns a Boolean.
The newChild parameter is a Node object.
The refChild parameter is a Node object.
canRemoveChild(oldChild)
This method returns a Boolean.
The oldChild parameter is a Node object.
canReplaceChild(newChild, oldChild)
This method returns a Boolean.
The newChild parameter is a Node object.
The oldChild parameter is a Node object.
canAppendChild(newChild)
This method returns a Boolean.
The newChild parameter is a Node object.
isNodeValid(deep, wFValidityCheckLevel)
This method returns a Boolean.
The deep parameter is of type Boolean.
The wFValidityCheckLevel parameter is of type Number.
This method can raise a DOMASException object.
Object ElementEditAS
ElementEditAS has the all the properties and methods of the NodeEditAS object as well as the properties and methods defined below.
The ElementEditAS object has the following properties:
definedElementTypes
This read-only property is a NodeList object.
The ElementEditAS object has the following methods:
contentType()
This method returns a Number.
canSetAttribute(attrname, attrval)
This method returns a Boolean.
The attrname parameter is of type String.
The attrval parameter is of type String.
canSetAttributeNode(attrNode)
This method returns a Boolean.
The attrNode parameter is a Attr object.
canSetAttributeNS(name, attrval, namespaceURI)
This method returns a Boolean.
The name parameter is of type String.
The attrval parameter is of type String.
The namespaceURI parameter is of type String.
canRemoveAttribute(attrname)
This method returns a Boolean.
The attrname parameter is of type String.
canRemoveAttributeNS(attrname, namespaceURI)
This method returns a Boolean.
The attrname parameter is of type String.
The namespaceURI parameter is of type String.
canRemoveAttributeNode(attrNode)
This method returns a Boolean.
The attrNode parameter is a Node object.
getChildElements()
This method returns a NodeList object.
getParentElements()
This method returns a NodeList object.
getAttributeList()
This method returns a NodeList object.
isElementDefined(elemTypeName)
This method returns a Boolean.
The elemTypeName parameter is of type String.
isElementDefinedNS(elemTypeName, namespaceURI, name)
This method returns a Boolean.
The elemTypeName parameter is of type String.
The namespaceURI parameter is of type String.
The name parameter is of type String.
Object CharacterDataEditAS
CharacterDataEditAS has the all the properties and methods of the NodeEditAS object as well as the properties and methods defined below.
The CharacterDataEditAS object has the following properties:
isWhitespaceOnly
This read-only property is of type Boolean.
The CharacterDataEditAS object has the following methods:
canSetData(offset, count)
This method returns a Boolean.
The offset parameter is of type Number.
The count parameter is of type Number.
canAppendData(arg)
This method returns a Boolean.
The arg parameter is of type String.
canReplaceData(offset, count, arg)
This method returns a Boolean.
The offset parameter is of type Number.
The count parameter is of type Number.
The arg parameter is of type String.
canInsertData(offset, arg)
This method returns a Boolean.
The offset parameter is of type Number.
The arg parameter is of type String.
canDeleteData(offset, count)
This method returns a Boolean.
The offset parameter is of type Number.
The count parameter is of type Number.
Object DOMASBuilder
DOMASBuilder has the all the properties and methods of the DOMBuilder object as well as the properties and methods defined below.
The DOMASBuilder object has the following properties:
abstractSchema
This property is a ASModel object.
The DOMASBuilder object has the following methods:
parseASURI(uri)
This method returns a ASModel object.
The uri parameter is of type String.
This method can raise a DOMASException object or a DOMSystemException object.
parseASInputSource(is)
This method returns a ASModel object.
The is parameter is a DOMInputSource object.
This method can raise a DOMASException object or a DOMSystemException object.
Object DOMASWriter
DOMASWriter has the all the properties and methods of the DOMWriter object as well as the properties and methods defined below.
The DOMASWriter object has the following methods:
writeASModel(destination, model)
This method has no return value.
The destination parameter is a DOMOutputStream object.
The model parameter is a ASModel object.
This method can raise a DOMSystemException object.
Prototype Object DOMImplementationLS
The DOMImplementationLS class has the following constants:
DOMImplementationLS.MODE_SYNCHRONOUS
This constant is of type Number and its value is 1.
DOMImplementationLS.MODE_ASYNCHRONOUS
This constant is of type Number and its value is 2.
Object DOMImplementationLS
The DOMImplementationLS object has the following methods:
createDOMBuilder(mode)
This method returns a DOMBuilder object.
The mode parameter is of type Number.
This method can raise a DOMException object.
createDOMWriter()
This method returns a DOMWriter object.
createDOMInputSource()
This method returns a DOMInputSource object.
Prototype Object DOMBuilder
The DOMBuilder class has the following constants:
DOMBuilder.ACTION_REPLACE
This constant is of type Number and its value is 1.
DOMBuilder.ACTION_APPEND
This constant is of type Number and its value is 2.
DOMBuilder.ACTION_INSERT_AFTER
This constant is of type Number and its value is 3.
DOMBuilder.ACTION_INSERT_BEFORE
This constant is of type Number and its value is 4.
Object DOMBuilder
The DOMBuilder object has the following properties:
entityResolver
This property is a DOMEntityResolver object.
errorHandler
This property is a DOMErrorHandler object.
filter
This property is a DOMBuilderFilter object.
The DOMBuilder object has the following methods:
setFeature(name, state)
This method has no return value.
The name parameter is of type String.
The state parameter is of type Boolean.
This method can raise a DOMException object.
canSetFeature(name, state)
This method returns a Boolean.
The name parameter is of type String.
The state parameter is of type Boolean.
getFeature(name)
This method returns a Boolean.
The name parameter is of type String.
This method can raise a DOMException object.
parseURI(uri)
This method returns a Document object.
The uri parameter is of type String.
This method can raise a DOMSystemException object.
parse(is)
This method returns a Document object.
The is parameter is a DOMInputSource object.
This method can raise a DOMSystemException object.
parseWithContext(is, cnode, action)
This method has no return value.
The is parameter is a DOMInputSource object.
The cnode parameter is a Node object.
The action parameter is of type Number.
This method can raise a DOMException object.
Object DOMWriter
The DOMWriter object has the following properties:
encoding
This property is of type String.
lastEncoding
This read-only property is of type String.
newLine
This property is of type String.
errorHandler
This property is a DOMErrorHandler object.
The DOMWriter object has the following methods:
setFeature(name, state)
This method has no return value.
The name parameter is of type String.
The state parameter is of type Boolean.
This method can raise a DOMException object.
canSetFeature(name, state)
This method returns a Boolean.
The name parameter is of type String.
The state parameter is of type Boolean.
getFeature(name)
This method returns a Boolean.
The name parameter is of type String.
This method can raise a DOMException object.
writeNode(destination, wnode)
This method returns a Boolean.
The destination parameter is a DOMOutputStream object.
The wnode parameter is a Node object.
This method can raise a DOMSystemException object.
writeToString(wnode)
This method returns a String.
The wnode parameter is a Node object.
This method can raise a DOMException object.
Object DOMInputSource
The DOMInputSource object has the following properties:
byteStream
This property is a DOMInputSource object.
characterStream
This property is a DOMReader object.
stringData
This property is of type String.
encoding
This property is of type String.
publicId
This property is of type String.
systemId
This property is of type String.
baseURI
This property is of type String.
Object LSLoadEvent
LSLoadEvent has the all the properties and methods of the Event object as well as the properties and methods defined below.
The LSLoadEvent object has the following properties:
newDocument
This read-only property is a Document object.
inputSource
This read-only property is a DOMInputSource object.
Object LSProgressEvent
LSProgressEvent has the all the properties and methods of the Event object as well as the properties and methods defined below.
The LSProgressEvent object has the following properties:
inputSource
This read-only property is a DOMInputSource object.
position
This read-only property is of type Number.
totalSize
This read-only property is of type Number.
Object DOMEntityResolver
The DOMEntityResolver object has the following methods:
resolveEntity(publicId, systemId, baseURI)
This method returns a DOMInputSource object.
The publicId parameter is of type String.
The systemId parameter is of type String.
The baseURI parameter is of type String.
This method can raise a DOMSystemException object.
Object DOMBuilderFilter
The DOMBuilderFilter object has the following properties:
whatToShow
This read-only property is of type Number.
The DOMBuilderFilter object has the following methods:
startNode(snode)
This method returns a Number.
The snode parameter is a Node object.
endNode(enode)
This method returns a Number.
The enode parameter is a Node object.
Object DOMWriterFilter
DOMWriterFilter has the all the properties and methods of the NodeFilter object as well as the properties and methods defined below.
The DOMWriterFilter object has the following properties:
whatToShow
This read-only property is of type Number.
Object DocumentLS
The DocumentLS object has the following properties:
async
This property is of type Boolean.
The DocumentLS object has the following methods:
abort()
This method has no return value.
load(uri)
This method returns a Boolean.
The uri parameter is of type String.
loadXML(source)
This method returns a Boolean.
The source parameter is of type String.
saveXML(snode)
This method returns a String.
The snode parameter is a Node object.
This method can raise a DOMException object.
Object ParseErrorEvent
ParseErrorEvent has the all the properties and methods of the Event object as well as the properties and methods defined below.
The ParseErrorEvent object has the following properties:
error
This read-only property is a DOMError object.