1 /*
2 * $Id: FacetTag.java,v 1.18 2007/04/27 22:00:11 ofung Exp $
3 */
4
5 /*
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
7 *
8 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
9 *
10 * The contents of this file are subject to the terms of either the GNU
11 * General Public License Version 2 only ("GPL") or the Common Development
12 * and Distribution License("CDDL") (collectively, the "License"). You
13 * may not use this file except in compliance with the License. You can obtain
14 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
15 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
16 * language governing permissions and limitations under the License.
17 *
18 * When distributing the software, include this License Header Notice in each
19 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
20 * Sun designates this particular file as subject to the "Classpath" exception
21 * as provided by Sun in the GPL Version 2 section of the License file that
22 * accompanied this code. If applicable, add the following below the License
23 * Header, with the fields enclosed by brackets [] replaced by your own
24 * identifying information: "Portions Copyrighted [year]
25 * [name of copyright owner]"
26 *
27 * Contributor(s):
28 *
29 * If you wish your version of this file to be governed by only the CDDL or
30 * only the GPL Version 2, indicate your decision by adding "[Contributor]
31 * elects to include this software in this distribution under the [CDDL or GPL
32 * Version 2] license." If you don't indicate a single choice of license, a
33 * recipient has the option to distribute your version of this file under
34 * either the CDDL, the GPL Version 2 or to extend the choice of license to
35 * its licensees as provided above. However, if you add GPL Version 2 code
36 * and therefore, elected the GPL Version 2 license, then the option applies
37 * only if the new code is made subject to such option by the copyright
38 * holder.
39 */
40
41 package javax.faces.webapp;
42
43
44 import javax.servlet.jsp.JspException;
45 import javax.servlet.jsp.tagext.TagSupport;
46
47
48 /**
49 * <p><strong>FacetTag</strong> is the JSP mechanism for denoting a
50 * {@link javax.faces.component.UIComponent} is to be added as a
51 * <code>facet</code> to the component associated with its parent.</p>
52 *
53 * <p>A <strong>FacetTag</strong> must have one and only one
54 * child. This child must be a {@link UIComponentTag} instance representing
55 * a single {@link javax.faces.component.UIComponent} instance.</p>
56 */
57
58 public class FacetTag extends TagSupport {
59
60
61 // -------------------------------------------------------------- Properties
62
63
64 /**
65 * <p>The name of this facet. This will be used as the facet name for
66 * our <code>UIComponentTag</code> child in our <code>UIComponentTag</code>
67 * parent's facet list.</p>
68 */
69 private String name = null;
70
71
72 /**
73 * <p>Return the name to be assigned to this facet.</p>
74 */
75 public String getName() {
76
77 return (name);
78
79 }
80
81
82 /**
83 * <p>Set the name to be assigned to this facet.</p>
84 *
85 * @param name The new facet name
86 */
87 public void setName(String name) {
88
89 this.name = name;
90
91 }
92
93
94 // ------------------------------------------------------------- Tag Methods
95
96
97 /**
98 * <p>Release any resources allocated by this tag instance.
99 */
100 public void release() {
101
102 super.release();
103 this.name = null;
104
105 }
106
107
108 /**
109 * <p>Return <code>EVAL_BODY_INCLUDE</code> to cause nested body
110 * content to be evaluated.</p>
111 */
112 public int doStartTag() throws JspException {
113
114 return (EVAL_BODY_INCLUDE);
115
116 }
117
118 }
Save This Page