log inhelp

View
 

Getting Started with PhoneGap-BlackBerry with the Latest Environment

Page history last edited by Jennifer Kyrnin 1 month, 2 weeks ago

 

Getting Started with PhoneGap-BlackBerry (Targeting BlackBerry OS 4.6+ Devices ONLY)

 

This article explains how to setup the BlackBerry development environment for PhoneGap applications targeted at devices running BlackBerry OS 4.6+ ONLY.

 

 This information will not help you develop PhoneGap applications targeted for BlackBerry OS 5+.  For instructions on how to do that, see link.

 

The BlackBerry developer environment is an Eclipse Plugin that includes a BlackBerry simulator and tools for application packaging / deployment.

 

Important

 

  • This guide is intended for Windows. It has been tested on Windows XP x86 and x64.
  • OS X partially works, but Eclipse cannot detect installed versions of JDE.
  • Currently, phonegap-blackberry can NOT be used to target devices running BlackBerry OS 5.0 and higher.  For instructions on getting started with PhoneGap on devices running BlackBerry OS 5.0 and higher, see the BlackBerry WebWorks guide. 

 

 

Sun JDK

 

  1. Download the latest version of the Java Developer Kit (JDK).
    • At the time of writing this article, the latest version is JDK 6 Update 20.
    • You must install a 32-bit version of the JDK.
    • The BlackBerry Plugin can only recognize a 32-bit JDK and Eclipse IDE. 
  2. Install the JDK.
    • During the installation, you will be asked to install the Java Runtime Environment (JRE) - please do this.

 

Eclipse IDE

 

  1. Download the latest version of the Eclipse IDE for Java Developers (or Eclipse IDE Classic).
    • At the time writing of this article, the latest version is Eclipse 3.5.2 (Galileo).
    • Users have reported that Eclipse 3.6 (Helios) works fine. 
  2. Install the Eclipse IDE.
    • Install by extracting the ZIP archive to a desired installation directory.
    • e.g. C:\Program Files\Eclipse\Eclipse-3.5.2 
  3. Run the Eclipse IDE for the first time.
    • To ensure there are no problems with the installation.
  4. Close the Eclipse IDE. 

 

BlackBerry Plugin for Eclipse

 

  1. Download the latest BlackBerry Plugin for Eclipse.
    • You will need a BlackBerry Developer Zone account (free).
    • The Plugin's name is misleading. BlackBerry Java Plugin for Eclipse v1.1 means the Plugin version is 1.1 (not Eclipse). 
  2. Install the Plugin to the Eclipse directory.
    • Make sure Eclipse is closed. 
    • The Plugin must be installed into the root of your Eclipse directory.
    • e.g. C:\Program Files\Eclipse\Eclipse-3.5.2\

 

BlackBerry JDE Component Packs

 

The JDE component packs allow you to build your Blackberry application for a specific Blackberry platform. By default, the BlackBerry Plugin includes JDE 5.0.

 

  1. Open the Eclipse IDE
  2. Select Help > Install Software
  3. Click the button Add..
  4. Select the JDE component packs.
    • Select versions 4.7, 4.6.1, and any others that you want. 
  5. Click OK
  6. Select Next > Next > Finish
    • There is a legal agreement on the last window
  7. When the Authentication prompt appears
    • Username & Password is your BlackBerry Developer Zone account.
    • If multiple login prompts appear, then enter your credentials into each.
      • Cancelling any login prompt will cancel the installation. 
  8. Restart Eclipse when prompted.
    • Do it. Restarting Eclipse is important. 

 

Aptana Plugin for Eclipse (Optional)

 

Installing the Eclipse Aptana plugin will enable HTML and JavaScript syntax highlighting.

 

  1. Open the Eclipse IDE
  2. From the menu
    1. Select Help > Install New Software...
  3. Click the Add... button
    1. Name: <Leave Blank>
    2. Location: http://download.aptana.org/tools/studio/plugin/install/studio
  4. Check the box next to the Apanta plugin
  5. Click Next until Finish 

 

Apache ANT

  1. Download ANT
  2. Extract to a desired installation directory, e.g. C:\apache-ant
  3. Set ANT_HOME
    1. Open System Properties -> Advanced -> Environment Variables
    2. Create a new system variable
      • Variable name: ANT_HOME
      • Variable value: C:\apache-ant
  4. Add ANT_HOME to PATH
    1. Open System Properties -> Advanced -> Environment Variables
    2. Under system variables, edit PATH
      • Add ;%ANT_HOME%\bin to the end of the PATH value.
      • e.g. %SystemRoot%\system32;%SystemRoot%;%JAVA_HOME%\bin;%ANT_HOME%\bin
  5. Verify that ANT is installed

    1. Open your command-line tool (cmd.exe or cygwin.exe)

       $ ant -v
 Apache Ant version 1.8.1 compiled on April 30 2010
 Trying the default build file: build.xml
 Buildfile: build.xml does not exist!
 Build failed

 

 

 

PhoneGap Application Setup

 

Create a BlackBerry Project

 

  1. Open the Eclipse IDE.
  2. Select File > New > Project...
  3. Select BlackBerry Project
  4. Press Next
  5. On the Create a BlackBerry Project screen
    • Project Name: Enter a name for your application
    • Use Project Specific JRE: Select JRE 4.7 or under
      • JRE 5.0 does not currently work with PhoneGap
  6. Press Finish.

 

 

Import the PhoneGap-BlackBerry Project

  1. Download the PhoneGap-BlackBerry source.
    Click the Download Source button in the top-right.
    Extract the PhoneGap-BlackBerry source. 
  2. e.g. C:\PhoneGap-BlackBerry\
  3. Copy & paste the following directories:
    • C:\PhoneGap-BlackBerry\app\www => C:\<Your Eclipse Project Path>\src\www
    • C:\PhoneGap-BlackBerry\framework\src\com => C:\<Your Eclipse Project Path>\src\com
    • C:\PhoneGap-BlackBerry\framework\src\org => C:\<Your Eclipse Project Path>\src\org
  4. Build the phonegap.js
    • CD C:\PhoneGap-BlackBerry\BlackBerry\4.x\framework 
    • Edit common.properties: Edit the jde.home to point to your Eclipse JDE Component Pack. You must double escape each backslash.

    • Edit project.properties

    • Copy the Blackberry Ant tools and Ant-Contrib JAR files that are in the \util directory of the latest zip file from PhoneGap to  => ANT_HOME/lib before building.

    • CD (back to where build.xml is) C:\PhoneGap-BlackBerry\BlackBerry\4.x\

    • ant build-javascript 
    • Copy generated phonegap.js to => C:\<Your Eclipse Project Path>\src\www
  5.  Open the Eclipse IDE
    Right-click on your BlackBerry-PhoneGap project
    Select Refresh 
    You should now see \com, \org and \www packages under the \src tree 

 

 

Run the PhoneGap-BlackBerry Project in the Simulator

 

  1. Open the Eclipse IDE
  2. Right-click on your PhoneGap-BlackBerry Project
    • Select Run As > BlackBerry Simulator
  3. The simulator will open and run your application.
    • The application can be found in the simulator's Downloads directory.

 

Enable HTTP Connections in the Simulator

Automatic Approach

  1. Open the Eclipse IDE
  2. Right-click on your PhoneGap-BlackBerry Project
    • Select Run As > Run Configurations...
  3. In the right-side panel
    • Select the Simulator tab
    • Select the General tab 
    • Check Launch Mobile Data System Connection Service (MDS-CS) with simulator
  4. Click Apply
  5. Click Close 

 

Manual Approach

  1. Run the MDS-CS batch script for a specific JDE Component Pack
    • e.g. C:\Program Files\Eclipse\Eclipse-3.5.2\plugins\net.rim.ejde.componentpack4.6.1_4.6.1.36\components\MDS\run.bat
  2. If the run.bat window does not remain open 
    • Set your JAVA_HOME environment variable
      • Right-click on My Computer
        • Select Properties
      • Select Advanced tab
      • Click Environment Variables
      • Create a new User Variable
        • Name: JAVA_HOME
        • Value: Your JRE Path (e.g. C:\Program Files (x86)\Java\jre6)
      • Click OK > OK > OK
PhoneGap-BlackBerry

 

 

 

 

 

PDF version