|
|
| Line 1: |
Line 1: |
| − | {{ScoutPage|cat=Tutorial}}
| + | #REDIRECT [[Scout/Tutorial/Minicrm/Write the first page]] |
| − | {{note|Scout Tutorial|This page belongs to the {{ScoutLink|Tutorial|minicrm|Minicrm Tutorial}}. }}
| + | |
| − | A typical Eclipse Scout application consists of multiple '''outlines'''. Think of it as a folder hierarchy. Each "folder" is called a '''page'''. These pages come '''with nodes''' (a list of child pages) or '''with a table''' (a table filled with rows of data from a data source such as a database). The '''table''' has named '''columns'''. We need to create models for all of these.
| + | |
| − | | + | |
| − | If we want to fill the tables with data, we need to create a '''service''' on the server side. This service will get data from the database and return ''tabular data'': data arranged in rows and columns which we can use to fill the tables we created on the client side.
| + | |
| − | | + | |
| − | Once we have all that we're ready to {{ScoutLink|Tutorial|minicrm/Add_A_Search_Form|add a search form}} to our application.
| + | |
| − | | + | |
| − | == What are we talking about? ==
| + | |
| − | | + | |
| − | When we talk about ''outlines'' and ''pages'', think of a simple application. In this tutorial we're creating a miniature CRM. Here's what it may look like, using the Eclipse Scout terminology:
| + | |
| − | | + | |
| − | # one outline for companies and persons
| + | |
| − | ## the companies page shows a table with rows from the company table on the database
| + | |
| − | ## the persons page shows a table with rows from the person table on the database
| + | |
| − | ## for every person there is a list of nodes naming all the child pages
| + | |
| − | # there may be other outlines for different tasks or topics, such as marketing campaigns | + | |
| − | | + | |
| − | [[Image:Scout Pages and Outlines.jpg|900px]] | + | |
| − | | + | |
| − | If you look at the diagram above, there are some interesting things to note.
| + | |
| − | | + | |
| − | # the outline itself acts like a page with nodes -- it just shows the titles of the child pages (persons and companies)
| + | |
| − | # there can be only one child page for a page "with table" -- every row in the table has the same child
| + | |
| − | # the title of a child page underneath a table is not shown -- by default the first visible column of the table replaces whatever the name was (in the example above "Catherine" replaces whatever the name of the Person Details Page was)
| + | |
| − | | + | |
| − | In this tutorial, our '''first page''' will be the '''company''' table page. The '''standard outline''' is a prerequisite, so we'll start there.
| + | |
| − | | + | |
| − | All of these structures are strictly client-side structures. The '''server''' couldn't care less about how the various services it provides will get used. The only thing we need on the server side is '''a service that returns tabular company data'''.
| + | |
| − | | + | |
| − | == Add an Outline first ==
| + | |
| − | | + | |
| − | Since a page can only be contained within an Outline, you need to define the ''Outline'' first. Open the client node in Eclipse Scout and expand the tree until you reach the ''Desktop'' node. Right-click on the node and choose the ''New Outline...'' menu.
| + | |
| − | | + | |
| − | [[Image:Newoutline.jpg|Newoutline.jpg]]
| + | |
| − | | + | |
| − | Choose ''Standard'' as the name and make sure the checkbox ''Add to Desktop'' is ticked. Then click ''Finish''.
| + | |
| − | | + | |
| − | [[Image:Newoutlinewizard.jpg|Newoutlinewizard.jpg]]
| + | |
| − | | + | |
| − | {{note|Multilingual Texts|If you type ''Standard'' into the name field, you'll see all sorts of texts in the language of your locale. If you're not sure whether the string you picked is the right one, you can right-click on it and choose ''Modify Entry...'' from the context menu. This will show you the ''key'' and all available translations. If you're still not happy, just create a new multilingual text: type ''Standard'' into the name field and pick '''New translated text...''' from the list.}}
| + | |
| − | | + | |
| − | When you expand the ''Desktop'', you should see the newly created ''StandardOutline''.
| + | |
| − | | + | |
| − | [[Image:Standardoutline.jpg|Standardoutline.jpg]]
| + | |
| − | | + | |
| − | {{note|Files Created|If you switch to the '''Java Perspective''', you can have a look at the created files: Package <tt>eclipse.org.minicrm.client.ui.desktop.outlines</tt> contains the new '''StandardOutline.java''' class. If you see the key "SC_Label_UseDefaults" being used in the source code, then you might have picked a multilingual text you did not intend to. Go back to the '''StandardOutline''' in the ''Scout Perspective'' and modify the entry for the name as discussed above in the note on multilingual texts.}}
| + | |
| − | | + | |
| − | == Add a Page to the Outline ==
| + | |
| − | | + | |
| − | Now you can add a new page to your StandardOutline. Right-click on the ''Child Pages'' node of your ''StandardOutline'' and then choose ''New Page...''.
| + | |
| − | | + | |
| − | [[Image:Newpage.jpg|Newpage.jpg]]
| + | |
| − | | + | |
| − | From the dropdown list choose '''AbstractPageWithTable''', then click next.
| + | |
| − | | + | |
| − | [[Image:Newtablepage.jpg|Newtablepage.jpg]]
| + | |
| − | | + | |
| − | Now enter the name for the new table page: ''Company''.
| + | |
| − | | + | |
| − | If there is no appropriate multilingual text, pick ''New translated text...'' from the list and provide a key and a default translation.
| + | |
| − | | + | |
| − | [[Image:Newtext.jpg|Newtext.jpg]]
| + | |
| − | | + | |
| − | [[Image:Companytext.jpg|Companytext.jpg]]
| + | |
| − | | + | |
| − | {{note|Files Changed|Creating a new translated text will create entries in different property files: ''Texts.properties'' for the default language, ''Texts_de.properties'' for German, and so on). You can find these property files in the ''Java Perspective'' under ''eclipse.org.minicrm.shared/resources/texts''. }}
| + | |
| − | | + | |
| − | Eclipse Scout also comes with an editor to '''edit all the property files for multilingual texts''' in one go. If you expand the ''shared'' node in your Eclipse Scout project, activate ''Texts'' and click on the <u>open nls editor</u> link in the Scout Object properties view. Here you can conveniently manage all your application texts.
| + | |
| − | | + | |
| − | [[Image:Nls.jpg|Nls.jpg]]
| + | |
| − | | + | |
| − | Back to the ''CompanyTablePage'' example: pick ''Company'' from the list (create a new translated text if you haven't done so already) and click ''Finish''.
| + | |
| − | | + | |
| − | [[Image:Companytablepage.jpg|Companytablepage.jpg]]
| + | |
| − | | + | |
| − | When you now expand the ''Child Pages'' folder below your ''StandardOutline'', you'll find the new ''CompanyTablePage''. When you expand the node ''Table'', you'll find a folder ''Menus'' and ''Columns''. Below ''Columns'' we will now '''add the columns''' that are needed to display the company data.
| + | |
| − | | + | |
| − | [[Image:Finishedcompanytablepage.jpg|Finishedcompanytablepage.jpg]]
| + | |
| − | | + | |
| − | {{note|Files|Creating the Company Table Page has created the file ''eclipse.org.minicrm.client.ui.desktop.outlines.pages/CompanyTablePage.java'' and it has added code to ''eclipse.org.minicrm.client.ui.desktop.outlines/StandardOutline.java''. The newly created method '''execCreateChildPages''' in ''StandardOutline'' shows how child pages are instantiated and added to the list.}}
| + | |
| − | | + | |
| − | == Add colums to the table ==
| + | |
| − | | + | |
| − | The next step is '''adding columns to the table'''. Add a column for the primary key (''CompanyNrColumn''), one for the company's short name (''ShortNameColumn'') and one for the company's name (''NameColumn'').
| + | |
| − | | + | |
| − | The context menu for creating a new table column is on the ''Columns'' node right below the page's table.
| + | |
| − | | + | |
| − | [[Image:Newcolumn.jpg|Newcolumn.jpg]]
| + | |
| − | | + | |
| − | First you have to choose a '''template''' for your column. The template used depends on the '''data type''' of your data and the '''format''' you want to use when displaying it. Eclipse Scout will attempt to cast your data types appropriately.
| + | |
| − | | + | |
| − | Choose ''Long Column'' for the first column and ''String Column'' for the remaining columns.
| + | |
| − | | + | |
| − | [[Image:Columntemplate.jpg|Columntemplate.jpg]]
| + | |
| − | | + | |
| − | ''CompanyNrColumn'' is going to be an invisible column. Thus, it requires no name. Just provide the ''Type Name''. The remaining columns get multilingual texts for their labels, just like everything else in an Eclipse Scout application.
| + | |
| − | | + | |
| − | [[Image:Newcolumnname.jpg|Newcolumnname.jpg]]
| + | |
| − | | + | |
| − | {| cellspacing=10 style="border-top: 1px solid black; border-bottom: 1px solid black; margin: 1em; "
| + | |
| − | !Template
| + | |
| − | !Name
| + | |
| − | !TypeName
| + | |
| − | !Width
| + | |
| − | !Displayable
| + | |
| − | |-
| + | |
| − | |LongColumn
| + | |
| − | |(none)
| + | |
| − | |CompanyNrColumn
| + | |
| − | |(irrelevant)
| + | |
| − | |no
| + | |
| − | |-
| + | |
| − | |StringColumn
| + | |
| − | |Short Name
| + | |
| − | |ShortNameColumn
| + | |
| − | |200
| + | |
| − | |yes
| + | |
| − | |-
| + | |
| − | |StringColumn
| + | |
| − | |Name
| + | |
| − | |NameColumn
| + | |
| − | |200
| + | |
| − | |yes
| + | |
| − | |}
| + | |
| − | | + | |
| − | {{note|Inner Classes|A '''page with table''' is a single Java class. In this example, we're talking about the '''CompanyTablePage'''. The '''table''' itself is an '''inner class''' of the page. The '''columns''' are '''inner classes''' of the table. Take a look at the source files to see how it works. The Scout SDK parses the Java code in order to create its model, and the Scout runtime does the same thing. You'll also note that '''annotations''' such as <tt>@Order(30.0)</tt> are used to determine the order of columns in the table.}}
| + | |
| − | | + | |
| − | == Column Width ==
| + | |
| − | | + | |
| − | If you restart your client, you will see that the table layout is '''not optimal'''.
| + | |
| − | | + | |
| − | The '''column width''' could be improved. The table has a property called ''Auto resize columns'' and every column has a property called ''Width''. You can either specify a higher width for all of your columns or you can tell your table to auto resize all columns. When auto resizing, the available width is shared by all columns.
| + | |
| − | | + | |
| − | {{warning|Auto Resizing|Generally speaking you should only use ''auto resize columns'' when '''prototyping'''. In a real application, most '''numbers and dates should be in fixed width columns'''. In addition to that, in some cases you will end up with a lot of columns. Twenty, thirty, and more columns are not unheard of. In this case, fixed columns width and (a lot of) horizontal scrolling is the only solution. Auto resized columns would result in an unreadable mess.}}
| + | |
| − | | + | |
| − | If you're not sure, use a width of 200 for text columns.
| + | |
| − | | + | |
| − | {|
| + | |
| − | |style="vertical-align:top"|[[Image:Tableprops.jpg]]
| + | |
| − | |
| + | |
| − | |}
| + | |
| − | | + | |
| − | {{note|Properties|Setting properties in the Scout SDK needs to leave traces in the Java code because there is no other storage medium. If you look at the property view, you'll note that all the '''bold''' properties have non-default values. The property names act as links. They'll take you to the source code. Setting the width of a column to 200 results in a method being defined for the inner class modeling the column: <tt>protected int getConfiguredWidth() { return 200; }</tt>. This is how Scout properties are mapped: By overriding methods of the abstract classes the framework provides (such as <tt>AbstractStringColumn</tt> etc.).}}
| + | |
| − | | + | |
| − | == Hiding Columns ==
| + | |
| − | | + | |
| − | In addition to that, users are typically '''not interested in primary keys'''. You should hide ''CompanyNrColumn'' from the user.
| + | |
| − | | + | |
| − | You can do that by unticking the '''Visible''' property on the column. Users can make invisible columns visible, however. If you want to prevent this (and in this case you do), untick the '''Displayable''' property. To mark the column as a primary key you have to tick the '''Primary Key''' property.
| + | |
| − | | + | |
| − | Then it will look like this:
| + | |
| − | [[Image:Organize.jpg]]
| + | |
| − | | + | |
| − | Note: There are only two columns
| + | |
| − | | + | |
| − | {{note|Visible and Displayable Colums|An invisible column is only invisible initially. Users can right-click on the column headers of a table and ''organize'' their columns. This is where users can show and hide columns, and this is where they can change their order. '''Invisible columns can be made visible''' using this dialog. If you want to prevent users from making invisible columns visible, you must make them ''not displayable''.}}
| + | |
| − | | + | |
| − | Sometimes '''invisible but displayable columns''' are used if a certain table is used like a ''report'' for slightly different target users. Some users are interested in a certain subset of columns, other users are interested in a different subset. Instead of preparing a customized table for every target user, you can provide a single table for all users with specialized columns being invisible but displayable. Every user can then configure the visibility of the particular extra columns they are interested in.
| + | |
| − | | + | |
| − | == The Flow of Data ==
| + | |
| − | | + | |
| − | Now that we have our user interface, we need to think about '''flow''': how does the data from the database get into our table?
| + | |
| − | | + | |
| − | Our table page has a method called '''execLoadTableData'''. We will override its default definition and call our '''outline service''' instead. In order to do this, we'll get a '''proxy''' from the service registry using the <tt>SERVICES</tt> object and the desired interface (''IStandardOutlineService.class'') as the key. We call the '''getCompanyTableData''' method on the proxy, it gets passed to the server, the method is called, the database is queried via the '''SQL''' object, the tabular data is returned to the proxy, it is returned to our function call, finally it will be used to populate the ''CompanyTablePage'' model. This in turn will be used to populate the user interface.
| + | |
| − | | + | |
| − | [[Image:Scout Table Page Data Flow.png|900px]]
| + | |
| − | | + | |
| − | == Create an Outline Service ==
| + | |
| − | | + | |
| − | In order to fill the table in our ''CompanyTablePage'' we need to have a '''service''' available on the server side. This service will contact the database and retrieve the data we need on the client.
| + | |
| − | | + | |
| − | First, we need to create an ''OutlineService''. Go to the ''server'' node in your Eclipse Scout project, expand it, go to ''Outline Services'', right-click and choose '''New Outline Service...'''.
| + | |
| − | | + | |
| − | [[Image:Newoutlineservice.jpg]]
| + | |
| − | | + | |
| − | {{note|Service Types|Services are grouped by ''type'' on the server side. '''Outline''' services are used by the pages "with table" in an outline. '''Process''' services are used by forms (dialogs). '''Lookup''' services are used by GUI items showing a list of values (smartfields, listboxes).}}
| + | |
| − | | + | |
| − | As name choose ''StandardOutlineService'' since this OutlineService goes together with your ''StandardOutline'' (hence, all the TablePages that belong to your ''StandardOutline'' will call a service operation in the ''StandardOutlineService'').
| + | |
| − | | + | |
| − | [[Image:Standardoutlineservice.jpg]]
| + | |
| − | | + | |
| − | Optional: If you click ''Next'', you will see that the Scout SDK will do a '''Service Proxy Registration''' for you in the client plugin of your project. This allows calling the service operations from within the client as well.
| + | |
| − | | + | |
| − | [[Image:Servicereg.jpg]]
| + | |
| − | | + | |
| − | {{note|Files Affected|If you create the outline service with the default service proxy registration, this will register the service in <tt>eclipse.org.minicrm.client/plugin.xml</tt>. The service ''interface'' is shared between client and server and therefore ends up in <tt>eclipse.org.minicrm.shared.services.outline/IStandardOutlineService.java</tt>. The service implementation itself is in <tt>eclipse.org.minicrm.server.services.outline/StandardOutlineService.java</tt>. The service is also registered in <tt>eclipse.org.minicrm.server/plugin.xml</tt>.}}
| + | |
| − | | + | |
| − | Click on ''Finish'' in order to create the new service.
| + | |
| − | | + | |
| − | {{tip|Organisation Alternatives|There are alternatives to the suggestion above. If you have one big service with a method for every page with table in an outline, you will end up with a big class file. If your outline is big enough such that multiple developers will be working on it at the same time, this will lead to a lot of merging in your version control system. An alternative is to create ''a separate service per page with table''. This results in a lot more classes and less merge conflicts in a crowded project.}}
| + | |
| − | | + | |
| − | Expand the node ''Outline Services'' and you'll see the new ''StandardOutlineService''. Right-click on it and choose '''New Service operation'''.
| + | |
| − | | + | |
| − | [[Image:Newserviceop.jpg]]
| + | |
| − | | + | |
| − | Choose ''getCompanyTableData'' as the name, and a two-dimensional object array <tt>Object[][]</tt> as the return type and click ''Finish''.
| + | |
| − | | + | |
| − | [[Image:Getcompanytabledata.jpg]]
| + | |
| − | | + | |
| − | {{note|Object[][]|Why aren't we using typed data to communicate between client and server? On the client side, we have a generic ''load table data'' method that needs to return <tt>Object[][]</tt>. It will call the service we just created. Thus, using <tt>Object[][]</tt> when sending tabular data from the server to the client is nothing but a '''shortcut'''.}}
| + | |
| − | | + | |
| − | When naming service operations that provide tabular data for use in table pages, following the pattern '''get'''Something'''TableData''' is a convention and considered good practice.
| + | |
| − | | + | |
| − | == Load data on the server ==
| + | |
| − | | + | |
| − | Open the implementation of ''getCompanyTableData'' either by expanding the node ''StandardOutlineService'' and double-clicking on ''getCompanyTableData'' or by opening the class ''StandardOutlineService'' directly (''Ctrl-Shift-T'') and scrolling down to ''getCompanyTableData''. This is the place where we have to add an SQL statement which retrieves the data from the database.
| + | |
| − | | + | |
| − | The DB you've downloaded contains the following two tables:
| + | |
| − | | + | |
| − | [[Image:Company.jpg]]
| + | |
| − | | + | |
| − | [[Image:Person.jpg]]
| + | |
| − | | + | |
| − | As described in the [[Scout Overview]], Eclipse Scout provides a base service called <tt>SQL</tt>. In order to access the database and select data, just call <tt>SQL.select(...)</tt>.
| + | |
| − | | + | |
| − | The first parameter to <tt>SQL.select</tt> is the '''SELECT statement'''.
| + | |
| − | | + | |
| − | <source lang="java">
| + | |
| − | public class StandardOutlineService extends AbstractService implements IStandardOutlineService {
| + | |
| − | | + | |
| − | public Object[][] getCompanyTableData() throws ProcessingException {
| + | |
| − | return SQL.select("" +
| + | |
| − | "SELECT COMPANY_NR," +
| + | |
| − | " SHORT_NAME," +
| + | |
| − | " NAME" +
| + | |
| − | " FROM COMPANY");
| + | |
| − | }
| + | |
| − | }
| + | |
| − | </source>
| + | |
| − | | + | |
| − | {{warning|Order Considered Relevant|When writing your SELECT statement pay attention to specify the db columns in exactly the same order as the order of your table columns. This is necessarily so because we're just passing an untyped <tt>Object[][]</tt> along. This is an unfortunate consequence of the shortcut we used. As you can see, there are benefits (no packing and unpacking of the tabular data) and drawbacks (the compiler does not check types) to using an untyped <tt>Object[][]</tt>.}}
| + | |
| − | | + | |
| − | The optional, second parameter to <tt>SQL.select</tt> are the '''Bind Bases'''. They are needed if you need constraints (a WHERE clause with bind variables) in your SELECT statement. We have no need for them right now, since we're going to select ''all'' the companies. Clearly, a typical tutorial example. :)
| + | |
| − | | + | |
| − | == Display data on the client ==
| + | |
| − | | + | |
| − | The last thing to do now is to add the call to the ''getCompanyTableData'' service operation, for this we need to overwrite the method ''AbstractPageWithTable.execLoadTableData(SearchFilter)''. Go back to your ''CompanyTablePage'', in the lower part of the properties view click on the ''+'' right to '''Exec Load Table Data''' in order to create this method in your table page.
| + | |
| − | | + | |
| − | | + | |
| − | [[Image:Execload.jpg|Execload.jpg]]
| + | |
| − | | + | |
| − | Now you can use the convenience accessor class '''SERVICES''' to find the required service using the ''IStandardOutlineService'' interface class and call ''getCompanyTableData'' to load the data in your TablePage.
| + | |
| − | | + | |
| − | <source lang="java">
| + | |
| − | @Override
| + | |
| − | protected Object[][] execLoadTableData(SearchFilter filter) throws ProcessingException {
| + | |
| − | return SERVICES.getService(IStandardOutlineService.class).getCompanyTableData();
| + | |
| − | }
| + | |
| − | </source>
| + | |
| − | | + | |
| − | '''Restart your application and enjoy!''' :-)
| + | |
| − | | + | |
| − | [[Image:Simple Scout Application.png]]
| + | |
