View source for Scout/Tutorial/5.0/HelloWorld

{{ScoutPage|cat=Tutorial 5.0}}

This page shows how to create your Hello World app using the {{ScoutLink|SDK|name=Scout SDK}}. We assume that you already have {{ScoutLink|HowTo/5.0|Install Scout SDK|installed Scout}}.

==Create a new Scout Project ==

[[Image:CreateANewScoutProject.PNG]]

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

[[Image:CreateANewScoutProject2.PNG]]

In the wizard choose Scout project and click ''Next''.

[[Image:CreateANewScoutProject3_5.PNG]]

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''.

[[Image:CreateANewScoutProject4.PNG]]

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

[[Image:CreateANewScoutProject5.PNG]]

The empty application is created by {{ScoutLink|SDK|name=Scout SDK}} and if you are not already in the {{ScoutLink|SDK|Perspective|Scout perspective}} you are prompted to switch now. Click on ''Yes''.

==Run the Empty Scout Application in the Scout SDK ==

[[Image:CreateANewScoutProject7Ver4.0.PNG]]

In the {{ScoutLink|SDK|Explorer_View|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.

[[Image:CreateANewScoutProject8Ver4.0.PNG]]

==Client Side: Add a Message Field to the Desktop Form ==

[[Image:Scout-NewFormField.PNG]]

In the {{ScoutLink|SDK|Explorer_View|Scout Explorer}} drill down to client, Forms, DesktopForm, MainBox
* '''client''' client part of Scout application
* '''Forms''' holding all {{ScoutLink|Concepts|Form|Forms}} available in the client part
* '''DesktopForm''' the {{ScoutLink|Concepts|Form|form}} created by the template chosen above: ''Application with a single form''
* '''MainBox''' the container (a {{ScoutLink|Concepts|GroupBox|GroupBox}}) holding all UI components of the form

To the main box we will add a message {{ScoutLink|Concepts|Field|field}}. Click right on ''MainBox'' and choose the menu ''New Form Field''.

[[Image:Scout-NewFormField2.PNG]]

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

[[Image:Scout-NewFormField3.PNG]]

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

[[Image:Scout-NewFormField4Ver4.0.PNG]]

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''

[[Image:Scout-NewFormField5.PNG]]

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''

[[Image:Scout-NewFormField6.PNG]]

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 {{ScoutLink|SDK|Explorer_View|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 {{ScoutLink|Concepts|Process_Service|process service}} was created as part of the selected application template. The ''load(DesktopFormData)'' method is defined out of the box.

[[Image:Scout-HelloworldVer4.0.PNG]]

Add a simple implementation for the ''load'' method:

<source lang="java" line="GESHI_NORMAL_LINE_NUMBERS" start="1">
public DesktopFormData load(DesktopFormData formData) {
  formData.getMessage().setValue("hello world");
  return formData;
}
</source>
 '''<span style="color:#FF0000"> (load ... throws ProcessingException, missing in default generation in Version 4.0) </span>'''

On line 2 we access the message field of the {{ScoutLink|Concepts|FormData|FormData}} and set its value to <code>"hello world"</code>. The updated form data is returned and eventually sent back to the client.

==Run the "hello world" application ==

In the {{ScoutLink|SDK|Explorer_View|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"

[[Image:Scout-Helloworld1.PNG]]