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