XTemplates

用于声明接受对象并根据关联模板将其转换为 HTML 的方法的标签接口。方法返回 SafeHtml 实例，该实例可在许多 GWT 和 GXT 小部件中用于呈现内容。

参考

• XTemplates Javadoc

功能

XTemplates 使通过各种功能生成内容变得容易。

• 字符串、原始类型和对象值变量支持。
• 将对象值格式化为字符串。
• 迭代对象和嵌套迭代对象支持。
• 条件支持。
• 调用返回布尔值的其他 Java 方法的能力。
• 基本数学和表达式支持。
• HTML 外部源支持。

定义

• XTemplate HTML 源 - 指的是 XTemplate 接口中的内联注释和外部注释 HTML 源定义。
• XTemplate 源属性 - 指的是 XTemplate 源属性，例如 {property} 和 {path.to.property}，它引用给定的对象属性。
• XTemplate 值或对象 - 指的是 XTemplate 接口方法参数参数，该参数携带 XTemplate 源属性的值。

简单 XTemplate 示例

模板是使用扩展 XTemplate 并包含注释 HTML 源并返回 SafeHtml 的接口创建的。

• 使用带有注释 HTML 源的 XTemplate 的示例

    public interface SampleXTemplates extends XTemplates {
      // Annotated HTML source with {name} property
      @XTemplate("<div>Hello, {name}!</div>")
      SafeHtml hello(String name);
    }
  

• 然后可以通过在模板类上调用 GWT.create 来创建 XTemplate 实例

    private SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  

• 调用 tpl.hello("test") 的示例将返回呈现的注释 HTML 的 SafeHtml 实例。

    public void display() { 
      // Displays Hello, test! and renders HTML as <div>Hello, test!<div> 
      RootPanel.get().add(new HTML(tpl.hello("test")));
    }        
  

XTemplate HTML 模板源

存在两种加载 HTML 模板源的方法，内联注释 HTML 或注释外部 HTML 源。

• 内联注释 HTML 源 和 外部注释 HTML 源 的示例

    public interface SampleXTemplates extends XTemplates {
      // Inline annotated HTML source
      @XTemplate("<div>Hello, {name}!</div>")
      SafeHtml hello(String name);
  
      // External annotated HTML source file.
      @XTemplate(source = "hello.html")
      SafeHtml helloExternal(String name);
    }
  

• 使用 XTemplate 模板方法的示例

    public void display() {
      // XTemplate instantiation
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  
      // Displays: Hello, Fred! or <div>Hello, Fred!</div>
      RootPanel.get().add(new HTML(tpl.hello("Fred")));
  
      // Displays: Hello, Willma! or <div>Hello, Willma!</div>
      RootPanel.get().add(new HTML(tpl.helloExternal("Willma")));
    }
  

属性

将值传递到 HTML 源模板使用 XTemplate 方法变量，该变量可以包括字符串、原始类型、对象、迭代对象、嵌套迭代对象和多个方法参数。诸如 {property} 和 {path.to.property} 之类的属性是 HTML 源属性和/或 XTemplate 源中的变量，属性查找规则在使用期间将其替换为属性值。

字符串和原始类型属性

通过 String 和原始类型将数据传递到模板。

• 变量通过用花括号包围名称来定义，例如 {property}

    public interface SampleXTemplates extends XTemplates {
      // Using a String variable
      @XTemplate("<div>Hello, {name} are you {age} years old?</div>")
      SafeHtml hello(String name, int age); 
    }
  

对象属性查找规则

当在 HTML 源中指定属性时，它将使用多种方法在提供的值中查找该属性的值。

• 在 HTML 源中使用 {name} 属性的示例将使用这些对象访问器来尝试查找值

    object.getName()
    object.hasName()
    object.isName()
    object.name()
  

对象属性

可以提供对象、多个对象、嵌套对象和迭代对象，当这样做时，属性的路径必须在花括号中明确指定，例如 {property} 或 {path.to.property}。

• 下面方法签名中使用的 Person 对象的示例

    public class Person {
      private String name;
      private int age;
      public Person(String name, int age) {
        this.name = name;
        this.age = age;
      }
      public String getName() {
        return name;
      }
      public int getAge() {
        return age;
      }
    }
  

• 设置带有方法签名中 Person 对象的 hello(Person person) 方法，然后在 HTML 源中提供 Person 的 {name} 和 {age} 属性。

   public interface SampleXTemplates extends XTemplates {
     // Providing person instance to the XTemplate method.
     @XTemplate("<div>Hello, {name}! Is your age {age}?</div>")
     SafeHtml hello(Person person);
   }
  

• 使用 XTemplate 方法 hello(person) 示例

    public void displayTemplates() {
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  
      // Displays: Hello, Barney! Is your age 34? or <div>Hello, Barney! Is your age 34?</div>
      Person barney = new Person("Barney", 34);
      RootPanel.get().add(new HTML(tpl.hello(barney)));
    }
  

多个参数

在 XTemplate 方法签名中提供多个对象需要在 HTML 源中使用特定路径，例如 {object1.path} 和 {object2.path}。

• 使用两个对象的示例

    public class Person {
      private String name;
      private List<Person> kids;
      public Person(String name, List<Person> kids) {
        this.name = name;
        this.kids = kids;
      }
      public String getName() {
        return name;
      }
      public List<Person> getKids() {
        return kids;
      }
    }
  
    public class Book {
      private String title;
      public Book(String title) {
        this.title = title;
      }
      public String getTitle() {
        return title;
      }
    }
  

• XTemplate 方法中多个对象的示例

    public interface SampleXTemplates extends XTemplates {
      @XTemplate("<div>Hello, {person.name}! Do you like the book {book.title}?</div>")
      SafeHtml hello(Person person, Book book);
    }
  

• 使用多对象 XTemplate 方法的示例

    public void display() {
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  
      Person fred = new Person("Fred");
      Book book = new Book("Ice Age");
  
      // Display Hello, Fred! Do you like the book Ice Age? or <div>Hello, Fred! Do you like the book Ice Age?</div>
      RootPanel.get().add(new HTML(tpl.hello(fred, book)));
    }        
  

嵌套属性

在 HTML 源中指定嵌套对象属性需要特定的路径属性，例如 {path.to.property}。

• 带有嵌套 Person，名为 father 的 Person 示例。

   public class Person {
     private String name;
     private int age;
     private Person father;
     public Person(Person father, String name, int age) {
       this.father = father;
       this.name = name;
       this.age = age;
     }
     public String getName() {
       return name;
     }
     public int getAge() {
       return age;
     }
     public Person getFather() {
       return father;
     }
   }
  

• 提供嵌套 person father 的路径的示例，例如 {father.name}

    public interface SampleXTemplates extends XTemplates {
      // Providing person instance to the XTemplate method.
      // {name} uses Person.getName();
      // {age} uses Person.getAge();
      // {father.name} uses Person.getFather().getName();
      @XTemplate("<div>Hello, {name}! Is your age {age}? {name}&lsquo;s father is {father.name}.</div>")
      SafeHtml hello(Person person);
    }
  

• 使用 XTemplate 的示例

    public void display() {
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  
      // Displays: Hello, Barney! Is your age 34?
      Person father = new Person(null, "Bob", 61);
      Person barney = new Person(father, "Barney", 34);
      RootPanel.get().add(new HTML(tpl.hello(barney)));
    }
  

更深层次的嵌套属性

通过指定嵌套对象变量的属性路径，更深入地访问对象图属性。

• 带有嵌套的 Person 对象图示例。

    public class Person {
      private String name;
      private int age;
      private Person father;
      private Book favoriteBook;
      public Person(Person father, String name, int age, Book favoriteBook) {
        this.father = father;
        this.name = name;
        this.age = age;
        this.favoriteBook = favoriteBook;
      }
      public String getName() {
        return name;
      }
      public int getAge() {
        return age;
      }
      public Person getFather() {
        return father;
      }
      public Book getFavoriteBook() {
        return favoriteBook;
      }
    }
  
    public class Book {
      private String title;
      private Recommendation recommendation;
      public Book(String title, Recommendation recommendation) {
        this.title = title;
        this.recommendation = recommendation;
      }
      public String getTitle() {
        return title;
      }
      public Recommendation getRecommendation() {
        return recommendation;
      }
    }
  
    public class Recommendation {
      private String message;
      public Recommendation(String message) {
        this.message = message;
      }
      public String getMessage() {
        return message;
      }
    }
  

• XTemplate HTML 源的示例

    <!-- hello.html file -->
    <div>
        Hello, {name}! Is your age {age}? 
        {name}&lsquo;s father is {father.name}.
        My favorite book is {favoriteBook.title} and
        has recommendation: {favoriteBook.recommendation.message}
    </div>        
  

• 使用更深层次的嵌套属性引用的示例

    public interface SampleXTemplates extends XTemplates {
      // Providing person instance to the XTemplate method.
      // {name} uses Person.getName();
      // {age} uses Person.getAge();
      // {father.name} uses Person.getFather().getName();
      // {favoriteBook.title} uses Person.getFavoriteBook().getTitle();
      // {favoriteBook.recommendation.message} uses Person.getFavoriteBook().getRecommendation().getMessage();
      @XTemplate(source = "hello.html")
      SafeHtml hello(Person person);
    }
  

• 使用 XTemplate 的示例

    public void display() {
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  
      // Displays: Hello, Barney! Is your age 34? Barney's father is Bob. My favorite book is 
      //           Dinosaurs and has recommendation: This book was good.
      Recommendation recommendation = new Recommendation("This book was good.");
      Book book = new Book("Dinosaurs", recommendation);
      Person father = new Person(null, "Bob", 61, null);
      Person barney = new Person(father, "Barney", 34, book);
      RootPanel.get().add(new HTML(tpl.hello(barney)));
    }
  

属性值格式化

内置属性格式化程序存在于货币、日期、小数、数字和科学数据类型的字符串格式化中。

• 内置字符串格式化程序

    {property:currency} 
    {property:date("format")} 
    {property:decimal} 
    {property:number("format")} 
    {property:scientific} 
  

货币

• 将属性格式化为货币

    {property:currency}
  

• 使用 {money:currency} 的示例

    // Example of object for use with this example
    public class Person {
      private String name;
      private BigDecimal money;
      public Person(String name, BigDecimal money) {
        this.name = name;
        this.money = money;
      }
      public String getName() {
        return name;
      }
      public BigDecimal getMoney() {
        return money;
      }
    }
  
    // XTemplate using {money:currency} formatting
    public interface SampleXTemplates extends XTemplates {
      @XTemplate("<div>You owe me {money:currency}.</div>")
      SafeHtml hello(Person person);
    }
  
    // Using the XTemplate
    public void display() {
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  
      // Displays: You owe me US$1.23.
      BigDecimal money = new BigDecimal("1.23");
      Person barney = new Person("Barney", money);
      RootPanel.get().add(new HTML(tpl.hello(barney)));
    }
  

日期

• 将属性格式化为日期：DateTimeFormat Javadoc - 格式化选项

    {property:date}
    {property:date("[custom format]")}
    {property:date("M/d/y")} // default
    {property:date("mm/dd/yyyy")}
  

• 使用 {property:date} 的示例

    // Example of object for use with this example
    public class Person {
      private String name;
      private Date hangout;
      public Person(String name, Date hangout) {
        this.name = name;
        this.hangout = hangout;
      }
      public String getName() {
        return name;
      }
      public Date getHangout() {
        return hangout;
      }
    }
  
    // XTemplate using {hangout:date} formatting
    public interface SampleXTemplates extends XTemplates {
      @XTemplate("<div>Hello, {name}! Lets hangout on {hangout:date}.</div>")
      SafeHtml hello(Person person);
    }
  
    // Using XTemplate
    public void display() {
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  
      // Displays: Hello, Barney! Lets hangout on 12/31/2014.
      Date hangout = new Date(2014-1900, 11, 31);
      Person barney = new Person("Barney", hangout);
      RootPanel.get().add(new HTML(tpl.hello(barney)));
    }
  

小数

• 将属性格式化为小数

    {property:decimal}    
  

• 使用 {property:decimal} 的示例

    // Example of object for use with this example
    public class Person {
      private String name;
      private double pi;
      public Person(String name, double pi) {
        this.name = name;
        this.pi = pi;
      }
      public String getName() {
        return name;
      }
      public double getPi() {
        return pi;
      }
    }
  
    // XTemplate using {pi:decimal} formatting
    public interface SampleXTemplates extends XTemplates {
      @XTemplate("<div>Would you like some apple {pi:decimal}?</div>")
      SafeHtml hello(Person person);
    }
  
    // Using XTemplate
    public void display() {
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  
      // Would you like some apple 3.14?
      double pi = 3.14;
      Person barney = new Person("Barney", pi);
      RootPanel.get().add(new HTML(tpl.hello(barney)));
    }
  

数字

• 将属性格式化为数字：NumberFormat Javadoc - 格式化选项

    {property:number}
    {property:number("[custom format]")}
    {property:number("#")} // default
    {property:number("#,##0.00")}
  

• 使用 {property:number} 的示例

    // Example of object for use with this example
    public class Person {
      private String name;
      private double pie;
      public Person(String name, double pie) {
        this.name = name;
        this.pie = pie;
      }
      public String getName() {
        return name;
      }
      public double getPie() {
        return pie;
      }
    }
  
    // XTemplate using {pie:number} formatting
    public interface SampleXTemplates extends XTemplates {
      @XTemplate("<div>Would you like some apple {pie:number(\"#,##0.00\")}?</div>")
      SafeHtml hello(Person person);
    }
  
    // Using XTemplate
    public void onModuleLoad() {
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  
      // Would you like some apple 3.14?
      double pie = 3.14;
      Person barney = new Person("Barney", pie);
      RootPanel.get().add(new HTML(tpl.hello(barney)));
    }
  

科学计数法

• 将属性格式化为科学计数法

    {property:scientific}
  

• 使用 {pie:scientific} 的示例

    // Example of object for use with this example
    public class Person {
      private String name;
      private double pie;
      public Person(String name, double pie) {
        this.name = name;
        this.pie = pie;
      }
      public String getName() {
        return name;
      }
      public double getPie() {
        return pie;
      }
    }
  
    // XTemplate using {pie:scientific} formatting
    public interface SampleXTemplates extends XTemplates {
      @XTemplate("<div>Would you like some apple {pie:scientific}?</div>")
      SafeHtml hello(Person person);
    }
  
    // Using XTemplate
    public void display() {
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  
      // Would you like some apple 3E0?
      double pie = 3.141592653589793238462643383279502884197169399;
      Person barney = new Person("Barney", pie);
      RootPanel.get().add(new HTML(tpl.hello(barney)));
    }
  

自定义属性格式化程序

如果内置属性格式化程序无法提供格式化值所需的内容，请构建自定义格式化程序，如下例所示。此自定义格式化程序示例可以将字符串缩短为特定长度。

• 用于示例的对象的示例

    public class Person {
      private String name;
      public Person(String name) {
        this.name = name;
      }
      public String getName() {
        return name;
      }
    }
  

• 带有自定义格式化程序的 XTemplate HTML 源示例

    <!-- hello.html file -->
    <div>
      <p>
          <!-- applies the custom formatter :shorten(7) -->
        Hello {person.name:shorten(7)}! 
      </p>
    </div>
  

• ShortenFactory 实例化的格式化程序的示例

   import com.sencha.gxt.core.client.XTemplates.Formatter;
   import com.sencha.gxt.core.client.util.Format;
  
   public class Shorten implements Formatter<String> {
     private int length;
  
     public Shorten(int length) {
       this.length = length;
     }
  
     @Override
     public String format(String data) {
       return Format.ellipse(data, length);
     }
   }
  

• 在 XTemplates 接口中注释的 ShortenFactory 类的示例

    public class ShortenFactory {
      public static Shorten getFormat(int length) {
        return new Shorten(length);
      }
    }        
  

• 注释的 shortner 格式化程序的示例

    @FormatterFactories(@FormatterFactory(factory = ShortenFactory.class, name = "shorten"))
    public interface SampleXTemplates extends XTemplates {
      @XTemplate(source = "hello.html")
      SafeHtml hello(Person person);
    }
  

• 使用带有自定义格式化程序的 XTemplate 的示例

    public void display() {
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  
      // Displays: Hello Barn...! 
      Person barney = new Person("Barney Rubbel");
      RootPanel.get().add(new HTML(tpl.hello(barney)));
    }
  

迭代列表和数组属性

使用 <tpl for="." /> 标签迭代列表和数组。

• 下面将列表和数组类型称为迭代属性。
• 当使用 <tpl for="." /> 并且提供的属性是迭代对象时，将在标签内进行迭代。
• 在 <tpl/> 标签内迭代时，特殊变量 {#} 将提供当前数组索引+1 (1,2,3...)。

嵌套迭代属性

任何类型的嵌套都可以使用属性，尽管必须给出特定路径才能引用属性。

• “.”指的是 this XTemplate 签名中提供的值。

• 在 <tpl for="." /> 标签中使用嵌套属性引用的示例

    <tpl for="." /> // 'this' or kids or the given iterative value
    <tpl for="kids" /> // this.getKids();
    <tpl for="kids.friends" /> // this.getKids().getFriends();
    <tpl for="kids.friends.teachers" /> // this.getKids().getFriends().getTeachers();
  

迭代嵌套路径 "." 的示例：

• 使用 <tpl for="." /> 迭代 List<Person> 的示例

    // Example object
    public class Person {
      private String name;
      public Person(String name) {
        this.name = name;
      }
      public String getName() {
        return name;
      }
    }
  

• HTML 源示例

    <!-- hello.html file -->
    <div>
      <tpl for='.'>
        <p>{#}. Hello {name}!</p>     
      </tpl>
    </div>
  

• XTemplate 示例

    // Example XTemplate with List<Person> people iteration
    public interface SampleXTemplates extends XTemplates {
      @XTemplate(source = "hello.html")
      SafeHtml hello(List<Person> people);
    }
  

• 使用示例

    // Example of using the XTemplate
    public void display() {
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  
      List<Person> people = new ArrayList<Person>();
      people.add(new Person("Fred"));
      people.add(new Person("Barney"));
  
      // Displays:
      // 1. Hello Fred!
      // 2. Hello Barney!
      RootPanel.get().add(new HTML(tpl.hello(people)));
    }
  

迭代嵌套路径 "kids" 的示例：

• 使用 kids 的另一个嵌套属性示例，例如 <tpl for="kids" />

    // Example object
    public class Person {
      private String name;
      private List<Person> kids;
      public Person(String name, List<Person> kids) {
        this.name = name;
        this.kids = kids;
      }
      public String getName() {
        return name;
      }
      public List<Person> getKids() {
        return kids;
      }
    }
  

• HTML 源示例

    <!-- hello.html -->
    <div>
      <tpl for='.'>
        <p>
          {#}. Hello {name}! Kids: 
            <tpl for='kids'>{name} </tpl>
        </p>
      </tpl>
    </div>
  

• XTemplate 示例

    // Example XTemplate with deeper object graph iteration
    public interface SampleXTemplates extends XTemplates {
      @XTemplate(source = "hello.html")
      SafeHtml hello(List<Person> people);
    }
  

• 使用示例

    // Using the XTemplate
    public void display() {
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  
      List<Person> fredsKids = new ArrayList<Person>();
      fredsKids.add(new Person("Pebbles", null));
      fredsKids.add(new Person("Stony", null));
  
      List<Person> barneysKids = new ArrayList<Person>();
      barneysKids.add(new Person("Bam-Bam", null));
  
      List<Person> people = new ArrayList<Person>();
      people.add(new Person("Fred", fredsKids));
      people.add(new Person("Barney", barneysKids));
  
      // Displays:
      // 1. Hello Fred! Kids: Pebbles Stony
      // 2. Hello Barney! Kids: Bam-Bam
      RootPanel.get().add(new HTML(tpl.hello(people)));
    }
  

If 语句

<tpl if="expression" /> 标签提供表达式的条件评估。

• 没有 else 运算符，但可以使用两个相反的 if 语句。

• If 语句示例 <tpl if="expression" />

    <tpl if="needsIcon" />
    <tpl if="id == 'download'" />
    <tpl if="name == &quot;Jack&quot;" />
    <tpl if="age &gt; 1 && age &lt; 10" />
    <tpl if="age &gt;= 10 && age &lt; 18" />
  

表达式引号封装

引号封装规则是 XML 标记的规则，相同的规则在此处适用。

• 单引号值封装可以通过几种方式完成。

    // double quote with single quote encapsulation
    <tpl if="id == 'download'" /> 
  
    // escaping single quotes
    <tpl if="id == \'download\'" /> 
  

• 可以使用双引号，但必须将它们从 " 编码为 "

    // "Jack" is encoded as "Jack"
    <tpl if="name == &quot;Jack&quot;" />        
  

表达式字符编码

XTemplate 系统使用 xml，它需要对这些字符进行编码。

If 语句示例

使用 <tpl if="expression" /> 标签的示例。

• HTML 源示例

    <!-- hello.html file -->
    <div>
      <p>
        Hello {person.name}! Kids with age &gt; 3: 
        <tpl for='person.kids'>
  
          <!-- if statement with encoded '>' as &gt; -->
          <tpl if="age &gt; 3">
            {name}
          </tpl>
  
        </tpl>
      </p>
    </div>
  

• XTemplate 示例

    public interface SampleXTemplates extends XTemplates {
      @XTemplate(source = "hello.html")
      SafeHtml hello(Person person);
    }
  

• 使用 XTemplate 的示例

    public void onModuleLoad() {
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  
      List<Person> kids = new ArrayList<Person>();
      kids.add(new Person("Pebbles", 7, null));
      kids.add(new Person("Stony", 8, null));
      kids.add(new Person("Bam-Bam", 2, null));
  
      Person fred = new Person("Fred", 34, kids);
  
      // Displays: Hello Fred! Kids with age > 3: Pebbles Stony 
      RootPanel.get().add(new HTML(tpl.hello(fred)));
    }        
  

基本数学运算符

基本数学运算符可以直接应用于数值数据值。

• 数学运算符遵循 Java 最高优先级顺序。

• 数学表达式必须包含在方括号 {[expression]} 或 {[year+5]} 中

    {[expression]}
    {[year+5]}
    {[price*(quantity+1.23)]}
  

数学表达式示例

可以使用基本 Java 类型数学表达式。这种 Java 类型的数学是有限的，更复杂的数学表达式更适合在 bean getter 访问器中使用。

• 带有数学表达式的 HTML 源示例

    <!-- hello.html file -->
    <div>
      <p>
        Hello {person.name}! Kids with age &gt; 3: 
        <tpl for='person.kids'>
          <tpl if="age &gt; 3">
            {name} age:{age} math:{[age+3]}
          </tpl>
        </tpl>
      </p>
    </div>
  

• XTemplate 示例

    public interface SampleXTemplates extends XTemplates {
      @XTemplate(source = "hello.html")
      SafeHtml hello(Person person);
    }
  

• 使用示例

    public void onModuleLoad() {
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
  
      List<Person> kids = new ArrayList<Person>();
      kids.add(new Person("Pebbles", 7, null));
      kids.add(new Person("Stony", 8, null));
      kids.add(new Person("Bam-Bam", 2, null));
  
      Person fred = new Person("Fred", 34, kids);
  
      // Displays: Hello Fred! Kids with age > 3: Pebbles age:7 math:10 Stony age:8 math:11 
      RootPanel.get().add(new HTML(tpl.hello(fred)));
    }        
  

国际化

在 XTemplate 中混合 GWT I18N 属性。此示例演示了将 Messages 与 XTemplate 一起使用，并且可以使用其他 I18N 模块类型完成相同的技术。

• 有关更多信息，请参阅 GWT 国际化指南

消息

将 Messages 与 XTemplate 结合使用的示例。

• XTemplate 中使用的对象的示例

    public class Person {
      private String name;
      public Person(String name) {
        this.name = name;
      }
      public String getName() {
        return name;
      }
    }
  

• 包含 Messages 翻译属性的本地化消息文件名的示例

    # AppMessages file names
    AppMessages.properties
    AppMessages_ca.properties
    AppMessages_cs.properties
    AppMessages_da.properties
    AppMessages_de.properties
    AppMessages_el_GR.properties
    AppMessages_es.properties
    AppMessages_fr.properties
    AppMessages_hu.properties
    AppMessages_it.properties
    AppMessages_no.properties
    AppMessages_pl.properties
    AppMessages_pt_BR.properties
    AppMessages_pt_PT.properties
    AppMessages_pt.properties
    AppMessages_ru.properties
    AppMessages_sl.properties
    AppMessages_ua.properties
    AppMessages_zh.properties
  
    # localized property which is put in all of the AppMessages files  
    hello = Hello
  

• Messages 示例

    // The file name must start in the translated property file names
    public interface AppMessages extends Messages {
      String hello();
    }
  

• 带有本地化消息 messages.hello 的 XTemplate HTML 源代码示例

    <!-- hello.html file -->
    <div>
      <p>
        {messages.hello} {person.name}!
      </p>
    </div>
  

• XTemplate 方法示例

    public interface SampleXTemplates extends XTemplates {
      @XTemplate(source = "hello.html")
      SafeHtml hello(AppMessages messages, Person person);
    }
  

  • 使用带有消息的 XTemplates 的示例

    public void display() {
      AppMessages messages = GWT.create(AppMessages.class);
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
    
      // Displays: Hello Fred!
      Person fred = new Person("Fred");
      RootPanel.get().add(new HTML(tpl.hello(messages, fred)));
    }
    

样式

向 HTML 模板元素添加样式。此示例演示了如何将 CSS 资源用作 XTemplate 参数。

• 一些 css 的示例

    /* style.css file */
    .widget {
        border: 1px red solid;
    }
  

• 应用程序 CSS 资源的示例

    import com.google.gwt.resources.client.ClientBundle;
    import com.google.gwt.resources.client.CssResource;
  
    public interface AppResources extends ClientBundle {
      public interface WidgetCssResource extends CssResource {
        String widget();
      }
  
      @Source("style.css")
      public WidgetCssResource widgetStyles();
    }
  

• 使用样式设置 XTemplate 模板的示例

    <!-- hello.html file -->
    <div class="{style.widget}">
      <p>
        Hello {person.name}!
      </p>
    </div>
  

• 使用 CSS 资源参数设置 Xtemplate 的示例

    public interface SampleXTemplates extends XTemplates {
      @XTemplate(source = "hello.html")
      SafeHtml hello(WidgetCssResource style, Person person);
    }
  

• 将 XTemplate 与 CSS 资源一起使用的示例。

    public void display() {
      SampleXTemplates tpl = GWT.create(SampleXTemplates.class);
      AppResources appResources = GWT.create(AppResources.class);
      appResources.widgetStyles().ensureInjected();
  
      // Displays: <div class="GCQJNTMCAN"><p>Hello Barney!</p></div>
      Person barney = new Person("Barney");
      RootPanel.get().add(new HTML(tpl.hello(appResources.widgetStyles(), barney)));
    }
  

常见的 XTemplate 问题

由于变量引用是字符串，因此会导致一些常见错误，而 GXT 具有良好的调试日志记录功能，可帮助快速诊断问题。

XTemplate 源代码变量命名错误

XTemplate 源代码中命名错误的变量将导致构建错误。下面的屏幕截图演示了在 XTemplate 源代码中错误命名变量的错误。该变量被命名为 {book.title}，但应该命名为 {favoriteBook.title}。

对象中没有 XTemplate 变量名的 getter

XTemplates 通过对象的 getter（如 getRecommendation()）引用对象实例变量，并且还查找 hasRecomendation()、isRecomendation() 和 recomendation() 来检索实例值。下面的屏幕截图演示了当 getter 或类似方法缺失并给出“no getter”错误时的情况。在此错误中，getRecommendation() 方法缺失，这对应于使用 {favoriteBook.recommendation}，它查找 getter 方法 getRecommendation()、hasRecomendation()、isRecomendation() 和 recomendation()，如果它们不存在，则抛出异常 no getter。