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