Package org.kuali.rice.krad.uif.view

Class FormView

java.lang.Object
org.kuali.rice.krad.datadictionary.DictionaryBeanBase
org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase
org.kuali.rice.krad.uif.component.ComponentBase
org.kuali.rice.krad.uif.container.ContainerBase
org.kuali.rice.krad.uif.view.View
org.kuali.rice.krad.uif.view.FormView
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, Container, LifecycleElement, Helpable, org.springframework.core.Ordered
Direct Known Subclasses:
DocumentView, IframeView, InquiryView, LookupView, MessageView, MockView
public class FormView extends View
Provides configuration for View instances that render an HTML form.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • FormView

      public FormView()

  • Method Details

    • performFinalize

      public void performFinalize(Object model, LifecycleElement parent)
      The following is performed:
      • Adds to its document ready script the setupValidator js function for setting up the validator for this view
      The following is performed:
      • Adds to its document ready script the setupValidator js function for setting up the validator for this view
      The following finalization is performed:
      • Sets the headerText of the header Group if it is blank
      • Set the messageText of the summary Message if it is blank
      • Finalizes LayoutManager
      The following finalization is done here:
      • progressiveRender and conditionalRefresh variables are processed if set
      • If any of the style properties were given, sets the style string on the style property
      • Set the skipInTabOrder flag for nested components
      The last phase before the view is rendered

      Here final preparations can be made based on the updated view state.

      Specified by:
      performFinalize in interface LifecycleElement
      Overrides:
      performFinalize in class View
      Parameters:
      model - - top level object containing the data
      parent - - parent component

    • isRenderForm

      public boolean isRenderForm()
      Indicates whether a Form element should be rendered for the View. This is necessary for pages that need to submit data back to the server. Note that even if a page is read-only, a form element is generally needed for the navigation. Defaults to true
      Returns:
      true if the form element should be rendered, false if it should not be

    • setRenderForm

      public void setRenderForm(boolean renderForm)
      Setter for the render form indicator
      Parameters:
      renderForm -

    • isValidateServerSide

      public boolean isValidateServerSide()
      Indicates whether to perform the validate model phase of the view lifecycle. This phase will validate the model against configured dictionary validations and report errors. Defaults to true
      Returns:
      boolean true if model data should be validated, false if it should not be

    • setValidateServerSide

      public void setValidateServerSide(boolean validateServerSide)
      Setter for the validate server side indicator
      Parameters:
      validateServerSide -

    • isValidateClientSide

      public boolean isValidateClientSide()
      Indicates whether to perform on-the-fly validation on the client using js during user data entry. Defaults to true
      Returns:
      the validateClientSide

    • setValidateClientSide

      public void setValidateClientSide(boolean validateClientSide)
      Setter for the validate client side indicator
      Parameters:
      validateClientSide -

    • getFormPostUrl

      public String getFormPostUrl()
      Specifies the URL the view's form should post to

      Any valid form post URL (full or relative) can be specified. If left empty, the form will be posted to the same URL of the preceding request URL.

      Returns:
      post URL

    • setFormPostUrl

      public void setFormPostUrl(String formPostUrl)
      Setter for the form post URL
      Parameters:
      formPostUrl -

    • getAdditionalHiddenValues

      public Map<String,String> getAdditionalHiddenValues()
      Map of property path and values that will get written out as hidden elements.
      Returns:
      map for additional hiddens, key will be used as the name of the elememt, the map value will be the value of the element

    • setAdditionalHiddenValues

      public void setAdditionalHiddenValues(Map<String,String> additionalHiddenValues)
      See Also: