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