Namespace: compression

Methods

staticbcdui.core.compression.compressDOMDocument(doc, fn, errorFn, isSync, compressAll)

core/compression/compressionPackage.js, line 414

Compresses a DOMDocument and encodes it in a string. This string can then be added to the URL to pass the DOMDocument to another page. Whenever possible this function tries to do the compression and encoding on the client. However if the client-side encoding is too big it makes a server request to get a more compact encoding. URL length limits for GET in chars:

• IE - 2048
• FF - 65536
• Webkit - 80000
• Opera - 190000
• Tomcat/Apache - 8190 overall, including url, header etc

therefore max guiStatusGZ length: max URL length minus path length

Name	Type	Default	Description
doc	DomDocument		The DOM document to be compressed.
fn	function		The callback function executed when the compression succeeds. This function gets a string argument with the compressed document.
errorFn	function		optional
isSync	boolean	false	optional If set to true the compression is forced to call the callback *fn* synchronously, i.e. keeping the event call stack, etc
compressAll	boolean	false	optional I f set to true 'tiny' compression is taken into account even for non guiStatus docs

staticbcdui.core.compression.uncompressDOMDocument(compressedXmlString, id){bcdui.core.DataProvider}

core/compression/compressionPackage.js, line 502

This function decodes an encoded and compressed XML document passed as the compressedXmlString() argument. It can either make the computations on the client or on the server dependent on the encoding type.

Name	Type	Description
compressedXmlString	string	The encoded and compressed XML document to be reconstructed.
id

Returns:

Type	Description
bcdui.core.DataProvider	A DataProvider instance holding the uncompressed data when it is in the Ready state.