Krail documentation

This documentation is in 3 parts

• Tutorial. As you would expect, this is a step by step tutorial.
• User Guide. Notes on how to do things, collated by feature
• Developer Guide. Notes on why things are done the way they are. In truth, this is really a loose collection of technical notes optimistically called a “developer guide”

Please do give feedback, whether it is something you do like or something you do not like.

Enjoy

David Sowerby

Contents:

Tutorial

• Introduction to the Tutorial
• Getting Started
  • Creating a Krail application with Gradle
    • Preparation
    • Create a build file
    • Create the Project
    • Import the Project to your IDE
    • Eclipse
    • Krail preparation
  • Exploring the Basic Application
  • Summary
  • Download from GitHub
• Page Navigation
  • Defining a Page
  • Introducing I18N
    • Create an I18N Annotation
  • Add a Page - direct method
    • Defining the I18NKeys
  • Using the Pages
  • View the Pages
  • Add a Page - Annotation method
  • Choosing the Method
  • Moving a Set of Pages
  • Navigation
    • Add some public pages
    • Getting the Navigator
    • Adding some components
    • Navigating with Parameters
    • Excluding a page from Navigation
  • Summary
  • Download from GitHub
• Themes
  • Replacing a UI
• User Notifications
  • Sending the Message
  • Current methods of presentation
  • Different methods of presentation
  • Summary
  • Download from GitHub
• Options
  • Out of the Box
  • Working example
    • Setting up the options
  • Using Hierarchies
  • Option Data Types
  • Summary
  • Download from GitHub
• Configuration from INI files
  • Overview
  • Example
• User Access Control
  • Example
  • Move the Pages
  • User accounts
  • Credentials Store
    • Permission Strings
    • Page Permission
    • Option permission
  • Authentication
  • Authorisation
  • Using the Realm
  • Control Access Through Code
  • Control Access Through Annotations
  • Summary
  • Download from GitHub
• I18N
  • Elements of I18N
  • Direct translation
    • Message with Parameters
  • Pattern sources
    • Selecting pattern sources
• Components and Validation
  • Preparation
    • Set up a page
    • Translations
    • Grid
  • Drilldown and Override
  • Form
    • About the form
  • Summary
  • Download from GitHub
• Persistence - JPA
  • Example
  • Prepare build
  • Create a Page
  • Configure connections
  • Prepare the service
  • Prepare the Entity
  • Prepare the user interface
  • Data
    • Using the EntityManager
    • DAO
  • Persistence for Option
• Guice & Scopes
  • Introduction
  • Singleton
  • VaadinSessionScoped
  • UIScoped
  • Applying a scope
  • <br>
• Event Bus
  • Introduction
  • The Tutorial task
  • Create a page
  • Message receivers
    • Base class
    • Receiver for each bus
  • Completing the View
  • Demonstrating the result
  • Summary
  • Download from GitHub
• Services
  • Lifecycle
    • Causes
• Push
  • Fixing the Refresh Problem
    • Modify the UI
    • Broadcast a message
    • Verifying the change
  • Using a Push Message
  • Footnote
  • Summary
  • Download from GitHub
• Create a project Using Eclipse
  • Acknowledgement
  • Introduction
  • Install Vaadin-Plugin
  • Create a new Vaadin Project
  • Apply Krail-Dependency
• Create a Hierarchy
• Functional Testing

User Guide

• Introduction to the User Guide
• Bootstrap
  • Bootstrap File
    • Sample File
    • File Content
• Injector Scope
  • Accessing the Injector
    • Deserialisation
    • View and UI Factory
• Serialization
  • Serialization and Shiro / JPA
  • Guice Deserialization for View and UI instances
    • Call Sequence
    • Matching constructor parameters with fields
    • Excluding fields
  • Non-Serializable classes
  • Making your classes ‘Guice Serializable’
• Forms
  • Overview
  • Defining a Form
  • Form construction
    • Validation
  • Model to Presentation mapping
    • Defaults
    • Changing defaults
    • Register a new mapping
  • Model to Presentation Converters
    • Adding / Replacing Converters
• License

Developer Guide

• Introduction to the Developer Guide
  • Accuracy
    • Up to date sections
• Goals and Objectives
  • Terminology
  • Goals
  • Objectives
  • Priorities
  • Krail Team Goals
    • Priorities
    • Spek Limitation
  • Documentation
• Bootstrap
  • Injector Location
  • Guice Bindings
  • Bootstrap file
  • Detecting the Environment
• Configuration
  • Objective
  • Configuration levels
    • Level 0 - Requires a re-compile
    • Level 1 - Loadable configuration
    • Level 2 - Dynamic options
• Event Bus
  • Overview
  • Publishing Messages
  • Subscribing to Messages
  • Automatic Subscription
  • Services and Messages
• Functional Testing
  • Component Ids
    • Affect on Performance
  • Page Loading
  • Functional Test Support
• Guice Scopes
  • Vaadin Environment
    • UI Scope
    • Vaadin Session Scope
    • Singleton
  • AOP
• I18N
  • Introduction
  • The Basics
    • The Pattern
    • The Key
    • The Bundle
    • Bundle Reader
    • Pattern Source
    • Translate
    • Current Locale
    • Configuration
  • Managing Keys
  • Managing Locale
    • CurrentLocale
    • Using I18N with Components
    • Extending I18N
    • Validation
• Options and Hierarchies
  • Relationship to Configuration
  • Layers of Options
  • Controlling the Options
  • Hierarchies
  • Storing the Options
  • OptionKey
• Page Navigation
  • When to use a UI or View
  • URI and Route
• Push
  • Background
  • Krail, Push and Vertx
  • Adaptations
  • Detecting the Environment
• Persistence
  • Introduction
  • Terminology
  • Identity
  • Multiple Persistence Units from the same provider
  • Option
    • Testing Bindings
  • Pattern
  • EntityProvider or EntityManagerProvider
  • Generic DAO
• Serialisation
  • Scope of impact
  • Objectives
  • Options and Obstacles
    • Use of Injector.injectMembers
    • Proxy serialisation
    • Bespoke transient field initialiser
  • Conclusion
• Services
  • Managing the Lifecycle
    • <a name=”state-changes-and-causes”></a>State Changes and Causes
  • Service Instantiation
• Testing
  • Introduction
  • ResourceUtils
  • VaadinService
• User Access Control
• Validation
  • Introduction
  • Use standard javax Validation
  • Use a different message for a single use of a javax annotation
  • Change a javax message for all uses
  • Move all translations to one source
    • standard
    • additional built-ins
  • Create a Custom Validation
    • The annotation
    • The Constraint Validator
    • The Key
• Vertx
  • Injector scope
• License

Glossary

• Glossary