Tapestry 最新版5.1.0.5教程（十一）：自定义组件CheckBoxGroup

我记得好像是Appfuse的作者曾经这样评价过Tapestry：只要你真正掌握了Tapestry，你的开发效率将会得到极大的提高。为什么呢？我认为他这样说的一个重要原因就是Tapestry的组件机制。Tapestry提供了非常便利的组件定义机制，随着Tapestry的组件不断积累，Tapestry的开发将会变得越来越简单。
本文就用一个实例来看一下Tapestry中是如何添加一个自定义组件的。
Tapestry的内置组件只提供了checkbox，而且只能返回一个boolean，用于表明是否被选中。
比如，要进行一个群众喜爱的水果调查，选项有: 苹果，葡萄，桃子，香蕉...，就需要对应每个选项设置一个布尔型变量，显得比较繁琐。
这里我们将添加一个组件用于将一组checkbox集中起来返回一个逗号分隔的字符串值。
通过查看Tapestry中的checkbox的源码（已经附在文章的后面）可以知道，Tapestry可以很容易地通过Request来获取Form中的变量的值。
遇到的问题：
Tapestry的checkbox组件不允许设置相同的name，如果name相同，Tapestry会自动在name后面添加后缀来使之不同。
If a component renders multiple times, a suffix will be appended to the to id to ensure uniqueness（http://tapestry.apache.org/tapestry5.1/tapestry-core/ref/org/apache/tapestry5/corelib/components/Checkbox.html）。如果各checkbox的name不同，我们无法通过request来获得一组checkbox的值。
思路：
在页面模板中不使用tapestry的checkbox组件，而使用Html的checkbox，这样可以避免tapestry自动修改checkbox的name。
添加一个新的tapestry组件，来映射接受所有同名的checkbox的值，并把值返回给tapestry页面中对应的变量。这个组件需要有一个属性，这个属性的值就是所有同组checkbox的name，这样，这个组件就可以通过Request来获取所有相同name的checkbox的值。
代码：

 1  public   class  CheckBoxGroup  extends  AbstractField {
 2 
 3      @SuppressWarnings( " unused " )
 4      @Parameter(required  =   true , autoconnect  =   true )
 5       private  String value;
 6 
 7      @Parameter(required  =   true , autoconnect  =   true )
 8       private  String groupName;
 9 
10      @Inject
11       private  Request request;
12 
13      @SuppressWarnings( " unused " )
14      @Mixin
15       private  RenderDisabled renderDisabled;
16 
17      @Inject
18       private  ComponentResources resources;
19 
20      @BeginRender
21       void  begin(MarkupWriter writer)
22      {
23          writer.element( " input " ,  " type " ,  " checkbox " ,
24                          " name " , groupName,
25                          " id " , getClientId(),
26                          " style " ,  " display:none " );
27 
28          resources.renderInformalParameters(writer);
29 
30          decorateInsideField();
31      }
32 
33      @AfterRender
34       void  after(MarkupWriter writer)
35      {
36          writer.end();  //  input
37      }
38 
39      @Override
40       protected   void  processSubmission(String elementName)
41      {
42          String elementValue  =   "" ;
43          String[] valueArray  =  request.getParameters(groupName);
44           if  ( valueArray  !=   null   &&  valueArray.length  >   0  ) {
45              elementValue  =  valueArray[ 0 ];
46               for  (  int  i  =   1 ; i  <  valueArray.length; i  ++  ) {
47                  elementValue  +=   " , "   +  valueArray[i];
48              }
49          }
50          value  =  elementValue;
51      }
52  }

组件的使用：
-----tml------
<t:CheckBoxGroup t:groupName="literal:bookId" t:value="selectedBooks"/>
<t:loop source="bookList" value="book" encoder="encoder">
    <div><input type="checkbox" name="bookId" value="${book.id}"/> ${book.name}</div>
</t:loop>
注意checkBoxGroup的groupName和其他checkbox的name必须一致，checkBoxGroup的value的值就是页面中的变量名

-----java-----
    @SuppressWarnings("unused")
    @Property
    private final ValueEncoder<Book> encoder = new ValueEncoder<Book>() {
        public String toClient(Book value) {
            return String.valueOf(value.getId());
        }
        public Book toValue(String clientValue) {
            return bookDao.getBook(Integer.parseInt(clientValue));
        }
    };
   
    public List<Book> getBookList() {
        return bookDao.getBooks();
    }
   
    @SuppressWarnings("unused")
    @Property
    private Book book;
   
    @SuppressWarnings("unused")
    @Property
    private String selectedBooks;