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.component.behavior.ClientBehaviorHolder;
23  import javax.faces.context.FacesContext;
24  import org.apache.myfaces.tobago.context.Markup;
25  import org.apache.myfaces.tobago.internal.component.AbstractUIForm;
26  import org.apache.myfaces.tobago.renderkit.css.CustomClass;
27  import org.apache.myfaces.tobago.renderkit.css.Style;
28  import org.apache.myfaces.tobago.internal.util.ArrayUtils;
29  import org.apache.myfaces.tobago.internal.util.StringUtils;
30  import org.apache.myfaces.tobago.internal.util.Deprecation;
31  import javax.el.ELException;
32  import javax.faces.FacesException;
33  import java.util.Arrays;
34  import java.util.ArrayList;
35  import java.util.Collection;
36  import java.util.List;
37  import javax.el.MethodExpression;
38  import javax.el.ValueExpression;
39  
40  /** 
41   If an action is preformed, everything within the next parent form belongs to the submit-area.
42    An action could be a button which is pressed.
43    tc:page is a form.
44    Everything in the submit-area is written into the model, even other forms.
45    * UIComponent class, generated from template {@code component.stg} with class
46    * {@link org.apache.myfaces.tobago.internal.taglib.component.FormTagDeclaration}.
47   */
48  public class UIForm
49      extends AbstractUIForm implements ClientBehaviorHolder, Visual {
50  
51    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.Form";
52  
53    public static final String COMPONENT_FAMILY = "javax.faces.Form";
54  
55  
56    enum PropertyKeys {
57      markup,
58      inline,
59      customClass,
60      style,
61    }
62  
63    public String getFamily() {
64      return COMPONENT_FAMILY;
65    }
66  
67  
68    public org.apache.myfaces.tobago.context.Markup getMarkup() {
69      Object object = getStateHelper().eval(PropertyKeys.markup);
70      if (object != null) {
71        return Markup.valueOf(object);
72      }
73      return null;
74    }
75  
76    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
77      getStateHelper().put(PropertyKeys.markup, markup);
78    }
79  
80    /**
81    Flag indicating this component should rendered as an inline element.
82    <br>Default: <code>false</code>
83    @deprecated*/
84    @Deprecated
85    public boolean isInline() {
86      Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.inline);
87      if (bool != null) {
88        return bool;
89      }
90      return false;
91    }
92  
93    @Deprecated
94    public void setInline(boolean inline) {
95        Deprecation.LOG.error("The attribute 'inline' of 'UIForm' is deprecated. "
96            + "Please refer the documentation for further information.");
97      getStateHelper().put(PropertyKeys.inline, inline);
98    }
99  
100   /**
101   Sets a CSS class in its parent, if the parent supports it.
102 
103    Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
104 
105    <pre>
106    &lt;tc:in&gt;
107      &lt;tc:style customClass="my-emphasized"/&gt;
108    &lt;/tc:in&gt;
109    </pre>
110 
111    One capability is, to used external CSS libs.
112    <br>
113    This feature should not be used imprudent.
114    Because it might be unstable against changes in the renderered HTML code.
115 
116   */
117   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
118     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
119   }
120 
121   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
122     getStateHelper().put(PropertyKeys.customClass, customClass);
123   }
124 
125   /**
126   For internal use. Used for rendering, if there is a child tag &lt;tc:style&gt;
127 
128   */
129   public org.apache.myfaces.tobago.renderkit.css.Style getStyle() {
130     return (org.apache.myfaces.tobago.renderkit.css.Style) getStateHelper().eval(PropertyKeys.style);
131   }
132 
133   public void setStyle(org.apache.myfaces.tobago.renderkit.css.Style style) {
134     getStateHelper().put(PropertyKeys.style, style);
135   }
136 
137 
138 }