Class UIForm

  • All Implemented Interfaces:
    EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, Visual

    @Generated("component.stg")
    public class UIForm
    extends AbstractUIForm
    implements javax.faces.component.behavior.ClientBehaviorHolder
    If an action is preformed, everything within the next parent form belongs to the submit-area. An action could be a button which is pressed. tc:page is a form. Everything in the submit-area is written into the model, even other forms. UIComponent class, generated from template component.stg with class FormTagDeclaration.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String COMPONENT_TYPE  
      • Fields inherited from class javax.faces.component.UIComponent

        ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
      • Fields inherited from interface javax.faces.component.NamingContainer

        SEPARATOR_CHAR
    • Constructor Summary

      Constructors 
      Constructor Description
      UIForm()  
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      CustomClass getCustomClass()
      Sets a CSS class in its parent, if the parent supports it.
      String getFamily()  
      Markup getMarkup()  
      boolean isInline()
      Deprecated. 
      boolean isPlain()
      Use with caution: Only for special cases!
      void restoreState​(javax.faces.context.FacesContext context, Object state)  
      void setCustomClass​(CustomClass customClass)  
      void setInline​(boolean inline)
      Deprecated.
      void setMarkup​(Markup markup)  
      void setPlain​(boolean plain)  
      • Methods inherited from class javax.faces.component.UIForm

        createUniqueId, getContainerClientId, invokeOnComponent, isPrependId, isSubmitted, setPrependId, visitTree
      • Methods inherited from class javax.faces.component.UIComponentBase

        addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
      • Methods inherited from class javax.faces.component.UIComponent

        getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
      • Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

        addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
    • Constructor Detail

      • UIForm

        public UIForm()
    • Method Detail

      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class javax.faces.component.UIForm
      • isInline

        @Deprecated
        public boolean isInline()
        Deprecated.
        Flag indicating this component should rendered as an inline element.
        Default: false
        Specified by:
        isInline in class AbstractUIForm
      • setInline

        @Deprecated
        public void setInline​(boolean inline)
        Deprecated.
      • isPlain

        public boolean isPlain()

        Use with caution: Only for special cases!

        This attribute is useful for tc:out if labelLayout=skip is set. Use true, if you want to only render the text (no surrounding tag). Use false, if you enable the possibility to apply styles to the output.

        For tc:form there will no div tag be rendered. So, the content can be used freely from layout managers.

        But, no AJAX is possible for components with "plain" set, because there is no client element with an "id" in the DOM.


        Default: false
        Specified by:
        isPlain in interface Visual
      • setPlain

        public void setPlain​(boolean plain)
      • getCustomClass

        public CustomClass getCustomClass()
        Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:
           <tc:in>
             <tc:style customClass="my-emphasized"/>
           </tc:in>
           
        One capability is, to used external CSS libs.
        This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.
        Specified by:
        getCustomClass in interface Visual
      • restoreState

        public void restoreState​(javax.faces.context.FacesContext context,
                                 Object state)
        Specified by:
        restoreState in interface javax.faces.component.StateHolder
        Overrides:
        restoreState in class javax.faces.component.UIComponentBase