WebApp Developers Manual

Edition 2.1 - The Kopano Team

This document, the WebApp Developers Manual, describes how to develop and extend WebApp. In addition various code snippets are provided for an easier incorporate the WebApp code architecture.

Table of contents

• 1. Introduction
  • 1.1. WebApp
  • 1.2. Requirements
  • 1.3. Document Structure Overview
• 2. Architecture Overview
• 3. Ext JS and OO-Javascript
  • 3.1. Classes
  • 3.2. Accessing Components
  • 3.3. Enums
  • 3.4. Singletons
• 4. Plugins
  • 4.1. Ways of Extending WebApp
  • 4.2. What’s new dialog
• 5. Insertion Points
  • 5.1. Enable insertion points
  • 5.2. Insertion points usage example
  • 5.3. Example: adding a button
• 6. Themes
  • 6.1. Setting the default theme
  • 6.2. Basic themes
  • 6.3. JSON themes
• 7. Widgets
  • 7.1. Creating a widget
  • 7.2. Widget configuration
  • 7.3. Events
• 8. Dialogs
  • 8.1. Events
  • 8.2. Example
  • 8.3. Dealing with MAPI records
    • 8.3.1. Displaying a record
• 9. Bidding System
  • 9.1. Bidding and insertion points
  • 9.2. Working
  • 9.3. Bidding on a shared component
  • 9.4. Example
• 10. Data Models
  • 10.1. Model-based architecture
  • 10.2. Separable model architecture
  • 10.3. Hierarchy model
  • 10.4. Settings model
• 11. MAPI
• 12. Communication
  • 12.1. Conceptual Overview
  • 12.2. Protocol
  • 12.3. Javascript Communication
  • 12.4. Response Handlers
  • 12.5. Notifications
• 13. Stores and RecordFactory
  • 13.1. Stores and Substores
    • 13.1.1. MAPI Store
    • 13.1.2. IPM Stores and ShadowStore
  • 13.2. RecordFactory
• 14. Deployment and Build System
  • 14.1. Deployment
  • 14.2. Build System
    • 14.2.1. Getting Started
      • 14.2.1.1. Linux
      • 14.2.1.2. Windows, Mac OSX
    • 14.2.2. Ant Introduction
    • 14.2.3. Tools
      • 14.2.3.1. JsConcat
      • 14.2.3.2. Ext-doc
      • 14.2.3.3. Closure Compiler
• 15. Translations
  • 15.1. Gettext
  • 15.2. Server-Side
    • 15.2.1. Implemented Functions on the Server-Side
  • 15.3. Client-Side
    • 15.3.1. Reading Translations and Passing it to the Client
    • 15.3.2. Implemented Functions on the Client-Side
• 16. Appendix A: Naming Conventions
  • 16.1. Namespace Structure
  • 16.2. Naming Packages and Classes
  • 16.3. Naming Insertion Points
    • 16.3.1. Coding Style Guidelines
    • 16.3.2. Documentation
  • 16.4. Documenting Classes
  • 16.5. Documenting Fields
  • 16.6. Documenting Constructors
  • 16.7. Documenting Methods
  • 16.8. Documenting Insertion Points
  • 16.9. Documenting Enumerations
• 17. Appendix B: References
• 18. Legal Notice