1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package javax.faces.view.facelets;
20
21 import java.io.IOException;
22
23 import javax.el.ELException;
24 import javax.faces.FacesException;
25 import javax.faces.component.UIComponent;
26 import javax.faces.context.FacesContext;
27
28 /**
29 * The parent or root object in a FaceletHandler composition. The Facelet will take care of populating the passed
30 * UIComponent parent in relation to the create/restore lifecycle of JSF.
31 */
32 public abstract class Facelet
33 {
34
35 /**
36 * The passed UIComponent parent will be populated/restored in accordance with the JSF 1.2 specification.
37 *
38 * @param facesContext
39 * The current FacesContext (Should be the same as FacesContext.getInstance())
40 * @param parent
41 * The UIComponent to populate in a compositional fashion. In most cases a Facelet will be base a
42 * UIViewRoot.
43 * @throws IOException
44 * @throws FacesException
45 * @throws FaceletException
46 * @throws ELException
47 */
48 public abstract void apply(FacesContext facesContext, UIComponent parent) throws IOException, FacesException,
49 FaceletException, ELException;
50 }