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