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