Jspresso : The Java RIA Framework

Jspresso Reference Manual

3.5.11

Abstract

This document is a reference manual for the Jspresso framework. It deals with all the building blocks of a Jspresso application.


Table of Contents

Preface
I. A Jspresso application from A to Z
I.1. Setting-up the development environment
I.1.1. Installing the tools
I.1.2. Generating the skeleton project
I.1.3. Importing the project in Eclipse
I.2. The human resources (HR) sample application
I.2.1. The domain model
I.2.2. The application workspaces
I.2.3. The profiles
I.3. Layering the application
I.3.1. The domain model
I.3.2. The backend
I.3.3. The frontend
I.4. Describing the domain model
I.4.1. Using the "Sugar for Jspresso" DSL
I.4.2. Interfaces
I.4.3. Generating the domain model code
I.4.4. Adding life-cycle behaviour
I.4.5. Entities
I.4.6. Components
I.4.7. Unidirectional relationships
I.4.8. Entity inheritance
I.4.9. Bi-directional relationships
I.4.10. Component services
I.4.11. Computed properties
I.4.12. Property processors
I.4.13. Hibernate mapping
I.5. Describing the views
I.5.1. Component views
I.5.2. Composite views
I.5.3. Collection views
I.5.4. Tree views
I.5.5. Other types of views
I.6. Wiring the application
I.6.1. Configuring the backend layer
I.6.2. Configuring the frontend layer
I.7. Creating and registering application workspaces and modules
I.7.1. The master data management workspace
I.7.2. Improving the development lifecycle : setting-up test data on startup
I.7.3. Developing the remaining workspaces
I.7.4. Securing the application access : Authorization
I.8. Packaging and deploying
I.8.1. A quick overview of options
I.8.2. Packaging the application WAR archive
I.8.3. Deploying to the application server
II. Domain model
II.1. Components and entities
II.1.1. Overview
II.1.2. Reference
II.2. Properties
II.2.1. Overview
II.2.2. Reference
III. Views
III.1. Simple views
III.1.1. Overview
III.1.2. Reference
III.2. Composite views
III.2.1. Overview
III.2.2. Reference
IV. Actions
IV.1. Overview
IV.2. Common part
IV.2.1. Reference
IV.3. Backend actions
IV.3.1. Reference
IV.4. Frontend actions
IV.4.1. Reference
IV.5. Built-in actions
V. Application Structure
V.1. Controllers
V.1.1. Overview
V.1.2. Reference
V.2. Modules
V.2.1. Overview
V.2.2. Reference
V.3. Enabling/Disabling
V.3.1. Overview
V.3.2. Reference
V.4. Startup
V.4.1. Overview

List of Figures

1. Jspresso Modules
I.1. Commons class diagram
I.2. Employees class diagram
I.3. Organization class diagram
I.4. General architecture diagram
I.5. The first component view
I.6. City LOV
I.7. Regular expression error message
I.8. Company view with English translation
I.9. Company view with French translation
I.10. The customized company view
I.11. The tabbed company view
I.12. The improved tab company view
I.13. The company and departments view
I.14. The improved company and departments view
I.15. The improved company and departments view with refined department columns
I.16. The company, departments and teams view
I.17. The company structure as a tree view
I.18. The login dialog with a french startup locale
I.19. The application main window with an English logged-in user
I.20. The application main window with a French logged-in user
I.21. The module hiearchy gets structured
I.22. The customized city bean module view
I.23. Access denied on workspace
I.24. The browser displays the Flex login dialog
I.25. You query the companies in Flex !
I.26. The browser displays the qooxdoo login dialog
I.27. You query the companies in qooxdoo !
II.1. Component descriptors diagram
II.2. Relationship property descriptors diagram
II.3. Scalar property descriptors diagram
III.1. View descriptors diagram
III.2. View descriptors diagram
IV.1. Actions class diagram
V.1. Controllers class diagram
V.2. Modules class diagram
V.3. Gates class diagram
V.4. Startup class diagram

List of Tables

I.1. Some screenshots of the master data management workspace
I.2. Some screenshots of the employees management workspace
I.3. Some screenshots of the organization management workspace
I.4. Some screenshots to show the manager business rule enforcement
I.5. Some screenshots to show the team members management
II.1. DefaultDescriptor properties
II.2. DefaultIconDescriptor properties
II.3. AbstractComponentDescriptor properties
II.4. BasicComponentDescriptor properties
II.5. BasicEntityDescriptor properties
II.6. BasicInterfaceDescriptor properties
II.7. BasicPropertyDescriptor properties
II.8. BasicRelationshipEndPropertyDescriptor properties
II.9. BasicCollectionPropertyDescriptor properties
II.10. BasicReferencePropertyDescriptor properties
II.11. BasicCollectionDescriptor properties
II.12. BasicListDescriptor properties
II.13. BasicSetDescriptor properties
II.14. BasicScalarPropertyDescriptor properties
II.15. AbstractEnumerationPropertyDescriptor properties
II.16. BasicEnumerationPropertyDescriptor properties
II.17. TypeEnumerationPropertyDescriptor properties
II.18. RangeEnumerationPropertyDescriptor properties
II.19. BasicBinaryPropertyDescriptor properties
II.20. BasicImageBinaryPropertyDescriptor properties
II.21. BasicJavaSerializablePropertyDescriptor properties
II.22. BasicBooleanPropertyDescriptor properties
II.23. BasicColorPropertyDescriptor properties
II.24. BasicDatePropertyDescriptor properties
II.25. BasicDurationPropertyDescriptor properties
II.26. BasicNumberPropertyDescriptor properties
II.27. BasicDecimalPropertyDescriptor properties
II.28. BasicPercentPropertyDescriptor properties
II.29. BasicIntegerPropertyDescriptor properties
II.30. BasicStringPropertyDescriptor properties
II.31. BasicImageUrlPropertyDescriptor properties
II.32. BasicPasswordPropertyDescriptor properties
II.33. BasicTextPropertyDescriptor properties
II.34. BasicHtmlPropertyDescriptor properties
II.35. BasicSourceCodePropertyDescriptor properties
II.36. BasicTimePropertyDescriptor properties
III.1. BasicViewDescriptor properties
III.2. AbstractCardViewDescriptor properties
III.3. BasicCardViewDescriptor properties
III.4. EntityCardViewDescriptor properties
III.5. BasicActionViewDescriptor properties
III.6. BasicCollectionViewDescriptor properties
III.7. BasicListViewDescriptor properties
III.8. BasicTableViewDescriptor properties
III.9. BasicComponentViewDescriptor properties
III.10. BasicPropertyViewDescriptor properties
III.11. BasicEnumerationPropertyViewDescriptor properties
III.12. BasicImageViewDescriptor properties
III.13. BasicReferencePropertyViewDescriptor properties
III.14. BasicTreeViewDescriptor properties
III.15. BasicTreeLevelDescriptor properties
III.16. BasicCompositeTreeLevelDescriptor properties
III.17. BasicSimpleTreeLevelDescriptor properties
III.18. BasicCompositeViewDescriptor properties
III.19. BasicBorderViewDescriptor properties
III.20. BasicConstrainedGridViewDescriptor properties
III.21. BasicEvenGridViewDescriptor properties
III.22. BasicSplitViewDescriptor properties
III.23. BasicTabViewDescriptor properties
IV.1. AbstractActionContextAware properties
IV.2. AbstractAction properties
IV.3. BasicLovViewDescriptorFactory properties
IV.4. ConnectorValueGetterCallback properties
IV.5. FileToByteArrayCallback properties
IV.6. ActionMap properties
IV.7. ActionList properties
IV.8. BackendAction properties
IV.9. AbstractChangePasswordAction properties
IV.10. DatabaseChangePasswordAction properties
IV.11. LdapChangePasswordAction properties
IV.12. AbstractCollectionAction properties
IV.13. AbstractAddCollectionToMasterAction properties
IV.14. AbstractCloneCollectionAction properties
IV.15. CloneComponentCollectionAction properties
IV.16. AddAnyCollectionToMasterAction properties
IV.17. AddComponentCollectionToMasterAction properties
IV.18. AddMapToMasterAction properties
IV.19. CloneMapCollectionAction properties
IV.20. PasteCollectionToMasterAction properties
IV.21. CollectionElementMoveAction properties
IV.22. RemoveCollectionFromMasterAction properties
IV.23. RemoveFromModuleObjectsAction properties
IV.24. SetActionParamFromSelectedComponentsAction properties
IV.25. AbstractHibernateAction properties
IV.26. AbstractHibernateCollectionAction properties
IV.27. RemoveCollectionFromMasterAction properties
IV.28. RemoveFromModuleObjectsAction properties
IV.29. RemoveModuleObjectAction properties
IV.30. QueryEntitiesAction properties
IV.31. ReloadAction properties
IV.32. ReloadModuleObjectAction properties
IV.33. SaveAction properties
IV.34. SaveModuleObjectAction properties
IV.35. AbstractLdapAction properties
IV.36. AbstractQbeAction properties
IV.37. FindAction properties
IV.38. QueryModuleFilterAction properties
IV.39. AddBeanAsSubModuleAction properties
IV.40. CreateQueryComponentAction properties
IV.41. GenerateJasperReportAction properties
IV.42. InitModuleFilterAction properties
IV.43. ListApplicationElementsAction properties
IV.44. ResetConnectorValueAction properties
IV.45. ScriptedBackendAction properties
IV.46. StaticScriptedBackendAction properties
IV.47. SelectEntityPropertyAction properties
IV.48. TransferCollectionAction properties
IV.49. FrontendAction properties
IV.50. AbstractChartAction properties
IV.51. DisplayChartAction properties
IV.52. AbstractEditComponentAction properties
IV.53. EditComponentAction properties
IV.54. ChangePasswordAction properties
IV.55. EditReportParametersAction properties
IV.56. EditSelectedComponentAction properties
IV.57. AbstractMessageAction properties
IV.58. InfoAction properties
IV.59. StaticInfoAction properties
IV.60. OkCancelAction properties
IV.61. StaticOkCancelAction properties
IV.62. YesNoAction properties
IV.63. StaticYesNoAction properties
IV.64. YesNoCancelAction properties
IV.65. StaticYesNoCancelAction properties
IV.66. AbstractModuleDirtyStateAction properties
IV.67. CheckAllModulesDirtyStateAction properties
IV.68. CheckModuleDirtyStateAction properties
IV.69. ChooseFileAction properties
IV.70. OpenFileAction properties
IV.71. OpenFileAsBinaryPropertyAction properties
IV.72. SaveFileAction properties
IV.73. SaveBinaryPropertyAsFileAction properties
IV.74. DisplayJasperReportAction properties
IV.75. AbstractReportAction properties
IV.76. ReportAction properties
IV.77. StaticReportAction properties
IV.78. AddCollectionToMasterAction properties
IV.79. BinaryPropertyInfoAction properties
IV.80. ChooseActionAction properties
IV.81. ChooseComponentAction properties
IV.82. CloseDialogAction properties
IV.83. ConnectorSelectionAction properties
IV.84. DisplayNextPinnedModuleAction properties
IV.85. DisplayPreviousPinnedModuleAction properties
IV.86. DisplayUrlAction properties
IV.87. DisplayStaticUrlAction properties
IV.88. ExecuteActionAction properties
IV.89. ExitAction properties
IV.90. LovAction properties
IV.91. ModalDialogAction properties
IV.92. ModuleConnectorSelectionAction properties
IV.93. ModuleRestartAction properties
IV.94. ModuleSelectionAction properties
IV.95. OkChooseComponentAction properties
IV.96. OkLovAction properties
IV.97. PageOffsetAction properties
IV.98. ParentModuleConnectorSelectionAction properties
IV.99. PrintAction properties
IV.100. SetConnectorValueAction properties
IV.101. TransferToClipboardAction properties
IV.102. WizardAction properties
IV.103. WorkspaceSelectionAction properties
IV.104. Built-in actions
V.1. AbstractController properties
V.2. AbstractBackendController properties
V.3. HibernateBackendController properties
V.4. AbstractFrontendController properties
V.5. DefaultRemoteController properties
V.6. DefaultSwingController properties
V.7. Workspace properties
V.8. Module properties
V.9. BeanCollectionModule properties
V.10. FilterableBeanCollectionModule properties
V.11. BeanModule properties
V.12. AbstractGate properties
V.13. AbstractModelGate properties
V.14. AbstractPropertyModelGate properties
V.15. BooleanPropertyModelGate properties
V.16. EnumerationPropertyModelGate properties
V.17. RegexPropertyModelGate properties
V.18. ClosedGate properties
V.19. GrantedRolesGate properties