GWT - 自定义小部件( Custom Widgets)

介绍 (Introduction)

UiBinder是一个旨在分离功能和用户界面视图的框架。

UiBinder框架允许开发人员将gwt应用程序构建为HTML页面，并在其中配置GWT小部件。
UiBinder框架使与UI设计人员的协作变得更容易，他们比XML源代码更熟悉XML，HTML和CSS
UIBinder提供了一种定义用户界面的声明方式。
UIBinder从UI中分离出程序逻辑。
UIBinder类似于JSP对Servlets的作用。

UiBinder工作流程

第1步:创建UI声明XML文件

创建基于XML/HTML的用户界面声明文件。我们在示例中创建了一个Login.ui.xml文件。

<ui:UiBinder xmlns:ui = 'urn:ui:com.google.gwt.uibinder'
   xmlns:gwt = 'urn:import:com.google.gwt.user.client.ui' 
   xmlns:res = 'urn:with:com.iowiki.client.LoginResources'>
   <ui:with type = "com.iowiki.client.LoginResources" field = "res">
   </ui:with>
   <gwt:HTMLPanel>
   ...  
   </gwt:HTMLPanel>
</ui:UiBinder>

第2步:使用ui:字段进行后期绑定

使用XML/HTML元素中的ui:field属性将XML中的UI字段与JAVA文件中的UI字段相关联，以便以后绑定。

<gwt:Label ui:field = "completionLabel1" />
<gwt:Label ui:field = "completionLabel2" />

第3步:创建UI XML的Java对应物

通过扩展Composite小部件，创建基于XML的基于XML的布局。我们在示例中创建了一个Login.java文件。

package com.iowiki.client;
   ...
public class Login extends Composite {
   ...
}

步骤4:使用UiField批注绑定Java UI字段

在Login.java使用@UiField注释来指定要在Login.java中绑定到基于XML的字段的对应类成员

public class Login extends Composite {
   ...
   @UiField
   Label completionLabel1;
   @UiField
   Label completionLabel2;  
   ...
}

步骤5:使用带有UiTemplate注释的UI XML绑定Java UI

指示GWT使用@UiTemplate注释绑定基于java的组件Login.java和基于XML的布局Login.ui.xml

public class Login extends Composite {
   private static LoginUiBinder uiBinder = GWT.create(LoginUiBinder.class);
   /*
    * @UiTemplate is not mandatory but allows multiple XML templates
    * to be used for the same widget. 
    * Default file loaded will be <class-name>.ui.xml
    */
   @UiTemplate("Login.ui.xml")
   interface LoginUiBinder extends UiBinder<Widget, Login> {
   }
   ...
}

第6步:创建CSS文件

创建一个外部CSS文件Login.css和基于Java的Resource LoginResources.java文件，相当于css样式

.blackText {
   font-family: Arial, Sans-serif;
   color: #000000;
   font-size: 11px;
   text-align: left;
}
...

步骤7:为CSS文件创建基于Java的资源文件

package com.iowiki.client;
...
public interface LoginResources extends ClientBundle {
   public interface MyCss extends CssResource {
      String blackText();
      ...
   }
   @Source("Login.css")
   MyCss style();
}

步骤8:在Java UI代码文件中附加CSS资源。

使用基于Java的小部件类Login.java附加外部CSS文件Login.java

public Login() {
   this.res = GWT.create(LoginResources.class);
   res.style().ensureInjected();
   initWidget(uiBinder.createAndBindUi(this));
}

UIBinder完整示例

此示例将指导您完成在GWT中显示UIBinder使用情况的简单步骤。按照以下步骤更新我们在GWT - Create Application的GWT应用程序GWT - Create Application章节 -

步	描述
1	在com.iowiki包下创建一个名为HelloWorld的项目，如GWT - Create Application一章中所述。
2	修改HelloWorld.gwt.xml ， HelloWorld.css ， HelloWorld.html和HelloWorld.java ，如下所述。保持其余文件不变。
3	编译并运行应用程序以验证实现的逻辑的结果。

以下是修改后的模块描述符src/com.iowiki/HelloWorld.gwt.xml 。

<?xml version = "1.0" encoding = "UTF-8"?>
<module rename-to = 'helloworld'>
   <!-- Inherit the core Web Toolkit stuff.                        -->
   <inherits name = 'com.google.gwt.user.User'/>
   <!-- Inherit the default GWT style sheet.                       -->
   <inherits name = 'com.google.gwt.user.theme.clean.Clean'/>
   <!-- Inherit the UiBinder module.                               -->
   <inherits name = "com.google.gwt.uibinder.UiBinder"/>
   <!-- Specify the app entry point class.                         -->
   <entry-point class = 'com.iowiki.client.HelloWorld'/>
   <!-- Specify the paths for translatable code                    -->
   <source path ='client'/>
   <source path = 'shared'/>
</module>

以下是修改后的样式表文件war/HelloWorld.css 。

body {
   text-align: center;
   font-family: verdana, sans-serif;
}
h1 {
   font-size: 2em;
   font-weight: bold;
   color: #777777;
   margin: 40px 0px 70px;
   text-align: center;
}

以下是修改后的HTML主机文件war/HelloWorld.html 。

<html>
   <head>
      <title>Hello World</title>
      <link rel = "stylesheet" href = "HelloWorld.css"/>
      <script language = "javascript" src = "helloworld/helloworld.nocache.js">
      </script>
   </head>
   <body>
      <h1>UiBinder Demonstration</h1>
      <div id = "gwtContainer"></div>
   </body>
</html>

现在创建一个新的UiBinder模板和所有者类（文件→新建→UiBinder）。

选择项目的客户端软件包，然后将其命名为Login。保留所有其他默认值。单击Finish按钮，插件将创建一个新的UiBinder模板和所有者类。

现在在src/com.iowiki/client包中创建Login.css文件，并在其中放置以下内容

.blackText {
   font-family: Arial, Sans-serif;
   color: #000000;
   font-size: 11px;
   text-align: left;
}
.redText {
   font-family: Arial, Sans-serif;
   color: #ff0000;
   font-size: 11px;
   text-align: left;
}
.loginButton {
   border: 1px solid #3399DD;
   color: #FFFFFF;
   background: #555555;
   font-size: 11px;
   font-weight: bold;
   margin: 0 5px 0 0;
   padding: 4px 10px 5px;
   text-shadow: 0 -1px 0 #3399DD;
}
.box {
   border: 1px solid #AACCEE;
   display: block;
   font-size: 12px;
   margin: 0 0 5px;
   padding: 3px;
   width: 203px;
}
.background {
   background-color: #999999;
   border: 1px none transparent;
   color: #000000;
   font-size: 11px;
   margin-left: -8px;
   margin-top: 5px;
   padding: 6px;
}

现在在src/com.iowiki/client包中创建LoginResources.java文件并在其中放置以下内容

package com.iowiki.client;
import com.google.gwt.resources.client.ClientBundle;
import com.google.gwt.resources.client.CssResource;
public interface LoginResources extends ClientBundle {
   /**
    * Sample CssResource.
    */
   public interface MyCss extends CssResource {
      String blackText();
      String redText();
      String loginButton();
      String box();
      String background();
   }
   @Source("Login.css")
   MyCss style();
}

使用以下内容替换src/com.iowiki/client包中的src/com.iowiki/client的内容

<ui:UiBinder xmlns:ui = 'urn:ui:com.google.gwt.uibinder'
   xmlns:gwt = 'urn:import:com.google.gwt.user.client.ui' 
   xmlns:res = 'urn:with:com.iowiki.client.LoginResources'>
   <ui:with type = "com.iowiki.client.LoginResources" field = "res">
   </ui:with>
   <gwt:HTMLPanel>
      <div align = "center">
         <gwt:VerticalPanel res:styleName = "style.background">
            <gwt:Label text = "Login" res:styleName = "style.blackText" />
            <gwt:TextBox ui:field="loginBox" res:styleName = "style.box" />
            <gwt:Label text = "Password" res:styleName = "style.blackText" />
            <gwt:PasswordTextBox ui:field = "passwordBox" res:styleName = "style.box" />
            <gwt:HorizontalPanel verticalAlignment = "middle">
               <gwt:Button ui:field = "buttonSubmit" text="Submit"
                  res:styleName = "style.loginButton" />
               <gwt:CheckBox ui:field = "myCheckBox" />
               <gwt:Label ui:field = "myLabel" text = "Remember me"
                  res:styleName = "style.blackText" />
            </gwt:HorizontalPanel>
            <gwt:Label ui:field = "completionLabel1" res:styleName = "style.blackText" />
            <gwt:Label ui:field = "completionLabel2" res:styleName = "style.blackText" />
         </gwt:VerticalPanel>
      </div>
   </gwt:HTMLPanel>
</ui:UiBinder>

用以下内容替换src/com.iowiki/client包中的src/com.iowiki/client的内容

package com.iowiki.client;
import com.google.gwt.core.client.GWT;
import com.google.gwt.event.dom.client.ClickEvent;
import com.google.gwt.event.logical.shared.ValueChangeEvent;
import com.google.gwt.uibinder.client.UiBinder;
import com.google.gwt.uibinder.client.UiField;
import com.google.gwt.uibinder.client.UiHandler;
import com.google.gwt.uibinder.client.UiTemplate;
import com.google.gwt.user.client.Window;
import com.google.gwt.user.client.ui.Composite;
import com.google.gwt.user.client.ui.Label;
import com.google.gwt.user.client.ui.TextBox;
import com.google.gwt.user.client.ui.Widget;
public class Login extends Composite {
   private static LoginUiBinder uiBinder = GWT.create(LoginUiBinder.class);
   /*
    * @UiTemplate is not mandatory but allows multiple XML templates
    * to be used for the same widget. 
    * Default file loaded will be <class-name>.ui.xml
    */
   @UiTemplate("Login.ui.xml")
   interface LoginUiBinder extends UiBinder<Widget, Login> {
   }
   @UiField(provided = true)
   final LoginResources res;
   public Login() {
      this.res = GWT.create(LoginResources.class);
      res.style().ensureInjected();
      initWidget(uiBinder.createAndBindUi(this));
   }
   @UiField
   TextBox loginBox;
   @UiField
   TextBox passwordBox;
   @UiField
   Label completionLabel1;
   @UiField
   Label completionLabel2;
   private Boolean tooShort = false;
   /*
    * Method name is not relevant, the binding is done according to the class
    * of the parameter.
    */
   @UiHandler("buttonSubmit")
   void doClickSubmit(ClickEvent event) {
      if (!tooShort) {
         Window.alert("Login Successful!");
      } else {
         Window.alert("Login or Password is too short!");
      }
   }
   @UiHandler("loginBox")
   void handleLoginChange(ValueChangeEvent<String> event) {
      if (event.getValue().length() < 6) {
         completionLabel1.setText("Login too short (Size must be > 6)");
         tooShort = true;
      } else {
         tooShort = false;
         completionLabel1.setText("");
      }
   }
   @UiHandler("passwordBox")
   void handlePasswordChange(ValueChangeEvent<String> event) {
      if (event.getValue().length() < 6) {
         tooShort = true;
         completionLabel2.setText("Password too short (Size must be > 6)");
      } else {
         tooShort = false;
         completionLabel2.setText("");
      }
   }
}

让我们有以下Java文件src/com.iowiki/HelloWorld.java ，它将演示UiBinder的使用。

package com.iowiki.client;
import com.google.gwt.core.client.EntryPoint;
import com.google.gwt.user.client.ui.RootPanel;
public class HelloWorld implements EntryPoint {
   public void onModuleLoad() {
      RootPanel.get().add(new Login());   
   }    
}

一旦准备好完成所有更改，让我们像在GWT - 创建应用程序章节中那样在开发模式下编译和运行应用程序。如果您的应用程序一切正常，这将产生以下结果 -

<上一篇.GWT - 自定义小部件( Custom Widgets)

GWT - RPC通信( RPC Communication).下一篇>

GWT - 教程

GWT - 概述

GWT - 环境设置( Environment Setup)

GWT - 应用程序( Applications)

GWT - 创建应用程序( Create Application)

GWT - 部署应用程序( Deploy Application)

GWT - CSS风格( Style with CSS)

GWT - 基本小部件( Basic Widgets)

GWT - 表单小部件( Form Widgets)

GWT - 复杂的小部件( Complex widgets)

GWT - 布局面板( Layout Panels)

GWT - 事件处理( Event Handling)