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