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.renderkit.css.Style;
28  import org.apache.myfaces.tobago.internal.util.ArrayUtils;
29  import org.apache.myfaces.tobago.internal.util.StringUtils;
30  import org.apache.myfaces.tobago.internal.util.Deprecation;
31  import javax.el.ELException;
32  import javax.faces.FacesException;
33  import java.util.Arrays;
34  import java.util.ArrayList;
35  import java.util.Collection;
36  import java.util.List;
37  import javax.el.MethodExpression;
38  import javax.el.ValueExpression;
39  
40  /** 
41   Renders a UIComponent that represents a single column of data within a
42    parent UISheet component.
43    * UIComponent class, generated from template {@code component.stg} with class
44    * {@link org.apache.myfaces.tobago.internal.taglib.component.ColumnTagDeclaration}.
45   */
46  public class UIColumn
47      extends AbstractUIColumn implements ClientBehaviorHolder, Visual {
48  
49    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.Column";
50  
51    public static final String COMPONENT_FAMILY = "javax.faces.Column";
52  
53  
54    enum PropertyKeys {
55      markup,
56      resizable,
57      customClass,
58      tip,
59      style,
60      label,
61      sortable,
62      align,
63    }
64  
65    public String getFamily() {
66      return COMPONENT_FAMILY;
67    }
68  
69  
70    public org.apache.myfaces.tobago.context.Markup getMarkup() {
71      Object object = getStateHelper().eval(PropertyKeys.markup);
72      if (object != null) {
73        return Markup.valueOf(object);
74      }
75      return null;
76    }
77  
78    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
79      getStateHelper().put(PropertyKeys.markup, markup);
80    }
81  
82    /**
83    Flag indicating whether or not the width of this column in a sheet is resizable, by the user.
84    <br>Default: <code>true</code>
85    */
86    public boolean isResizable() {
87      Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.resizable);
88      if (bool != null) {
89        return bool;
90      }
91      return true;
92    }
93  
94    public void setResizable(boolean resizable) {
95      getStateHelper().put(PropertyKeys.resizable, resizable);
96    }
97  
98    /**
99    Sets a CSS class in its parent, if the parent supports it.
100 
101    Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
102 
103    <pre>
104    &lt;tc:in&gt;
105      &lt;tc:style customClass="my-emphasized"/&gt;
106    &lt;/tc:in&gt;
107    </pre>
108 
109    One capability is, to used external CSS libs.
110    <br>
111    This feature should not be used imprudent.
112    Because it might be unstable against changes in the renderered HTML code.
113 
114   */
115   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
116     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
117   }
118 
119   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
120     getStateHelper().put(PropertyKeys.customClass, customClass);
121   }
122 
123   /**
124   Text value to display as tooltip.
125 
126   */
127   public java.lang.String getTip() {
128     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
129   }
130 
131   public void setTip(java.lang.String tip) {
132     getStateHelper().put(PropertyKeys.tip, tip);
133   }
134 
135   /**
136   For internal use. Used for rendering, if there is a child tag &lt;tc:style&gt;
137 
138   */
139   public org.apache.myfaces.tobago.renderkit.css.Style getStyle() {
140     return (org.apache.myfaces.tobago.renderkit.css.Style) getStateHelper().eval(PropertyKeys.style);
141   }
142 
143   public void setStyle(org.apache.myfaces.tobago.renderkit.css.Style style) {
144     getStateHelper().put(PropertyKeys.style, style);
145   }
146 
147   /**
148   A localized user presentable label for this component.
149 
150   */
151   public java.lang.String getLabel() {
152     return (java.lang.String) getStateHelper().eval(PropertyKeys.label);
153   }
154 
155   public void setLabel(java.lang.String label) {
156     getStateHelper().put(PropertyKeys.label, label);
157   }
158 
159   /**
160   Flag indicating whether or not this column is sortable.
161    To make a column sortable the data of the sheet must be one of
162    <code>java.util.List</code> or <code>Object[]</code>.
163   <br>Default: <code>false</code>
164   */
165   public boolean isSortable() {
166     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.sortable);
167     if (bool != null) {
168       return bool;
169     }
170     return false;
171   }
172 
173   public void setSortable(boolean sortable) {
174     getStateHelper().put(PropertyKeys.sortable, sortable);
175   }
176 
177   /**
178   Alignment of this column.
179 
180   */
181   public java.lang.String getAlign() {
182     return (java.lang.String) getStateHelper().eval(PropertyKeys.align);
183   }
184 
185   public void setAlign(java.lang.String align) {
186     getStateHelper().put(PropertyKeys.align, align);
187   }
188 
189 
190 }