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"

(Key Concepts)
(168 intermediate revisions by 21 users not shown)
Line 1: Line 1:
{| class="FCK__ShowTableBorders" align="right"
+
__NOTOC__
|-
+
__NOEDITSECTION__
| __TOC__
+
|}
+
  
The [http://www.eclipse.org/proposals/scout/ Eclipse Scout] project is a proposed open source project under the Eclipse Technology Project.  
+
<div style="float: right; width: 30%; ">
 +
<h3>Get Started</h3>
 +
* '''[https://eclipsescout.github.io/6.0/beginners-guide.html#installation-and-setup Install]''' Scout
 +
* Do the '''[https://eclipsescout.github.io/6.0/beginners-guide.html#cha-helloworld Hello World]'''
 +
* Read the '''[https://eclipsescout.github.io/6.0/ Documentation]'''
 +
* '''{{ScoutLink|Contribution|name=Contribute}}''' to Scout
 +
</div>
  
== What is it  ==
+
<h3>'''Eclipse Scout''' - Future Proof Business Applications</h3>
  
The eclipse Scout Plug-Ins are used to build applications based on eclipse and equinox. These may be standalone apps, client/server apps, headless apps on server-side equinox etc.  
+
[[Image:ScoutIconLarge.gif|left]]
  
Eclipse Scout consists of a runtime and an sdk part. The runtime part consists of approx. five Plug-Ins, the SDK consists of approx. three Plug-Ins.  
+
[[Image:scout_neon_business_application.png|800px]]
  
The runtime is purely based on equinox, and eclipse. The SDK part is an extension to JDT and PDE with a complete perspective for easy click-and-build of a complete application.
+
Scout applications are based on Java/HTML5 and run on desktop, tablet, and mobile devices.
  
== Key Concepts  ==
+
{| border="0" cellspacing="0" valign="top" style="width:100%; margin-top: 15px;"
  
An applications built with eclipse Scout typically has a UI with perspectives, views, forms and pages. It may also have a back-end part that is running in an application server with server-side equinox. Perspectives, views, forms and pages are not limited to SWT, Scout supports complete GUI pluggability and also supports Swing of the box.
+
|-valign="top"  
 
+
|style="width:50%; padding-right: 15px; padding-bottom: 15px;"|
With eclipse Scout you have
+
<h3>Get in Touch</h3>
 
+
* '''[http://www.eclipse.org/scout Scout Home]''' - the Scout website
#Separation of ui (user interface layer) and gui (graphical user interface), swt and swing gui factory
+
* '''[http://www.eclipse.org/forums/eclipse.scout Scout Forum]''' - community discussions
#Complete workspace overview, multiple Plug-Ins participating to the same application are visualized with their high-level dependencies
+
* '''[https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;bug_status=RESOLVED;bug_status=VERIFIED;product=Scout&columnlist=bug_id%2Cbug_severity%2Cpriority%2Ctarget_milestone%2Cbug_status%2Cresolution%2Ccomponent%2Cassigned_to%2Cshort_desc Scout Bugs]''' - all open bugs
#Much convenience and support in writing only the code you want to write when for example writing a new form with many sections and fields
+
* '''[https://dev.eclipse.org/mailman/listinfo/scout-dev Scout Newsgroup]''' - scout-dev@eclipse.org
#Automatic nls support as-you-type
+
* '''[https://www.ohloh.net/p/eclipsescout Scout ohloh]''' - code metrics and more
#Soap-based remote service tunnel for hi-speed service remoting to a eclipse server-side application
+
* '''[http://www.bsi-software.com BSI Business Systems Integration AG]''' - the currently contributing organization
#Extension point for declaring OSGi services and remote service proxies
+
|
#Extension point for UI component to gui widget mapping
+
<h3>Scout Project News</h3>
#Complete abstration layer for desktop (workbench), outlines (perspectives), forms (views, dialogs) and fields
+
* '''[http://twitter.com/EclipseScout Twitter]''' - follow us on Twitter
#Configurable code
+
* '''[http://www.bsiag.com/scout Blog]''' - News about Scout
#Template concept for creating abstract class libraries
+
* '''{{ScoutLink|Release|Mars|Overview|name=Mars Documentation }}''' - Scout 5.0
#Strong typed code, minimized "string binding" and therefore best support by PDE and JDT
+
* '''{{ScoutLink|Release|Neon|Overview|name=Neon Documentation }}''' - Scout 6.0 (development)
#No meta data and no one-way code genration; everything is in the Java code you write. If you prefer to write code manually, or via click-and-build, doesn't matter
+
* '''[[media:Factsheet_Neon_2015_16.pdf‎|Scout Factsheet]]''' - the 2015/16 edition
 
+
* '''{{ScoutLink|Overview|Slides|Scout Presentations}}''' - slides and related materials
== Screens  ==
+
|
 
+
|}
&nbsp;
+
 
+
== My first application  ==
+
 
+
Easiest way to begin is creating a new eclipse scout project group and choosing the mail sample application. A project group is a set of Plug-Ins that make up your application. Project name: com.example.mail Project parts: client, server, swt ui This will create the Plug-Ins (listed by layer)
+
 
+
#com.example.mail.ui.swt.core
+
#com.example.mail.client.core
+
#com.example.mail.shared.core
+
#com.example.mail.server.core
+
 
+
== A scout form  ==
+
 
+
To get an idea consider this form with a title and two string fields. That's it.
+
This form is displayed as a complete swt form with swt fields when using the swt gui Plug-In.
+
It can also be displayed using the swing gui Plug-In, or (in development) using the apache wicket gui Plug-In to serve the form from the server as a web page.
+
 
+
public class PersonForm extends AbstractForm{
+
 
+
  public PersonForm(){
+
  }
+
 
+
  /**
+
    * This method and all other getConfigured* and exec* methods can be written manually
+
    * or via the property editor in the scout sdk view
+
    */
+
  @Override
+
  protected String getConfiguredTitle(){
+
    return Texts.get("MailReader");
+
  }
+
 
+
 
+
  public MainBox getMainBox(){
+
    return (MainBox)getRootGroupBox();
+
  }
+
 
+
  public FirstNameField getFirstNameField(){
+
    return getFieldByClass(FirstNameField.class);
+
  }
+
 
+
  public LastNameField getLastNameField(){
+
    return getFieldByClass(LastNameField.class);
+
  }
+
 
+
  public OkButton getOkButton(){
+
    return getFieldByClass(OkButton.class);
+
  }
+
 
+
  public CancelButton getCancelButton(){
+
    return getFieldByClass(CancelButton.class);
+
  }
+
 
+
  /**
+
    * Start the form with the create handler
+
    */
+
  public void startCreate() throws ProcessingException{
+
    startInternal(new CreateHandler());
+
  }
+
 
+
  /**
+
    * Start the form with the modify handler
+
    */
+
  public void startModify() throws ProcessingException{
+
    startInternal(new ModifyHandler());
+
  }
+
 
+
 
+
  @Order(10)
+
  public class MainBox extends AbstractGroupBox{
+
 
+
    @Order(10)
+
    public class FirstNameField extends AbstractStringField{
+
      @Override
+
      protected String getConfiguredLabel(){
+
        return Texts.get("FirstName");
+
      }
+
    }
+
   
+
 
+
    @Order(20)
+
    public class LastNameField extends AbstractStringField{
+
      @Override
+
      protected String getConfiguredLabel(){
+
        return Texts.get("LastName");
+
      }
+
    }
+
   
+
 
+
    @Order(30)
+
    public class OkButton extends AbstractOkButton{
+
    }
+
   
+
    @Order(40)
+
    public class CancelButton extends AbstractCancelButton{
+
    }
+
   
+
  }
+
 
+
 
+
  /**
+
    * This is the form handler when started with .startCreate();
+
    */
+
  public class CreateHandler extends AbstractFormHandler{
+
    protected void execLoad() throws ProcessingException{
+
      //...
+
    }
+
 
+
    protected void execStore() throws ProcessingException{
+
      //...
+
    }
+
  }
+
 
+
  /**
+
    * This is the form handler when started with .startModify();
+
    */
+
  public class ModifyHandler extends AbstractFormHandler{
+
    protected void execLoad() throws ProcessingException{
+
      //...
+
    }
+
 
+
    protected void execStore() throws ProcessingException{
+
      //...
+
    }
+
  }
+
 
+
}
+
 
+
<br>
+
 
+
== How Tos  ==
+
 
+
*[[Create a Scout Dialog]]  
+
*[[Create a Scout Process Service]]
+
 
+
=== Where do I load data into a TablePage?  ===
+
  
*override method '''execLoadTableData '''where you call an outline service operation that returns a Object[][] field
+
[[Category:Eclipse Project]]
*Parameter SearchFilter of execLoadTableData contains all additional WHERE clauses (that start with „AND…“) defined in the getConfiguredSearchTerm methods
+
[[Category:Eclipse Technology Project]]
 +
[[Category:Scout]]

Revision as of 08:50, 7 June 2016


Get Started

Eclipse Scout - Future Proof Business Applications

ScoutIconLarge.gif

Scout neon business application.png

Scout applications are based on Java/HTML5 and run on desktop, tablet, and mobile devices.

Get in Touch

Scout Project News

Back to the top