You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by bo...@apache.org on 2012/06/07 22:20:55 UTC

[35/50] [abbrv] android commit: First Draft of how to use CordovaWebView

First Draft of how to use CordovaWebView


Project: http://git-wip-us.apache.org/repos/asf/incubator-cordova-android/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cordova-android/commit/c6851cf7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-android/tree/c6851cf7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-android/diff/c6851cf7

Branch: refs/heads/master
Commit: c6851cf7c54b76f85fd39d84e81763eef0c334ad
Parents: 3b9d46f
Author: Joe Bowser <bo...@apache.org>
Authored: Wed May 16 10:58:33 2012 -0700
Committer: Joe Bowser <bo...@apache.org>
Committed: Wed May 16 10:58:33 2012 -0700

----------------------------------------------------------------------
 guides/CordovaWebView Guide.md |   53 +++++++++++++++++++++++++++++++++++
 1 files changed, 53 insertions(+), 0 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-cordova-android/blob/c6851cf7/guides/CordovaWebView Guide.md
----------------------------------------------------------------------
diff --git a/guides/CordovaWebView Guide.md b/guides/CordovaWebView Guide.md
new file mode 100644
index 0000000..34bbb43
--- /dev/null
+++ b/guides/CordovaWebView Guide.md	
@@ -0,0 +1,53 @@
+# How to use Cordova as a component #
+
+Beginning in Cordova 1.8, with the assistance of the CordovaActivity, you can use Cordova as a component in your Android applications.  This component is known in Android
+as the CordovaWebView, and new Cordova-based applications from 1.8 and greater will be using the CordovaWebView as its main view, whether the legacy DroidGap approach is 
+used or not.
+
+
+The pre-requisites are the same as the pre-requisites for Android application development.  It is assumed that you are familiar with Android Development.  If not, please
+look at the Getting Started guide to developing an Cordova Application and start there before continuing with this approach.  Since this is not the main method that people use
+to run applications, the instructions are currently manual.  In the future, we may try to further automate the project generation.
+
+## Pre-requisites ##
+
+1. **Cordova 1.8** or greater downloaded
+2. Android SDK updated with 15
+
+## Guide to using CordovaWebView in an Android Project ##
+
+1. Use bin/create to fetch the commons-codec-1.6.jar
+2. Go into framework and run ant jar to build the cordova jar (currently cordova-1.8.jar at the time of writing)
+3. Copy the cordova jar into your Android project libs directory
+4. Edit your main.xml to look similar the following. The layout_height, layout_width and ID can be modified to suit your application:
+
+` <org.apache.cordova.CordovaWebView$
+        android:id="@+id/tutorialView"$
+        android:layout_width="match_parent"$
+        android:layout_height="match_parent" />$
+`
+
+5. Modify your activity so that it implements the CordovaInterface.  It is recommended that you implement the methods that are included.  You may wish to copy the methods from framework/src/org/apache/cordova/DroidGap.java, or you may wish to implement your own methods.  Below is a fragment of code from a basic application that uses the interface:
+
+`
+public class CordovaViewTestActivity extends Activity implements CordovaInterface {$
+    CordovaWebView phoneGap;$
+    $
+    /** Called when the activity is first created. */$
+    @Override$
+    public void onCreate(Bundle savedInstanceState) {$
+        super.onCreate(savedInstanceState);$
+        setContentView(R.layout.main);$
+        $
+        phoneGap = (CordovaWebView) findViewById(R.id.phoneGapView);$
+        $
+        phoneGap.loadUrl("file:///android_asset/www/index.html");$
+    }$
+`
+
+6. Copy the HTML and Javascript used to the assets directory of your Android project
+7. Copy cordova.xml and plugins.xml from framework/res/xml to the framework/res/xml in your project
+
+
+
+