Appcelerator Blog

The Leading Resource for All Things Mobile

Appcelerator Titanium Cookbook, Second Edition

2 Flares 2 Flares ×

Or: How to port a Classic app to Alloy

Titan Jason Kneen recently delivered his first book, published by Packt. It’s the second edition of one of the most popular Titanium books ever, originally written by another Titan, Boydlee Pollentine.

Grab an e-copy of Appcelerator Titanium Smartphone App Development Cookbook – Second Edition now with a 50% discount using ATSAP50.

What’s new?

The original book was published four years ago, which is forever in mobile-land. Think Android 4, iPhone 4 running iOS 5, iPad 2, Steve Jobs just passed. So most importantly, Jason has updated all of the existing recipes to the latest Platform and Titanium versions.

But Jason didn’t just stop there – he added another 60 pages! From small additions like a recipe on the Android Action Bar and sharing to Twitter, Facebook and Android Intents, to two completely new chapters on URL schemes and of course the Alloy MVC, which was released early in 2013.

Porting an (example) app to Alloy

Although Jason added a chapter on Alloy, the original classic Titanium samples have not been ported to Alloy. So for this blog post, I thought I’d take the opportunity to demonstrate how to do just that using the Funny Face sample in chapter 7.

You can find the source code for the original and Alloy version of the Funny Face Sample on GitHub. Be aware that the original runs on iOS only and that the email dialog to send the photo requires you to run the app on a device.

The Quick & Dirty Way

I hope you have been following the best practice to use a separate CommonJS Module for each view (window) of your classic Titanium app since this is also the pattern that Alloy follows. If you want it done and over with, then you could simply drop the classic code of each of your CommonJS modules in an Alloy controller and add one final line to tell Alloy what the top level view of that controller is:

$.addTopLevelView(win1);

Then all you’re left to do is wherever you used to require another CommonJS module to open the next screen, replace this with:

Alloy.createController('myController').getView().open();

However, let’s do it the slightly less quick and clean way.

1. Move assets

Anything that will not become an Alloy controller, must be moved to either app/assets or app/lib. Both will be copied to Resources when Alloy compiles. However, it is best practice to keep code (utility libraries) in the lib folder and the rest in assets.

For our sample, all we had to do is move Resources/images to app/assets/images.

2. Create XML Markup

This is the hardest step. As you might know, elements in Alloy XML Markup by default compile to Ti.UI.create[Tag]([attributes]). This helps us to create XML markup for all of these calls plus [parent].add([child]), which are used to create the view hierarchy in classic. Though I normally advise differently, for ports I suggest that you add an id attribute to all elements, using the original variable name as the value. This will help us in step 4.

var win1 = Ti.UI.createWindow({
	backgroundColor: 'white'
});
<Alloy>
	<Window id="win1">
		<!-- child views -->
	</Window>
</Alloy>

3. Create TSS

Although both XML attributes and TSS properties compile to parameters for the Ti.UI.create*() calls, the easiest and also preferred way is to use TSS. You can pretty much copy the parameter object from the classic code and drop it in your TSS file. Use the IDs you added as part of the first step to assign the style to the right element.

var win1 = Ti.UI.createWindow({
	backgroundColor: 'white'
});
"#win1": {
	backgroundColor: 'white'
}

There are some properties I would create attributes for to make the XML Markup more readable, like Label texts, Button titles and the image property for ImageViews, much like you would in HTML.

4. Event Listeners

All we are left with for our controller is our logic. Some of the functions will be linked to views as event listener. Knowing that Alloy will compile XML attributes like onClick="foo" to addEventListener('click', foo), name these (often anonymous) functions in your controller code and add the required attributes in the XML code.

saveBtn.addEventListener('click', function(e) { .. });
<Button id="saveBtn" onClick="onSaveClick" />
function onSaveClick(e) { .. }

5. Resolve the view references

Finally, the controller logic will probably reference views it modifies or calls methods on. If you have used the original variable names as IDs as I suggested in the first step, then a step-by-step search and replace will do to prefix those references with $. as that object will hold references to them.

win1.open();
$.win1.open();

6. Test & Tidy

As you can see in Alloy Controller I left pretty much all of the original code intact. Normally you’d take this opportunity to tidy up your code a bit of course.

I did fix some Android issues and as you can see, I used Alloy’s constants for Conditional Code and the built-in Measurement utility library.

Did you know that… Though it is best practice to use OS_IOS also Ti.Platform.name === 'iPhone OS' will be replaced with a boolean when Alloy compiles, and the code block removed when it’s dead code for your target platform?

Now you have no more reasons left not to switch to Alloy!

One Last Thing – A Giveaway!

We’ve gotten our hands on a few copies of the new cookbook to give away!  All you need to do is retweet.  Here’s the fine print:

  • To enter, retweet @Appcelerator’s tweet about the giveaway.
  • One entry per person; no purchase necessary.
  • We’ll pick winners at random on Jan 28, 2016 and let them know via Twitter.  Winners should claim within a week or we may choose another winner!
2 Flares Twitter 0 Facebook 0 Google+ 0 LinkedIn 2 Email -- 2 Flares ×

2 Comments

  1. Jonathan

    Looks like that code works for the ebook only

    -Jon

    • Thanks for noticing that Jonathan! We’ve updated the wording to read “e-copy” instead.

Comments are closed.

Sign up for updates!

Become a mobile leader. Take the first step to scale mobile innovation throughout your enterprise.
Get in touch
computer and tablet showing Appcelerator software
Start free, grow from there.
2 Flares Twitter 0 Facebook 0 Google+ 0 LinkedIn 2 Email -- 2 Flares ×