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