com.sun.facelets.TemplateClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsf-facelets Show documentation
Show all versions of jsf-facelets Show documentation
Facelets is an open source alternative view handler technology for JavaServer Faces (JSF).
The newest version!
/**
* Licensed under the Common Development and Distribution License,
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.sun.com/cddl/
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.sun.facelets;
import java.io.IOException;
import javax.el.ELException;
import javax.faces.FacesException;
import javax.faces.component.UIComponent;
/**
* FaceletHandlers can implement this contract and push themselves into the
* FaceletContext for participating in templating. Templates will attempt to
* resolve content for a specified name until one of the TemplatClients return
* 'true'.
*
* @author Jacob Hookom
* @version $Id: TemplateClient.java,v 1.2 2006/03/29 04:10:11 jhook Exp $
*/
public interface TemplateClient {
/**
* This contract is much like the normal FaceletHandler.apply method, but it
* takes in an optional String name which tells this instance what
* fragment/definition it's looking for. If you are a match, apply your
* logic to the passed UIComponent and return true, otherwise do nothing and
* return false.
*
* @param ctx
* the FaceletContext of your instance, not the
* templates'
* @param parent
* current UIComponent instance to be applied
* @param name
* the String name or null if the whole body should be included
* @return true if this client matched/applied the definition for the passed
* name
* @throws IOException
* @throws FacesException
* @throws FaceletException
* @throws ELException
*/
public boolean apply(FaceletContext ctx, UIComponent parent, String name)
throws IOException, FacesException, FaceletException, ELException;;
}