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