Home > Store

XPages Extension Library: A Step-by-Step Guide to the Next Generation of XPages Components

Add To My Wish List

XPages Extension Library: A Step-by-Step Guide to the Next Generation of XPages Components

By Paul Hannan, Declan Sciolla-Lynch, Jeremy Hodge, Paul Withers, Tim Tripcony
Published May 11, 2012 by IBM Press. Part of the IBM Press series.

Book

Sorry, this book is no longer in print.

Not for Sale

Description

Sample Content

Updates

More Information

Description

Copyright 2012
Dimensions: 7" x 9-1/8"
Pages: 576
Edition: 1st

Book
ISBN-10: 0-13-290181-1
ISBN-13: 978-0-13-290181-9

The XPages Extension Library’s next-generation XPages controls make application development far more efficient, effective, scalable, and rewarding. With IBM® Lotus® Notes®/Domino® 8.5.3 and Upgrade Pack 1, IBM has incorporated powerful new capabilities and support. These components and technologies are now fully ready for even the toughest production challenges.

XPages Extension Library is the first and only complete guide to Domino development with this library; it’s the best manifestation yet of the underlying XPages Extensibility Framework. Complementing the popular Mastering XPages, it gives XPages developers complete information for taking full advantage of the new components from IBM.

Combining reference material and practical use cases, the authors offer step-by- step guidance for installing and configuring the XPages Extension Library and using its state-of-the-art applications infrastructure to quickly create rich web applications with outstanding user experiences. Next, the authors provide detailed step-by-step guidance for leveraging the library’s powerful new support for REST services, mobile and social development, and relational data. The book concludes by showing how to include Java™ code in Domino XPages applications—a great way to make them even more powerful.

Coverage includes

Automating deployment of XPages Extension Library throughout your IBM Lotus Notes/Domino or IBM XWork environment
Integrating modern design patterns and best practices into Lotus Domino applications with drag-and-drop ease
Incorporating AJAX capabilities with Switch, In Place Form, and other dynamic content controls
Extending applications with Dojo widgets, popups, Tooltips, Dialogs, and Pickers
Implementing state-of-the-art navigation and outlines
Using Layout and Dynamic Views controls to painlessly modernize most Domino applications to XPages
Quickly building mobile interfaces for existing applications
Using social enablers to connect with social platforms and incorporate social features
Integrating SQL datasources into XPages data-driven applications



Sample Content

Online Sample Chapter

Dojo Made Easy

Sample Pages

Download the sample pages (includes Chapter 5 and Index)

Foreword xv

Preface xix

Acknowledgments xxv

About the Authors xxvii

Contributing Authors xxix

Part I: The Extension Library, Installation, Deployment, and an Application Tour

Chapter 1 The Next Generation of XPages Controls 3

So How Did We Get Here? 4

Then Came Domino R.8.5.2, and the Extensibility Door Opened 4

OpenNTF and the Controls Too Good Not to Release 5

To Extensibility and Beyond 5

What Makes an XPages Control Next Generation? 5

What Is the XPages Extension Library? 6

Making Domino Application Development Easier, Faster, and Better 8

What Are the Most Important Controls and Why? 8

XPages Learning Shortcuts 9

Bells and Whistles: Welcome to the Future 10

Get Social 10

Upwardly Mobile 11

Relational Data 11

RESTful Web Services 12

Doing It Yourself with Java 12

Conclusion 12

Chapter 2 Installation and Deployment of the XPages Extension Library 13

Downloading the ExtLib 13

Installing the ExtLib via the Upgrade Pack 17

Deploying ExtLib to Developers in Designer 18

Uninstalling the Extension Library from Designer 27

Server Deployment 28

Automatic Server Deployment in Domino 8.5.3 28

Automatic Server Deployment in Domino 8.5.2 34

Manually Deploying Libraries to a Server 38

Deploying the Extension Library to End Users 40

Widget Catalog Setup 41

Creating a Widget Configuration 42

Provisioning the Extension Library Widget to Other Users 50

Conclusion 52

Chapter 3 TeamRoom Template Tour 53

Where to Get the TeamRoom Template and How to Get Started 54

The TeamRoom Template and Why It Was a Good Candidate for Modernization 55

TeamRoom Redesign Brief and Features 56

Application Layout 56

Recent Activities: The Home Page 59

All Documents 60

The Document Form 61

Calendar 63

Members 64

Mobile 66

Lessons Learned and Best Practices 67

Conclusion 68

Part II : The Basics: The Application’s Infrastructure

Chapter 4 Forms, Dynamic Content, and More! 71

Form Layout Components 71

Form Table (xe:formTable, xe:formRow, xe:formColumn) 71

Forum Post (xe:forumPost) 78

Dynamic Content 80

In Place Form Control (xe:inPlaceForm) 80

Dynamic Content (xe:dynamicContent) 83

Switch (xe:switchFacet) 88

Miscellaneous Controls 89

Multi-Image (xe:multiImage) 89

List Container (xe:list) 91

Keep Session Alive (xe:keepSessionAlive) 92

Conclusion 93

Chapter 5 Dojo Made Easy 95

What Is Dojo? 95

Default Dojo Libraries Using Dojo Modules in XPages 96

Simple Dojo Example: dijit.form.ValidationTextBox 99

Dojo Example for Slider 100

Dojo Themes 102

Dojo Modules and Dojo in the Extension Library 103

Benefits and Differences of Dojo Extension Library Components 104

Dojo Extensions to the Edit Box Control 104

Dojo Text Box (xe:djTextBox) 104

Dojo Validation Text Box (xe:djValidationTextBox) 106

Dojo Number Text Box, Dojo Currency Text Box (xe:djNumberTextBox and xe:djCurrencyTextBox) 113

Dojo Number Spinner (xe:djNumberSpinner) 115

Dojo Date Text Box and Dojo Time Text Box (xe:djDateTextBox and xe:djTimeTextBox) 116

Dojo Extensions to the Multiline Edit Box Control 119

Dojo Extensions to the Select Control 120

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

Dojo Check Box and Dojo Radio Button 126

Dojo Extensions to Buttons 126

Dojo Toggle Button Control 128

Composite Dojo Extensions 130

Sliders 131

Dojo Link Select (xe:djLinkSelect) 135

Dojo Image Select 137

Dojo Effects Simple Actions 140

Dojo Fade and Wipe Effects 140

Dojo Slide To Effect 142

Dojo Animation 143

Conclusion 147

Chapter 6 Pop-Ups: Tooltips, Dialogs, and Pickers 149

Tooltip (xe:tooltip) 149

Dialogs 153

Dialog (xe:dialog) 153

Tooltip Dialog (xe:tooltipDialog) 160

Value Picker (xe:valuePicker) 162

Dojo Name Text Box and Dojo List Text Box (xe:djextNameTextBox and xe:djextListTextBox) 164

Name Picker (xe:namePicker) 165

Validating a Picker 167

Conclusion 170

Chapter 7 Views 171

Dynamic View Panel (xe:dynamicViewPanel) 171

Data Grid 175

REST Service 176

Dojo Data Grid Control (xe:djxDataGrid) 179

Dojo Data Grid Contents 182

InViewEditing 184

View Events 186

iNotes ListView (xe:listView) 187

Dynamic ListView 188

ListView Column 192

iNotes Calendar (xe:calendarView) 194

Calendar Views in the Notes Client 194

REST Service: calendarJsonLegacyService 196

REST Service: Notes Calendar Store 197

Notes Calendar Control 200

View Events 203

Data View (xe:dataView) 206

Pagers 207

PagerSaveState (xe:pagerSaveState) /View State Beans 212

Columns 214

Multiple Columns 219

Forum View 220

Conclusion 221

Chapter 8 Outlines and Navigation 223

The Dojo Layout Controls 223

The Content Pane 223

The Border Container and Border Pane 225

Accordion Container and Accordion Pane 229

The Tab Container and the Tab Pane 231

The Stack Container and the Stack Pane 238

Understanding the Tree Node Concept 239

Standard Node Types 239

The Advanced Node Types 242

Using the Navigator Controls 247

The Navigator Control 247

The Bread Crumbs Control (xe:breadCrumbs) 249

The List of Links Control (xe:linkList) 250

The Sort Links Control (xe:sortLinks) 251

The Link Container Controls 251

The Pop-up Menu Control (xe:popupMenu) 252

The Toolbar Control (xe:toolbar) 254

The Outline Control (xe:outline) 255

The Accordion Control (xe:accordion) 256

The Tag Cloud Control (xe:tagCloud) 257

The Widget Container Control (xe:widgetContainer) 260

Conclusion 261

Chapter 9 The Application’s Layout 263

History of OneUI 263

Easy OneUI Development with the Application Layout Control 264

Legal 267

Navigation Path 268

The Footer 269

The Placebar 270

Search Bar 271

The Banner 272

The Title Bar 273

Product Logo 273

Mast Header and Footer 273

The Layout Control Tooling in Designer 274

Using the Application Layout Within a Custom Control 276

Conclusion 280

Part III: Bell and Whistles: Mobile, REST, RDBMS, and Social Chapter 10 XPages Goes Mobile 283

In the Beginning 283

The XPages Mobile Controls the Extension Library 284

The Basics of the XPages Mobile Controls 284

The Single Page Application Control<xe:singlePageApp> 286

The Mobile Page Control<xe:appPage> 288

The Page Heading Control<xe:djxmHeading> 288

Rounded List (xe:djxmRoundRectList) 289

Static Line Item (xe:djxmLineItem) 291

Mobile Switch (xe:djxmSwitch) 292

Tab Bar (xe:tabBar) 295

Tab Bar Button (xe:tabBarButton) 298

The XPages Mobile Theme 298

Hello Mobile World Tutorial 300

1. Enable the App for the Extension Library and Mobile 300

2. Create a New XPage and Mobile Application 301

3. Add a View Document Collection to the Mobile Page 302

4. Display More Rows 304

5. Opening a Document from the Data View 306

6. Editing and Saving Document Changes 311

Deep Dive into the Controls in the Extension Library, with Examples of Their Use 315

Outline Control 315

Hash Tags 318

Form Table Control (xe:formTable) 318

Dynamic Content Control 320

Data View Control 321

Updates

Submit Errata



More Information



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.

Privacy Notice

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

Email Address