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.Facet;
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.component.Facets;
28  import org.apache.myfaces.tobago.component.RendererTypes;
29  import org.apache.myfaces.tobago.internal.taglib.declaration.HasCurrentMarkup;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.HasLabel;
32  import org.apache.myfaces.tobago.internal.taglib.declaration.HasMarkup;
33  import org.apache.myfaces.tobago.internal.taglib.declaration.HasTip;
34  import org.apache.myfaces.tobago.internal.taglib.declaration.IsGridLayoutContainer;
35  
36  import javax.faces.component.UIColumn;
37  
38  /**
39   * Renders a UIComponent that represents a single column of data within a
40   * parent UISheet component.
41   */
42  @Tag(name = "column")
43  @UIComponentTag(
44      uiComponent = "org.apache.myfaces.tobago.component.UIColumn",
45      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUIColumn",
46      uiComponentFacesClass = "javax.faces.component.UIColumn",
47      componentFamily = UIColumn.COMPONENT_FAMILY,
48      rendererType = RendererTypes.COLUMN,
49      facets = {
50          @Facet(name = Facets.DROP_DOWN_MENU, description = "Contains a UIMenu instance to render a drop down menu.",
51              allowedChildComponenents = "org.apache.myfaces.tobago.Menu")
52      })
53  public interface ColumnTagDeclaration
54      extends HasIdBindingAndRendered, HasLabel, HasTip, HasMarkup, HasCurrentMarkup, IsGridLayoutContainer {
55    /**
56     * Alignment of this column.
57     */
58    @TagAttribute
59    @UIComponentTagAttribute()
60    void setAlign(String align);
61  
62    /**
63     * Flag indicating whether or not this column is sortable.
64     * To make a column sortable the data of the sheet must be one of
65     * <code>java.util.List</code> or <code>Object[]</code>.
66     */
67    @TagAttribute
68    @UIComponentTagAttribute(type = {"boolean"}, defaultValue = "false")
69    void setSortable(String sortable);
70  
71    /**
72     * Flag indicating whether or not the width of this column in a sheet is resizable, by the user.
73     */
74    @TagAttribute
75    @UIComponentTagAttribute(type = {"boolean"}, defaultValue = "true")
76    void setResizable(String resizable);
77  
78    /**
79     * The layout token for this column.
80     * Allowd layout tokens ('*', '&lt;x>*', '&lt;x>px' or '&lt;x>%').
81     * Where '*' is equivalent to '1*'.
82     */
83    @TagAttribute
84    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure")
85    void setWidth(String width);
86  }