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.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 ClientBehaviorHolder, 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    }
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    URI to object source
79  
80    */
81    public java.lang.String getSrc() {
82      return (java.lang.String) getStateHelper().eval(PropertyKeys.src);
83    }
84  
85    public void setSrc(java.lang.String src) {
86      getStateHelper().put(PropertyKeys.src, src);
87    }
88  
89    /**
90    Name of the element.
91     If not set the id will be used as name. The id in JSF normally contains colons.
92     This doesn't work in Internet Explorer 9 and lower when using window.open(src, target).
93  
94    */
95    public java.lang.String getName() {
96      return (java.lang.String) getStateHelper().eval(PropertyKeys.name);
97    }
98  
99    public void setName(java.lang.String name) {
100     getStateHelper().put(PropertyKeys.name, name);
101   }
102 
103   /**
104   Sets a CSS class in its parent, if the parent supports it.
105 
106    Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:
107 
108    <pre>
109    &lt;tc:in&gt;
110      &lt;tc:style customClass="my-emphasized"/&gt;
111    &lt;/tc:in&gt;
112    </pre>
113 
114    One capability is, to used external CSS libs.
115    <br>
116    This feature should not be used imprudent.
117    Because it might be unstable against changes in the renderered HTML code.
118 
119   */
120   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
121     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
122   }
123 
124   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
125     getStateHelper().put(PropertyKeys.customClass, customClass);
126   }
127 
128 
129 }