| CFML Reference |
|
|
WDDX JavaScript Objects |
|
| CFML Reference |
|
|
WDDX JavaScript Objects |
|
The WddxSerializer object includes functions that serialize any JavaScript data structure.
The only function that developers typically call is serialize.
Creates a WDDX packet for a passed WddxRecordset instance.
object.serialize( rootobj )
| Parameter | Description |
|---|---|
| object |
Instance name of the WddxSerializer object |
| rootobj |
JavaScript data structure to serialize |
Returns a serialized WDDX packet as a String if the function succeeds, or a null value if an error occurs.
Call this function to serialize the data in a WddxRecordset instance.
This example shows a JavaScript function that you can call to serialize a WddxRecordset instance. It copies serialized data to a form field for display:
function serializeData(data, formField)
{
wddxSerializer = new WddxSerializer();
wddxPacket = wddxSerializer.serialize(data);
if (wddxPacket != null)
{
formField.value = wddxPacket;
}
else
{
alert("Couldn't serialize data");
}
}
Serializes a property of a structure. If an object is not a string, number, array, Boolean, or date, WddxSerializer treats it as a structure.
object.serializeVariable( name, obj )
| Parameter | Description |
|---|---|
| object |
Instance name of a WddxSerializer object |
| name |
Property to serialize |
| obj |
Instance name of the value to serialize |
Returns a Boolean True if serialization was successful, or False if an error occurs.
This is an internal function; you do not typically call it.
This example is from the WddxSerializer serializeValue function:
...
// Some generic object; treat it as a structure
this.write("<struct>");
for (prop in obj)
{
bSuccess = this.serializeVariable(prop, obj[prop]);
if (! bSuccess)
{
break;
}
}
this.write("</struct>");
...
Recursively serializes eligible data in a passed instance. Eligible data includes:
This function serializes null values as empty strings.
object.serializeValue( obj )
| Parameter | Description |
|---|---|
| object |
Instance name of the WddxSerializer object |
| obj |
Instance name of the WddxRecordset object to serialize |
Returns a Boolean True if obj was serialized successfully; or False if an error occurs.
This is an internal function; you do not typically call it.
This example is from the WddxSerializer serialize function:
...
this.wddxPacket = "";
this.write("<wddxPacket version='1.0'><header/><data>");
bSuccess = this.serializeValue(rootObj);
this.write("</data></wddxPacket>");
if (bSuccess)
{
return this.wddxPacket;
}
else
{
return null;
}
...
Appends data to a serialized data stream.
object.write( str )
| Parameter | Description |
|---|---|
| object |
Instance name of the WddxSerializer object |
| str |
String to be copied to the serialized data stream |
Returns an updated serialized data stream as a String.
This is an internal function; you do not typically call it.
This example is from the WddxSerializer serializeValue function:
...
else if (typeof(obj) == "number")
{
// Number value
this.write("<number>" + obj + "</number>");
}
else if (typeof(obj) == "boolean")
{
// Boolean value
this.write("<boolean value='" + obj + "'/>");
}
...