Fork us on GitHub

PhoneGap/Cordova Compatibility For Codename One

We are thrilled to announce that you can now import your existing PhoneGap/Cordova code to Codename One
Post Image

PhoneGap/Cordova Compatibility For Codename One

We just released the first version of the open source CN1Cordova project on github. This means you can take a common Cordova/PhoneGap app, import it into NetBeans and build a native app using our cloud build servers without any changes!
Before we delve into the exact process of converting an app lets start by reviewing the exact benefits PhoneGap/Cordova developers can gain from Codename One. You can also check out the video tutorial and slides below.

Why Would I Want To Convert?

What Advantages Does Codename One Hold For PhoneGap/Cordova Developers?

Build Cloud On Steroids
Better Native Code Support
Better Protection Of IP
IDE Integration Java - JavaScript - HTML
Easy, Doesn't Require A Mac, Automates Certificates/Signing
Migration To Java

What Are The Limitations?

The first version of the converter doesn't currently translate plugins, it does have some builtin plugins for features such as camera etc.
This is something we intend to address soon so the translation process will be smoother.

Since the native implementation of plugins in Codename One differs a great deal from native plugins in PhoneGap/Cordova there will be some manual work required to migrate plugins. Thankfully since most plugin functionality is already supported in the core Codename One Java API, this is relatively trivial work for most cases.

Currently the browser component used in Codename One is based on the JavaFX browser component which is pretty awful. Its based on webkit but has many limitations in regard to full HTML5 compliance and doesn't correctly specify things such as user-agent. It does work with most JavaScript frameworks correctly though.
We have plans to replace that component with a more mature browser component based on chromium if there is enough community interest to justify the effort.

Why Didn't You Do This Sooner?

We were (and still are) concerned about confusion. Codename One uses a rather elaborate architecture of converting bytecode to native code. This is coupled with an OpenGL ES based rendering pipeline and native widget mixing. Yet despite that fact and the fact that we specifically wrote in the top bar of the page that Codename One is NOT an HTML5 solution we still got the feedback of "well another HTML5 framework".
Our concern was that if we would include PhoneGap this confusion and ambiguity would just grow and hinder our ability to differentiate Codename One in a market dominated by 3 core ideas (HTML5, native & porting tool) as something that doesn't fit in either one of those 3 pillars.

However, a few months ago we started adding things like JavaScript support which uses TeaVM and our own set of complex libraries to facilitate WORA (Write Once Run Anywhere). Which makes our offering even more complex...
Furthermore, at this point with so many other projects making noise about cross platform mobile development, we came to the conclusion that "avoiding confusion" isn't the right strategy.

Does This Mean a Shift In Focus For Codename One?

Our core competitive advantage has always been our huge API and client UI libraries, even with the support above it is still one of the key advantages.
Playing with PhoneGap and some other tools these past few months has further cemented our conviction that despite the fact that almost 4 years have passed since launching Codename One we are still in a league of our own.

Porting A Cordova/PhoneGap app To Codename One

Pre-requisites for this are: NetBeans IDE with the Codename One Plugin installed, JDK 8 (not Java JRE.. JDK!) & Apache Ant.
Download and extract.

From the terminal or command prompt

$ cd cn1-cordova-tools
$ ant create -Dsource=/full/path/to/cordova/app

Note: make sure you are using Java 8 and if not make sure your JAVA_HOME environment variable points at the Java 8 home directory otherwise you might get an UnsupportedClassVersionError. Also make sure you are using the full path to the Cordova app and not a short path or this won't work (no relative paths etc.).
This will create Netbeans Project inside the cn1-cordova-tools directory with settings (package id and name) matching the app specified in the -Dsource argument. The contents of the app's www directory will be copied to the project's src/html directory.

You can open this project up in NetBeans to start working on it. You will be able to run and debug the Java source files in the project. To send a cloud build or change project configuration just use the right click menu and select the correct options.

As mentioned above plugins won't be imported. If the app has plugins installed, you'll see a warning printed.
Future versions should add support for this in some form (e.g. replacing well known plugins with Codename One plugins). There is already support in Codename One for developing Cordova plugins and distributing them as cn1libs (Codename One's native library/plugin format). We will publish the instructions for this as the integration matures.

Share this Post:

Posted by Shai Almog

Shai is the co-founder of Codename One. He's been a professional programmer for over 25 years. During that time he has worked with dozens of companies including Sun Microsystems.
For more follow Shai on Twitter & github.