New Form Wizard

The New Form wizard is be used to create a new form including a form data, permissions and and related service. To start the wizard use File New Other… or press Ctrl+N.

Figure 1. The new Form Wizard

In the case of Figure 1 the package org.eclipse.scout.apps.helloworld.client.helloworld has been selected in the Package Explorer. The only wizard field that then needs to be filled in manually is the Name field.

By clicking on the Finish button the wizard is started and the specified components are created.

Wizard Fields and Default Values

Most of the fields of the Figure 1 will be filled with default values depending on the current context of the IDE. The context can be derived from a package selected in the Package Explorer or from the class in the active Java Editor.

Source Folder: The source folder of the Maven client module used for the creation of the form class. The default value is the src/main/java folder in the Maven client module.
Package: The Java package that will contain the form class. The Scout SDK will try to guess the package name from the current context and derive matching package names for the Maven shared and server modules.
Name: The name of the form class. According to Scout conventions the class name ends with the suffix Form.
Super Class: The super class for the form. AbstractForm is the default value.
Create FormData: If ticked, a form data class will be created in the shared module.
Create Service: If ticked, a service interface is created in the shared module and a service implementation is created in the Maven server module.
Create Permissions: If ticked, read and update permissions are created in the Maven shared module.
Shared Source Folder: The source folder of the Maven shared module used for creation of the form data, the service interface and the permission classes. The default value is the src/main/java folder in the Maven shared module.
Server Source Folder: The source folder of the Maven server module used for the service class creation. The default value is the src/main/java folder in the Maven server module.

Created Components

In the Figure 1 example shown above the Scout SDK will create the following components.

In Maven module helloworld.client
- The MyForm form class in folder src/main/java and package org.eclipse.scout.apps.helloworld.client.helloworld
In Maven module helloworld.shared
- In folder src/main/java and package org.eclipse.scout.apps.helloworld.shared.helloworld
  - The IMyService service interface
  - The ReadMyPermission permission class
  - The UpdateMyPermission permission class
- The MyFormData form data class in folder src/generated/java and package org.eclipse.scout.apps.helloworld.shared.helloworld
In Maven module helloworld.server
- The MyService service class in folder src/main/java and package org.eclipse.scout.apps.helloworld.server.helloworld

Go back to the Scout Wizards.

Do you want to improve this document? Have a look at the sources on GitHub.