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.context.FacesContext;
23  import org.apache.myfaces.tobago.context.Markup;
24  import org.apache.myfaces.tobago.internal.component.AbstractUIColumn;
25  import org.apache.myfaces.tobago.renderkit.css.CustomClass;
26  import org.apache.myfaces.tobago.renderkit.css.Style;
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 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      style,
59      label,
60      sortable,
61      align,
62    }
63  
64    public String getFamily() {
65      return COMPONENT_FAMILY;
66    }
67  
68  
69    public org.apache.myfaces.tobago.context.Markup getMarkup() {
70      Object object = getStateHelper().eval(PropertyKeys.markup);
71      if (object != null) {
72        return Markup.valueOf(object);
73      }
74      return null;
75    }
76  
77    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
78      getStateHelper().put(PropertyKeys.markup, markup);
79    }
80  
81    /**
82    Flag indicating whether or not the width of this column in a sheet is resizable, by the user.
83    <br>Default: <code>true</code>
84    */
85    public boolean isResizable() {
86      Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.resizable);
87      if (bool != null) {
88        return bool;
89      }
90      return true;
91    }
92  
93    public void setResizable(boolean resizable) {
94      getStateHelper().put(PropertyKeys.resizable, resizable);
95    }
96  
97    /**
98    Sets a CSS class in its parent, if the parent supports it.
99  
100    Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
101 
102    <pre>
103    &lt;tc:in&gt;
104      &lt;tc:style customClass="my-emphasized"/&gt;
105    &lt;/tc:in&gt;
106    </pre>
107 
108    One capability is, to used external CSS libs.
109    <br>
110    This feature should not be used imprudent.
111    Because it might be unstable against changes in the renderered HTML code.
112 
113   */
114   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
115     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
116   }
117 
118   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
119     getStateHelper().put(PropertyKeys.customClass, customClass);
120   }
121 
122   /**
123   Text value to display as tooltip.
124 
125   */
126   public java.lang.String getTip() {
127     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
128   }
129 
130   public void setTip(java.lang.String tip) {
131     getStateHelper().put(PropertyKeys.tip, tip);
132   }
133 
134   /**
135   For internal use. Used for rendering, if there is a child tag &lt;tc:style&gt;
136 
137   */
138   public org.apache.myfaces.tobago.renderkit.css.Style getStyle() {
139     return (org.apache.myfaces.tobago.renderkit.css.Style) getStateHelper().eval(PropertyKeys.style);
140   }
141 
142   public void setStyle(org.apache.myfaces.tobago.renderkit.css.Style style) {
143     getStateHelper().put(PropertyKeys.style, style);
144   }
145 
146   /**
147   A localized user presentable label for this component.
148 
149   */
150   public java.lang.String getLabel() {
151     return (java.lang.String) getStateHelper().eval(PropertyKeys.label);
152   }
153 
154   public void setLabel(java.lang.String label) {
155     getStateHelper().put(PropertyKeys.label, label);
156   }
157 
158   /**
159   Flag indicating whether or not this column is sortable.
160    To make a column sortable the data of the sheet must be one of
161    <code>java.util.List</code> or <code>Object[]</code>.
162   <br>Default: <code>false</code>
163   */
164   public boolean isSortable() {
165     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.sortable);
166     if (bool != null) {
167       return bool;
168     }
169     return false;
170   }
171 
172   public void setSortable(boolean sortable) {
173     getStateHelper().put(PropertyKeys.sortable, sortable);
174   }
175 
176   /**
177   Alignment of this column.
178 
179   */
180   public java.lang.String getAlign() {
181     return (java.lang.String) getStateHelper().eval(PropertyKeys.align);
182   }
183 
184   public void setAlign(java.lang.String align) {
185     getStateHelper().put(PropertyKeys.align, align);
186   }
187 
188 
189 }