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.UIPanel;
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   * This element renders as an HTML table with specified number of columns.
28   * <p>
29   * Children of this element are rendered as cells in the table, filling
30   * rows from left to right.  Facets named "header" and "footer" are optional
31   * and specify the content of the thead and tfoot rows, respectively.
32   * </p>
33   */
34  @JSFComponent
35  (name = "h:panelGrid",
36  clazz = "javax.faces.component.html.HtmlPanelGrid",template=true,
37  tagClass = "org.apache.myfaces.taglib.html.HtmlPanelGridTag",
38  defaultRendererType = "javax.faces.Grid",
39  implementz = "javax.faces.component.behavior.ClientBehaviorHolder"
40  )
41  abstract class _HtmlPanelGrid extends UIPanel implements _EventProperties,
42  _StyleProperties, _UniversalProperties, _RoleProperty
43  {
44  
45    static public final String COMPONENT_FAMILY =
46      "javax.faces.Panel";
47    static public final String COMPONENT_TYPE =
48      "javax.faces.HtmlPanelGrid";
49  
50    /**
51     * HTML: The background color of this element.
52     * 
53     * @JSFProperty
54     */
55    public abstract String getBgcolor();
56  
57    /**
58     * CSV of several row index to start (and end a previous) tbody element
59     * 
60     * @since 2.0
61     */
62    @JSFProperty
63    public abstract String getBodyrows();
64    
65    /**
66     * HTML: Specifies the width of the border of this element, in pixels.  Deprecated in HTML 4.01.
67     * 
68     * @JSFProperty
69     *   defaultValue="Integer.MIN_VALUE"
70     */
71    public abstract int getBorder();
72  
73    /**
74     * HTML: Specifies the amount of empty space between the cell border and
75     * its contents.  It can be either a pixel length or a percentage.
76     * 
77     * @JSFProperty
78     */
79    public abstract String getCellpadding();
80  
81    /**
82     * HTML: Specifies the amount of space between the cells of the table.
83     * It can be either a pixel length or a percentage of available 
84     * space.
85     * 
86     * @JSFProperty
87     */
88    public abstract String getCellspacing();
89  
90    /**
91     * A comma separated list of CSS class names to apply to td elements in
92     * each column.
93     * 
94     * @JSFProperty
95     */
96    public abstract String getColumnClasses();
97  
98    /**
99     * Specifies the number of columns in the grid.
100    * 
101    * @JSFProperty
102    *   defaultValue="1"
103    */
104   public abstract int getColumns();
105 
106   /**
107    * The CSS class to be applied to footer cells.
108    * 
109    * @JSFProperty
110    */
111   public abstract String getFooterClass();
112 
113   /**
114    * HTML: Controls what part of the frame that surrounds a table is 
115    * visible.  Values include:  void, above, below, hsides, lhs, 
116    * rhs, vsides, box, and border.
117    * 
118    * @JSFProperty
119    */
120   public abstract String getFrame();
121 
122   /**
123    * The CSS class to be applied to header cells.
124    * 
125    * @JSFProperty
126    */
127   public abstract String getHeaderClass();
128 
129   /**
130    * A comma separated list of CSS class names to apply to td elements in
131    * each row.
132    * 
133    * @JSFProperty
134    */
135   public abstract String getRowClasses();
136 
137   /**
138    * HTML: Controls how rules are rendered between cells.  Values include:
139    * none, groups, rows, cols, and all.
140    * 
141    * @JSFProperty
142    */
143   public abstract String getRules();
144 
145   /**
146    * HTML: Provides a summary of the contents of the table, for
147    * accessibility purposes.
148    * 
149    * @JSFProperty
150    */
151   public abstract String getSummary();
152 
153   /**
154    * HTML: Specifies the desired width of the table, as a pixel length or
155    * a percentage of available space.
156    * 
157    * @JSFProperty
158    */
159   public abstract String getWidth();
160 
161   /**
162    * A comma separated list of CSS class names to apply to all captions.
163    * If there are less classes than the number of rows, apply the same
164    * sequence of classes to the remaining captions, so the pattern is repeated.
165    * More than one class can be applied to a row by separating the classes
166    * with a space.
167    *
168    * @return  the new captionClass value
169    */
170   @JSFProperty
171   public abstract String getCaptionClass();
172   
173   /**
174    * Gets The CSS class to be applied to the Caption.
175    *
176    * @return  the new captionStyle value
177    */
178   @JSFProperty
179   public abstract String getCaptionStyle();
180 
181 }