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