View Javadoc

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.tag.ui;
20  
21  import javax.faces.component.UIComponentBase;
22  
23  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFComponent;
24  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;
25  
26  /**
27   * Just like composition has decorate as a non-trimming version of the same behavior,
28   * component has fragment. This allows you to logically insert a UIComponent into the 
29   * tree and possibly bind this fragment to a JavaBean property or Map for management. 
30   * The fragment tag was also added to Facelets to get around some of the optimizations 
31   * used in handling text within your document. If you are using components such as 
32   * <f:panelGrid/>, which renders its children, you may want more control over the 
33   * building process that Facelets does and using a fragment tag will help guarantee 
34   * parent/child relationships for you.
35   * 
36   * <p>
37   * The component class used for this tag is 
38   * org.apache.myfaces.view.facelets.tag.ui.ComponentRef and the 
39   * real java class that contains this description is not used on runtime.
40   * </p>
41   */
42  @JSFComponent(
43          configExcluded=true,
44          defaultRendererType="javax.faces.resource.Script")
45  abstract class _Fragment extends UIComponentBase
46  {
47      public final static String COMPONENT_TYPE = "facelets.ui.ComponentRef";
48      public final static String COMPONENT_FAMILY = "facelets";
49  
50  
51      @JSFProperty(tagExcluded=true)
52      @Override
53      public boolean isRendered()
54      {
55          return super.isRendered();
56      }
57  }