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   * <p>
35   * WARNING: This component is preliminary and may be changed without a major release.
36   * </p>
37   *
38   * Renders a SplitLayout.
39   * A area with two child components rendered horizontally or vertically and allows to change the
40   * layout relation of this two components on the client.
41   */
42  @Tag(name = "splitLayout")
43  @UIComponentTag(
44      uiComponent = "org.apache.myfaces.tobago.component.UISplitLayout",
45      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUISplitLayout",
46      componentFamily = AbstractUIGridLayout.COMPONENT_FAMILY,
47      rendererType = "SplitLayout",
48      allowedChildComponenents = "NONE")
49  public interface SplitLayoutTagDeclaration
50        extends HasId, HasSpacing, HasBinding, IsVisual {
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 {@link Orientation#horizontal} and {@link Orientation#vertical}.
64     */
65    @TagAttribute(required = true)
66    @UIComponentTagAttribute(
67        type = "org.apache.myfaces.tobago.layout.Orientation",
68        allowedValues = {Orientation.HORIZONTAL, Orientation.VERTICAL})
69    void setOrientation(String orientation);
70  
71    /**
72     * This attribute advises the layout manager, to not use space that comes from non rendered components.
73     */
74    @TagAttribute
75    @UIComponentTagAttribute(type = "boolean")
76    void setRigid(String rigid);
77  }