Scout/Concepts/Template

Scout

Wiki Home

Website

Download • Git

Community

Forums • Blog • Twitter • G+

Bugzilla

Bugzilla

A template is some portion of code (a class) that is defined to be used many times in the Client.

Overview

The templates are visible in the Explorer View under your scout project > Client > Templates

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.

    @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");
        }
      }
    }

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.

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.

 //...
 @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);
  }
 //...

The commented getConfiguredLabel is moved in the concrete class:

    @Order(10.0)
    public class BillingAddressBox extends AbstractAddressBox {
      @Override
      protected String getConfiguredLabel() {
        return TEXTS.get("BillingAddress");
      }
    }

Now the correspondance address field can be created by choosing the template as type for the new field.

    @Order(20.0)
    public class CorrespondanceAddressBox extends AbstractAddressBox {
      @Override
      protected String getConfiguredLabel() {
        return TEXTS.get("Correspondance");
      }
    }

TODO
FormData annotation in the Form.

TODO
Template and SQL binding (in Process Service). Merge with this post: Process Service and Templates

Form template

A form template is nothing more than an Abstract class extending org.eclipse.scout.rt.client.ui.form.AbstractForm . Your template can be located where you want (where it makes sense, depending on your code organization). Possible package: <your_app>.client.ui.template.form

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:

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();
  }
}

See also

• Explorer View