Source code: com/sun/facelets/Facelet.java
1 /**
2 * Licensed under the Common Development and Distribution License,
3 * you may not use this file except in compliance with the License.
4 * You may obtain a copy of the License at
5 *
6 * http://www.sun.com/cddl/
7 *
8 * Unless required by applicable law or agreed to in writing, software
9 * distributed under the License is distributed on an "AS IS" BASIS,
10 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11 * implied. See the License for the specific language governing
12 * permissions and limitations under the License.
13 */
14
15 package com.sun.facelets;
16
17 import java.io.IOException;
18
19 import javax.el.ELException;
20 import javax.faces.FacesException;
21 import javax.faces.component.UIComponent;
22 import javax.faces.context.FacesContext;
23
24 /**
25 * The parent or root object in a FaceletHandler composition. The Facelet will
26 * take care of populating the passed UIComponent parent in relation to the
27 * create/restore lifecycle of JSF.
28 *
29 * @author Jacob Hookom
30 * @version $Id: Facelet.java,v 1.2 2005/08/24 04:38:58 jhook Exp $
31 */
32 public abstract class Facelet {
33
34 /**
35 * The passed UIComponent parent will be populated/restored in accordance
36 * with the JSF 1.2 specification.
37 *
38 * @param facesContext
39 * The current FacesContext (Should be the same as
40 * FacesContext.getInstance())
41 * @param parent
42 * The UIComponent to populate in a compositional fashion. In
43 * most cases a Facelet will be base a UIViewRoot.
44 * @throws IOException
45 * @throws FacesException
46 * @throws FaceletException
47 * @throws ELException
48 */
49 public abstract void apply(FacesContext facesContext, UIComponent parent)
50 throws IOException, FacesException, FaceletException, ELException;
51 }