|
|
| Line 1: |
Line 1: |
| − | {{ScoutPage|cat=Client}}
| + | The Scout documentation has been moved to https://eclipsescout.github.io/. |
| − | | + | |
| − | A template is some portion of code (a class) that is defined to be used many times in the {{ScoutLink|Concepts|Client Plug-In|Client}}.
| + | |
| − | | + | |
| − | == Overview ==
| + | |
| − | The templates are visible in the {{ScoutLink|SDK|Explorer View|Explorer View}} under '''your scout project > Client > Templates''' | + | |
| − | | + | |
| − | [[Image:ScoutExplorer Templates.png]]
| + | |
| − | | + | |
| − | == Form Field template ==
| + | |
| − | | + | |
| − | An easy way to reuse form field code is to use templates. Templates are implemented as abstract classes that may be extended by form fields. Creation and usage of templates is supported by the Scout SDK.
| + | |
| − | | + | |
| − | Templates may be extracted from existing fields or other templates. The Scout SDK template support allows for quite powerful refactorings and helps keeping your code clean and DRY with little effort.
| + | |
| − | | + | |
| − | === Example ===
| + | |
| − | Consider the following example: A group box for the billing address containing some fields.
| + | |
| − | | + | |
| − | <source lang="java">
| + | |
| − | @Order(10.0)
| + | |
| − | public class BillingAddressBox extends AbstractGroupBox {
| + | |
| − | @Override
| + | |
| − | protected String getConfiguredLabel() {
| + | |
| − | return TEXTS.get("BillingAddress");
| + | |
| − | }
| + | |
| − | @Order(10.0)
| + | |
| − | public class StreetField extends AbstractStringField {
| + | |
| − | @Override
| + | |
| − | protected String getConfiguredLabel() {
| + | |
| − | return TEXTS.get("Street");
| + | |
| − | }
| + | |
| − | }
| + | |
| − | @Order(20.0)
| + | |
| − | public class CityField extends AbstractSmartField<Long> {
| + | |
| − | @Override
| + | |
| − | protected Class<? extends ICodeType<?>> getConfiguredCodeType() {
| + | |
| − | return CityCodeType.class;
| + | |
| − | }
| + | |
| − | @Override
| + | |
| − | protected String getConfiguredLabel() {
| + | |
| − | return TEXTS.get("City");
| + | |
| − | }
| + | |
| − | }
| + | |
| − | }
| + | |
| − | </source>
| + | |
| − | | + | |
| − | Now let's assume you would like to create a similar box for the correspondence address without copying the code. This is possible by selecting "Create template..." on the group box.
| + | |
| − | | + | |
| − | [[Image:Scout_createNewTemplate.jpg]]
| + | |
| − | | + | |
| − | [[Image:Scout_createTemplateDialog.jpg]]
| + | |
| − | | + | |
| − | A new abstract class is created containing the code of BillingAddressBox. To make the AddressBox template more useful, we move the configured label code to the BillingAddressBox.
| + | |
| − | <source lang="java">
| + | |
| − | //...
| + | |
| − | @FormData(value = AbstractAddressBoxData.class, sdkCommand = SdkCommand.CREATE, defaultSubtypeSdkCommand = DefaultSubtypeSdkCommand.CREATE)
| + | |
| − | public abstract class AbstractAddressBox extends AbstractGroupBox {
| + | |
| − | /* @Override
| + | |
| − | protected String getConfiguredLabel() {
| + | |
| − | return TEXTS.get("BillingAddress");
| + | |
| − | } */
| + | |
| − | public CityField getCityField() {
| + | |
| − | return getFieldByClass(CityField.class);
| + | |
| − | }
| + | |
| − | //...
| + | |
| − | </source>
| + | |
| − | The commented getConfiguredLabel is moved in the concrete class:
| + | |
| − | <source lang="java">
| + | |
| − | @Order(10.0)
| + | |
| − | public class BillingAddressBox extends AbstractAddressBox {
| + | |
| − | @Override
| + | |
| − | protected String getConfiguredLabel() {
| + | |
| − | return TEXTS.get("BillingAddress");
| + | |
| − | }
| + | |
| − | }
| + | |
| − | </source>
| + | |
| − | | + | |
| − | Now the correspondance address field can be created by choosing the template as type for the new field.
| + | |
| − | | + | |
| − | <source lang="java">
| + | |
| − | @Order(20.0)
| + | |
| − | public class CorrespondanceAddressBox extends AbstractAddressBox {
| + | |
| − | @Override
| + | |
| − | protected String getConfiguredLabel() {
| + | |
| − | return TEXTS.get("Correspondance");
| + | |
| − | }
| + | |
| − | }
| + | |
| − | </source>
| + | |
| − | | + | |
| − | <!--
| + | |
| − | Form
| + | |
| − | In some cases you have the GroupBox that is displayed in multiple forms, you might be interested in
| + | |
| − | -->
| + | |
| − | | + | |
| − | {{note|TODO| {{ScoutLink|Concepts|FormData|FormData}} annotation in the Form.}}
| + | |
| − | | + | |
| − | {{note|TODO|Template and SQL binding (in Process Service). Merge with this post: [http://www.eclipse.org/forums/index.php/t/261235/ Process Service and Templates]}}
| + | |
| − | | + | |
| − | == Form template ==
| + | |
| − | | + | |
| − | A form template is nothing more than an Abstract class extending {{ScoutJavadoc|org.eclipse.scout.rt.client.ui.form.AbstractForm|C}}. Your template can be located where you want (where it makes sense, depending on your code organization). Possible package: <tt><your_app>.client.ui.template.form</tt>
| + | |
| − | | + | |
| − | There isn't any support yet in the Scout Perspective to create a form template. You need to use the Java tooling from the IDE.
| + | |
| − | | + | |
| − | This is a minimal example:
| + | |
| − | | + | |
| − | <source lang="java">
| + | |
| − | import org.eclipse.scout.commons.exception.ProcessingException;
| + | |
| − | import org.eclipse.scout.rt.client.ui.form.AbstractForm;
| + | |
| − | | + | |
| − | public abstract class AbstractMyForm extends AbstractForm {
| + | |
| − | | + | |
| − | /**
| + | |
| − | * @throws ProcessingException
| + | |
| − | */
| + | |
| − | public AbstractMyForm() throws ProcessingException {
| + | |
| − | super();
| + | |
| − | }
| + | |
| − | }
| + | |
| − | </source>
| + | |
| − | | + | |
| − | == See also ==
| + | |
| − | * {{ScoutLink|SDK|Explorer View|Explorer View}}
| + | |
