Class Index | File Index

Classes


Class core.Zip


Defined in: Zip.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
core.Zip(url, entriesReadCallback)
Method Summary
Method Attributes Method Name and Description
<inner>  
createByteArray(successCallback, errorCallback)
Create a bytearray from the zipfile.
 
<inner>  
load(filename, callback)
<inner>  
loadAsDataURL(filename, mimetype, callback)
<inner>  
loadAsDOM(filename, callback)
<inner>  
loadAsString(filename, callback)
<inner>  
loadContentXmlAsFragments(filename, handler)
<inner>  
remove(filename)
Removes entry from the zip.
<inner>  
save(filename, data, compressed, date)
Add or replace an entry to the zip file.
<inner>  
write(callback)
Write the zipfile to the given path.
<inner>  
writeAs(newurl, callback)
Write the zipfile to the given path.
Class Detail
core.Zip(url, entriesReadCallback)
Parameters:
{!string} url
path to zip file, should be readable by the runtime
{?function(?string|!core.Zip):undefined} entriesReadCallback
callback indicating the zip has loaded this list of entries, the arguments are a string that indicates error if present and the created object
Method Detail
<inner> {undefined} createByteArray(successCallback, errorCallback)
Create a bytearray from the zipfile.
Parameters:
{!function(!Uint8Array):undefined} successCallback
receiving zip as bytearray
{!function(?string):undefined} errorCallback
receiving possible err
Returns:
{undefined}

{!Array.} getEntries()
Returns:
{!Array.}

<inner> {undefined} load(filename, callback)
Parameters:
{!string} filename
{!function(?string|?Uint8Array)} callback
receiving err and data
Returns:
{undefined}

<inner> loadAsDataURL(filename, mimetype, callback)
Parameters:
{!string} filename
{!string} mimetype
{!function(?string|?string):undefined} callback

<inner> {undefined} loadAsDOM(filename, callback)
Parameters:
{!string} filename
{function(?string|?Document):undefined} callback
Returns:
{undefined}

<inner> {undefined} loadAsString(filename, callback)
Parameters:
{!string} filename
{!function(?string|?string):undefined} callback
receiving err and data
Returns:
{undefined}

<inner> {undefined} loadContentXmlAsFragments(filename, handler)
Parameters:
{!string} filename
{!{rootElementReady: function(?string|?string=|boolean=):undefined}} handler
Returns:
{undefined}

<inner> {!boolean} remove(filename)
Removes entry from the zip.
Parameters:
{!string} filename
Returns:
{!boolean} return false if entry is not found; otherwise true.

<inner> {undefined} save(filename, data, compressed, date)
Add or replace an entry to the zip file. This data is not stored to disk yet, and therefore, no callback is necessary.
Parameters:
{!string} filename
{!Uint8Array} data
{!boolean} compressed
{!Date} date
Returns:
{undefined}

<inner> {undefined} write(callback)
Write the zipfile to the given path.
Parameters:
{!function(?string):undefined} callback
receiving possible err
Returns:
{undefined}

<inner> {undefined} writeAs(newurl, callback)
Write the zipfile to the given path.
Parameters:
{!string} newurl
{!function(?string):undefined} callback
receiving possible err
Returns:
{undefined}

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Aug 06 2015 04:10:39 GMT+0200 (MESZ)