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