Home > Articles > Web Development

Dojo Made Easy

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

Dojo Extensions to the Select Control

As with the other input controls, the Dojo modules for selecting values have been included in the Extension Library. Besides the Dojo Radio Button (xe:djRadioButton) and Dojo Check Box (xe:djCheckBox) controls, there are two Dojo versions of the core Combo Box control: the Dojo Combo Box (xe:djComboBox) and Dojo Filtering Select (xe:djFilteringSelect).

The core Combo Box control is good for ensuring that users select from a restricted list of options, but it does not allow type-ahead. The Edit Box control offers this kind of type-ahead functionality, but it does not force the user to select one of the options provided. The benefit of the Dojo Combo Box and Dojo Filtering Select controls in the Extension Library is that they combine the type-ahead and restrict the user to just the options available. The sole difference between the two is that the Dojo Combo Box control holds a list only of values, whereas the Dojo Filtering Select control holds a list of label/value pairs.

Dojo Combo Box and Dojo Filtering Select (xe:djComboBox and xe:djFilteringSelect)

Developers who are more familior with dojo.data stores such as the ItemFileReadStore can take advantage of the store property and reference a JavaScript store. This is just a JSON object returning a collection of items that could be returned by an XAgent or some other API to return a JSON object. However, if the source data has been provided by a third party, it might not return a name attribute for the Dojo Combo Box to search. In this situation, the searchAttr property can be used to specify a different attribute in the JSON object on which to search. By default, any search, whether against defined items or against a dojo.data store, is case insensitive, but you can enforce case sensitivity by setting the ignoreCase property to true.

By default, whether querying a coded list of options or a dojo.data store, a starts with query will be performed. That is, the only results returned will be those that start with the letter or letters. Sometimes developers might prefer to query the store differently; Dojo provides this functionality. There are three expressions to be used for starts with searches, contains searches, and exact match searches. However, the expressions use the phrase "${", which has a specific meaning to the XSP Command Manager, so the easiest method of entering the expressions is using Server-Side JavaScript. The three variants are included in Listing 5.7, Listing 5.8, and Listing 5.9.

Listing 5.7. Contains Search Expression

<xe:djComboBox
   id="djComboBox2"
   value="#{sessionScope.djComboBox1}"
   tooltipPosition="before"
   title="This is a comboBox" pageSize="2">

<xe:this.queryExpr><![CDATA[${javascript:"*$\{0}*"}]]></xe:this.queryEx
pr>
   <xp:selectItem
      itemLabel="Ford"
      itemValue="ford">
   </xp:selectItem>
   <xp:selectItem
      itemLabel="Toyota"
      itemValue="toyota">
   </xp:selectItem>
   <xp:selectItem
      itemLabel="Renault"
      itemValue="renault">
   </xp:selectItem>
   <xp:selectItem
      itemLabel="Mercedes"
      itemValue="mercedes">
   </xp:selectItem>
</xe:djComboBox>

Listing 5.8. Exact Match Search Expression

<xe:djComboBox
   id="djComboBox2"
   value="#{sessionScope.djComboBox1}"
   tooltipPosition="before"
   title="This is a comboBox"
   pageSize="2">
<xe:this.queryExpr><![CDATA[${javascript:"$\{0}"}]]></xe:this.queryExpr
>
   <xp:selectItem
      itemLabel="Ford"
      itemValue="ford">
   </xp:selectItem>
   <xp:selectItem
      itemLabel="Toyota"
      itemValue="toyota">
   </xp:selectItem>
   <xp:selectItem
      itemLabel="Renault"
      itemValue="renault">
</xp:selectItem>
   <xp:selectItem
      itemLabel="Mercedes"
      itemValue="mercedes">
   </xp:selectItem>
</xe:djComboBox>

Listing 5.9. Starts with Search Expression

<xe:djComboBox
   id="djComboBox2"
   value="#{sessionScope.djComboBox1}"
   tooltipPosition="before"
   title="This is a comboBox" pageSize="2">

<xe:this.queryExpr><![CDATA[${javascript:"*$\{0}"}]]></xe:this.queryExp
r>
   <xp:selectItem
      itemLabel="Ford"
      itemValue="ford">
   </xp:selectItem>
   <xp:selectItem
      itemLabel="Toyota"
      itemValue="toyota">
   </xp:selectItem>
   <xp:selectItem
      itemLabel="Renault"
      itemValue="renault">
   </xp:selectItem>
   <xp:selectItem
      itemLabel="Mercedes"
      itemValue="mercedes">
   </xp:selectItem>
</xe:djComboBox>

To ease selection, a number of properties are available. The pageSize property allows you to define some entries that the drop-down box should show. If the query returns more entries, a link is added to allow the user to page down and page up through the available options, as shown in Figure 5.12 and Figure 5.13. This property doesn’t enhance performance by minimizing the number of options delivered to the browser, but you can use it to enhance presentation. As with the Dojo Number Spinner control, it is also possible to manage the response to the selection. In this case, the searchDelay property allows you to set the number of milliseconds delay before matching results are returned.

Figure 5.12

Figure 5.12. More choices on Dojo Combo Box.

Figure 5.13

Figure 5.13. Previous choices on Dojo Combo Box.

Because the Dojo Filtering Select uses label/value pairs and the Dojo Combo Box uses just a list of values, Dojo Filtering Select takes advantage of two additional properties and an event to handle the labels displayed. The first is labelType. By default, the labels are treated as plain text, but by setting this property to html, the labels are treated as HTML. The second is labelAttr, applicable for developers using a datastore. As with the searchAttr property, you can use this with a Dojo datastore to tell the Dojo Filtering Select to display labels from the store based on an attribute other than name. This does not affect the attribute from the store that is used to search on as the user types. To do that, you need to define the searchAttr property as well. An additional event is available on the Dojo Filtering Select called labelFunc. This triggers on selection of a valid entry and can trigger either Client-Side or Server-Side JavaScript.

Chapter 11, “REST Services,” covers REST services and other data integration, so at this point only a brief example of this functionality is shown in Listing 5.10. Lines 1 to 22 cover the REST service. Note that the jsId defined for the service in line 3 is allocated to the djFilteringSelect in line 26. In line 27, the FilteringSelect shows a list of U.S. states using the labelAttr property, but searches on the two-character abbreviation using the searchAttr property. The results are limited to 10 per page using the pageSize property in line 29.

Listing 5.10. Dojo Filtering Select Using DataStore

1 <xe:restService
2 id="restService1"
3 jsId="stateStore">
4    <xe:this.service>
5       <xe:viewItemFileService
6          viewName="AllStates"
7          defaultColumns="true"
8          dojoType="dojo.data.ItemFileReadStore"
9          count="400">
10         <xe:this.columns>
11            <xe:restViewColumn
12               columnName="Name"
13               name="Name">
14            </xe:restViewColumn>
15            <xe:restViewColumn
16               columnName="Key"
17               name="Key">
18            </xe:restViewColumn>
19         </xe:this.columns>
20      </xe:viewItemFileService>
21   </xe:this.service>
22 </xe:restService>
23 <xe:djFilteringSelect
24    id="djComboBox3"
25    value="#{sessionScope.djComboBox2}"
26    store="stateStore"
27    labelAttr="Name"
28    searchAttr="Key"
29    pageSize="10">
30 </xe:djFilteringSelect>

Table 5.9 details the noteworthy properties of the Dojo Combo Box and Dojo Filtering Select.

Table 5.9. xe:djComboBox and xe:djFilteringSelect Properties

Property

Description

hasArrow

Defines whether a drop-down arrow appears beside the field, to show selections.

ignoreCase

Defines whether the search of the store is case-sensitive.

queryExpr

Defines a query for the way the store is searched, as a “starts with”, “contains”, or “exact match”. For terminology, see Listing 5.7, Listing 5.8, and Listing 5.9.

searchAttr

Defines the attribute in the Dojo datastore to search on; by default, it is name.

searchDelay

Defines the number of milliseconds to delay before beginning the search.

pageSize

Allows the developer to specify the number of entries to show on each page of the search results.

store

Allows the developer to define a Dojo datastore from which to take the options for the Dojo Combo Box or Dojo Filtering Select.

labelAttr

Defines the attribute in the Dojo datastore from which to retrieve the label. If no property is defined, the attribute in the searchAttr property is used. This property is available only for the Dojo Filtering Select.

labelFunc

Defines an event handler to be called when the label changes, returning the label to be displayed. This property is available only for the Dojo Filtering Select.

labelType

Defines whether the label is plain text or HTML. This property is available only for the Dojo Filtering Select.

Dojo Check Box and Dojo Radio Button

The primary intention of the Dojo Check Box and Dojo Radio Button controls is to style the controls appropriate for other Dojo controls. Both controls support the same functionality as the core control versions, so you can assign them to a group with custom values defined. The main difference with the Radio Button Group or Check Box Group is that the core controls for groups display their options in a table within a fieldset. The Dojo Check Box and Dojo Radio Button controls display options inline. In addition to this standard functionality and similarity to the other Dojo controls, the Dojo Check Box and Dojo Radio Button are enabled for accessibility. So the title property and the WAI-related properties can be defined, as can any of the other Dojo controls.

  • + 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