Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: for the plan.

Jump to: navigation, search


< Scout‎ | Tutorial‎ | 4.0

Wiki Home

Hello World This page shows how to create your Hello World app using the Scout SDK. We assume that you already have installed Scout.

Create a new Scout Project


Start your Eclipse with an empty workspace and Use the New|Project ... menu


In the wizard choose Scout project and click Next


Enter org.eclipse.scout.helloworld as an application name. The last part of the name (after the last period) will automatically be used as the project alias. Then, click Next


Select Application with a single form as your app template, then click Finish


The empty application is created by Scout SDK and if you are not already in the Scout perspective you are prompted to change there now, click on Yes

Run the Empty Scout Application in the Scout SDK


In the Scout Explorer open the node Scout Projects, then click on org.eclipse.scout.helloworld. This will show the Scout Object Properties for the application.

After starting first the server (1) and then the Swing client (2) from the launching boxes as shown below, the empty client will appear.


Client Side: Add a Message Field to the Desktop Form


In the Scout Explorer drill down to client, Forms, DesktopForm, MainBox

  • client client part of Scout application
  • Forms holding all Forms available in the client part
  • DesktopForm the form created by the template chosen above: Application with a single form
  • MainBox the container (a GroupBox) holding all UI components of the form

To the main box we will add a message field. Click right on MainBox and choose the menu New Form Field.


Step 1: Select field type. Here we'll use a String Field. Then click Next (you may directly click on it or use the search box as shown above)


Step 2: Add the field label, type "Message" that triggers the dropdown list. Choose New translated text... (or use an existing text)


Step 3: Fill in the default translation. Some other fields are automatically filled:

  • Key Name used to retrieve the translated text in the code
  • default The translation for the default language (usually English). More languages and text translations may be added any time (see Scout/Concepts/NLS-Support)

Then click OK


Step 4: Verify details of the new string field by clicking again into the Text: The bold title is the key name and all translations should be shown

Confirm by clicking Finish


Navigate down from the MainBox to the newly created MessageField. Double click on the MessageField node to display the generated code (selected code in screenshot above) in the Java editor window.

Server Side: Implement the Data Loading

In the Scout Explorer navigate to the server node, then Services, and DesktopService. The DesktopService is the server side service corresponding to the DesktopForm defined on the client side. This process service was created as part of the selected application template. The load(DesktopFormData) method is defined out of the box.


Add a simple implementation for the load method:

  1. public DesktopFormData load(DesktopFormData formData) {
  2.   formData.getMessage().setValue("hello world");
  3.   return formData;
  4. }
 (load ... throws ProcessingException, missing in default generation in Version 4.0) 

On line 2 we access the message field of the FormData and set its value to "hello world". The updated form data is returned and eventually sent back to the client.

Run the "hello world" application

In the Scout Explorer go back to top-level node Scout Projects, then click on org.eclipse.scout.helloworld to access the launch boxes in the Scout Object Properties.

  • Start the server in the server box
  • Start the client in the SWT box

And, "Ta Taa"


Back to the top