View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package javax.faces.component.html;
20  
21  import javax.faces.component.UIColumn;
22  
23  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFComponent;
24  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;
25  
26  /**
27   * Creates a UIComponent that represents a single column of data within a parent UIData component.
28   * <p>
29   * This tag is commonly used as a child of the h:dataTable tag, to represent a column of
30   * data within an html table. It can be decorated with nested "header" and "footer" facets
31   * which cause the output of header and footer rows.
32   * </p>
33   * <p>
34   * The non-facet child components of this column are re-rendered on each table row
35   * to generate the content of the cell. Those child components can reference the "var"
36   * attribute of the containing h:dataTable to generate appropriate output for each row.
37   * </p>
38   */
39  @JSFComponent
40  (name = "h:column",
41  clazz = "javax.faces.component.html.HtmlColumn",template=true,
42  tagClass = "org.apache.myfaces.taglib.html.HtmlColumnTag")
43  abstract class _HtmlColumn extends UIColumn
44  {
45  
46    static public final String COMPONENT_FAMILY = "javax.faces.Column";
47    static public final String COMPONENT_TYPE = "javax.faces.HtmlColumn";
48  
49    /**
50     * CSS class to be used for the header.
51     *
52     * @return  the new headerClass value
53     */
54    @JSFProperty
55    public abstract String getHeaderClass();
56  
57    /**
58     * CSS class to be used for the footer.
59     *
60     * @return  the new footerClass value
61     */
62    @JSFProperty
63    public abstract String getFooterClass();
64  
65  }