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

Direct Known Subclasses:

ComponentLibraryView, DocumentView, InquiryView, LookupView, MessageView

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

viewIndex

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

FormView()

Method Summary

protected <T> void	copyProperties(T component) Copies the properties over for the copy method
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.krad.uif.view.View

assignComponentId, assignComponentIds, assignPageIds, completeValidation, getActionFlags, getAdditionalCssFiles, getAdditionalScriptFiles, getApplicationFooter, getApplicationHeader, getAuthorizer, getBreadcrumbItem, getBreadcrumbOptions, getBreadcrumbs, getComponentsForLifecycle, getComponentTypeName, getCurrentPage, getCurrentPageId, getDefaultBindingObjectPath, getDialogs, getEditModes, getEntryPageId, getExpressionVariables, getFormClass, getGrowls, getIdSequence, getItems, getNamespaceCode, getNavigation, getNavigationBlockUI, getNextId, getObjectPathToConcreteClassMapping, getPage, getParentLocation, getPathBasedBreadcrumbs, getPreLoadScript, getPresentationController, getRefreshBlockUI, getSessionPolicy, getStateMapping, getStateObjectBindingPath, getSupportedComponents, getTheme, getTopGroup, getViewHelperService, getViewHelperServiceClass, getViewIndex, getViewMenuGroupName, getViewMenuLink, getViewName, getViewRequestParameters, getViewStatus, getViewTemplates, getViewTypeName, index, isApplyDirtyCheck, isDisableBrowserCache, isDisableNativeAutocomplete, isFinal, isGrowlMessagingEnabled, isInitialized, isMergeWithPageItems, isPersistFormToSession, isSinglePageView, isStickyApplicationFooter, isStickyApplicationHeader, isStickyBreadcrumbs, isStickyFooter, isStickyHeader, isStickyTopGroup, isSupportsRequestOverrideOfReadOnlyFields, isTranslateCodesOnReadOnlyDisplay, isUnifiedHeader, isUseLibraryCssClasses, performApplyModel, performFinalize, performInitialization, setActionFlags, setAdditionalCssFiles, setAdditionalScriptFiles, setApplicationFooter, setApplicationHeader, setApplyDirtyCheck, setAuthorizer, setAuthorizerClass, setBreadcrumbItem, setBreadcrumbOptions, setBreadcrumbs, setCurrentPageId, setDefaultBindingObjectPath, setDialogs, setDisableBrowserCache, setDisableNativeAutocomplete, setEditModes, setEntryPageId, setExpressionVariables, setFormClass, setGrowlMessagingEnabled, setGrowls, setIdSequence, setItems, setMergeWithPageItems, setNamespaceCode, setNavigation, setNavigationBlockUI, setObjectPathToConcreteClassMapping, setPage, setParentLocation, setPathBasedBreadcrumbs, setPersistFormToSession, setPreLoadScript, setPresentationController, setPresentationControllerClass, setRefreshBlockUI, setSessionPolicy, setSinglePageView, setStateMapping, setStateObjectBindingPath, setStickyApplicationFooter, setStickyApplicationHeader, setStickyBreadcrumbs, setStickyFooter, setStickyHeader, setStickyTopGroup, setSupportsRequestOverrideOfReadOnlyFields, setTheme, setTopGroup, setTranslateCodesOnReadOnlyDisplay, setUnifiedHeader, setUseLibraryCssClasses, setViewHelperService, setViewHelperServiceClass, setViewMenuGroupName, setViewMenuLink, setViewName, setViewRequestParameters, setViewStatus, setViewTemplates, setViewTypeName, sortItems

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

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

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

addCellCssClass, addDataAttribute, addDataAttributeIfNonEmpty, addStyleClass, appendToStyle, copy, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellStyleClassesAsString, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getComponentSecurityClass, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setWidth

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

getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph

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

getComponentCode, setComponentCode

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.krad.uif.component.Component

addCellCssClass, addDataAttribute, addStyleClass, appendToStyle, copy, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, pushAllToContext, pushObjectToContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setWidth

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

getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph

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

getComponentCode

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

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

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

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 -

copyProperties

protected <T> void copyProperties(T component)

Description copied from class: ComponentBase

Copies the properties over for the copy method

Overrides:

copyProperties in class View

Parameters:

component - base bean

See Also:

ComponentBase.copy()