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.AbstractUIPage;
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   Renders a page element.
41    * UIComponent class, generated from template {@code component.stg} with class
42    * {@link org.apache.myfaces.tobago.internal.taglib.component.PageTagDeclaration}.
43   */
44  public class UIPage
45      extends AbstractUIPage implements Visual {
46  
47    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.Page";
48  
49    public static final String COMPONENT_FAMILY = "javax.faces.Form";
50  
51    private static final Collection<String> EVENT_NAMES = Arrays.asList("click", "dblclick", "load", "resize");
52  
53    @Override
54    public Collection<String> getEventNames() {
55      return EVENT_NAMES;
56    }
57  
58    @Override
59    public String getDefaultEventName() {
60      return "click";
61    }
62  
63  
64    enum PropertyKeys {
65      markup,
66      customClass,
67      style,
68      applicationIcon,
69      label,
70      focusId,
71    }
72  
73    public String getFamily() {
74      return COMPONENT_FAMILY;
75    }
76  
77  
78    public org.apache.myfaces.tobago.context.Markup getMarkup() {
79      Object object = getStateHelper().eval(PropertyKeys.markup);
80      if (object != null) {
81        return Markup.valueOf(object);
82      }
83      return null;
84    }
85  
86    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
87      getStateHelper().put(PropertyKeys.markup, markup);
88    }
89  
90    /**
91    Sets a CSS class in its parent, if the parent supports it.
92  
93     Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
94  
95     <pre>
96     &lt;tc:in&gt;
97       &lt;tc:style customClass="my-emphasized"/&gt;
98     &lt;/tc:in&gt;
99     </pre>
100 
101    One capability is, to used external CSS libs.
102    <br>
103    This feature should not be used imprudent.
104    Because it might be unstable against changes in the renderered HTML code.
105 
106   */
107   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
108     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
109   }
110 
111   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
112     getStateHelper().put(PropertyKeys.customClass, customClass);
113   }
114 
115   /**
116   For internal use. Used for rendering, if there is a child tag &lt;tc:style&gt;
117 
118   */
119   public org.apache.myfaces.tobago.renderkit.css.Style getStyle() {
120     return (org.apache.myfaces.tobago.renderkit.css.Style) getStateHelper().eval(PropertyKeys.style);
121   }
122 
123   public void setStyle(org.apache.myfaces.tobago.renderkit.css.Style style) {
124     getStateHelper().put(PropertyKeys.style, style);
125   }
126 
127   /**
128   Absolute URL to an image or image name to lookup in tobago resource path
129    representing the application. In HTML it is used as a favicon.
130 
131   */
132   public java.lang.String getApplicationIcon() {
133     return (java.lang.String) getStateHelper().eval(PropertyKeys.applicationIcon);
134   }
135 
136   public void setApplicationIcon(java.lang.String applicationIcon) {
137     getStateHelper().put(PropertyKeys.applicationIcon, applicationIcon);
138   }
139 
140   /**
141   A localized user presentable label for this component.
142 
143   */
144   public java.lang.String getLabel() {
145     return (java.lang.String) getStateHelper().eval(PropertyKeys.label);
146   }
147 
148   public void setLabel(java.lang.String label) {
149     getStateHelper().put(PropertyKeys.label, label);
150   }
151 
152   /**
153   Contains the id of the component which should have the focus after
154    loading the page.
155    Set to empty string for disabling setting of focus.
156    Default (null) enables the "auto focus" feature.
157 
158   */
159   public java.lang.String getFocusId() {
160     return (java.lang.String) getStateHelper().eval(PropertyKeys.focusId);
161   }
162 
163   public void setFocusId(java.lang.String focusId) {
164     getStateHelper().put(PropertyKeys.focusId, focusId);
165   }
166 
167 
168 }