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