Home > Articles

This chapter is from the book

This chapter is from the book

Anatomy of a Cordova Application

Now that you know a little bit about how to create a Cordova application project, it’s time to show you what makes a Cordova application a Cordova application. In this section, I show how to create a Cordova web application that leverages one of the Cordova Core APIs.

To begin, I opened a terminal window and navigated to the folder where I wanted to create the project. Next, I issued the following commands:

cordova create hellocordova1
cd hellocordova1
cordova platform add android ios
cordova plugin add org.apache.cordova.device

This created a hellocordova1 project folder, added the Android and iOS platforms to the project, and then added the code for the Cordova Device API. Next, I navigated to the project’s www folder and pasted the code from Listing 1.1 into the project’s existing index.html file.

Listing 1.1 Hello Cordova 1

<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="Content-type" content="text/html; charset=utf-8">
    <meta name="viewport" id="viewport" content="width=device-width, 
      height=device-height, initial-scale=1.0, maximum-scale=1.0, 
      user-scalable=no;" />
    <script type="text/javascript" charset="utf-8" src="cordova.js">
    </script>
    <script type="text/javascript" charset="utf-8">
      function onBodyLoad() {
        document.addEventListener("deviceready", onDeviceReady, false);
      }

      function onDeviceReady() {
        var br = "<br />";
        //Get the appInfo DOM element
        var element = document.getElementById('devInfo');
        //Replace it with specific information about the device 
        //running the application
        element.innerHTML = 'Cordova Version: ' + device.cordova + br +
          'Operating System: ' + device.platform + br + 
          'OS Version: ' + device.version + br + 
          'Device Model: ' + device.model + br +       
          'Universally Unique Identifier: ' + device.uuid;
      }
    </script>
  </head>
  <body onload="onBodyLoad()">  
    <h1>Cordova Information</h1>
    <p>This is an Apache Cordova application that makes calls to the 
       Cordova Device API.</p>
    <p id="devInfo">Waiting for Cordova initialization to complete.</p>
  </body>
</html>

The index.html file shown in the listing is like any other HTML page you’ve seen, with some extra elements that enable it to understand how to interact with the Cordova container. The content-type setting is a standard HTML setting and should look the same as it would for any other HTML5 application. Within the <Head> section of the web page are two new entries, meta tags that describe the content type for the application and viewport settings.

The viewport settings shown in the following code tell the embedded web browser rendering the content how much of the available screen real estate should be used for the application and how to scale the content on the screen:

<meta name="viewport" id="viewport" content="width=device-width, 
  height=device-height, initial-scale=1.0, maximum-scale=1.0, 
  user-scalable=no;" />

In this case, the HTML page is configured to use the maximum height and width of the screen (through the width=device-width and height=device-height attributes) and to scale the content at 100% and not allow the user to change that in any way (through the initial-scale=1, maximum-scale=1, and user-scalable=no attributes).

There’s also a new script tag in the code that loads the Cordova JavaScript library:

<script type="text/javascript" charset="utf-8" src="cordova.js"></script>

This loads the Cordova API library and makes some Cordova capabilities available to the program.

The JavaScript code in a Cordova application does not have immediate access to any installed Cordova APIs after the web application has loaded. The native Cordova application container must complete its initialization process before it can respond to calls JavaScript made using the Cordova APIs. To accommodate this delay in API availability, a web developer building Cordova applications must instruct the container to notify the web application when the Cordova APIs have completed initialization. Any application processing that requires the use of the APIs should be executed by the application only after it has received notification that the APIs are available.

In the application, this notification is accomplished through the addition of an onload event defined in the page’s body section as shown in the following:

<body onload="onBodyLoad()">

Within the onBodyLoad function, the code registers an event listener that instructs the application to call the onDeviceReady function when the device is ready, when the Cordova application container has finished its initialization routines and fired its deviceready event:

document.addEventListener("deviceready", onDeviceReady, false);

In this example application the onDeviceReady function updates the page rendered on the screen to display all of the available properties exposed by the Cordova Device API (described in Chapter 8) as shown in the following:

//Replace it with specific information about the device 
//running the application
element.innerHTML = 'Cordova Version: ' + device.cordova + br +
  'Operating System: ' + device.platform + br + 
  'OS Version: ' + device.version + br + 
  'Device Model: ' + device.model + br + 
  'Universally Unique Identifier: ' + device.uuid;

To run the application on an Android emulator, open a terminal window, navigate to the Cordova project folder, and issue the following command:

cordova emulate android

The default Android emulator will launch and display the application as shown in Figure 1.5.

Figure 1.5

Figure 1.5 Hello Cordova 1 Running on an Android Emulator

When the application runs on an iOS simulator, it will display a screen similar to what is shown in Figure 1.6.

Figure 1.6

Figure 1.6 Hello Cordova 1 Running on an iOS Simulator

One of the common questions I get from people first learning Cordova is “Can I use HTML5 or JavaScript framework X with Cordova?” (substituting the name of their favorite HTML5 or JavaScript framework—jQuery Mobile, Sencha Touch, Dojo, and so on—into the question). The answer is unequivocally yes. The Cordova application simply renders whatever web content you pass to it using the native browser web view exposed by the mobile device OS.

As a side project, to help developers easily build more beautiful mobile applications, Adobe created Topcoat (www.topcoat.io). Topcoat is a set of CSS files and open-source fonts that can be used to create fast, themeable, beautiful web sites. In an effort to make the sample applications highlighted in this book prettier, where appropriate I’m going to use Topcoat to apply styling to many of the applications.

So, once I downloaded the Topcoat files, I extracted them and copied over the font and CSS files to my project folder, then updated the application’s HTML to use the Topcoat styling. You can see an updated listing for the example application, now called Hello Cordova 2, in Listing 1.2.

Listing 1.2 Hello Cordova 2

<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="Content-type" content="text/html; charset=utf-8">
    <meta name="viewport" id="viewport" content="width=device-width, 
      height=device-height, initial-scale=1.0, maximum-scale=1.0, 
      user-scalable=no;" />
    <link rel="stylesheet" type="text/css" 
      href="css/topcoat-mobile-light.min.css">
    <script type="text/javascript" charset="utf-8" src="cordova.js">
    </script>
    <script type="text/javascript" charset="utf-8">
    function onBodyLoad() {
      document.addEventListener("deviceready", onDeviceReady, false);
    }
    function makeListItem(textStr) {
      return '<li class="topcoat-list__item">' + textStr + '</li>';
    }
    function onDeviceReady() {
      var tmpStr;
      tmpStr = '<ul class="topcoat-list__container">
        <h3 class="topcoat-list__header">Device API Properties</h3>';
      tmpStr+= makeListItem('Cordova Version: ' + device.cordova);
      tmpStr+= makeListItem('Operating System: ' + device.platform);
      tmpStr+= makeListItem('OS Version: ' + device.version);
      tmpStr+= makeListItem('Device Model: ' + device.model);
      tmpStr+= makeListItem('Universally Unique Identifier: ' + 
        device.uuid);
      tmpStr+= '</ul>';
      //Get the appInfo DOM element
      var element = document.getElementById('devInfo');
      //Replace it with specific information about the device running 
      //the application
      element.innerHTML =tmpStr;
    }
    </script>
  </head>
  <body onload="onBodyLoad()">
    <div class="topcoat-navigation-bar">
      <div class="topcoat-navigation-bar__item center full">
        <h1 class="topcoat-navigation-bar__title">Hello Cordova #2</h1>
      </div>
    </div>
    <h1>Cordova Information</h1>

    <p>This is an Apache Cordova application that makes calls to the 
      Cordova Device API.</p>
    <div class="topcoat-list" id="devInfo">
      <h3 class="topcoat-list__header">
        Waiting for Cordova to initialize
      </h3>
    </div>
  </body>
</html>

I added the application’s title to a title bar, assigning class=“topcoat-navigation-bar”, class=“topcoat-navigation-bar__item center full”, and class=“topcoat-navigation-bar__title” to the elements of the header as shown in the listing. To render the list of Device API properties on the screen, I created an unordered list, with the appropriate class assignment, then applied class=“topcoat-list__item” to each list item. When the modified application runs on an Android emulator, it displays a screen similar to what is shown in Figure 1.7.

Figure 1.7

Figure 1.7 Hello Cordova 2 Running on an Android Emulator

Notice how much better that looks? To prove it works as well on iOS, when the application runs on an iOS simulator, it displays a screen similar to what is shown in Figure 1.8.

Figure 1.8

Figure 1.8 Hello Cordova 2 Running on an iOS Simulator

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020