Home > Articles > Home & Office Computing > The Web/Virtual Worlds/Social Networking

  • Print
  • + Share This
This chapter is from the book

This chapter is from the book

2.5 Creating Your First Widget: LoanPaymentWidget

Now it’s time to build a widget that uses the previously built LoanPaymentService. Here’s a summary of the steps you’ll follow to build a widget.

  1. Create a new widget. Give it a name and a description.
  2. Upload any resources, such as images (optional).
  3. Include any libraries your widget uses.
  4. Provide the HTML, CSS, and JavaScript code.
  5. Use Find & Use to call zembly services from your widget.
  6. Preview and publish.
  7. Embed in a web page.

At the top of the page, select 26inline01.jpg and then select Widget. zembly pops up a secondary dialog that lets you either select a template for your widget or simply create a blank widget. Select Create a blank widget as shown in Figure 2.31.

Figure 2.31

Figure 2.31 Creating a blank widget

When you create a widget, you have the opportunity to supply three different files. You can also add images (which you’ll do in this example) and include libraries in a separate step. You’ll use (X)HTML for page markup, CSS for style specifications, and JavaScript for program logic. Figure 2.32 shows LoanPaymentWidget, the target widget that you’ll build, running in a browser.

Figure 2.32

Figure 2.32 LoanPaymentWidget running in a browser

This widget includes an image, three input text fields with labels arranged in a table, a Calculate Payment button, and an output field that displays the result returned from the service.

Uploading an Image

To include an image with your widget, you upload it to zembly’s servers. To upload the image, click Browse in the Resources dialog. Navigate and select an image from your file system. After you click Upload, the image appears in the Resources window, as shown in Figure 2.33. Now click on the image to add it to your widget as an <img> tag.

Figure 2.33

Figure 2.33 Uploading images to add to your widget

After selecting the image, the HTML code includes an <img> tag as follows. (Select the (X)HTML tab.)

<img src="${res('house.jpg')}">

You’ll move the <img> tag inside the outermost <div>, as shown in Listing 2.3.

Including Library Prototype JS

From the Resources tab, select Libraries at the bottom. Select Prototype from the list of libraries, as shown in Figure 2.34. Prototype is a general-purpose JavaScript library that includes functions (such as enhanced array iteration) and syntax shortcuts for DOM elements.

Figure 2.34

Figure 2.34 Including the Prototype JavaScript library in your widget

Building LoanPaymentWidget

Listing 2.3 shows the HTML code for this widget. The input elements are organized within a table element to create symmetrical spacing. The <div> tag with id="result-Div" holds the results returned from the LoanPaymentService; the <div> tag with id="errorDiv" holds any returned error messages.

Listing 2.3. LoanPaymentWidget (HTML)

<div id="loanDiv" class="widget">
   <img src="${res('house.jpg')}">
   <div id="headingDiv" class="heading">
   Loan Payment Calculator
   </div>
   <table>
      <tr><td>Principal:</td>
         <td>
         <input id="principal" type="text" size="20" value="300000">
         </td></tr>
      <tr><td>Interest:</td>
         <td>
         <input id="interest" type="text" size="20" value="6.0">
         </td></tr>
      <tr><td>Term (years):</td>
         <td>
         <input id="years" type="text" size="20" value="30">
         </td></tr>
      <tr><td colspan="2">
         <div id="calcdiv" class="calc">
         <button id="calcButton">Calculate Payment</button>
         </div>
         </td></tr>
      <tr><td colspan="2">
         <div id="resultDiv" class="results">
         </div>
         <div id="errorDiv" class="errorResults">
         </div>
         </td></tr>
   </table>
</div>

Using CSS for Styling

The widget’s CSS file provides style sheets for the widget. Note that there is a separate style for results and errorResults. Here is the CSS code.

Listing 2.4. LoanPaymentWidget (CSS)

div.widget {
   background-color: #e6e6ff;
   border: 1px solid #aaaaff;
   padding: 5px 5px 5px 5px;
   font-size: 0.8em;
}
div.heading {
   font-size: 1.3em;
   font-weight: bold;
   text-align: center;
}
div.calc {
   margin: 5px;
   text-align: center;
}
div.results {
   margin: 5px 2px 2px 2px;
   padding: 1px 2px 2px 2px;
   font-weight: bold;
   text-align: center;
}
div.errorResults {
   margin: 5px 2px 2px 2px;
   padding: 1px 2px 2px 2px;
   font-weight: bold;
   color: #C61C1C;
   text-align: center;
}

Calling LoanPaymentService in Your Widget

zembly makes it easy for you to add code to call services in your widget (this works when building services, too). Open the JavaScript editor for your widget (click the JavaScript tab in the editor zone). Then select the Find & Use tab in the window to the right of the editor zone. You’ll see a Search window. Type in LoanPaymentService and click Search.

Figure 2.35 shows the results (quite a few, as it turns out). Using the avatars as a clue, find the LoanPaymentService near the start of the list. If you click its description, zembly opens the LoanPaymentService page in a new window. You can then study its documentation (or code). To add code to call the service to your widget, simply click Add to editor in the search results window. This will give you the correct calling template as a starting point. You can then edit the JavaScript to specify the parameter values and add the coding logic for your widget.

Figure 2.35

Figure 2.35 Find & Use Search for Services lets you easily add code to your widget

Listing 2.5 shows the JavaScript that calls LoanPaymentService using the three input values. Prototype’s Event.observe function connects the calcButton click event to the handler.

After obtaining the principal, interest, and years input from the user, you pass these parameters to the LoanPaymentService. The return value is in data, which you prepend with a dollar sign ($) (for a successful payment result) or error, which returns an error code (error.code) and message (error.message). You insert the payment or the error information into the page’s HTML markup.

$("resultDiv").innerHTML = [insert payment html here];
$("errorDiv").innerHTML = [insert error html here];

Because style errorDiv defines its text color as red as shown below (and in Listing 2.4 on page 39), error messages appear in red and normal return results are in black.

div.errorResults {
   margin: 5px 2px 2px 2px;
   padding: 1px 2px 2px 2px;
   font-weight: bold;
   color: #C61C1C;
   text-align: center;
}

The Prototype shortcut notation uses $("element_id") instead of the more verbose document.getElementById("element_id").

Listing 2.5. LoanPaymentWidget (JavaScript)

Event.observe($("calcButton"), 'click', function() {
   var principal = $("principal").value;
   var interest = $("interest").value;
   var years = $("years").value;

   Things.callService("ganderson.LoanPaymentService",
   {
      "principal": principal, // The principal of the loan (in dollars)
      "interest": interest, // The interest rate (per cent) (e.g., 6.5)
      "years": years // How long your loan will endure (in years)
   },
   {  onSuccess: function(data) {
            var resultsHtml = "$" + data;
            $("resultDiv").innerHTML = resultsHtml;
            $("errorDiv").innerHTML = "";

      },
      onFailure: function(error) {
            $("errorDiv").innerHTML = error.code + ": " + error.message
               + ".<br/>";
            $("resultDiv").innerHTML = "";
         }
      });
});

Previewing and Publishing

Test your widget using the Preview tab or the Preview widget box. When you’re satisfied that the widget is working, publish your widget by selecting the 32inline01.jpg button. After you publish a widget, you can embed it in any web page.

Embedding LoanPaymentWidget

This widget is embedded in a web page with the following HTML source.

<iframe width=400 height=280
   src="https://94f52847744e493b944aed46cf255e63.zembly.com/things/
      94f52847744e493b944aed46cf255e63;iframe" frameborder="0">
</iframe>

You copy/paste the source from the widget’s documentation page (under Share This Widget). Here, we’ve supplied height and width attributes to adjust the size of the iframe tag area.

  • + Share This
  • 🔖 Save To Your Account

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