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.component.behavior.ClientBehaviorHolder;
23  import javax.faces.context.FacesContext;
24  import org.apache.myfaces.tobago.context.Markup;
25  import org.apache.myfaces.tobago.internal.component.AbstractUIImage;
26  import org.apache.myfaces.tobago.renderkit.css.CustomClass;
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 org.apache.myfaces.tobago.component.Tags;
31  import javax.annotation.Generated;
32  import javax.el.ELException;
33  import javax.faces.FacesException;
34  import java.util.Arrays;
35  import java.util.ArrayList;
36  import java.util.Collection;
37  import java.util.List;
38  import javax.el.MethodExpression;
39  import javax.el.ValueExpression;
40  
41  /**
42   Renders an image.
43    * UIComponent class, generated from template {@code component.stg} with class
44    * {@link org.apache.myfaces.tobago.internal.taglib.component.ImageTagDeclaration}.
45   */
46  @Generated("component.stg")
47  public class UIImage
48      extends AbstractUIImage implements ClientBehaviorHolder {
49  
50    public static final String COMPONENT_TYPE = Tags.image.componentType();
51  
52    public static final String COMPONENT_FAMILY = "javax.faces.Graphic";
53  
54  
55    enum PropertyKeys {
56      markup,
57      alt,
58      customClass,
59      tip,
60      disabled,
61    }
62  
63    public String getFamily() {
64      return COMPONENT_FAMILY;
65    }
66  
67  
68    public org.apache.myfaces.tobago.context.Markup getMarkup() {
69      Object object = getStateHelper().eval(PropertyKeys.markup);
70      if (object != null) {
71        return Markup.valueOf(object);
72      }
73      return null;
74    }
75  
76    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
77      getStateHelper().put(PropertyKeys.markup, markup);
78    }
79  
80    /**
81    Alternate textual description of the image rendered by this component.
82  
83    */
84    public java.lang.String getAlt() {
85      return (java.lang.String) getStateHelper().eval(PropertyKeys.alt);
86    }
87  
88    public void setAlt(java.lang.String alt) {
89      getStateHelper().put(PropertyKeys.alt, alt);
90    }
91  
92    /**
93    Sets a CSS class in its parent, if the parent supports it.
94  
95     Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:
96  
97     <pre>
98     &lt;tc:in&gt;
99       &lt;tc:style customClass="my-emphasized"/&gt;
100    &lt;/tc:in&gt;
101    </pre>
102 
103    One capability is, to used external CSS libs.
104    <br>
105    This feature should not be used imprudent.
106    Because it might be unstable against changes in the renderered HTML code.
107 
108   */
109   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
110     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
111   }
112 
113   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
114     getStateHelper().put(PropertyKeys.customClass, customClass);
115   }
116 
117   /**
118   Text value to display as tooltip.
119 
120   */
121   public java.lang.String getTip() {
122     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
123   }
124 
125   public void setTip(java.lang.String tip) {
126     getStateHelper().put(PropertyKeys.tip, tip);
127   }
128 
129   /**
130   Flag indicating that this element is disabled.
131   <br>Default: <code>false</code>
132   */
133   public boolean isDisabled() {
134     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.disabled);
135     if (bool != null) {
136       return bool;
137     }
138     return false;
139   }
140 
141   public void setDisabled(boolean disabled) {
142     getStateHelper().put(PropertyKeys.disabled, disabled);
143   }
144 
145 
146   @Override
147   public void restoreState(FacesContext context, Object state) {
148     // FIXME HACK for mojarra SystemEventListener state restoring bug
149     pushComponentToEL(context, this);
150     super.restoreState(context, state);
151     popComponentFromEL(context);
152   }
153 
154 }