public/cordova-android
public/cordova-android
9
0
Fork 0
forked from github/cordova-android
Code Pull Requests Activity

Add docs and fixed to pass through the Google Closure Compiler without warnings

Browse Source
This commit is contained in:
defrex 2011-03-30 12:14:21 -04:00 committed by Fil Maj
parent bdadbbc339
commit bde59adc04
14 changed files with 210 additions and 168 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
framework/assets/js/accelerometer.js
View File

@ -9,7 +9,8 @@
if (!PhoneGap.hasResource("accelerometer")) { if (!PhoneGap.hasResource("accelerometer")) {
PhoneGap.addResource("accelerometer"); PhoneGap.addResource("accelerometer");
Acceleration = function(x, y, z) { /** @constructor */
function Acceleration(x, y, z) {
this.x = x; this.x = x;
this.y = y; this.y = y;
this.z = z; this.z = z;

11
framework/assets/js/app.js
View File

@ -11,6 +11,7 @@ PhoneGap.addResource("app");
/** /**
* Constructor * Constructor
* @constructor
*/ */
App = function() {}; App = function() {};
@ -23,7 +24,7 @@ App.prototype.clearCache = function() {
/** /**
* Load the url into the webview. * Load the url into the webview.
* *
* @param url The URL to load * @param url The URL to load
* @param props Properties that can be passed in to the activity: * @param props Properties that can be passed in to the activity:
* wait: int => wait msec before loading URL * wait: int => wait msec before loading URL
@ -33,7 +34,7 @@ App.prototype.clearCache = function() {
* loadUrlTimeoutValue: int => time in msec to wait before triggering a timeout error * loadUrlTimeoutValue: int => time in msec to wait before triggering a timeout error
* errorUrl: URL => URL to load if there's an error loading specified URL with loadUrl(). Should be a local URL such as file:///android_asset/www/error.html"); * errorUrl: URL => URL to load if there's an error loading specified URL with loadUrl(). Should be a local URL such as file:///android_asset/www/error.html");
* keepRunning: boolean => enable app to keep running in background * keepRunning: boolean => enable app to keep running in background
* *
* Example: * Example:
* App app = new App(); * App app = new App();
* app.loadUrl("http://server/myapp/index.html", {wait:2000, loadingDialog:"Wait,Loading App", loadUrlTimeoutValue: 60000}); * app.loadUrl("http://server/myapp/index.html", {wait:2000, loadingDialog:"Wait,Loading App", loadUrlTimeoutValue: 60000});
@ -59,7 +60,7 @@ App.prototype.clearHistory = function() {
/** /**
* Add a class that implements a service. * Add a class that implements a service.
* *
* @param serviceType * @param serviceType
* @param className * @param className
*/ */
@ -70,10 +71,10 @@ App.prototype.addService = function(serviceType, className) {
/** /**
* Override the default behavior of the Android back button. * Override the default behavior of the Android back button.
* If overridden, when the back button is pressed, the "backKeyDown" JavaScript event will be fired. * If overridden, when the back button is pressed, the "backKeyDown" JavaScript event will be fired.
* *
* Note: The user should not have to call this method. Instead, when the user * Note: The user should not have to call this method. Instead, when the user
* registers for the "backbutton" event, this is automatically done. * registers for the "backbutton" event, this is automatically done.
* *
* @param override T=override, F=cancel override * @param override T=override, F=cancel override
*/ */
App.prototype.overrideBackbutton = function(override) { App.prototype.overrideBackbutton = function(override) {

32
framework/assets/js/contact.js
View File

@ -11,22 +11,23 @@ PhoneGap.addResource("contact");
/** /**
* Contains information about a single contact. * Contains information about a single contact.
* @constructor
* @param {DOMString} id unique identifier * @param {DOMString} id unique identifier
* @param {DOMString} displayName * @param {DOMString} displayName
* @param {ContactName} name * @param {ContactName} name
* @param {DOMString} nickname * @param {DOMString} nickname
* @param {ContactField[]} phoneNumbers array of phone numbers * @param {Array.<ContactField>} phoneNumbers array of phone numbers
* @param {ContactField[]} emails array of email addresses * @param {Array.<ContactField>} emails array of email addresses
* @param {ContactAddress[]} addresses array of addresses * @param {Array.<ContactAddress>} addresses array of addresses
* @param {ContactField[]} ims instant messaging user ids * @param {Array.<ContactField>} ims instant messaging user ids
* @param {ContactOrganization[]} organizations * @param {Array.<ContactOrganization>} organizations
* @param {DOMString} revision date contact was last updated * @param {DOMString} revision date contact was last updated
* @param {DOMString} birthday contact's birthday * @param {DOMString} birthday contact's birthday
* @param {DOMString} gender contact's gender * @param {DOMString} gender contact's gender
* @param {DOMString} note user notes about contact * @param {DOMString} note user notes about contact
* @param {ContactField[]} photos * @param {Array.<ContactField>} photos
* @param {ContactField[]} categories * @param {Array.<ContactField>} categories
* @param {ContactField[]} urls contact's web sites * @param {Array.<ContactField>} urls contact's web sites
* @param {DOMString} timezone the contacts time zone * @param {DOMString} timezone the contacts time zone
*/ */
var Contact = function (id, displayName, name, nickname, phoneNumbers, emails, addresses, var Contact = function (id, displayName, name, nickname, phoneNumbers, emails, addresses,
@ -53,7 +54,8 @@ var Contact = function (id, displayName, name, nickname, phoneNumbers, emails, a
/** /**
* ContactError. * ContactError.
* An error code assigned by an implementation when an error has occurred * An error code assigned by an implementation when an error has occurreds
* @constructor
*/ */
var ContactError = function() { var ContactError = function() {
this.code=null; this.code=null;
@ -152,6 +154,7 @@ Contact.prototype.save = function(successCB, errorCB) {
/** /**
* Contact name. * Contact name.
* @constructor
* @param formatted * @param formatted
* @param familyName * @param familyName
* @param givenName * @param givenName
@ -170,6 +173,7 @@ var ContactName = function(formatted, familyName, givenName, middle, prefix, suf
/** /**
* Generic contact field. * Generic contact field.
* @constructor
* @param {DOMString} id unique identifier, should only be set by native code * @param {DOMString} id unique identifier, should only be set by native code
* @param type * @param type
* @param value * @param value
@ -184,6 +188,7 @@ var ContactField = function(type, value, pref) {
/** /**
* Contact address. * Contact address.
* @constructor
* @param {DOMString} id unique identifier, should only be set by native code * @param {DOMString} id unique identifier, should only be set by native code
* @param formatted * @param formatted
* @param streetAddress * @param streetAddress
@ -204,6 +209,7 @@ var ContactAddress = function(formatted, streetAddress, locality, region, postal
/** /**
* Contact organization. * Contact organization.
* @constructor
* @param {DOMString} id unique identifier, should only be set by native code * @param {DOMString} id unique identifier, should only be set by native code
* @param name * @param name
* @param dept * @param dept
@ -222,6 +228,7 @@ var ContactOrganization = function(name, dept, title) {
/** /**
* Represents a group of Contacts. * Represents a group of Contacts.
* @constructor
*/ */
var Contacts = function() { var Contacts = function() {
this.inProgress = false; this.inProgress = false;
@ -258,10 +265,10 @@ Contacts.prototype.create = function(properties) {
}; };
/** /**
* This function returns and array of contacts. It is required as we need to convert raw * This function returns and array of contacts. It is required as we need to convert raw
* JSON objects into concrete Contact objects. Currently this method is called after * JSON objects into concrete Contact objects. Currently this method is called after
* navigator.service.contacts.find but before the find methods success call back. * navigator.service.contacts.find but before the find methods success call back.
* *
* @param jsonArray an array of JSON Objects that need to be converted to Contact objects. * @param jsonArray an array of JSON Objects that need to be converted to Contact objects.
* @returns an array of Contact objects * @returns an array of Contact objects
*/ */
@ -277,6 +284,7 @@ Contacts.prototype.cast = function(pluginResult) {
/** /**
* ContactFindOptions. * ContactFindOptions.
* @constructor
* @param filter used to match contacts against * @param filter used to match contacts against
* @param multiple boolean used to determine if more than one contact should be returned * @param multiple boolean used to determine if more than one contact should be returned
* @param updatedSince return only contact records that have been updated on or after the given time * @param updatedSince return only contact records that have been updated on or after the given time

3
framework/assets/js/crypto.js
View File

@ -11,6 +11,9 @@
if (!PhoneGap.hasResource("crypto")) { if (!PhoneGap.hasResource("crypto")) {
PhoneGap.addResource("crypto"); PhoneGap.addResource("crypto");
/**
* @constructor
*/
var Crypto = function() { var Crypto = function() {
}; };

155
framework/assets/js/file.js
View File

@ -11,8 +11,9 @@ PhoneGap.addResource("file");
/** /**
* This class provides some useful information about a file. * This class provides some useful information about a file.
* This is the fields returned when navigator.fileMgr.getFileProperties() * This is the fields returned when navigator.fileMgr.getFileProperties()
* is called. * is called.
* @constructor
*/ */
FileProperties = function(filePath) { FileProperties = function(filePath) {
this.filePath = filePath; this.filePath = filePath;
@ -22,12 +23,13 @@ FileProperties = function(filePath) {
/** /**
* Represents a single file. * Represents a single file.
* *
* name {DOMString} name of the file, without path information * @constructor
* fullPath {DOMString} the full path of the file, including the name * @param name {DOMString} name of the file, without path information
* type {DOMString} mime type * @param fullPath {DOMString} the full path of the file, including the name
* lastModifiedDate {Date} last modified date * @param type {DOMString} mime type
* size {Number} size of the file in bytes * @param lastModifiedDate {Date} last modified date
* @param size {Number} size of the file in bytes
*/ */
File = function(name, fullPath, type, lastModifiedDate, size) { File = function(name, fullPath, type, lastModifiedDate, size) {
this.name = name || null; this.name = name || null;
@ -37,7 +39,8 @@ File = function(name, fullPath, type, lastModifiedDate, size) {
this.size = size || 0; this.size = size || 0;
}; };
FileError = function() { /** @constructor */
function FileError() {
this.code = null; this.code = null;
}; };
@ -62,8 +65,9 @@ FileError.PATH_EXISTS_ERR = 12;
// File manager // File manager
//----------------------------------------------------------------------------- //-----------------------------------------------------------------------------
FileMgr = function() { /** @constructor */
}; function FileMgr() {
}
FileMgr.prototype.getFileProperties = function(filePath) { FileMgr.prototype.getFileProperties = function(filePath) {
return PhoneGap.exec(null, null, "File", "getFileProperties", [filePath]); return PhoneGap.exec(null, null, "File", "getFileProperties", [filePath]);
@ -126,6 +130,7 @@ PhoneGap.addConstructor(function() {
* For Android: * For Android:
* The root directory is the root of the file system. * The root directory is the root of the file system.
* To read from the SD card, the file name is "sdcard/my_file.txt" * To read from the SD card, the file name is "sdcard/my_file.txt"
* @constructor
*/ */
FileReader = function() { FileReader = function() {
this.fileName = ""; this.fileName = "";
@ -164,7 +169,7 @@ FileReader.prototype.abort = function() {
var error = new FileError(); var error = new FileError();
error.code = error.ABORT_ERR; error.code = error.ABORT_ERR;
this.error = error; this.error = error;
// If error callback // If error callback
if (typeof this.onerror === "function") { if (typeof this.onerror === "function") {
this.onerror({"type":"error", "target":this}); this.onerror({"type":"error", "target":this});
@ -378,7 +383,8 @@ FileReader.prototype.readAsArrayBuffer = function(file) {
* For Android: * For Android:
* The root directory is the root of the file system. * The root directory is the root of the file system.
* To write to the SD card, the file name is "sdcard/my_file.txt" * To write to the SD card, the file name is "sdcard/my_file.txt"
* *
* @constructor
* @param file {File} File object containing file properties * @param file {File} File object containing file properties
* @param append if true write to the end of the file, otherwise overwrite the file * @param append if true write to the end of the file, otherwise overwrite the file
*/ */
@ -420,13 +426,13 @@ FileWriter.prototype.abort = function() {
// check for invalid state // check for invalid state
if (this.readyState === FileWriter.DONE || this.readyState === FileWriter.INIT) { if (this.readyState === FileWriter.DONE || this.readyState === FileWriter.INIT) {
throw FileError.INVALID_STATE_ERR; throw FileError.INVALID_STATE_ERR;
} }
// set error // set error
var error = new FileError(), evt; var error = new FileError(), evt;
error.code = error.ABORT_ERR; error.code = error.ABORT_ERR;
this.error = error; this.error = error;
// If error callback // If error callback
if (typeof this.onerror === "function") { if (typeof this.onerror === "function") {
this.onerror({"type":"error", "target":this}); this.onerror({"type":"error", "target":this});
@ -435,7 +441,7 @@ FileWriter.prototype.abort = function() {
if (typeof this.onabort === "function") { if (typeof this.onabort === "function") {
this.oneabort({"type":"abort", "target":this}); this.oneabort({"type":"abort", "target":this});
} }
this.readyState = FileWriter.DONE; this.readyState = FileWriter.DONE;
// If write end callback // If write end callback
@ -446,7 +452,7 @@ FileWriter.prototype.abort = function() {
/** /**
* Writes data to the file * Writes data to the file
* *
* @param text to be written * @param text to be written
*/ */
FileWriter.prototype.write = function(text) { FileWriter.prototype.write = function(text) {
@ -526,13 +532,13 @@ FileWriter.prototype.write = function(text) {
}; };
/** /**
* Moves the file pointer to the location specified. * Moves the file pointer to the location specified.
* *
* If the offset is a negative number the position of the file * If the offset is a negative number the position of the file
* pointer is rewound. If the offset is greater than the file * pointer is rewound. If the offset is greater than the file
* size the position is set to the end of the file. * size the position is set to the end of the file.
* *
* @param offset is the location to move the file pointer to. * @param offset is the location to move the file pointer to.
*/ */
FileWriter.prototype.seek = function(offset) { FileWriter.prototype.seek = function(offset) {
@ -544,12 +550,12 @@ FileWriter.prototype.seek = function(offset) {
if (!offset) { if (!offset) {
return; return;
} }
// See back from end of file. // See back from end of file.
if (offset < 0) { if (offset < 0) {
this.position = Math.max(offset + this.length, 0); this.position = Math.max(offset + this.length, 0);
} }
// Offset is bigger then file size so set position // Offset is bigger then file size so set position
// to the end of the file. // to the end of the file.
else if (offset > this.length) { else if (offset > this.length) {
this.position = this.length; this.position = this.length;
@ -558,12 +564,12 @@ FileWriter.prototype.seek = function(offset) {
// to start writing. // to start writing.
else { else {
this.position = offset; this.position = offset;
} }
}; };
/** /**
* Truncates the file to the size specified. * Truncates the file to the size specified.
* *
* @param size to chop the file at. * @param size to chop the file at.
*/ */
FileWriter.prototype.truncate = function(size) { FileWriter.prototype.truncate = function(size) {
@ -640,7 +646,8 @@ FileWriter.prototype.truncate = function(size) {
); );
}; };
LocalFileSystem = function() { /** @constructor */
function LocalFileSystem() {
}; };
// File error codes // File error codes
@ -651,7 +658,7 @@ LocalFileSystem.APPLICATION = 3;
/** /**
* Requests a filesystem in which to store application data. * Requests a filesystem in which to store application data.
* *
* @param {int} type of file system being requested * @param {int} type of file system being requested
* @param {Function} successCallback is called with the new FileSystem * @param {Function} successCallback is called with the new FileSystem
* @param {Function} errorCallback is called with a FileError * @param {Function} errorCallback is called with a FileError
@ -670,7 +677,7 @@ LocalFileSystem.prototype.requestFileSystem = function(type, size, successCallba
}; };
/** /**
* *
* @param {DOMString} uri referring to a local file in a filesystem * @param {DOMString} uri referring to a local file in a filesystem
* @param {Function} successCallback is called with the new entry * @param {Function} successCallback is called with the new entry
* @param {Function} errorCallback is called with a FileError * @param {Function} errorCallback is called with a FileError
@ -680,12 +687,12 @@ LocalFileSystem.prototype.resolveLocalFileSystemURI = function(uri, successCallb
}; };
/** /**
* This function returns and array of contacts. It is required as we need to convert raw * This function returns and array of contacts. It is required as we need to convert raw
* JSON objects into concrete Contact objects. Currently this method is called after * JSON objects into concrete Contact objects. Currently this method is called after
* navigator.service.contacts.find but before the find methods success call back. * navigator.service.contacts.find but before the find methods success call back.
* *
* @param a JSON Objects that need to be converted to DirectoryEntry or FileEntry objects. * @param a JSON Objects that need to be converted to DirectoryEntry or FileEntry objects.
* @returns an entry * @returns an entry
*/ */
LocalFileSystem.prototype._castFS = function(pluginResult) { LocalFileSystem.prototype._castFS = function(pluginResult) {
var entry = null; var entry = null;
@ -695,7 +702,7 @@ LocalFileSystem.prototype._castFS = function(pluginResult) {
entry.name = pluginResult.message.root.name; entry.name = pluginResult.message.root.name;
entry.fullPath = pluginResult.message.root.fullPath; entry.fullPath = pluginResult.message.root.fullPath;
pluginResult.message.root = entry; pluginResult.message.root = entry;
return pluginResult; return pluginResult;
} }
LocalFileSystem.prototype._castEntry = function(pluginResult) { LocalFileSystem.prototype._castEntry = function(pluginResult) {
@ -713,17 +720,17 @@ LocalFileSystem.prototype._castEntry = function(pluginResult) {
entry.name = pluginResult.message.name; entry.name = pluginResult.message.name;
entry.fullPath = pluginResult.message.fullPath; entry.fullPath = pluginResult.message.fullPath;
pluginResult.message = entry; pluginResult.message = entry;
return pluginResult; return pluginResult;
} }
LocalFileSystem.prototype._castEntries = function(pluginResult) { LocalFileSystem.prototype._castEntries = function(pluginResult) {
var entries = pluginResult.message; var entries = pluginResult.message;
var retVal = []; var retVal = [];
for (i=0; i<entries.length; i++) { for (i=0; i<entries.length; i++) {
retVal.push(window.localFileSystem._createEntry(entries[i])); retVal.push(window.localFileSystem._createEntry(entries[i]));
} }
pluginResult.message = retVal; pluginResult.message = retVal;
return pluginResult; return pluginResult;
} }
LocalFileSystem.prototype._createEntry = function(castMe) { LocalFileSystem.prototype._createEntry = function(castMe) {
@ -740,8 +747,8 @@ LocalFileSystem.prototype._createEntry = function(castMe) {
entry.isFile = castMe.isFile; entry.isFile = castMe.isFile;
entry.name = castMe.name; entry.name = castMe.name;
entry.fullPath = castMe.fullPath; entry.fullPath = castMe.fullPath;
return entry; return entry;
} }
LocalFileSystem.prototype._castDate = function(pluginResult) { LocalFileSystem.prototype._castDate = function(pluginResult) {
@ -756,15 +763,16 @@ LocalFileSystem.prototype._castDate = function(pluginResult) {
file.name = pluginResult.message.name; file.name = pluginResult.message.name;
file.fullPath = pluginResult.message.fullPath; file.fullPath = pluginResult.message.fullPath;
file.lastModifedDate = new Date(pluginResult.message.lastModifiedDate); file.lastModifedDate = new Date(pluginResult.message.lastModifiedDate);
pluginResult.message = file; pluginResult.message = file;
} }
return pluginResult; return pluginResult;
} }
/** /**
* Information about the state of the file or directory * Information about the state of the file or directory
* *
* @constructor
* {Date} modificationTime (readonly) * {Date} modificationTime (readonly)
*/ */
Metadata = function() { Metadata = function() {
@ -773,8 +781,9 @@ Metadata = function() {
/** /**
* Supplies arguments to methods that lookup or create files and directories * Supplies arguments to methods that lookup or create files and directories
* *
* @param {boolean} create file or directory if it doesn't exist * @constructor
* @param {boolean} create file or directory if it doesn't exist
* @param {boolean} exclusive if true the command will fail if the file or directory exists * @param {boolean} exclusive if true the command will fail if the file or directory exists
*/ */
Flags = function(create, exclusive) { Flags = function(create, exclusive) {
@ -784,7 +793,8 @@ Flags = function(create, exclusive) {
/** /**
* An interface representing a file system * An interface representing a file system
* *
* @constructor
* {DOMString} name the unique name of the file system (readonly) * {DOMString} name the unique name of the file system (readonly)
* {DirectoryEntry} root directory of the file system (readonly) * {DirectoryEntry} root directory of the file system (readonly)
*/ */
@ -795,7 +805,8 @@ FileSystem = function() {
/** /**
* An interface representing a directory on the file system. * An interface representing a directory on the file system.
* *
* @constructor
* {boolean} isFile always false (readonly) * {boolean} isFile always false (readonly)
* {boolean} isDirectory always true (readonly) * {boolean} isDirectory always true (readonly)
* {DOMString} name of the directory, excluding the path leading to it (readonly) * {DOMString} name of the directory, excluding the path leading to it (readonly)
@ -812,7 +823,7 @@ DirectoryEntry = function() {
/** /**
* Copies a directory to a new location * Copies a directory to a new location
* *
* @param {DirectoryEntry} parent the directory to which to copy the entry * @param {DirectoryEntry} parent the directory to which to copy the entry
* @param {DOMString} newName the new name of the entry, defaults to the current name * @param {DOMString} newName the new name of the entry, defaults to the current name
* @param {Function} successCallback is called with the new entry * @param {Function} successCallback is called with the new entry
@ -824,7 +835,7 @@ DirectoryEntry.prototype.copyTo = function(parent, newName, successCallback, err
/** /**
* Looks up the metadata of the entry * Looks up the metadata of the entry
* *
* @param {Function} successCallback is called with a Metadata object * @param {Function} successCallback is called with a Metadata object
* @param {Function} errorCallback is called with a FileError * @param {Function} errorCallback is called with a FileError
*/ */
@ -834,7 +845,7 @@ DirectoryEntry.prototype.getMetadata = function(successCallback, errorCallback)
/** /**
* Gets the parent of the entry * Gets the parent of the entry
* *
* @param {Function} successCallback is called with a parent entry * @param {Function} successCallback is called with a parent entry
* @param {Function} errorCallback is called with a FileError * @param {Function} errorCallback is called with a FileError
*/ */
@ -844,7 +855,7 @@ DirectoryEntry.prototype.getParent = function(successCallback, errorCallback) {
/** /**
* Moves a directory to a new location * Moves a directory to a new location
* *
* @param {DirectoryEntry} parent the directory to which to move the entry * @param {DirectoryEntry} parent the directory to which to move the entry
* @param {DOMString} newName the new name of the entry, defaults to the current name * @param {DOMString} newName the new name of the entry, defaults to the current name
* @param {Function} successCallback is called with the new entry * @param {Function} successCallback is called with the new entry
@ -856,7 +867,7 @@ DirectoryEntry.prototype.moveTo = function(parent, newName, successCallback, err
/** /**
* Removes the entry * Removes the entry
* *
* @param {Function} successCallback is called with no parameters * @param {Function} successCallback is called with no parameters
* @param {Function} errorCallback is called with a FileError * @param {Function} errorCallback is called with a FileError
*/ */
@ -866,7 +877,7 @@ DirectoryEntry.prototype.remove = function(successCallback, errorCallback) {
/** /**
* Returns a URI that can be used to identify this entry. * Returns a URI that can be used to identify this entry.
* *
* @param {DOMString} mimeType for a FileEntry, the mime type to be used to interpret the file, when loaded through this URI. * @param {DOMString} mimeType for a FileEntry, the mime type to be used to interpret the file, when loaded through this URI.
* @return uri * @return uri
*/ */
@ -883,7 +894,7 @@ DirectoryEntry.prototype.createReader = function(successCallback, errorCallback)
/** /**
* Creates or looks up a directory * Creates or looks up a directory
* *
* @param {DOMString} path either a relative or absolute path from this directory in which to look up or create a directory * @param {DOMString} path either a relative or absolute path from this directory in which to look up or create a directory
* @param {Flags} options to create or excluively create the directory * @param {Flags} options to create or excluively create the directory
* @param {Function} successCallback is called with the new entry * @param {Function} successCallback is called with the new entry
@ -895,7 +906,7 @@ DirectoryEntry.prototype.getDirectory = function(path, options, successCallback,
/** /**
* Creates or looks up a file * Creates or looks up a file
* *
* @param {DOMString} path either a relative or absolute path from this directory in which to look up or create a file * @param {DOMString} path either a relative or absolute path from this directory in which to look up or create a file
* @param {Flags} options to create or excluively create the file * @param {Flags} options to create or excluively create the file
* @param {Function} successCallback is called with the new entry * @param {Function} successCallback is called with the new entry
@ -907,7 +918,7 @@ DirectoryEntry.prototype.getFile = function(path, options, successCallback, erro
/** /**
* Deletes a directory and all of it's contents * Deletes a directory and all of it's contents
* *
* @param {Function} successCallback is called with no parameters * @param {Function} successCallback is called with no parameters
* @param {Function} errorCallback is called with a FileError * @param {Function} errorCallback is called with a FileError
*/ */
@ -917,24 +928,26 @@ DirectoryEntry.prototype.removeRecursively = function(successCallback, errorCall
/** /**
* An interface that lists the files and directories in a directory. * An interface that lists the files and directories in a directory.
* @constructor
*/ */
DirectoryReader = function(fullPath){ function DirectoryReader(fullPath){
this.fullPath = fullPath || null; this.fullPath = fullPath || null;
}; };
/** /**
* Returns a list of entries from a directory. * Returns a list of entries from a directory.
* *
* @param {Function} successCallback is called with a list of entries * @param {Function} successCallback is called with a list of entries
* @param {Function} errorCallback is called with a FileError * @param {Function} errorCallback is called with a FileError
*/ */
DirectoryReader.prototype.readEntries = function(successCallback, errorCallback) { DirectoryReader.prototype.readEntries = function(successCallback, errorCallback) {
PhoneGap.exec(successCallback, errorCallback, "File", "readEntries", [this.fullPath]); PhoneGap.exec(successCallback, errorCallback, "File", "readEntries", [this.fullPath]);
} }
/** /**
* An interface representing a directory on the file system. * An interface representing a directory on the file system.
* *
* @constructor
* {boolean} isFile always true (readonly) * {boolean} isFile always true (readonly)
* {boolean} isDirectory always false (readonly) * {boolean} isDirectory always false (readonly)
* {DOMString} name of the file, excluding the path leading to it (readonly) * {DOMString} name of the file, excluding the path leading to it (readonly)
@ -951,7 +964,7 @@ FileEntry = function() {
/** /**
* Copies a file to a new location * Copies a file to a new location
* *
* @param {DirectoryEntry} parent the directory to which to copy the entry * @param {DirectoryEntry} parent the directory to which to copy the entry
* @param {DOMString} newName the new name of the entry, defaults to the current name * @param {DOMString} newName the new name of the entry, defaults to the current name
* @param {Function} successCallback is called with the new entry * @param {Function} successCallback is called with the new entry
@ -963,7 +976,7 @@ FileEntry.prototype.copyTo = function(parent, newName, successCallback, errorCal
/** /**
* Looks up the metadata of the entry * Looks up the metadata of the entry
* *
* @param {Function} successCallback is called with a Metadata object * @param {Function} successCallback is called with a Metadata object
* @param {Function} errorCallback is called with a FileError * @param {Function} errorCallback is called with a FileError
*/ */
@ -973,7 +986,7 @@ FileEntry.prototype.getMetadata = function(successCallback, errorCallback) {
/** /**
* Gets the parent of the entry * Gets the parent of the entry
* *
* @param {Function} successCallback is called with a parent entry * @param {Function} successCallback is called with a parent entry
* @param {Function} errorCallback is called with a FileError * @param {Function} errorCallback is called with a FileError
*/ */
@ -983,7 +996,7 @@ FileEntry.prototype.getParent = function(successCallback, errorCallback) {
/** /**
* Moves a directory to a new location * Moves a directory to a new location
* *
* @param {DirectoryEntry} parent the directory to which to move the entry * @param {DirectoryEntry} parent the directory to which to move the entry
* @param {DOMString} newName the new name of the entry, defaults to the current name * @param {DOMString} newName the new name of the entry, defaults to the current name
* @param {Function} successCallback is called with the new entry * @param {Function} successCallback is called with the new entry
@ -995,7 +1008,7 @@ FileEntry.prototype.moveTo = function(parent, newName, successCallback, errorCal
/** /**
* Removes the entry * Removes the entry
* *
* @param {Function} successCallback is called with no parameters * @param {Function} successCallback is called with no parameters
* @param {Function} errorCallback is called with a FileError * @param {Function} errorCallback is called with a FileError
*/ */
@ -1005,7 +1018,7 @@ FileEntry.prototype.remove = function(successCallback, errorCallback) {
/** /**
* Returns a URI that can be used to identify this entry. * Returns a URI that can be used to identify this entry.
* *
* @param {DOMString} mimeType for a FileEntry, the mime type to be used to interpret the file, when loaded through this URI. * @param {DOMString} mimeType for a FileEntry, the mime type to be used to interpret the file, when loaded through this URI.
* @return uri * @return uri
*/ */
@ -1015,7 +1028,7 @@ FileEntry.prototype.toURI = function(mimeType) {
/** /**
* Creates a new FileWriter associated with the file that this FileEntry represents. * Creates a new FileWriter associated with the file that this FileEntry represents.
* *
* @param {Function} successCallback is called with the new FileWriter * @param {Function} successCallback is called with the new FileWriter
* @param {Function} errorCallback is called with a FileError * @param {Function} errorCallback is called with a FileError
*/ */
@ -1029,7 +1042,7 @@ FileEntry.prototype.createWriter = function(successCallback, errorCallback) {
}); });
} }
} }
if (typeof successCallback == "function") { if (typeof successCallback == "function") {
successCallback(writer); successCallback(writer);
} }
@ -1037,7 +1050,7 @@ FileEntry.prototype.createWriter = function(successCallback, errorCallback) {
/** /**
* Returns a File that represents the current state of the file that this FileEntry represents. * Returns a File that represents the current state of the file that this FileEntry represents.
* *
* @param {Function} successCallback is called with the new File object * @param {Function} successCallback is called with the new File object
* @param {Function} errorCallback is called with a FileError * @param {Function} errorCallback is called with a FileError
*/ */

12
framework/assets/js/filetransfer.js
View File

@ -1,7 +1,7 @@
/* /*
* PhoneGap is available under *either* the terms of the modified BSD license *or* the * PhoneGap is available under *either* the terms of the modified BSD license *or* the
* MIT License (2008). See http://opensource.org/licenses/alphabetical for full text. * MIT License (2008). See http://opensource.org/licenses/alphabetical for full text.
* *
* Copyright (c) 2005-2010, Nitobi Software Inc. * Copyright (c) 2005-2010, Nitobi Software Inc.
* Copyright (c) 2010, IBM Corporation * Copyright (c) 2010, IBM Corporation
*/ */
@ -11,11 +11,13 @@ PhoneGap.addResource("filetransfer");
/** /**
* FileTransfer uploads a file to a remote server. * FileTransfer uploads a file to a remote server.
* @constructor
*/ */
FileTransfer = function() {}; FileTransfer = function() {};
/** /**
* FileUploadResult * FileUploadResult
* @constructor
*/ */
FileUploadResult = function() { FileUploadResult = function() {
this.bytesSent = 0; this.bytesSent = 0;
@ -25,6 +27,7 @@ FileUploadResult = function() {
/** /**
* FileTransferError * FileTransferError
* @constructor
*/ */
FileTransferError = function() { FileTransferError = function() {
this.code = null; this.code = null;
@ -35,13 +38,13 @@ FileTransferError.INVALID_URL_ERR = 2;
FileTransferError.CONNECTION_ERR = 3; FileTransferError.CONNECTION_ERR = 3;
/** /**
* Given an absolute file path, uploads a file on the device to a remote server * Given an absolute file path, uploads a file on the device to a remote server
* using a multipart HTTP request. * using a multipart HTTP request.
* @param filePath {String} Full path of the file on the device * @param filePath {String} Full path of the file on the device
* @param server {String} URL of the server to receive the file * @param server {String} URL of the server to receive the file
* @param successCallback (Function} Callback to be invoked when upload has completed * @param successCallback (Function} Callback to be invoked when upload has completed
* @param errorCallback {Function} Callback to be invoked upon error * @param errorCallback {Function} Callback to be invoked upon error
* @param options {FileUploadOptions} Optional parameters such as file name and mimetype * @param options {FileUploadOptions} Optional parameters such as file name and mimetype
*/ */
FileTransfer.prototype.upload = function(filePath, server, successCallback, errorCallback, options, debug) { FileTransfer.prototype.upload = function(filePath, server, successCallback, errorCallback, options, debug) {
@ -61,12 +64,13 @@ FileTransfer.prototype.upload = function(filePath, server, successCallback, erro
params = {}; params = {};
} }
} }
PhoneGap.exec(successCallback, errorCallback, 'FileTransfer', 'upload', [filePath, server, fileKey, fileName, mimeType, params, debug]); PhoneGap.exec(successCallback, errorCallback, 'FileTransfer', 'upload', [filePath, server, fileKey, fileName, mimeType, params, debug]);
}; };
/** /**
* Options to customize the HTTP request used to upload files. * Options to customize the HTTP request used to upload files.
* @constructor
* @param fileKey {String} Name of file request parameter. * @param fileKey {String} Name of file request parameter.
* @param fileName {String} Filename to be used by the server. Defaults to image.jpg. * @param fileName {String} Filename to be used by the server. Defaults to image.jpg.
* @param mimeType {String} Mimetype of the uploaded file. Defaults to image/jpeg. * @param mimeType {String} Mimetype of the uploaded file. Defaults to image/jpeg.

1
framework/assets/js/geolocation.js
View File

@ -25,6 +25,7 @@ Geolocation = function() {
/** /**
* Position error object * Position error object
* *
* @constructor
* @param code * @param code
* @param message * @param message
*/ */

4
framework/assets/js/media.js
View File

@ -18,6 +18,7 @@ PhoneGap.mediaObjects = {};
/** /**
* Object that receives native callbacks. * Object that receives native callbacks.
* PRIVATE * PRIVATE
* @constructor
*/ */
PhoneGap.Media = function() {}; PhoneGap.Media = function() {};
@ -66,6 +67,7 @@ PhoneGap.Media.onStatus = function(id, msg, value) {
/** /**
* This class provides access to the device media, interfaces to both sound and video * This class provides access to the device media, interfaces to both sound and video
* *
* @constructor
* @param src The file name or url to play * @param src The file name or url to play
* @param successCallback The callback to be called when the file is done playing or recording. * @param successCallback The callback to be called when the file is done playing or recording.
* successCallback() - OPTIONAL * successCallback() - OPTIONAL
@ -174,8 +176,6 @@ Media.prototype.getDuration = function() {
/** /**
* Get position of audio. * Get position of audio.
*
* @return
*/ */
Media.prototype.getCurrentPosition = function(success, fail) { Media.prototype.getCurrentPosition = function(success, fail) {
PhoneGap.exec(success, fail, "Media", "getCurrentPositionAudio", [this.id]); PhoneGap.exec(success, fail, "Media", "getCurrentPositionAudio", [this.id]);

1
framework/assets/js/notification.js
View File

@ -11,6 +11,7 @@ PhoneGap.addResource("notification");
/** /**
* This class provides access to notifications on the device. * This class provides access to notifications on the device.
* @constructor
*/ */
Notification = function() { Notification = function() {
}; };

63
framework/assets/js/phonegap.js.base
View File

@ -1,7 +1,7 @@
/* /*
* PhoneGap is available under *either* the terms of the modified BSD license *or* the * PhoneGap is available under *either* the terms of the modified BSD license *or* the
* MIT License (2008). See http://opensource.org/licenses/alphabetical for full text. * MIT License (2008). See http://opensource.org/licenses/alphabetical for full text.
* *
* Copyright (c) 2005-2010, Nitobi Software Inc. * Copyright (c) 2005-2010, Nitobi Software Inc.
* Copyright (c) 2010-2011, IBM Corporation * Copyright (c) 2010-2011, IBM Corporation
*/ */
@ -76,6 +76,7 @@ PhoneGap.addResource = function(name) {
/** /**
* Custom pub-sub channel that can have functions subscribed to it * Custom pub-sub channel that can have functions subscribed to it
* @constructor
*/ */
PhoneGap.Channel = function (type) PhoneGap.Channel = function (type)
{ {
@ -87,7 +88,7 @@ PhoneGap.Channel = function (type)
}; };
/** /**
* Subscribes the given function to the channel. Any time that * Subscribes the given function to the channel. Any time that
* Channel.fire is called so too will the function. * Channel.fire is called so too will the function.
* Optionally specify an execution context for the function * Optionally specify an execution context for the function
* and a guid that can be used to stop subscribing to the channel. * and a guid that can be used to stop subscribing to the channel.
@ -127,7 +128,7 @@ PhoneGap.Channel.prototype.subscribeOnce = function(f, c) {
return g; return g;
}; };
/** /**
* Unsubscribes the function with the given guid from the channel. * Unsubscribes the function with the given guid from the channel.
*/ */
PhoneGap.Channel.prototype.unsubscribe = function(g) { PhoneGap.Channel.prototype.unsubscribe = function(g) {
@ -136,7 +137,7 @@ PhoneGap.Channel.prototype.unsubscribe = function(g) {
delete this.handlers[g]; delete this.handlers[g];
}; };
/** /**
* Calls all functions subscribed to this channel. * Calls all functions subscribed to this channel.
*/ */
PhoneGap.Channel.prototype.fire = function(e) { PhoneGap.Channel.prototype.fire = function(e) {
@ -229,7 +230,7 @@ PhoneGap.addPlugin = function(name, obj) {
}; };
/** /**
* onDOMContentLoaded channel is fired when the DOM content * onDOMContentLoaded channel is fired when the DOM content
* of the page has been parsed. * of the page has been parsed.
*/ */
PhoneGap.onDOMContentLoaded = new PhoneGap.Channel('onDOMContentLoaded'); PhoneGap.onDOMContentLoaded = new PhoneGap.Channel('onDOMContentLoaded');
@ -277,7 +278,7 @@ PhoneGap.onPause = new PhoneGap.Channel('onPause');
/** /**
* onDestroy channel is fired when the PhoneGap native code * onDestroy channel is fired when the PhoneGap native code
* is destroyed. It is used internally. * is destroyed. It is used internally.
* Window.onunload should be used by the user. * Window.onunload should be used by the user.
*/ */
PhoneGap.onDestroy = new PhoneGap.Channel('onDestroy'); PhoneGap.onDestroy = new PhoneGap.Channel('onDestroy');
@ -287,7 +288,7 @@ PhoneGap.onDestroy.subscribeOnce(function() {
PhoneGap.shuttingDown = false; PhoneGap.shuttingDown = false;
// _nativeReady is global variable that the native side can set // _nativeReady is global variable that the native side can set
// to signify that the native code is ready. It is a global since // to signify that the native code is ready. It is a global since
// it may be called before any PhoneGap JS is ready. // it may be called before any PhoneGap JS is ready.
if (typeof _nativeReady !== 'undefined') { PhoneGap.onNativeReady.fire(); } if (typeof _nativeReady !== 'undefined') { PhoneGap.onNativeReady.fire(); }
@ -323,7 +324,7 @@ PhoneGap.waitForInitialization = function(feature) {
* Indicate that initialization code has completed and the feature is ready to be used. * Indicate that initialization code has completed and the feature is ready to be used.
* *
* @param feature {String} The unique feature name * @param feature {String} The unique feature name
*/ */
PhoneGap.initializationComplete = function(feature) { PhoneGap.initializationComplete = function(feature) {
var channel = PhoneGap.deviceReadyChannelsMap[feature]; var channel = PhoneGap.deviceReadyChannelsMap[feature];
if (channel) { if (channel) {
@ -361,7 +362,7 @@ PhoneGap.Channel.join(function() {
// Fire onDeviceReady event once all constructors have run and PhoneGap info has been // Fire onDeviceReady event once all constructors have run and PhoneGap info has been
// received from native side, and any user defined initialization channels. // received from native side, and any user defined initialization channels.
PhoneGap.Channel.join(function() { PhoneGap.Channel.join(function() {
// Turn off app loading dialog // Turn off app loading dialog
navigator.notification.activityStop(); navigator.notification.activityStop();
@ -392,18 +393,18 @@ document.addEventListener = function(evt, handler, capture) {
} }
} else if (e === 'pause') { } else if (e === 'pause') {
PhoneGap.onPause.subscribe(handler); PhoneGap.onPause.subscribe(handler);
} }
else { else {
// If subscribing to Android backbutton // If subscribing to Android backbutton
if (e === 'backbutton') { if (e === 'backbutton') {
PhoneGap.exec(null, null, "App", "overrideBackbutton", [true]); PhoneGap.exec(null, null, "App", "overrideBackbutton", [true]);
} }
PhoneGap.m_document_addEventListener.call(document, evt, handler, capture); PhoneGap.m_document_addEventListener.call(document, evt, handler, capture);
} }
}; };
// Intercept calls to document.removeEventListener and watch for events that // Intercept calls to document.removeEventListener and watch for events that
// are generated by PhoneGap native code // are generated by PhoneGap native code
PhoneGap.m_document_removeEventListener = document.removeEventListener; PhoneGap.m_document_removeEventListener = document.removeEventListener;
@ -413,7 +414,7 @@ document.removeEventListener = function(evt, handler, capture) {
// If unsubscribing to Android backbutton // If unsubscribing to Android backbutton
if (e === 'backbutton') { if (e === 'backbutton') {
PhoneGap.exec(null, null, "App", "overrideBackbutton", [false]); PhoneGap.exec(null, null, "App", "overrideBackbutton", [false]);
} }
PhoneGap.m_document_removeEventListener.call(document, evt, handler, capture); PhoneGap.m_document_removeEventListener.call(document, evt, handler, capture);
}; };
@ -432,7 +433,7 @@ PhoneGap.fireEvent = function(type) {
* The restriction on ours is that it must be an array of simple types. * The restriction on ours is that it must be an array of simple types.
* *
* @param args * @param args
* @return * @return {String}
*/ */
PhoneGap.stringify = function(args) { PhoneGap.stringify = function(args) {
if (typeof JSON === "undefined") { if (typeof JSON === "undefined") {
@ -464,7 +465,7 @@ PhoneGap.stringify = function(args) {
// don't copy the functions // don't copy the functions
s = s + '""'; s = s + '""';
} else if (args[i][name] instanceof Object) { } else if (args[i][name] instanceof Object) {
s = s + this.stringify(args[i][name]); s = s + PhoneGap.stringify(args[i][name]);
} else { } else {
s = s + '"' + args[i][name] + '"'; s = s + '"' + args[i][name] + '"';
} }
@ -490,7 +491,7 @@ PhoneGap.stringify = function(args) {
* Does a deep clone of the object. * Does a deep clone of the object.
* *
* @param obj * @param obj
* @return * @return {Object}
*/ */
PhoneGap.clone = function(obj) { PhoneGap.clone = function(obj) {
var i, retVal; var i, retVal;
@ -544,7 +545,7 @@ PhoneGap.callbackStatus = {
/** /**
* Execute a PhoneGap command. It is up to the native side whether this action is synch or async. * Execute a PhoneGap command. It is up to the native side whether this action is synch or async.
* The native side can return: * The native side can return:
* Synchronous: PluginResult object as a JSON string * Synchronous: PluginResult object as a JSON string
* Asynchrounous: Empty string "" * Asynchrounous: Empty string ""
@ -555,7 +556,7 @@ PhoneGap.callbackStatus = {
* @param {Function} fail The fail callback * @param {Function} fail The fail callback
* @param {String} service The name of the service to use * @param {String} service The name of the service to use
* @param {String} action Action to be run in PhoneGap * @param {String} action Action to be run in PhoneGap
* @param {String[]} [args] Zero or more arguments to pass to the method * @param {Array.<String>} [args] Zero or more arguments to pass to the method
*/ */
PhoneGap.exec = function(success, fail, service, action, args) { PhoneGap.exec = function(success, fail, service, action, args) {
try { try {
@ -563,13 +564,13 @@ PhoneGap.exec = function(success, fail, service, action, args) {
if (success || fail) { if (success || fail) {
PhoneGap.callbacks[callbackId] = {success:success, fail:fail}; PhoneGap.callbacks[callbackId] = {success:success, fail:fail};
} }
var r = prompt(this.stringify(args), "gap:"+this.stringify([service, action, callbackId, true])); var r = prompt(PhoneGap.stringify(args), "gap:"+PhoneGap.stringify([service, action, callbackId, true]));
// If a result was returned // If a result was returned
if (r.length > 0) { if (r.length > 0) {
eval("var v="+r+";"); eval("var v="+r+";");
// If status is OK, then return value back to caller // If status is OK, then return value back to caller
if (v.status === PhoneGap.callbackStatus.OK) { if (v.status === PhoneGap.callbackStatus.OK) {
@ -592,7 +593,7 @@ PhoneGap.exec = function(success, fail, service, action, args) {
// If no result // If no result
else if (v.status === PhoneGap.callbackStatus.NO_RESULT) { else if (v.status === PhoneGap.callbackStatus.NO_RESULT) {
// Clear callback if not expecting any more results // Clear callback if not expecting any more results
if (!v.keepCallback) { if (!v.keepCallback) {
delete PhoneGap.callbacks[callbackId]; delete PhoneGap.callbacks[callbackId];
@ -645,7 +646,7 @@ PhoneGap.callbackSuccess = function(callbackId, args) {
console.log("Error in success callback: "+callbackId+" = "+e); console.log("Error in success callback: "+callbackId+" = "+e);
} }
} }
// Clear callback if not expecting any more results // Clear callback if not expecting any more results
if (!args.keepCallback) { if (!args.keepCallback) {
delete PhoneGap.callbacks[callbackId]; delete PhoneGap.callbacks[callbackId];
@ -669,7 +670,7 @@ PhoneGap.callbackError = function(callbackId, args) {
catch (e) { catch (e) {
console.log("Error in error callback: "+callbackId+" = "+e); console.log("Error in error callback: "+callbackId+" = "+e);
} }
// Clear callback if not expecting any more results // Clear callback if not expecting any more results
if (!args.keepCallback) { if (!args.keepCallback) {
delete PhoneGap.callbacks[callbackId]; delete PhoneGap.callbacks[callbackId];
@ -735,7 +736,7 @@ PhoneGap.JSCallbackToken = null;
/** /**
* This is only for Android. * This is only for Android.
* *
* Internal function that uses XHR to call into PhoneGap Java code and retrieve * Internal function that uses XHR to call into PhoneGap Java code and retrieve
* any JavaScript code that needs to be run. This is used for callbacks from * any JavaScript code that needs to be run. This is used for callbacks from
* Java to JavaScript. * Java to JavaScript.
*/ */
@ -757,7 +758,7 @@ PhoneGap.JSCallback = function() {
// Callback function when XMLHttpRequest is ready // Callback function when XMLHttpRequest is ready
xmlhttp.onreadystatechange=function(){ xmlhttp.onreadystatechange=function(){
if(xmlhttp.readyState === 4){ if(xmlhttp.readyState === 4){
// Exit if shutting down app // Exit if shutting down app
if (PhoneGap.shuttingDown) { if (PhoneGap.shuttingDown) {
return; return;
@ -836,7 +837,7 @@ PhoneGap.UsePolling = false; // T=use polling, F=use XHR
/** /**
* This is only for Android. * This is only for Android.
* *
* Internal function that uses polling to call into PhoneGap Java code and retrieve * Internal function that uses polling to call into PhoneGap Java code and retrieve
* any JavaScript code that needs to be run. This is used for callbacks from * any JavaScript code that needs to be run. This is used for callbacks from
* Java to JavaScript. * Java to JavaScript.
*/ */
@ -874,7 +875,7 @@ PhoneGap.JSCallbackPolling = function() {
/** /**
* Create a UUID * Create a UUID
* *
* @return * @return {String}
*/ */
PhoneGap.createUUID = function() { PhoneGap.createUUID = function() {
return PhoneGap.UUIDcreatePart(4) + '-' + return PhoneGap.UUIDcreatePart(4) + '-' +
@ -916,7 +917,7 @@ PhoneGap.close = function(context, func, params) {
* @param {Function} successCallback The callback to call when the file has been loaded. * @param {Function} successCallback The callback to call when the file has been loaded.
*/ */
PhoneGap.includeJavascript = function(jsfile, successCallback) { PhoneGap.includeJavascript = function(jsfile, successCallback) {
var id = document.getElementsByTagName("head")[0]; var id = document.getElementsByTagName("head")[0];
var el = document.createElement('script'); var el = document.createElement('script');
el.type = 'text/javascript'; el.type = 'text/javascript';
if (typeof successCallback === 'function') { if (typeof successCallback === 'function') {

7
framework/assets/js/position.js
View File

@ -25,7 +25,8 @@ Position = function(coords, timestamp) {
this.timestamp = (timestamp !== 'undefined') ? timestamp : new Date().getTime(); this.timestamp = (timestamp !== 'undefined') ? timestamp : new Date().getTime();
}; };
Coordinates = function(lat, lng, alt, acc, head, vel, altacc) { /** @constructor */
function Coordinates(lat, lng, alt, acc, head, vel, altacc) {
/** /**
* The latitude of the position. * The latitude of the position.
*/ */
@ -53,8 +54,8 @@ Coordinates = function(lat, lng, alt, acc, head, vel, altacc) {
/** /**
* The altitude accuracy of the position. * The altitude accuracy of the position.
*/ */
this.altitudeAccuracy = (altacc !== 'undefined') ? altacc : null; this.altitudeAccuracy = (altacc !== 'undefined') ? altacc : null;
}; }
/** /**
* This class specifies the options for requesting position data. * This class specifies the options for requesting position data.

22
framework/assets/js/storage.js
View File

@ -18,6 +18,7 @@ PhoneGap.addResource("storage");
/** /**
* Storage object that is called by native code when performing queries. * Storage object that is called by native code when performing queries.
* PRIVATE METHOD * PRIVATE METHOD
* @constructor
*/ */
var DroidDB = function() { var DroidDB = function() {
this.queryQueue = {}; this.queryQueue = {};
@ -105,6 +106,7 @@ DroidDB.prototype.fail = function(reason, id) {
/** /**
* Transaction object * Transaction object
* PRIVATE METHOD * PRIVATE METHOD
* @constructor
*/ */
var DroidDB_Tx = function() { var DroidDB_Tx = function() {
@ -165,7 +167,7 @@ DroidDB_Tx.prototype.queryComplete = function(id) {
var i; var i;
for (i in this.queryList) { for (i in this.queryList) {
if (this.queryList.hasOwnProperty(i)) { if (this.queryList.hasOwnProperty(i)) {
count++; count++;
} }
} }
if (count === 0) { if (count === 0) {
@ -205,6 +207,7 @@ DroidDB_Tx.prototype.queryFailed = function(id, reason) {
* SQL query object * SQL query object
* PRIVATE METHOD * PRIVATE METHOD
* *
* @constructor
* @param tx The transaction object that this query belongs to * @param tx The transaction object that this query belongs to
*/ */
var DroidDB_Query = function(tx) { var DroidDB_Query = function(tx) {
@ -260,6 +263,7 @@ DroidDB_Tx.prototype.executeSql = function(sql, params, successCallback, errorCa
/** /**
* SQL result set that is returned to user. * SQL result set that is returned to user.
* PRIVATE METHOD * PRIVATE METHOD
* @constructor
*/ */
DroidDB_Result = function() { DroidDB_Result = function() {
this.rows = new DroidDB_Rows(); this.rows = new DroidDB_Rows();
@ -268,6 +272,7 @@ DroidDB_Result = function() {
/** /**
* SQL result set object * SQL result set object
* PRIVATE METHOD * PRIVATE METHOD
* @constructor
*/ */
DroidDB_Rows = function() { DroidDB_Rows = function() {
this.resultSet = []; // results array this.resultSet = []; // results array
@ -301,14 +306,17 @@ DroidDB_openDatabase = function(name, version, display_name, size) {
/** /**
* For browsers with no localStorage we emulate it with SQLite. Follows the w3c api. * For browsers with no localStorage we emulate it with SQLite. Follows the w3c api.
* TODO: Do similar for sessionStorage. * TODO: Do similar for sessionStorage.
*/ */
/**
* @constructor
*/
var CupcakeLocalStorage = function() { var CupcakeLocalStorage = function() {
try { try {
this.db = openDatabase('localStorage', '1.0', 'localStorage', 2621440); this.db = openDatabase('localStorage', '1.0', 'localStorage', 2621440);
var storage = {}; var storage = {};
this.length = 0; this.length = 0;
function setLength (length) { function setLength (length) {
@ -326,8 +334,8 @@ var CupcakeLocalStorage = function() {
setLength(result.rows.length); setLength(result.rows.length);
PhoneGap.initializationComplete("cupcakeStorage"); PhoneGap.initializationComplete("cupcakeStorage");
}); });
}, },
function (err) { function (err) {
alert(err.message); alert(err.message);
} }
@ -344,7 +352,7 @@ var CupcakeLocalStorage = function() {
} }
); );
}; };
this.getItem = function(key) { this.getItem = function(key) {
return storage[key]; return storage[key];
}; };
this.removeItem = function(key) { this.removeItem = function(key) {

28
lib/classic.rb
View File

@ -5,7 +5,7 @@ class Classic
@android_sdk_path, @name, @pkg, @www, @path = a @android_sdk_path, @name, @pkg, @www, @path = a
build build
end end
def build def build
setup setup
clobber clobber
@ -16,8 +16,8 @@ class Classic
copy_libs copy_libs
add_name_to_strings add_name_to_strings
write_java write_java
end end
def setup def setup
@android_dir = File.expand_path(File.dirname(__FILE__).gsub(/lib$/,'')) @android_dir = File.expand_path(File.dirname(__FILE__).gsub(/lib$/,''))
@framework_dir = File.join(@android_dir, "framework") @framework_dir = File.join(@android_dir, "framework")
@ -31,14 +31,14 @@ class Classic
@app_js_dir = '' @app_js_dir = ''
@content = 'index.html' @content = 'index.html'
end end
# replaces @path with new android project # replaces @path with new android project
def clobber def clobber
FileUtils.rm_r(@path) if File.exists? @path FileUtils.rm_r(@path) if File.exists? @path
FileUtils.mkdir_p @path FileUtils.mkdir_p @path
end end
# removes local.properties and recreates based on android_sdk_path # removes local.properties and recreates based on android_sdk_path
# then generates framework/phonegap.jar # then generates framework/phonegap.jar
def build_jar def build_jar
%w(local.properties phonegap.js phonegap.jar).each do |f| %w(local.properties phonegap.js phonegap.jar).each do |f|
@ -46,7 +46,7 @@ class Classic
end end
open(File.join(@framework_dir, "local.properties"), 'w') do |f| open(File.join(@framework_dir, "local.properties"), 'w') do |f|
f.puts "sdk.dir=#{ @android_sdk_path }" f.puts "sdk.dir=#{ @android_sdk_path }"
end end
Dir.chdir(@framework_dir) Dir.chdir(@framework_dir)
`ant jar` `ant jar`
Dir.chdir(@android_dir) Dir.chdir(@android_dir)
@ -55,9 +55,9 @@ class Classic
# runs android create project # runs android create project
# TODO need to allow more flexible SDK targetting via config.xml # TODO need to allow more flexible SDK targetting via config.xml
def create_android def create_android
IO.popen("android list targets") { |f| IO.popen("android list targets") { |f|
targets = f.readlines(nil)[0].scan(/id\:.*$/) targets = f.readlines(nil)[0].scan(/id\:.*$/)
if (targets.length > 0) if (targets.length > 0)
target_id = targets.last.match(/\d+/).to_a.first target_id = targets.last.match(/\d+/).to_a.first
`android create project -t #{ target_id } -k #{ @pkg } -a #{ @name } -n #{ @name } -p #{ @path }` `android create project -t #{ target_id } -k #{ @pkg } -a #{ @name } -n #{ @name } -p #{ @path }`
else else
@ -66,7 +66,7 @@ class Classic
end end
} }
end end
# copies the project/www folder into tmp/android/www # copies the project/www folder into tmp/android/www
def include_www def include_www
FileUtils.mkdir_p File.join(@path, "assets", "www") FileUtils.mkdir_p File.join(@path, "assets", "www")
@ -127,7 +127,7 @@ class Classic
end end
File.open(File.join(@path, "assets", "www", @app_js_dir, "phonegap.#{ version }.js"), 'w') {|f| f.write(phonegapjs) } File.open(File.join(@path, "assets", "www", @app_js_dir, "phonegap.#{ version }.js"), 'w') {|f| f.write(phonegapjs) }
end end
# puts app name in strings # puts app name in strings
def add_name_to_strings def add_name_to_strings
x = "<?xml version=\"1.0\" encoding=\"utf-8\"?> x = "<?xml version=\"1.0\" encoding=\"utf-8\"?>
@ -138,8 +138,8 @@ class Classic
" "
open(File.join(@path, "res", "values", "strings.xml"), 'w') do |f| open(File.join(@path, "res", "values", "strings.xml"), 'w') do |f|
f.puts x.gsub(' ','') f.puts x.gsub(' ','')
end end
end end
# create java source file # create java source file
def write_java def write_java
@ -164,7 +164,7 @@ class Classic
FileUtils.mkdir_p(code_dir) FileUtils.mkdir_p(code_dir)
open(File.join(code_dir, "#{ @name }.java"),'w') { |f| f.puts j } open(File.join(code_dir, "#{ @name }.java"),'w') { |f| f.puts j }
end end
# friendly output for now # friendly output for now
def msg def msg
puts "Created #{ @path }" puts "Created #{ @path }"

36
lib/create.rb
View File

@ -1,5 +1,5 @@
# Create # Create
# #
# Generates an Android project from a valid WWW directory and puts it in ../[PROJECT NAME]_android # Generates an Android project from a valid WWW directory and puts it in ../[PROJECT NAME]_android
# #
class Create < Classic class Create < Classic
@ -8,35 +8,35 @@ class Create < Classic
read_config read_config
build build
end end
def guess_paths(path) def guess_paths(path)
# if no path is supplied uses current directory for project # if no path is supplied uses current directory for project
path = FileUtils.pwd if path.nil? path = FileUtils.pwd if path.nil?
# if a www is found use it for the project # if a www is found use it for the project
path = File.join(path, 'www') if File.exists? File.join(path, 'www') path = File.join(path, 'www') if File.exists? File.join(path, 'www')
# defaults # defaults
@name = path.split("/").last.gsub('-','').gsub(' ','') # no dashses nor spaces @name = path.split("/").last.gsub('-','').gsub(' ','') # no dashses nor spaces
@path = File.join(path, '..', "#{ @name }_android") @path = File.join(path, '..', "#{ @name }_android")
@www = path @www = path
@pkg = "com.phonegap.#{ @name }" @pkg = "com.phonegap.#{ @name }"
@android_sdk_path = Dir.getwd[0,1] != "/" ? `android-sdk-path.bat android.bat`.gsub('\\tools','').gsub('\\', '\\\\\\\\') : `which android`.gsub(/\/tools\/android$/,'').chomp @android_sdk_path = Dir.getwd[0,1] != "/" ? `android-sdk-path.bat android.bat`.gsub('\\tools','').gsub('\\', '\\\\\\\\') : `which android`.gsub(/\/tools\/android$/,'').chomp
@android_dir = File.expand_path(File.dirname(__FILE__).gsub('lib','')) @android_dir = File.expand_path(File.dirname(__FILE__).gsub('lib',''))
@framework_dir = File.join(@android_dir, "framework") @framework_dir = File.join(@android_dir, "framework")
@icon = File.join(@www, 'icon.png') @icon = File.join(@www, 'icon.png')
@app_js_dir = '' @app_js_dir = ''
@content = 'index.html' @content = 'index.html'
# stop executation on errors # stop executation on errors
raise "Expected index.html in the following folder #{ path }.\nThe path is expected to be the directory droidgap create is run from or specified as a command line arg like droidgap create my_path." unless File.exists? File.join(path, 'index.html') raise "Expected index.html in the following folder #{ path }.\nThe path is expected to be the directory droidgap create is run from or specified as a command line arg like droidgap create my_path." unless File.exists? File.join(path, 'index.html')
raise 'Could not find android in your PATH!' if @android_sdk_path.empty? raise 'Could not find android in your PATH!' if @android_sdk_path.empty?
end end
# reads in a config.xml file # reads in a config.xml file
def read_config def read_config
config_file = File.join(@www, 'config.xml') config_file = File.join(@www, 'config.xml')
if File.exists?(config_file) if File.exists?(config_file)
require 'rexml/document' require 'rexml/document'
f = File.new config_file f = File.new config_file
@ -47,9 +47,9 @@ class Create < Classic
@config[:icons] = {} @config[:icons] = {}
defaultIconSize = 0 defaultIconSize = 0
doc.root.elements.each do |n| doc.root.elements.each do |n|
@config[:name] = n.text.gsub('-','').gsub(' ','') if n.name == 'name' @config[:name] = n.text.gsub('-','').gsub(' ','') if n.name == 'name'
@config[:description] = n.text if n.name == 'description' @config[:description] = n.text if n.name == 'description'
@config[:content] = n.attributes["src"] if n.name == 'content' @config[:content] = n.attributes["src"] if n.name == 'content'
if n.name == 'icon' if n.name == 'icon'
if n.attributes["width"] == '72' && n.attributes["height"] == '72' if n.attributes["width"] == '72' && n.attributes["height"] == '72'
@config[:icons]["drawable-hdpi".to_sym] = n.attributes["src"] @config[:icons]["drawable-hdpi".to_sym] = n.attributes["src"]
@ -74,12 +74,12 @@ class Create < Classic
end end
end end
if n.name == "preference" && n.attributes["name"] == 'javascript_folder' if n.name == "preference" && n.attributes["name"] == 'javascript_folder'
@config[:js_dir] = n.attributes["value"] @config[:js_dir] = n.attributes["value"]
end end
end end
# extract android specific stuff # extract android specific stuff
@config[:versionCode] = doc.elements["//android:versionCode"] ? doc.elements["//android:versionCode"].text : 3 @config[:versionCode] = doc.elements["//android:versionCode"] ? doc.elements["//android:versionCode"].text : 3
@config[:minSdkVersion] = doc.elements["//android:minSdkVersion"] ? doc.elements["//android:minSdkVersion"].text : 1 @config[:minSdkVersion] = doc.elements["//android:minSdkVersion"] ? doc.elements["//android:minSdkVersion"].text : 1
@ -92,6 +92,6 @@ class Create < Classic
@app_js_dir = @config[:js_dir] ? @config[:js_dir] : '' @app_js_dir = @config[:js_dir] ? @config[:js_dir] : ''
# sets the start page # sets the start page
@content = @config[:content] ? @config[:content] : 'index.html' @content = @config[:content] ? @config[:content] : 'index.html'
end end
end end
end end