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.AbstractUIProgress;
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 progress bar.
39    * UIComponent class, generated from template {@code component.stg} with class
40    * {@link org.apache.myfaces.tobago.internal.taglib.component.ProgressTagDeclaration}.
41   */
42  public class UIProgress
43      extends AbstractUIProgress implements Visual {
44  
45    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.Progress";
46  
47    public static final String COMPONENT_FAMILY = "javax.faces.Output";
48  
49  
50    enum PropertyKeys {
51      markup,
52      max,
53      customClass,
54      tip,
55      style,
56    }
57  
58    public String getFamily() {
59      return COMPONENT_FAMILY;
60    }
61  
62  
63    public org.apache.myfaces.tobago.context.Markup getMarkup() {
64      Object object = getStateHelper().eval(PropertyKeys.markup);
65      if (object != null) {
66        return Markup.valueOf(object);
67      }
68      return null;
69    }
70  
71    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
72      getStateHelper().put(PropertyKeys.markup, markup);
73    }
74  
75    /**
76    The maximum of the value of the progress.
77  
78    */
79    public java.lang.Double getMax() {
80      return (java.lang.Double) getStateHelper().eval(PropertyKeys.max);
81    }
82  
83    public void setMax(java.lang.Double max) {
84      getStateHelper().put(PropertyKeys.max, max);
85    }
86  
87    /**
88    Sets a CSS class in its parent, if the parent supports it.
89  
90     Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:
91  
92     <pre>
93     &lt;tc:in&gt;
94       &lt;tc:style customClass="my-emphasized"/&gt;
95     &lt;/tc:in&gt;
96     </pre>
97  
98     One capability is, to used external CSS libs.
99     <br>
100    This feature should not be used imprudent.
101    Because it might be unstable against changes in the renderered HTML code.
102 
103   */
104   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
105     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
106   }
107 
108   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
109     getStateHelper().put(PropertyKeys.customClass, customClass);
110   }
111 
112   /**
113   Text value to display as tooltip.
114 
115   */
116   public java.lang.String getTip() {
117     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
118   }
119 
120   public void setTip(java.lang.String tip) {
121     getStateHelper().put(PropertyKeys.tip, tip);
122   }
123 
124   /**
125   For internal use. Used for rendering, if there is a child tag &lt;tc:style&gt;
126 
127   */
128   public org.apache.myfaces.tobago.renderkit.css.Style getStyle() {
129     return (org.apache.myfaces.tobago.renderkit.css.Style) getStateHelper().eval(PropertyKeys.style);
130   }
131 
132   public void setStyle(org.apache.myfaces.tobago.renderkit.css.Style style) {
133     getStateHelper().put(PropertyKeys.style, style);
134   }
135 
136 
137 }