com.sun.jsftemplating.layout.descriptors.LayoutInsert Maven / Gradle / Ivy

Go to download
/*
 * The contents of this file are subject to the terms 
 * of the Common Development and Distribution License 
 * (the License).  You may not use this file except in
 * compliance with the License.
 * 
 * You can obtain a copy of the license at 
 * https://jsftemplating.dev.java.net/cddl1.html or
 * jsftemplating/cddl1.txt.
 * See the License for the specific language governing 
 * permissions and limitations under the License.
 * 
 * When distributing Covered Code, include this CDDL 
 * Header Notice in each file and include the License file 
 * at jsftemplating/cddl1.txt.  
 * If applicable, add the following below the CDDL Header, 
 * with the fields enclosed by brackets [] replaced by
 * you own identifying information: 
 * "Portions Copyrighted [year] [name of copyright owner]"
 * 
 * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
 */
package com.sun.jsftemplating.layout.descriptors;

import com.sun.jsftemplating.layout.event.EncodeEvent;

import java.io.IOException;

import java.util.Iterator;
import java.util.List;
import java.util.Stack;

import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;


/**
 *  	This class represents a ui:insert.
 *
 *  @author Jason Lee
 *  @author Ken Paulsen ([email protected])
 */
public class LayoutInsert extends LayoutElementBase {
    private static final long serialVersionUID = 1L;
    private String name;

    /**
     * @param parent
     * @param id
     */
    public LayoutInsert(LayoutElement parent, String id) {
	super(parent, id);
    }

    /**
     *	 Returns the name of the {@link LayoutDefine} to look for when
     *	    including content for this LayoutInsert.  This value
     *	    may be null to indicate that it should use its body
     *	    content.
     */
    public String getName() {
	return name;
    }

    /**
     *	 Sets the name of the {@link LayoutDefine} to look for when including
     *	    content for this LayoutInsert.  This value may be
     *	    null to indicate that it should use its body content.
     */
    public void setName(String name) {
	this.name = name;
    }

    /**
     *   This method is override to enable searching of its content via the
     *	    name of this insert (if supplied), or the rendering of its body if
     *	    not supplied, or not found.  If this is encountered outside the
     *	    context of a composition, it will render its body content also.
     *
     * @see LayoutElementBase#encodeThis(javax.faces.context.FacesContext, javax.faces.component.UIComponent)
     */
    @Override
    protected boolean encodeThis(FacesContext context, UIComponent component) throws IOException {
	Stack stack =
	    LayoutComposition.getCompositionStack(context);
	if (stack.empty()) {
	    // Render whatever is inside the insert
	    return true;
	}

	// Get assoicated UIComposition
	String name = getName();
	if (name == null) {
	    encodeChildren(context, component, stack.get(0));
	} else {
	    // First resolve any EL in the insertName
	    name = "" + resolveValue(context, component, name);

	    // Search for specific LayoutDefine
	    LayoutElement def = LayoutInsert.findLayoutDefine(
		    context, component, stack, name);
	    if (def == null) {
		// Render whatever is inside the insert
		return true;
	    } else {
		// Found ui:define, render it
		encodeChildren(context, component, def);
	    }
	}
	return false; // Already rendered it
    }

    /**
     *	 Encode the appropriate children...
     */
    private void encodeChildren(FacesContext context, UIComponent component, LayoutElement parentElt) throws IOException {
	// Fire an encode event
	dispatchHandlers(context, ENCODE, new EncodeEvent(component));

	// Iterate over children
	LayoutElement childElt = null;
	Iterator it = parentElt.getChildLayoutElements().iterator();
	while (it.hasNext()) {
	    childElt = it.next();
	    childElt.encode(context, component);
	}
    }

    /**
     *	 This method searches the given the entire stack for a
     *	    {@link LayoutDefine} with the given name.
     */
    public static LayoutDefine findLayoutDefine(FacesContext context, UIComponent parent, List eltList, String name) {
	Iterator stackIt = eltList.iterator();
	LayoutDefine define = null;
	while (stackIt.hasNext()) {
	    define = findLayoutDefine(context, parent, stackIt.next(), name);
	    if (define != null) {
		return define;
	    }
	}

	// Not found!
	return null;
    }

    /**
     *	 This method searches the given {@link LayoutElement} for a
     *	    {@link LayoutDefine} with the given name.
     */
    private static LayoutDefine findLayoutDefine(FacesContext context, UIComponent parent, LayoutElement elt, String name) {
	Iterator it = elt.getChildLayoutElements().iterator();
	LayoutElement def = null;
	while (it.hasNext()) {
	    def = it.next();
	    if ((def instanceof LayoutDefine) && def.
		    getId(context, parent).equals(name)) {
		// We found what we're looking for...
		return (LayoutDefine) def;
	    }
	}

	// We still haven't found it, search the child LayoutElements
	it = elt.getChildLayoutElements().iterator();
	while (it.hasNext()) {
	    def = findLayoutDefine(context, parent, it.next(), name);
	    if (def != null) {
		return (LayoutDefine) def;
	    }
	}

	// Not found!
	return null;
    }
}