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