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 javax.faces.component.html;
20  
21  import javax.faces.component.UIPanel;
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   * This element is used to group other components where the specification requires one child element.
28   * 
29   * If any of the HTML or CSS attributes are set, its content is rendered within a span element.
30   */
31  @JSFComponent
32  (name = "h:panelGroup",
33  clazz = "javax.faces.component.html.HtmlPanelGroup",template=true,
34  tagClass = "org.apache.myfaces.taglib.html.HtmlPanelGroupTag",
35  defaultRendererType = "javax.faces.Group"
36  )
37  abstract class _HtmlPanelGroup extends UIPanel implements _StyleProperties
38  {
39  
40    static public final String COMPONENT_FAMILY =
41      "javax.faces.Panel";
42    static public final String COMPONENT_TYPE =
43      "javax.faces.HtmlPanelGroup";
44  
45    /**
46     * The type of layout markup to use when rendering this group. If the value is "block"
47     * the renderer must produce an HTML "div" element. Otherwise HTML "span" element must be produced.
48     *
49     * @return  the new layout value
50     */
51    @JSFProperty
52    public abstract String getLayout();
53  
54  }