jakarta.faces.component.UIColumn Maven / Gradle / Ivy
Show all versions of jakarta.faces Show documentation
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.faces.component;
/**
*
* UIColumn is a {@link UIComponent} that represents a single column of data within a parent
* {@link UIData} component.
*
*/
public class UIColumn extends UIComponentBase {
// ------------------------------------------------------ Manifest Constants
/**
*
* The standard component type for this component.
*
*/
public static final String COMPONENT_TYPE = "jakarta.faces.Column";
/**
*
* The standard component family for this component.
*
*/
public static final String COMPONENT_FAMILY = "jakarta.faces.Column";
// ----------------------------------------------------------- Constructors
/**
*
* Create a new {@link UIColumn} instance with default property values.
*
*/
public UIColumn() {
super();
setRendererType(null);
}
// -------------------------------------------------------------- Properties
/**
* Get the component family.
*
* @return the component family.
*/
@Override
public String getFamily() {
return COMPONENT_FAMILY;
}
/**
*
* Return the footer facet of the column (if any). A convenience method for getFacet("footer").
*
*
* @return the footer component.
*/
public UIComponent getFooter() {
return getFacet("footer");
}
/**
*
* Set the footer facet of the column. A convenience method for getFacets().put("footer", footer).
*
*
* @param footer the new footer facet
*
* @throws NullPointerException if footer is null
*/
public void setFooter(UIComponent footer) {
getFacets().put("footer", footer);
}
/**
*
* Return the header facet of the column (if any). A convenience method for getFacet("header").
*
*
* @return the header component.
*/
public UIComponent getHeader() {
return getFacet("header");
}
/**
*
* Set the header facet of the column. A convenience method for getFacets().put("header", header).
*
*
* @param header the new header facet
*
* @throws NullPointerException if header is null
*/
public void setHeader(UIComponent header) {
getFacets().put("header", header);
}
}