Simple plugin which allows you to open popular files (PDF, WORD, EXCEL, JPG, GIF, POWERPOINT, VIDEOS, MUSIC etc.) stored locally on your device with Phonegap for Android.
Using this plugin requires Android PhoneGap. It has been successfully tested on Android device with Cordova 2.2
To install the plugin, move
fileopener.js to your project's www folder and include a reference to it in your html file after
Create a directory within your project called
src/com/phonegap/plugins/fileopener and move
FileOpener.java into it.
res/xml/plugins.xml file add the following line:
<plugin name="FileOpener" value="com.phonegap.plugins.fileopener.FileOpener"/>
The plugin creates the object
window.plugins.fileOpener. To use, call the
window.plugins.fileOpener.open("file:///sdcard/Android/data/com.example.application/document.doc"); window.plugins.fileOpener.open("file:///sdcard/Android/data/com.example.application/manual.pdf"); window.plugins.fileOpener.open("file:///sdcard/Android/data/com.example.application/presentation.ppt"); window.plugins.fileOpener.open("file:///sdcard/Android/data/com.example.application/image.jpg");
After you run the command above, Android device will either open the file with proper external application installed on your device or ask you which application to use, if you haven't set before which application to use to open the specific type of file. What is great, when you exit the external app, Android will return to your application.
January 2, 2013 Initial release
Please have in mind, that the plugin can open any local file on your Android device, so in some cases you may have to secure the code better. For example you could store your application folder
file:///sdcard/Android/data/com.example.application/ in your
FileOpener.java file instead of
You may also change the way the plugin checks file extension (currently it uses simple
I wrote this plugin basing on the great VideoPlayer plugin by Macdonst (https://github.com/macdonst/VideoPlayer). Big thanks go also to Raymond Camden whose article about Intents inspired me to write plugin (http://www.raymondcamden.com/index.cfm/2012/5/1/Example-of-Intents-with-PhoneGap).
PhoneGap is available under either the terms of the modified BSD license or the MIT License (2008). As a recipient of PhonegGap, you may choose which license to receive this code under (except as noted in per-module LICENSE files). Some modules may not be the copyright of Nitobi. These modules contain explicit declarations of copyright in both the LICENSE files in the directories in which they reside and in the code itself. No external contributions are allowed under licenses which are fundamentally incompatible with the MIT or BSD licenses that PhoneGap is distributed under.
The text of the MIT and BSD licenses is reproduced below.
The "New" BSD License
Copyright (c) 2005-2011, Nitobi Software Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of Phonegap/Nitobi nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.