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