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.sandbox;
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.internal.component.AbstractUIGridLayout;
27  import org.apache.myfaces.tobago.internal.taglib.declaration.HasBinding;
28  import org.apache.myfaces.tobago.internal.taglib.declaration.HasBorder;
29  import org.apache.myfaces.tobago.internal.taglib.declaration.HasCurrentMarkup;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.HasId;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.HasMargin;
32  import org.apache.myfaces.tobago.internal.taglib.declaration.HasMargins;
33  import org.apache.myfaces.tobago.internal.taglib.declaration.HasMarkup;
34  import org.apache.myfaces.tobago.internal.taglib.declaration.HasSpacing;
35  
36    /**
37     * Renders a SplitLayout.
38     * A area with two child components rendered horizontally or vertically and allows to change the
39     * layout relation of this two components on the client.
40     */
41  @Tag(name = "splitLayout")
42  @UIComponentTag(
43      uiComponent = "org.apache.myfaces.tobago.component.UISplitLayout",
44      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUISplitLayout",
45      uiComponentFacesClass = "javax.faces.component.UIComponentBase",
46      componentFamily = AbstractUIGridLayout.COMPONENT_FAMILY,
47      rendererType = "SplitLayout",
48      allowedChildComponenents = "NONE", isLayout = true)
49  public interface SplitLayoutTagDeclaration extends HasId, HasBorder, HasSpacing, HasMargin,
50      HasMargins, HasBinding, HasMarkup, HasCurrentMarkup {
51  
52    /**
53     * This value defines the layout constraints for the layout.
54     * It is two layout tokens separated by a semicolon. See GridLayout.
55     * Example: '2*;*'.
56     */
57    @TagAttribute
58    @UIComponentTagAttribute(defaultValue = "1*;1*")
59    void setLayout(String rows);
60  
61    /**
62     * This value defines the orientation of the split layout.
63     * Possible values are 'HORIZONTAL' and 'VERTICAL'.
64     */
65  
66    @TagAttribute(required = true)
67    @UIComponentTagAttribute(allowedValues = {"HORIZONTAL", "VERTICAL"})
68    void setOrientation(String orientation);
69  
70    /**
71     * This attribute advises the layout manager, to not use space that comes from non rendered components.
72     */
73    @TagAttribute
74    @UIComponentTagAttribute(type = "boolean")
75    void setRigid(String rigid);
76  }