KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > myfaces > wap > def > DataTable


1 /*
2  * Copyright 2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.myfaces.wap.def;
17
18 /**
19  * Renders an WML table element. Render the "header" and a "footer" facet if is presented at least in one column. Header and footer is rendered as the first or the last row of the table. Each nested column element represents one column. Number of rows is determined by structure of value property.
20  *
21  * @wapfaces.tag
22  * componentFamily="UIData"
23  * rendererType="TableRenderer"
24  * tagName="dataTable"
25  * tagBaseClass="org.apache.myfaces.wap.base.ComponentTagBase"
26  * bodyContent="JSP"
27  *
28  * @author <a HREF="mailto:Jiri.Zaloudek@ivancice.cz">Jiri Zaloudek</a> (latest modification by $Author: matzew $)
29  * @version $Revision: 1.1 $ $Date: 2004/12/30 09:37:25 $
30  * $Log: DataTable.java,v $
31  * Revision 1.1 2004/12/30 09:37:25 matzew
32  * added a new RenderKit for WML. Thanks to Jirí Žaloudek
33  *
34  */
35
36
37 public class DataTable extends javax.faces.component.UIData {
38     
39 /**
40      * Aligns the text in a column. Specify a list of the align values, one for each column. Posible are values: "C", "L" or "R". Example: aling="RRCL" - the first column is align to right, second right, third center and the fourth column to left. Default aling is left.
41      *
42      * @wapfaces.attribute
43      * valueBinding="true"
44      */
45     java.lang.String JavaDoc align;
46     
47     /**
48      * The attribute styleClass affiliates an element with one or more classes. Multiple elements can be given the same styleClass name.
49      *
50      * @wapfaces.attribute
51      * valueBinding="true"
52      */
53     java.lang.String JavaDoc styleClass;
54
55     /**
56      * Sets a title for the table.
57      *
58      * @wapfaces.attribute
59      * valueBinding="true"
60      */
61     java.lang.String JavaDoc title;
62     
63     /**
64      * The xml:lang attribute specifies the natural or formal language of an element or its attributes.
65      *
66      * @wapfaces.attribute
67      * valueBinding="true"
68      */
69     java.lang.String JavaDoc xmllang;
70     
71     // ============= INHERIT ATTRIBUTES ======================================
72 /**
73      * Zero-relative row number of the first row to be displayed. If this property is set to zero, rendering will begin with the first row of the underlying data.
74      *
75      * @wapfaces.attribute
76      * inherit="true"
77      * valueBinding="true"
78      */
79     int first;
80     
81     /**
82      * The number of rows to display, starting with the one identified by the "first" property. If this value is set to zero, all available rows in the underlying data model will be displayed.
83      *
84      * @wapfaces.attribute
85      * inherit="true"
86      * valueBinding="true"
87      */
88     int rows;
89
90     /**
91      * Name of a request-scope attribute under which the model data for the row selected by the current value of the "rowIndex" property (i.e. also the current value of the "rowData" property) will be exposed.
92      *
93      * @wapfaces.attribute
94      * inherit="true"
95      * valueBinding="true"
96      */
97     java.lang.String JavaDoc var;
98     
99     /**
100      * The current value of this component.
101      *
102      * @wapfaces.attribute
103      * inherit="true"
104      * valueBinding="true"
105      */
106     java.lang.String JavaDoc value;
107     
108     // ============= ABSTARACT ATTRIBUTES ======================================
109 /**
110      * The component identifier for the associated component.
111      *
112      * @wapfaces.attribute
113      * abstract="true"
114      * inherit="true"
115      */
116     java.lang.String JavaDoc id;
117     
118     /**
119      * Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
120      *
121      * @wapfaces.attribute
122      * abstract="true"
123      * inherit="true"
124      */
125     boolean rendered;
126         
127     /**
128      * The value binding expression linking this component to a property in a backing bean.
129      *
130      * @wapfaces.attribute
131      * abstract="true"
132      * inherit="true"
133      */
134     java.lang.String JavaDoc binding;
135         
136 }
137
Popular Tags