org.apache.myfaces.view.facelets
Class Facelet

java.lang.Object
  org.apache.myfaces.view.facelets.Facelet

Direct Known Subclasses:

AbstractFacelet

public abstract class Facelet
extends java.lang.Object

The parent or root object in a FaceletHandler composition. The Facelet will take care of populating the passed UIComponent parent in relation to the create/restore lifecycle of JSF.

Version:

$Id: Facelet.java,v 1.3 2008/07/13 19:01:40 rlubke Exp $

Author:

Jacob Hookom

Constructor Summary

Facelet()

Method Summary

abstract void

apply(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent parent) The passed UIComponent parent will be populated/restored in accordance with the JSF 1.2 specification.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Facelet

public Facelet()

Method Detail

apply

public abstract void apply(javax.faces.context.FacesContext facesContext,
                           javax.faces.component.UIComponent parent)
                    throws java.io.IOException,
                           javax.faces.FacesException,
                           javax.faces.view.facelets.FaceletException,
                           javax.el.ELException

The passed UIComponent parent will be populated/restored in accordance with the JSF 1.2 specification.

Parameters:

facesContext - The current FacesContext (Should be the same as FacesContext.getInstance())

parent - The UIComponent to populate in a compositional fashion. In most cases a Facelet will be base a UIViewRoot.

Throws:

java.io.IOException

javax.faces.FacesException

javax.faces.view.facelets.FaceletException

javax.el.ELException