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.AbstractUIObject;
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   Show external content inside of an application.
39    This will typically renders an iframe tag.
40    * UIComponent class, generated from template {@code component.stg} with class
41    * {@link org.apache.myfaces.tobago.internal.taglib.component.ObjectTagDeclaration}.
42   */
43  public class UIObject
44      extends AbstractUIObject implements Visual {
45  
46    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.Object";
47  
48    public static final String COMPONENT_FAMILY = "javax.faces.Output";
49  
50  
51    enum PropertyKeys {
52      markup,
53      src,
54      name,
55      customClass,
56      style,
57    }
58  
59    public String getFamily() {
60      return COMPONENT_FAMILY;
61    }
62  
63  
64    public org.apache.myfaces.tobago.context.Markup getMarkup() {
65      Object object = getStateHelper().eval(PropertyKeys.markup);
66      if (object != null) {
67        return Markup.valueOf(object);
68      }
69      return null;
70    }
71  
72    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
73      getStateHelper().put(PropertyKeys.markup, markup);
74    }
75  
76    /**
77    URI to object source
78  
79    */
80    public java.lang.String getSrc() {
81      return (java.lang.String) getStateHelper().eval(PropertyKeys.src);
82    }
83  
84    public void setSrc(java.lang.String src) {
85      getStateHelper().put(PropertyKeys.src, src);
86    }
87  
88    /**
89    Name of the element.
90     If not set the id will be used as name. The id in JSF normally contains colons.
91     This doesn't work in Internet Explorer 9 and lower when using window.open(src, target).
92  
93    */
94    public java.lang.String getName() {
95      return (java.lang.String) getStateHelper().eval(PropertyKeys.name);
96    }
97  
98    public void setName(java.lang.String name) {
99      getStateHelper().put(PropertyKeys.name, name);
100   }
101 
102   /**
103   Sets a CSS class in its parent, if the parent supports it.
104 
105    Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:
106 
107    <pre>
108    &lt;tc:in&gt;
109      &lt;tc:style customClass="my-emphasized"/&gt;
110    &lt;/tc:in&gt;
111    </pre>
112 
113    One capability is, to used external CSS libs.
114    <br>
115    This feature should not be used imprudent.
116    Because it might be unstable against changes in the renderered HTML code.
117 
118   */
119   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
120     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
121   }
122 
123   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
124     getStateHelper().put(PropertyKeys.customClass, customClass);
125   }
126 
127   /**
128   For internal use. Used for rendering, if there is a child tag &lt;tc:style&gt;
129 
130   */
131   public org.apache.myfaces.tobago.renderkit.css.Style getStyle() {
132     return (org.apache.myfaces.tobago.renderkit.css.Style) getStateHelper().eval(PropertyKeys.style);
133   }
134 
135   public void setStyle(org.apache.myfaces.tobago.renderkit.css.Style style) {
136     getStateHelper().put(PropertyKeys.style, style);
137   }
138 
139 
140 }