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