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, ScriptEventSupport, Container, LifecycleElement, Helpable, org.springframework.core.Ordered

Direct Known Subclasses:

ComponentLibraryView, 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:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.krad.uif.view.View

applyDirtyCheck, viewIndex

Fields inherited from class org.kuali.rice.krad.uif.component.ComponentBase

templateOptions

Fields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

componentCode

Fields inherited from interface org.kuali.rice.krad.uif.component.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
FormView()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAdditionalHiddenValues() Map of property path and values that will get written out as hidden elements.
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	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
void	setAdditionalHiddenValues(Map<String,String> additionalHiddenValues)
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.krad.uif.view.View

addViewTemplate, afterEvaluateExpression, clearIndex, clone, completeValidation, getActionFlags, getAdditionalCssFiles, getAdditionalHeadLinks, getAdditionalMetaTags, getAdditionalScriptFiles, getApplicationFooter, getApplicationHeader, getApplicationTitleText, getAuthorizer, getBreadcrumbItem, getBreadcrumbItems, getBreadcrumbOptions, getBreadcrumbs, getBuildFooter, getComponentTypeName, getContentContainerClassesAsString, getContentContainerCssClasses, getCurrentPage, getCurrentPageId, getDefaultBindingObjectPath, getDialogs, getEditModes, getEntryPageId, getExpressionVariables, getFormClass, getGrowls, getItems, getNamespaceCode, getNavigation, getNavigationBlockUI, getObjectPathToConcreteClassMapping, getPage, getPagesForPreprocessing, getParentLocation, getPathBasedBreadcrumbs, getPreloadPoolSize, getPreLoadScript, getPreModelContext, getPresentationController, getRefreshBlockUI, getRequestAuthorizationCacheClass, getSessionPolicy, getStateMapping, getStateObjectBindingPath, getSupportedComponents, getTheme, getTopGroup, getViewHelperService, getViewHelperServiceClass, getViewIndex, getViewName, getViewRequestParameters, getViewTemplates, getViewTypeName, initializeDialogLoadScript, initializeDialogReclocationScript, isApplyDirtyCheck, isDisableBrowserCache, isDisableNativeAutocomplete, isGrowlMessagingEnabled, isMergeWithPageItems, isPersistFormToSession, isSinglePageView, isStickyApplicationFooter, isStickyApplicationHeader, isStickyBreadcrumbs, isStickyFooter, isStickyHeader, isStickyTopGroup, isSupportsRequestOverrideOfReadOnlyFields, isTranslateCodesOnReadOnlyDisplay, isUnifiedHeader, isUseLibraryCssClasses, notifyCompleted, performApplyModel, performInitialization, setActionFlags, setAdditionalCssFiles, setAdditionalHeadLinks, setAdditionalMetaTags, setAdditionalScriptFiles, setApplicationFooter, setApplicationHeader, setApplicationTitleText, setApplyDirtyCheck, setAuthorizer, setAuthorizerClass, setBreadcrumbItem, setBreadcrumbOptions, setBreadcrumbs, setBuildFooter, setContentContainerCssClasses, setCurrentPageId, setDefaultBindingObjectPath, setDialogs, setDisableBrowserCache, setDisableNativeAutocomplete, setEditModes, setEntryPageId, setExpressionVariables, setFormClass, setGrowlMessagingEnabled, setGrowls, setItems, setMergeWithPageItems, setNamespaceCode, setNavigation, setNavigationBlockUI, setNestedComponentId, setObjectPathToConcreteClassMapping, setPage, setParentLocation, setPathBasedBreadcrumbs, setPersistFormToSession, setPreloadPoolSize, setPreLoadScript, setPresentationController, setPresentationControllerClass, setRefreshBlockUI, setRequestAuthorizationCacheClass, setSessionPolicy, setSinglePageView, setStateMapping, setStateObjectBindingPath, setStickyApplicationFooter, setStickyApplicationHeader, setStickyBreadcrumbs, setStickyFooter, setStickyHeader, setStickyTopGroup, setSupportsRequestOverrideOfReadOnlyFields, setTheme, setTopGroup, setTranslateCodesOnReadOnlyDisplay, setUnifiedHeader, setUseLibraryCssClasses, setViewHelperService, setViewHelperServiceClass, setViewName, setViewRequestParameters, setViewTemplates, setViewTypeName, sortItems

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

getAdditionalTemplates, getDefaultItemPosition, getEnterKeyAction, getFooter, getHeader, getHeaderText, getHelp, getHelpTitle, getInstructionalMessage, getInstructionalText, getLayoutManager, getValidationMessages, isProcessRemoteFieldHolders, setDefaultItemPosition, setEnterKeyAction, setFooter, setHeader, setHeaderText, setHelp, setInstructionalMessage, setInstructionalText, setLayoutManager, setRenderFooter, setRenderHeader, setTooltipOfComponent, setValidationMessages

Methods inherited from class org.kuali.rice.krad.uif.component.ComponentBase

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, checkMutable, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getAriaAttributes, getAriaAttributesAsString, getCanCopyOnReadOnly, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContainerIdSuffix, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getExcludeIf, getExcludeUnless, getFieldsToSendOnRefresh, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPhasePathMapping, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getReadOnly, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRole, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getViewPath, getViewStatus, getWidth, getWrapperCssClasses, getWrapperCssClassesAsString, getWrapperStyle, initializeComponentSecurity, isDisableSessionPersistence, isDisclosedByAction, isEditAuthz, isFinal, isForceSessionPersistence, isHidden, isInitialized, isModelApplied, isMutable, isOmitFromFormPost, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRender, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, isViewAuthz, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCanCopyOnReadOnly, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContainerIdSuffix, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setEditAuthz, setExcludeIf, setExcludeUnless, setFieldsToSendOnRefresh, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, setOmitFromFormPost, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPhasePathMapping, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRole, setRowSpan, setScriptDataAttributes, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewAuthz, setViewPath, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle, skipLifecycle

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

copy, dataDictionaryPostProcessing, getComponentCode, setComponentCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.uif.component.Component

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getAriaAttributes, getAriaAttributesAsString, getCanCopyOnReadOnly, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getExcludeIf, getExcludeUnless, getFieldsToSendOnRefresh, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getLibraryCssClasses, getMethodToCallOnRefresh, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getReadOnly, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRole, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, getWrapperCssClasses, getWrapperStyle, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isOmitFromFormPost, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCanCopyOnReadOnly, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFieldsToSendOnRefresh, setForceSessionPersistence, setHidden, setLibraryCssClasses, setOmitFromFormPost, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRole, setRowSpan, setScriptDataAttributes, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle

Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

dataDictionaryPostProcessing, getComponentCode

Methods inherited from interface org.kuali.rice.krad.uif.util.LifecycleElement

checkMutable, getContainerIdSuffix, getId, getPhasePathMapping, getViewPath, getViewStatus, isFinal, isInitialized, isModelApplied, isMutable, isRender, pushAllToContext, pushObjectToContext, setContainerIdSuffix, setId, setPhasePathMapping, setRender, setViewPath, skipLifecycle

Methods inherited from interface org.kuali.rice.krad.uif.component.ScriptEventSupport

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript

Constructor Detail

FormView

public FormView()

Method Detail

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:

getAdditionalHiddenValues()