API Preview tool | The Dojo Toolkit

dojox/wire/ml/util.js

Provides:
- dojox.wire.ml.util
Requires:
- dojox.xml.parser in common
- dojox.wire.Wire in common

dojox.wire.ml.XmlElement

type
```
Function
```
parameters:
- element: (typeof Element||String)
```
An XML element or a tag name
```
summary
```
An object wrapping an XML element
```
description
```
This class represents an XML element.
```

dojox.wire.ml.XmlElement.constructor
- constructor - constructor
- type
```
Function
```
- parameters:
  - element: (typeof Element||String)
```
An XML element or a tag name
```
- summary
```
Initialize with an XML element or a tag name
```

dojox.wire.ml.XmlElement.getPropertyValue

parameters:
- property: (typeof String)
```
A property name
```
returns
```
undefined|String||Array|XmlElement
```
summary
```
Return a property value
```

description

If 'property' starts with '@', the attribute value is returned.
If 'property' specifies "text()", the value of the first child
text is returned.
Otherwise, child elements of the tag name specified with
'property' are returned.

return_summary
```
A property value
```
type
```
Function
```

dojox.wire.ml.XmlElement.element.firstChild

dojox.wire.ml.XmlElement.setPropertyValue

parameters:
- property: (typeof String)
```
A property name
```
- value: (typeof String||Array||XmlElement)
```
A property value
```
returns
```
undefined
```
summary
```
Store a property value
```

description

If 'property' starts with '@', 'value' is set to the attribute.
If 'property' specifies "text()", 'value' is set as the first
child text.
If 'value' is a string, a child element of the tag name
specified with 'property' is created and 'value' is set as
the first child text of the child element.
Otherwise, 'value' is set to as child elements.

type
```
Function
```

dojox.wire.ml.XmlElement.toString

returns
```
String
```

summary

Return a value of the first text child of the element

description

A value of the first text child of the element is returned.

return_summary

A value of the first text child of the element

type
```
Function
```

dojox.wire.ml.XmlElement.element.firstChild.nodeValue
- type
```
String
```

dojox.wire.ml.XmlElement.toObject

returns
```
null|String|Object
```

summary

Return an object representation of the element

description

An object with properties for child elements, attributes and
text is returned.

return_summary
```
An object representation of the element
```
type
```
Function
```

dojox.wire.ml.XmlElement.element.attributes.length
- type
```
Number
```

dojox.wire.ml.XmlElement._getDocument

returns
```
Document
```
summary
```
Return a DOM document
```

description

If 'element' is specified, a DOM document of the element is
returned.
Otherwise, a DOM document is created.

return_summary
```
A DOM document
```
type
```
Function
```

dojox.wire.ml.XmlElement.element
- type
```
An
```
- summary
```
XML element or a tag name
```

dojox.wire.ml._getValue

parameters:

source: (typeof String)

A string to specify an object and its property

args: (typeof Array)
```
An optional arguments array
```

returns
```
undefined|Object|anything
```
summary
```
Return a value
```

description

This method obtains an object by an ID of a widget or an DOM
element.
If 'source' specifies a dotted notation to its property, a Wire is
used to get the object property.
If 'source' starts with "arguments", 'args' is used as a root
object for the Wire.

return_summary
```
A value
```
type
```
Function
```

dojox.wire.ml._setValue

parameters:
- target: (typeof String)
```
A string to specify an object and its property
```
- value: (typeof anything)
```
A value
```
returns
```
undefined
```
summary
```
Store a value
```

description

This method stores a value by an ID of a widget or an DOM
element with a dotted notation to its property, using a Wire.

type
```
Function
```

dojox.wire.ml.util
- type
```
Object
```
dojox.wire.ml
- type
```
Object
```
dojox.wire
- type
```
Object
```
dojox
- type
```
Object
```

dojox/wire/ml/util.js

Provides:

Requires:

dojox.wire.ml.XmlElement

dojox.wire.ml.XmlElement.constructor

dojox.wire.ml.XmlElement.getPropertyValue

dojox.wire.ml.XmlElement.element.firstChild

dojox.wire.ml.XmlElement.setPropertyValue

dojox.wire.ml.XmlElement.toString

dojox.wire.ml.XmlElement.element.firstChild.nodeValue

dojox.wire.ml.XmlElement.toObject

dojox.wire.ml.XmlElement.element.attributes.length

dojox.wire.ml.XmlElement._getDocument

dojox.wire.ml.XmlElement.element

dojox.wire.ml._getValue

dojox.wire.ml._setValue

dojox.wire.ml.util

dojox.wire.ml

dojox.wire

dojox