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  
20  package org.apache.myfaces.tobago.internal.taglib.component;
21  
22  import org.apache.myfaces.tobago.apt.annotation.Tag;
23  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
24  import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
25  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
26  import org.apache.myfaces.tobago.component.RendererTypes;
27  import org.apache.myfaces.tobago.internal.taglib.declaration.HasCurrentMarkup;
28  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
29  import org.apache.myfaces.tobago.internal.taglib.declaration.HasMarkup;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.IsGridLayoutComponent;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.IsGridLayoutContainer;
32  
33  import javax.faces.component.UIPanel;
34  
35  /**
36   * Renders a panel-like layout element with the ability to span over more than
37   * one layout cell. A cell may only contain one child.
38   * @deprecated The Cell is deprecated since Tobago 1.5.0
39   */
40  @Deprecated
41  @Tag(name = "cell")
42  @UIComponentTag(
43      uiComponent = "org.apache.myfaces.tobago.component.UICell",
44      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUICell",
45      uiComponentFacesClass = "javax.faces.component.UIPanel",
46      componentFamily = UIPanel.COMPONENT_FAMILY,
47      rendererType = RendererTypes.CELL)
48  public interface CellTagDeclaration 
49      extends HasIdBindingAndRendered, IsGridLayoutComponent, IsGridLayoutContainer, HasMarkup, HasCurrentMarkup {
50  
51    @UIComponentTagAttribute(
52        type = {"java.lang.Integer"},
53        defaultValue = "1")
54    void setColumnSpan(String columnSpan);
55  
56    @UIComponentTagAttribute(
57        type = {"java.lang.Integer"},
58        defaultValue = "1")
59    void setRowSpan(String rowSpan);
60  
61    /**
62     * Count of layout columns to span over.
63     */
64    @TagAttribute
65    @UIComponentTagAttribute(
66        type = {"java.lang.Integer"},
67        defaultValue = "1",
68        generate = false)
69    void setSpanX(String spanX);
70  
71    /**
72     * Count of layout rows to span over.
73     */
74    @TagAttribute
75    @UIComponentTagAttribute(
76        type = {"java.lang.Integer"},
77        defaultValue = "1",
78    generate = false)
79    void setSpanY(String spanY);
80  
81    /**
82     * possible values are:
83     * <ul>
84     * <li>'false' : no scrollbars should be rendered</li>
85     * <li>'true'  : scrollbars should always be rendered</li>
86     * <li>'auto'  : scrollbars should be rendered when needed</li>
87     * </ul>
88     */
89    @TagAttribute
90    @UIComponentTagAttribute(defaultValue = "false",
91        allowedValues = {"false", "true", "auto"})
92    void setScrollbars(String scrollbars);
93  }