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