01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package com.sun.rave.web.ui.component;
42:
43: import com.sun.rave.web.ui.component.util.descriptors.LayoutComponent;
44: import com.sun.rave.web.ui.component.util.descriptors.LayoutDefinition;
45:
46: import javax.faces.component.NamingContainer;
47: import javax.faces.component.UIComponent;
48: import javax.faces.context.FacesContext;
49:
50: /**
51: * <P> This interface defines additional methods in addition to those defined
52: * by UIComponent that are needed to work with a TemplateRenderer.</P>
53: *
54: * <P> JSF did not define an interface for UIComponent, so I cannot extend an
55: * interface here. This means that casting is needed to use UIComponent
56: * features from a TemplateComponent.</P>
57: *
58: * @author Ken Paulsen (ken.paulsen@sun.com)
59: */
60: public interface TemplateComponent extends ChildManager,
61: NamingContainer {
62:
63: /**
64: * This method will find the request child UIComponent by id. If it is
65: * not found, it will attempt to create it if it can find a LayoutElement
66: * describing it.
67: *
68: * @param context The FacesContext
69: * @param id The UIComponent id to search for
70: *
71: * @return The requested UIComponent
72: */
73: public UIComponent getChild(FacesContext context, String id);
74:
75: /**
76: * This method returns the LayoutDefinition associated with this component.
77: *
78: * @param context The FacesContext
79: *
80: * @return LayoutDefinition associated with this component.
81: */
82: public LayoutDefinition getLayoutDefinition(FacesContext context);
83:
84: /**
85: * This method returns the LayoutDefinitionKey for this component.
86: *
87: * @return key The key to use in the LayoutDefinitionManager
88: */
89: public String getLayoutDefinitionKey();
90:
91: /**
92: * This method sets the LayoutDefinition key for this component.
93: *
94: * @param key The key to use in the LayoutDefinitionManager
95: */
96: public void setLayoutDefinitionKey(String key);
97: }
|