View Javadoc
1   // ---------- Attention: Generated code, please do not modify! -----------  
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one or more
5    * contributor license agreements.  See the NOTICE file distributed with
6    * this work for additional information regarding copyright ownership.
7    * The ASF licenses this file to You under the Apache License, Version 2.0
8    * (the "License"); you may not use this file except in compliance with
9    * the License.  You may obtain a copy of the License at
10   *
11   *      http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  
20  package org.apache.myfaces.tobago.component;
21  
22  import javax.faces.component.behavior.ClientBehaviorHolder;
23  import javax.faces.context.FacesContext;
24  import org.apache.myfaces.tobago.context.Markup;
25  import org.apache.myfaces.tobago.internal.component.AbstractUIColumn;
26  import org.apache.myfaces.tobago.renderkit.css.CustomClass;
27  import org.apache.myfaces.tobago.internal.util.ArrayUtils;
28  import org.apache.myfaces.tobago.internal.util.StringUtils;
29  import org.apache.myfaces.tobago.internal.util.Deprecation;
30  import javax.el.ELException;
31  import javax.faces.FacesException;
32  import java.util.Arrays;
33  import java.util.ArrayList;
34  import java.util.Collection;
35  import java.util.List;
36  import javax.el.MethodExpression;
37  import javax.el.ValueExpression;
38  
39  /** 
40   Renders a UIComponent that represents a single column of data within a
41    parent UISheet component.
42    * UIComponent class, generated from template {@code component.stg} with class
43    * {@link org.apache.myfaces.tobago.internal.taglib.component.ColumnTagDeclaration}.
44   */
45  public class UIColumn
46      extends AbstractUIColumn implements ClientBehaviorHolder, Visual {
47  
48    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.Column";
49  
50    public static final String COMPONENT_FAMILY = "javax.faces.Column";
51  
52  
53    enum PropertyKeys {
54      markup,
55      resizable,
56      customClass,
57      tip,
58      label,
59      sortable,
60      align,
61    }
62  
63    public String getFamily() {
64      return COMPONENT_FAMILY;
65    }
66  
67  
68    public org.apache.myfaces.tobago.context.Markup getMarkup() {
69      Object object = getStateHelper().eval(PropertyKeys.markup);
70      if (object != null) {
71        return Markup.valueOf(object);
72      }
73      return null;
74    }
75  
76    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
77      getStateHelper().put(PropertyKeys.markup, markup);
78    }
79  
80    /**
81    Flag indicating whether or not the width of this column in a sheet is resizable, by the user.
82    <br>Default: <code>true</code>
83    */
84    public boolean isResizable() {
85      Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.resizable);
86      if (bool != null) {
87        return bool;
88      }
89      return true;
90    }
91  
92    public void setResizable(boolean resizable) {
93      getStateHelper().put(PropertyKeys.resizable, resizable);
94    }
95  
96    /**
97    Sets a CSS class in its parent, if the parent supports it.
98  
99     Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
100 
101    <pre>
102    &lt;tc:in&gt;
103      &lt;tc:style customClass="my-emphasized"/&gt;
104    &lt;/tc:in&gt;
105    </pre>
106 
107    One capability is, to used external CSS libs.
108    <br>
109    This feature should not be used imprudent.
110    Because it might be unstable against changes in the renderered HTML code.
111 
112   */
113   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
114     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
115   }
116 
117   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
118     getStateHelper().put(PropertyKeys.customClass, customClass);
119   }
120 
121   /**
122   Text value to display as tooltip.
123 
124   */
125   public java.lang.String getTip() {
126     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
127   }
128 
129   public void setTip(java.lang.String tip) {
130     getStateHelper().put(PropertyKeys.tip, tip);
131   }
132 
133   /**
134   A localized user presentable label for this component.
135 
136   */
137   public java.lang.String getLabel() {
138     return (java.lang.String) getStateHelper().eval(PropertyKeys.label);
139   }
140 
141   public void setLabel(java.lang.String label) {
142     getStateHelper().put(PropertyKeys.label, label);
143   }
144 
145   /**
146   Flag indicating whether or not this column is sortable.
147    To make a column sortable the data of the sheet must be one of
148    <code>java.util.List</code> or <code>Object[]</code>.
149   <br>Default: <code>false</code>
150   */
151   public boolean isSortable() {
152     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.sortable);
153     if (bool != null) {
154       return bool;
155     }
156     return false;
157   }
158 
159   public void setSortable(boolean sortable) {
160     getStateHelper().put(PropertyKeys.sortable, sortable);
161   }
162 
163   /**
164   Alignment of this column.
165 
166   */
167   public java.lang.String getAlign() {
168     return (java.lang.String) getStateHelper().eval(PropertyKeys.align);
169   }
170 
171   public void setAlign(java.lang.String align) {
172     getStateHelper().put(PropertyKeys.align, align);
173   }
174 
175 
176 }