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 org.apache.myfaces.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.view.facelets.FaceletContext;
27 import javax.faces.view.facelets.FaceletException;
28
29 /**
30 * FaceletHandlers can implement this contract and push themselves into the FaceletContext for participating in
31 * templating. Templates will attempt to resolve content for a specified name until one of the TemplatClients return
32 * 'true'.
33 *
34 * @author Jacob Hookom
35 * @version $Id$
36 */
37 public interface TemplateClient
38 {
39
40 /**
41 * This contract is much like the normal FaceletHandler.apply method, but it takes in an optional String name which
42 * tells this instance what fragment/definition it's looking for. If you are a match, apply your logic to the passed
43 * UIComponent and return true, otherwise do nothing and return false.
44 *
45 * @param ctx
46 * the FaceletContext of <i>your</i> instance, not the templates'
47 * @param parent
48 * current UIComponent instance to be applied
49 * @param name
50 * the String name or null if the whole body should be included
51 * @return true if this client matched/applied the definition for the passed name
52 * @throws IOException
53 * @throws FacesException
54 * @throws FaceletException
55 * @throws ELException
56 */
57 public boolean apply(FaceletContext ctx, UIComponent parent, String name) throws IOException, FacesException,
58 FaceletException, ELException;;
59 }