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      viewport,
71      customClass,
72      style,
73      applicationIcon,
74      label,
75      focusId,
76    }
77  
78    public String getFamily() {
79      return COMPONENT_FAMILY;
80    }
81  
82  
83    public org.apache.myfaces.tobago.context.Markup getMarkup() {
84      Object object = getStateHelper().eval(PropertyKeys.markup);
85      if (object != null) {
86        return Markup.valueOf(object);
87      }
88      return null;
89    }
90  
91    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
92      getStateHelper().put(PropertyKeys.markup, markup);
93    }
94  
95    /**
96    Adding the value for the viewport meta tag in the page header in HTML.
97    <br>Default: <code>width=device-width, initial-scale=1.0</code>
98    */
99    public java.lang.String getViewport() {
100     java.lang.String viewport = (java.lang.String) getStateHelper().eval(PropertyKeys.viewport);
101     if (viewport != null) {
102       return viewport;
103     }
104     return "width=device-width, initial-scale=1.0";
105   }
106 
107   public void setViewport(java.lang.String viewport) {
108     getStateHelper().put(PropertyKeys.viewport, viewport);
109   }
110 
111   /**
112   Sets a CSS class in its parent, if the parent supports it.
113 
114    Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
115 
116    <pre>
117    &lt;tc:in&gt;
118      &lt;tc:style customClass="my-emphasized"/&gt;
119    &lt;/tc:in&gt;
120    </pre>
121 
122    One capability is, to used external CSS libs.
123    <br>
124    This feature should not be used imprudent.
125    Because it might be unstable against changes in the renderered HTML code.
126 
127   */
128   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
129     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
130   }
131 
132   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
133     getStateHelper().put(PropertyKeys.customClass, customClass);
134   }
135 
136   /**
137   For internal use. Used for rendering, if there is a child tag &lt;tc:style&gt;
138 
139   */
140   public org.apache.myfaces.tobago.renderkit.css.Style getStyle() {
141     return (org.apache.myfaces.tobago.renderkit.css.Style) getStateHelper().eval(PropertyKeys.style);
142   }
143 
144   public void setStyle(org.apache.myfaces.tobago.renderkit.css.Style style) {
145     getStateHelper().put(PropertyKeys.style, style);
146   }
147 
148   /**
149   Absolute URL to an image or image name to lookup in tobago resource path
150    representing the application. In HTML it is used as a favicon.
151 
152   */
153   public java.lang.String getApplicationIcon() {
154     return (java.lang.String) getStateHelper().eval(PropertyKeys.applicationIcon);
155   }
156 
157   public void setApplicationIcon(java.lang.String applicationIcon) {
158     getStateHelper().put(PropertyKeys.applicationIcon, applicationIcon);
159   }
160 
161   /**
162   A localized user presentable label for this component.
163 
164   */
165   public java.lang.String getLabel() {
166     return (java.lang.String) getStateHelper().eval(PropertyKeys.label);
167   }
168 
169   public void setLabel(java.lang.String label) {
170     getStateHelper().put(PropertyKeys.label, label);
171   }
172 
173   /**
174   Contains the id of the component which should have the focus after
175    loading the page.
176    Set to empty string for disabling setting of focus.
177    Default (null) enables the "auto focus" feature.
178 
179   */
180   public java.lang.String getFocusId() {
181     return (java.lang.String) getStateHelper().eval(PropertyKeys.focusId);
182   }
183 
184   public void setFocusId(java.lang.String focusId) {
185     getStateHelper().put(PropertyKeys.focusId, focusId);
186   }
187 
188 
189 }