Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Scout/Tutorial/3.8/webservices/Create Company Table Page"

< Scout‎ | Tutorial‎ | 3.8
 
(24 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_1.png|thumb|Create Company Table Page]]
+
{{ScoutPage|cat=Tutorial 3.8}}
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_2.png|thumb|Choose Page Layout]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_3.png|thumb|Give Page a name and link it with MainOutline]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_4.png|thumb|Create column]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_5.png|thumb|Choose type for column]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_6.png|thumb|Enter name for column]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_8.png|thumb|Hide Primary Key column]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_9.png|thumb|Autoresize columns]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_10.png|thumb|Create Outline - Step 2]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_11.png|thumb|Create Outline - Step 2]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_12.png|thumb|Create Outline - Step 2]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_13.png|thumb|Create Outline - Step 2]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_14.png|thumb|Create Outline - Step 2]]
+
 
+
 
== Create Company Table Page ==
 
== Create Company Table Page ==
On the client node, go to 'Desktop' | 'Outlines' | 'MainOutline'. Right click on the node to create a new {{ScoutLink|Concepts|TablePage}} [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_1.png]. As page layout, choose <code>AbstractPageWithTable</code> [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_2.png] to create a page representing tabular data. On the next step, enter <code>Company</code> as name for that page and choose to add this page to the <code>MainOutline</code> [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_3.png]. By clicking Finish, the page is created and attached to the MainOutline.
+
On the client node, go to 'Desktop' | 'Outlines' | 'StandardOutline' | 'Child Pages'. Right click on the node to create a new {{ScoutLink|Concepts|TablePage}} [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_1.png]. As page layout, choose <code>AbstractPageWithTable</code> [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_2.png] to create a page representing tabular data. On the next step, enter <code>Company</code> as name for that page and choose to add this page to the <code>StandardOutline</code> [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_3.png]. By clicking Finish, the page is created and attached to the StandardOutline.
  
 
== Create columns ==
 
== Create columns ==
Line 39: Line 26:
  
 
== Create service to load company data from database ==
 
== Create service to load company data from database ==
Finally, we have to populate the table with company data. For that purpose, we create an Outline Service. An Outline Service is just like all other services in Scout. Basically, they are plain [http://en.wikipedia.org/wiki/OSGi OSGi] services which are registered in <code>plugin.xml</code> and are accessible by <code>SERVICES#get(<service name>)</code>. Depending on the service factory chosen in their service registration, they act as proxy for client-server communication, meaning that all service requests are tunneled to the backend. For more details, please refer to {{ScoutLink|Concepts|Communication}}.
+
Now we have to populate the table with company data. For that purpose, double click on the <code>StandardOutlineService</code> under 'Server' | 'Outline Services' to open the corresponding Java class. In there, create the operation <code>getCompanyTableData</code> to load company data from database. Also add the operation signature to the service interface <code>IStandardOutlineService</code> to be accessible from client side. To find the interface IStandardOutlineService, press Ctrl+Shift+T, type IStandardOutlineService and click 'Open'.
  
To create the Outline Service, go to the server node. Right click on the node 'Outline Services' to create the new outline service [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_10.png].
+
<source lang="java">
 +
public class StandardOutlineService extends AbstractService implements IStandardOutlineService {
  
'''Service definition [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_11.png]'''
+
  @Override
Class name: MainOutlineService
+
  public Object[][] getCompanyTableData() throws ProcessingException {
Super Type: AbstractService
+
    return SQL.select("" +
 +
        "SELECT  COMPANY_NR, " +
 +
        "        NAME, " +
 +
        "        SYMBOL " +
 +
        "FROM    COMPANY ");
 +
  }
 +
}
 +
</source>
  
'''Service registration [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_12.png]'''
+
== Load company data into CompanyTablePage ==
On the second wizard page you can choose where to create and register the service.
+
Now as the <code>StandardOutlineService</code> is ready to load company data from the database, go back to the <code>CompanyTablePage</code> to consume the service's data.
For client-server communication services, you typically create a service interface in the <code>Shared Plug-In</code>  
+
On the Scout Property View, click on the operation <code>Exec Load Table Data</code> to populate the company table [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_13.png]. Implement the method as follows:
with a proxy registration on client side for that interface. That is also what we need to do for the <code>MainOutlineService</code>.
+
 
 +
<source lang="java">
 +
@Override
 +
protected Object[][] execLoadTableData(SearchFilter filter) throws ProcessingException {
 +
  return SERVICES.getService(IStandardOutlineService.class).getCompanyTableData();
 +
}
 +
</source>
 +
 
 +
Finally, if you launch the application, you should see something like this:
 +
 
 +
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_14.png|600px]]
 +
 
 +
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_1.png|thumb|Create Company Table Page]]
 +
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_2.png|thumb|Choose Page Layout]]
 +
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_3.png|thumb|Give Page a name and link it with StandardOutline]]
 +
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_4.png|thumb|Create column]]
 +
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_5.png|thumb|Choose type for column]]
 +
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_6.png|thumb|Enter name for column]]
 +
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_8.png|thumb|Hide Primary Key column]]
 +
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_9.png|thumb|Autoresize columns]]
 +
[[Image:org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage_13.png|thumb|Populate company table with data]]

Latest revision as of 18:18, 27 April 2012

The Scout documentation has been moved to https://eclipsescout.github.io/.

Create Company Table Page

On the client node, go to 'Desktop' | 'Outlines' | 'StandardOutline' | 'Child Pages'. Right click on the node to create a new The Scout documentation has been moved to https://eclipsescout.github.io/. [1]. As page layout, choose AbstractPageWithTable [2] to create a page representing tabular data. On the next step, enter Company as name for that page and choose to add this page to the StandardOutline [3]. By clicking Finish, the page is created and attached to the StandardOutline.

Create columns

On the CompanyTablePage node, go to 'Table' | 'Columns'. Right click on the node to create a new The Scout documentation has been moved to https://eclipsescout.github.io/. [4]. Please add the following three columns to that table:

CompanyNrColumn
Type: Long Column [5]
Name: Do not fill because column represents primary key and therefore is hidden
Class name: CompanyNrColumn [6]
NameColumn
Type: String Column
Name: Name
Class name: NameColumn
SymbolColumn
Type: String Column
Name: Symbol
Class name: SymbolColumn

To not display the CompanyNr column because of holding the primary key, go to that column in Scout SDK and uncheck Displayable in Scout Property View [7].

To have the columns equally distributed over the available space of the table page, go to the The Scout documentation has been moved to https://eclipsescout.github.io/. node and check Auto Resize Columns in Scout Property View [8].

Create service to load company data from database

Now we have to populate the table with company data. For that purpose, double click on the StandardOutlineService under 'Server' | 'Outline Services' to open the corresponding Java class. In there, create the operation getCompanyTableData to load company data from database. Also add the operation signature to the service interface IStandardOutlineService to be accessible from client side. To find the interface IStandardOutlineService, press Ctrl+Shift+T, type IStandardOutlineService and click 'Open'.

public class StandardOutlineService extends AbstractService implements IStandardOutlineService {
 
  @Override
  public Object[][] getCompanyTableData() throws ProcessingException {
    return SQL.select("" +
        "SELECT   COMPANY_NR, " +
        "         NAME, " +
        "         SYMBOL " +
        "FROM     COMPANY ");
  }
}

Load company data into CompanyTablePage

Now as the StandardOutlineService is ready to load company data from the database, go back to the CompanyTablePage to consume the service's data. On the Scout Property View, click on the operation Exec Load Table Data to populate the company table [9]. Implement the method as follows:

@Override
protected Object[][] execLoadTableData(SearchFilter filter) throws ProcessingException {
  return SERVICES.getService(IStandardOutlineService.class).getCompanyTableData();
}

Finally, if you launch the application, you should see something like this:

Org.eclipse.scout.tutorial.jaxws.CreateCompanyTablePage 14.png

Create Company Table Page
Choose Page Layout
Give Page a name and link it with StandardOutline
Create column
Choose type for column
Enter name for column
Hide Primary Key column
Autoresize columns
Populate company table with data

Back to the top