qooxdoo Documentation Release 5.0.2 qooxdoo developers January 12, 2017 Copyright ©2011–2017 1&1 Internet AG CONTENTS 1 Introduction 1 1.1 About...................................................1 1.1.1 Framework...........................................1 1.1.2 GUI Toolkit...........................................1 1.1.3 Communication.........................................1 1.1.4 More Information (online)...................................2 1.2 Feature Overview............................................2 1.2.1 Runtimes............................................2 1.2.2 Object-orientation........................................2 1.2.3 Programming..........................................2 1.2.4 Internationalization.......................................3 1.2.5 API reference..........................................3 1.2.6 Testing.............................................3 1.2.7 Deployment...........................................3 1.2.8 Migration............................................4 1.3 Architectural Overview.........................................4 1.4 Getting Started..............................................4 1.4.1 qx.Website...........................................4 1.4.2 qx.Desktop...........................................6 1.4.3 qx.Mobile............................................7 1.4.4 qx.Server............................................8 1.4.5 Others.............................................. 10 2 Core 11 2.1 Object Orientation............................................ 11 2.1.1 Introduction to Object Orientation............................... 11 2.1.2 Features of Object Orientation................................. 12 2.1.3 Classes............................................. 18 2.1.4 Interfaces............................................ 24 2.1.5 Mixins.............................................. 27 2.2 Properties................................................. 29 2.2.1 Introduction to Properties.................................... 29 2.2.2 Properties in more detail.................................... 33 2.2.3 Initialization Behavior..................................... 43 2.2.4 Property features summarized................................. 44 2.3 Environment............................................... 46 2.3.1 Environment.......................................... 46 2.4 Data Binding............................................... 51 2.4.1 Data Binding.......................................... 51 i 2.5 Interaction Events............................................ 64 2.5.1 Pointer Events.......................................... 64 2.5.2 Gesture Events......................................... 64 3 qx.Website 67 3.1 General.................................................. 67 3.1.1 qx.Website Overview...................................... 67 3.1.2 Module Overview........................................ 68 3.2 Widget Library.............................................. 74 3.2.1 qx.Website Widgets....................................... 74 3.3 Tutorials................................................. 76 3.3.1 Tutorial: Building Notifications................................ 76 3.4 Layouts.................................................. 80 3.4.1 Layouts............................................. 80 3.5 Technical Topics............................................. 81 3.5.1 Plugins............................................. 81 3.5.2 Referring to the qx.bom API.................................. 82 4 qx.Desktop 89 4.1 Overview................................................. 89 4.1.1 Widgets............................................. 89 4.1.2 Composites........................................... 89 4.1.3 Roots.............................................. 90 4.1.4 Applications........................................... 90 4.1.5 Communication......................................... 91 4.2 How to Develop a qx.Desktop Application............................... 91 4.2.1 General Cycle of Activities................................... 91 4.2.2 Build Version.......................................... 91 4.2.3 Running the Source Version through a Web Server...................... 92 4.3 Widgets Introduction........................................... 93 4.3.1 Widget............................................. 93 4.3.2 Basic Widgets.......................................... 94 4.3.3 Interaction............................................ 96 4.3.4 Resources............................................ 99 4.3.5 Selection Handling....................................... 102 4.3.6 Drag & Drop.......................................... 105 4.3.7 Inline Widgets.......................................... 109 4.3.8 Custom Widgets........................................ 111 4.3.9 Form Handling......................................... 116 4.3.10 Menu Handling......................................... 132 4.3.11 Window Management...................................... 136 4.3.12 Table Styling.......................................... 137 4.3.13 Widget Reference........................................ 151 4.4 Layouts.................................................. 151 4.4.1 Layouting............................................ 151 4.5 Themes.................................................. 156 4.5.1 Theming............................................. 156 4.5.2 Appearance........................................... 164 4.5.3 Custom Themes......................................... 170 4.5.4 Decorators............................................ 172 4.5.5 Web Fonts............................................ 174 4.5.6 Using themes of contributions in your application....................... 175 4.5.7 Three steps for efficient theme development.......................... 177 4.6 Technical Concepts............................................ 179 ii 4.6.1 The Event Layer........................................ 179 4.6.2 HTML Element Handling.................................... 180 4.6.3 The Focus Layer........................................ 182 4.6.4 Using qx.Website in qx.Desktop................................ 184 4.7 Tutorials................................................. 185 4.7.1 Tutorial Part 1: The Beginning of a Tweets App........................ 185 4.7.2 Tutorial Part 2: Finishing the UI................................ 187 4.7.3 Tutorial Part 3: Time for Communication........................... 191 4.7.4 Tutorial Part 4.1: Form Handling................................ 196 4.7.5 Tutorial Part 4.2: Custom Widgets............................... 198 4.7.6 Tutorial Part 4.2.1: Basic Theming............................... 204 4.7.7 Tutorial Part 4.3: Translation.................................. 208 4.7.8 Tutorial Part 4.4: Unit Testing................................. 212 4.7.9 Tutorial Part 4.5: Virtual List.................................. 217 4.8 Migration................................................. 220 4.8.1 Migration from qx.Desktop 2.x................................. 220 5 qx.Mobile 223 5.1 General.................................................. 223 5.1.1 Overview............................................ 223 5.1.2 qx.Mobile Requirements.................................... 225 5.1.3 Getting Started with qooxdoo qx.Mobile............................ 226 5.2 Tutorials................................................. 227 5.2.1 Tutorial: Creating a Tweets Client with qooxdoo mobile................... 227 5.3 Development............................................... 236 5.3.1 Mobile and tablet switch.................................... 236 5.3.2 Theming............................................. 240 5.3.3 Migrating a qx.Mobile theme to another version........................ 244 5.3.4 Resolution and Pixel Density.................................. 249 5.3.5 Debugging........................................... 252 5.4 Deployment............................................... 254 5.4.1 Deployment........................................... 254 6 qx.Server 255 6.1 Server Overview............................................. 255 6.1.1 Included Features........................................ 255 6.1.2 Supported Runtimes...................................... 255 6.1.3 Installation........................................... 256 6.1.4 Basic Example......................................... 256 6.1.5 Additional Scenarios...................................... 256 6.2 qx.Server Requirements......................................... 256 6.2.1 Runtimes............................................ 257 6.2.2 Installation........................................... 257 6.3 RequireJS Support............................................ 257 6.3.1 Representable interface..................................... 258 6.3.2 Config file............................................ 258 7 Communication 261 7.1 Low-level requests............................................ 261 7.2 Higher-level requests........................................... 261 7.2.1 Higher-level requests...................................... 261 7.2.2 AJAX.............................................. 266 7.3 REST................................................... 268 7.3.1 REST (Representational State Transfer)............................ 268 iii 7.4 Remote Procedure Calls (RPC)..................................... 272 7.4.1 RPC (Remote Procedure Call)................................. 272 7.4.2 RPC Servers........................................... 277 7.5 Specific Widget Communication..................................... 281 7.5.1 Using the remote table