1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36
37 package javax.faces.component;
38
39
40 /**
41 * <p><strong>UIColumn</strong> is a {@link UIComponent} that represents
42 * a single column of data within a parent {@link UIData} component.</p>
43 */
44
45 public class UIColumn extends UIComponentBase {
46
47
48 // ------------------------------------------------------ Manifest Constants
49
50
51 /**
52 * <p>The standard component type for this component.</p>
53 */
54 public static final String COMPONENT_TYPE = "javax.faces.Column";
55
56
57 /**
58 * <p>The standard component family for this component.</p>
59 */
60 public static final String COMPONENT_FAMILY = "javax.faces.Column";
61
62
63 // ----------------------------------------------------------- Constructors
64
65
66 /**
67 * <p>Create a new {@link UIColumn} instance with default property
68 * values.</p>
69 */
70 public UIColumn() {
71
72 super();
73 setRendererType(null);
74
75 }
76
77
78 // -------------------------------------------------------------- Properties
79
80
81 public String getFamily() {
82
83 return (COMPONENT_FAMILY);
84
85 }
86
87
88 /**
89 * <p>Return the footer facet of the column (if any). A convenience
90 * method for <code>getFacet("footer")</code>.</p>
91 */
92 public UIComponent getFooter() {
93
94 return getFacet("footer");
95
96 }
97
98
99 /**
100 * <p>Set the footer facet of the column. A convenience
101 * method for <code>getFacets().put("footer", footer)</code>.</p>
102 *
103 * @param footer the new footer facet
104 *
105 * @throws NullPointerException if <code>footer</code> is
106 * <code>null</code>
107 */
108 public void setFooter(UIComponent footer) {
109
110 getFacets().put("footer", footer);
111
112 }
113
114
115 /**
116 * <p>Return the header facet of the column (if any). A convenience
117 * method for <code>getFacet("header")</code>.</p>
118 */
119 public UIComponent getHeader() {
120
121 return getFacet("header");
122
123 }
124
125
126 /**
127 * <p>Set the header facet of the column. A convenience
128 * method for <code>getFacets().put("header", header)</code>.</p>
129 *
130 * @param header the new header facet
131 *
132 * @throws NullPointerException if <code>header</code> is
133 * <code>null</code>
134 */
135 public void setHeader(UIComponent header) {
136
137 getFacets().put("header", header);
138
139 }
140
141
142 }