UIColumn.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.faces.component;

/**
 * <p>
 * <strong>UIColumn</strong> is a {@link UIComponent} that represents a single column of data within
 * a parent {@link UIData} component.
 * </p>
 */
public class UIColumn extends UIComponentBase {

    // ------------------------------------------------------ Manifest Constants

    /**
     * <p>
     * The standard component type for this component.
     * </p>
     */
    public static final String COMPONENT_TYPE = "javax.faces.Column";

    /**
     * <p>
     * The standard component family for this component.
     * </p>
     */
    public static final String COMPONENT_FAMILY = "javax.faces.Column";

    
    // ----------------------------------------------------------- Constructors

    /**
     * <p>
     * Create a new {@link UIColumn} instance with default property values.
     * </p>
     */
    public UIColumn() {
        super();
        setRendererType(null);
    }
    

    // -------------------------------------------------------------- Properties

    /**
     * Get the component family.
     * 
     * @return the component family.
     */
    @Override
    public String getFamily() {
        return COMPONENT_FAMILY;
    }

    /**
     * <p>
     * Return the footer facet of the column (if any). A convenience method for
     * <code>getFacet("footer")</code>.
     * </p>
     * 
     * @return the footer component.
     */
    public UIComponent getFooter() {
        return getFacet("footer");
    }

    /**
     * <p>
     * Set the footer facet of the column. A convenience method for
     * <code>getFacets().put("footer", footer)</code>.
     * </p>
     * 
     * @param footer the new footer facet
     * 
     * @throws NullPointerException if <code>footer</code> is <code>null</code>
     */
    public void setFooter(UIComponent footer) {
        getFacets().put("footer", footer);
    }

    /**
     * <p>
     * Return the header facet of the column (if any). A convenience method for
     * <code>getFacet("header")</code>.
     * </p>
     * 
     * @return the header component.
     */
    public UIComponent getHeader() {
        return getFacet("header");
    }

    /**
     * <p>
     * Set the header facet of the column. A convenience method for
     * <code>getFacets().put("header", header)</code>.
     * </p>
     * 
     * @param header the new header facet
     * 
     * @throws NullPointerException if <code>header</code> is <code>null</code>
     */
    public void setHeader(UIComponent header) {
        getFacets().put("header", header);
    }

}