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.component.AbstractUIFlowLayout;
28  import org.apache.myfaces.tobago.internal.taglib.declaration.HasBinding;
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.layout.TextAlign;
35  
36  /**
37   * XXX Warning: Still in progress! Please do not use it until other announcement.
38   * Renders a FlowLayout that positions the content components in there natural order.
39   */
40  @Tag(name = "flowLayout")
41  @UIComponentTag(
42      uiComponent = "org.apache.myfaces.tobago.component.UIFlowLayout",
43      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUIFlowLayout",
44      uiComponentFacesClass = "javax.faces.component.UIComponentBase",
45      componentFamily = AbstractUIFlowLayout.COMPONENT_FAMILY,
46      rendererType = RendererTypes.FLOW_LAYOUT,
47      allowedChildComponenents = "NONE", isLayout = true)
48  public interface FlowLayoutTagDeclaration
49      extends HasId,
50      /*HasSpacing, TODO*/
51      HasMargin, HasMargins, /*todo: do we need the margin here? Or should be use the margin from the container? */ 
52      HasBinding, HasMarkup, HasCurrentMarkup {
53  
54    /**
55     * The alignment of the elements inside of the container, possible values are:
56     * {@value TextAlign#STRING_LEFT},
57     * {@value TextAlign#STRING_RIGHT},
58     * {@value TextAlign#STRING_CENTER} und
59     * {@value TextAlign#STRING_JUSTIFY}.
60     */
61    @TagAttribute
62    @UIComponentTagAttribute(
63        type = {"org.apache.myfaces.tobago.layout.TextAlign"},
64        defaultValue = "TextAlign.LEFT",
65        allowedValues = {
66            TextAlign.STRING_LEFT, TextAlign.STRING_RIGHT, TextAlign.STRING_CENTER, TextAlign.STRING_JUSTIFY})
67    void setTextAlign(String textAlign);
68  }