org.kuali.rice.kns.uif.container
Class FormView

java.lang.Object
  org.kuali.rice.kns.uif.core.ComponentBase
      org.kuali.rice.kns.uif.container.ContainerBase
          org.kuali.rice.kns.uif.container.View
              org.kuali.rice.kns.uif.container.FormView

All Implemented Interfaces:

Serializable, Container, Component, ScriptEventSupport, org.springframework.core.Ordered

Direct Known Subclasses:

DocumentView, InquiryView, LookupView

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:

Serialized Form

Field Summary

private String	formPostUrl
private boolean	renderForm
private static long	serialVersionUID
private boolean	validateClientSide
private boolean	validateServerSide

Fields inherited from interface org.kuali.rice.kns.uif.core.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

FormView()

Method Summary

String	getFormPostUrl() Specifies the URL the view's form should post to
boolean	isRenderForm() Indicates whether a Form element should be rendered for the View.
boolean	isValidateClientSide() Indicates whether to perform on-the-fly validation on the client using js during user data entry.
boolean	isValidateServerSide() Indicates whether to perform the validate model phase of the view lifecycle.
void	setFormPostUrl(String formPostUrl) Setter for the form post URL
void	setRenderForm(boolean renderForm) Setter for the render form indicator
void	setValidateClientSide(boolean validateClientSide) Setter for the validate client side indicator
void	setValidateServerSide(boolean validateServerSide) Setter for the validate server side indicator

Methods inherited from class org.kuali.rice.kns.uif.container.View

determineViewLabelPropertyName, getAbstractTypeClasses, getActionFlags, getAdditionalCssFiles, getAdditionalScriptFiles, getAppendOption, getAuthorizerClass, getBreadcrumbs, getComponentTypeName, getCurrentPage, getCurrentPageId, getDefaultBindingObjectPath, getEditModes, getEntryPageId, getExpressionVariables, getFormClass, getGrowlsWidget, getItems, getNavigation, getNestedComponents, getPage, getPresentationControllerClass, getReturnTarget, getSupportedComponents, getSupportsOnDocumentReady, getSupportsOnLoad, getSupportsOnSubmit, getViewHelperService, getViewHelperServiceClassName, getViewIndex, getViewLabelFieldBindingInfo, getViewLabelFieldPropertyName, getViewMenuGrouping, getViewMenuLink, getViewName, getViewRequestParameters, getViewStatus, getViewTypeName, index, isDialogMode, isFinal, isGrowlMessagingEnabled, isInitialized, isSinglePageView, isValidateDirty, performFinalize, performInitialization, setAbstractTypeClasses, setActionFlags, setAdditionalCssFiles, setAdditionalScriptFiles, setAppendOption, setAuthorizerClass, setBreadcrumbs, setCurrentPageId, setDefaultBindingObjectPath, setDialogMode, setEditModes, setEntryPageId, setExpressionVariables, setFormClass, setGrowlMessagingEnabled, setGrowlsWidget, setItems, setNavigation, setPage, setPresentationControllerClass, setReturnTarget, setSinglePageView, setValidateDirty, setViewHelperServiceClassName, setViewLabelFieldBindingInfo, setViewLabelFieldPropertyName, setViewMenuGrouping, setViewMenuLink, setViewName, setViewRequestParameters, setViewStatus, setViewTypeName

Methods inherited from class org.kuali.rice.kns.uif.container.ContainerBase

getAdditionalMessageKeys, getAttributeFields, getErrorsField, getFooter, getHeader, getHelp, getItemOrderingSequence, getLayoutManager, getSummary, getSummaryMessageField, isFieldContainer, performApplyModel, setAdditionalMessageKeys, setErrorsField, setFieldContainer, setFooter, setHeader, setHelp, setItemOrderingSequence, setLayoutManager, setRenderFooter, setRenderHeader, setSummary, setSummaryMessageField

Methods inherited from class org.kuali.rice.kns.uif.core.ComponentBase

addStyleClass, appendToStyle, getAlign, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getConditionalColSpan, getConditionalReadOnly, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getConditionalRender, getConditionalRequired, getConditionalRowSpan, getContext, getEventCode, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertiesForReferenceCopy, getPropertyExpressions, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRequired, getRowSpan, getStyle, getStyleClasses, getStyleClassesAsString, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnUnload, getTemplate, getTitle, getValign, getWidth, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRender, isSelfRendered, isSkipInTabOrder, pushObjectToContext, setAlign, setColSpan, setComponentModifiers, setComponentOptions, setConditionalColSpan, setConditionalReadOnly, setConditionalRefresh, setConditionalRender, setConditionalRequired, setConditionalRowSpan, setContext, setFinalizeMethodInvoker, setFinalizeMethodToCall, setHidden, setId, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyExpressions, setPropertyReplacers, setReadOnly, setRefresh, setRefreshWhenChanged, setRender, setRender, setRenderOutput, setRequired, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setStyleClasses, setTemplate, setTitle, setValign, setWidth

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.kns.uif.core.Component

addStyleClass, appendToStyle, getColSpan, getComponentModifiers, getComponentOptions, getConditionalReadOnly, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getConditionalRender, getContext, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertiesForReferenceCopy, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRequired, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRender, isSelfRendered, pushObjectToContext, setColSpan, setComponentModifiers, setComponentOptions, setConditionalReadOnly, setConditionalRefresh, setConditionalRender, setContext, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setRowSpan, setSelfRendered, setStyle, setStyleClasses, setTemplate, setTitle

Methods inherited from interface org.kuali.rice.kns.uif.core.ScriptEventSupport

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnUnload, setOnBlurScript

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

renderForm

private boolean renderForm

validateServerSide

private boolean validateServerSide

validateClientSide

private boolean validateClientSide

formPostUrl

private String formPostUrl

Constructor Detail

FormView

public FormView()

Method Detail

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

See Also:

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:

String post URL

setFormPostUrl

public void setFormPostUrl(String formPostUrl)

Setter for the form post URL

Parameters:

formPostUrl -