org.kuali.rice.krad.uif.view
Class DocumentView

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
                          org.kuali.rice.krad.uif.view.DocumentView

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, ScriptEventSupport, Container, LifecycleElement, Helpable, org.springframework.core.Ordered

Direct Known Subclasses:

MaintenanceDocumentView, TransactionalDocumentView

public class DocumentView
extends FormView

View type for KRAD documents

Provides commons configuration and default behavior applicable to documents in the KRAD module.

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

DocumentView()

Method Summary

Class<? extends KeyValuesFinder>	getAttachmentTypesValuesFinderClass() Gets attachment types values finder classs
Class<? extends Document>	getDocumentClass() Gets the document class
protected DocumentEntry	getDocumentEntryForView() Retrieves the associated DocumentEntry for the document view
boolean	isAllowsNoteAttachments() Gets boolean that indicates if the document view allows note attachments
boolean	isAllowsNoteFYI() Gets boolean that indicates if the document view allows note FYI
boolean	isDisplayTopicFieldInNotes() Gets boolean that indicates if the document view displays the topic field in notes
void	performInitialization(Object model) The following initialization is performed: Retrieve the document entry Set up the document view authorizer and presentation controller The following initialization is performed: If a single paged view, set items in page group and put the page in the items list If ViewSessionPolicy.enableTimeoutWarning is enabled add the session timeout dialogs to the views list of dialog groups The following initialization is performed: Sorts the containers list of components Initializes the instructional field if necessary Initializes LayoutManager Initializes the component
void	setAllowsNoteAttachments(boolean allowsNoteAttachments) Sets boolean that indicates if the document view allows note attachments
void	setAllowsNoteFYI(boolean allowsNoteFYI) Sets boolean that indicates if the document view allows note FYI
void	setAttachmentTypesValuesFinderClass(Class<? extends KeyValuesFinder> attachmentTypesValuesFinderClass) Sets attachment types values finder classs
void	setDisplayTopicFieldInNotes(boolean displayTopicFieldInNotes) Sets boolean that indicates if the document view displays the topic field in notes
void	setDocumentClass(Class<? extends Document> documentClass) Sets the document class

Methods inherited from class org.kuali.rice.krad.uif.view.FormView

getAdditionalHiddenValues, getFormPostUrl, isRenderForm, isValidateClientSide, isValidateServerSide, performFinalize, setAdditionalHiddenValues, setFormPostUrl, setRenderForm, setValidateClientSide, setValidateServerSide

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

addViewTemplate, clearIndex, clone, completeValidation, getActionFlags, getAdditionalCssFiles, getAdditionalHeadLinks, getAdditionalMetaTags, getAdditionalScriptFiles, getApplicationFooter, getApplicationHeader, getAuthorizer, getBreadcrumbItem, getBreadcrumbItems, getBreadcrumbOptions, getBreadcrumbs, getComponentTypeName, getContentContainerClassesAsString, getContentContainerCssClasses, getCurrentPage, getCurrentPageId, getDefaultBindingObjectPath, getDialogs, getEditModes, getEntryPageId, getExpressionVariables, getFormClass, getGrowls, getItems, getNamespaceCode, getNavigation, getNavigationBlockUI, getObjectPathToConcreteClassMapping, getPage, getParentLocation, getPathBasedBreadcrumbs, getPreLoadScript, getPreModelContext, getPresentationController, getRefreshBlockUI, getSessionPolicy, getStateMapping, getStateObjectBindingPath, getSupportedComponents, getTheme, getTopGroup, getViewHelperService, getViewHelperServiceClass, getViewIndex, getViewMenuGroupName, getViewMenuLink, getViewName, getViewRequestParameters, getViewTemplates, getViewTypeName, initializePendingTasks, isApplyDirtyCheck, isDisableBrowserCache, isDisableNativeAutocomplete, isGrowlMessagingEnabled, isMergeWithPageItems, isPersistFormToSession, isSinglePageView, isStickyApplicationFooter, isStickyApplicationHeader, isStickyBreadcrumbs, isStickyFooter, isStickyHeader, isStickyTopGroup, isSupportsRequestOverrideOfReadOnlyFields, isTranslateCodesOnReadOnlyDisplay, isUnifiedHeader, isUseLibraryCssClasses, notifyCompleted, performApplyModel, setActionFlags, setAdditionalCssFiles, setAdditionalHeadLinks, setAdditionalMetaTags, setAdditionalScriptFiles, setApplicationFooter, setApplicationHeader, setApplyDirtyCheck, setAuthorizer, setAuthorizerClass, setBreadcrumbItem, setBreadcrumbOptions, setBreadcrumbs, setContentContainerCssClasses, setCurrentPageId, setDefaultBindingObjectPath, setDialogs, setDisableBrowserCache, setDisableNativeAutocomplete, setEditModes, setEntryPageId, setExpressionVariables, setFormClass, setGrowlMessagingEnabled, setGrowls, 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, setViewTemplates, setViewTypeName, sortItems

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

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

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

addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, checkMutable, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, 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, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, 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, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, isViewAuthz, preventModification, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setEditAuthz, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, 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, setRowSpan, setScriptDataAttributes, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewAuthz, setViewPath, setViewStatus, 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, unwrap

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

addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getLibraryCssClasses, getMethodToCallOnRefresh, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, getWrapperCssClasses, getWrapperStyle, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setLibraryCssClasses, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, 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, getId, getPhasePathMapping, getViewPath, getViewStatus, isFinal, isInitialized, isModelApplied, isMutable, pushAllToContext, pushObjectToContext, setId, setPhasePathMapping, setViewPath, setViewStatus, skipLifecycle

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

copy, preventModification, unwrap

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

DocumentView

public DocumentView()

Method Detail

performInitialization

public void performInitialization(Object model)

The following initialization is performed:

• Retrieve the document entry
• Set up the document view authorizer and presentation controller

The following initialization is performed:

• If a single paged view, set items in page group and put the page in the items list
• If ViewSessionPolicy.enableTimeoutWarning is enabled add the session timeout dialogs to the views list of dialog groups

The following initialization is performed:

• Sorts the containers list of components
• Initializes the instructional field if necessary
• Initializes LayoutManager

Initializes the component

Where components can set defaults and setup other necessary state. The initialize method should only be called once per component lifecycle and is invoked within the initialize phase of the view lifecylce.

Specified by:

performInitialization in interface LifecycleElement

Overrides:

performInitialization in class View

Parameters:

model - - object instance containing the view data

See Also:

ComponentDefaultInitializeTask

getDocumentEntryForView

protected DocumentEntry getDocumentEntryForView()

Retrieves the associated DocumentEntry for the document view

Returns:

DocumentEntry entry (exception thrown if one is not found)

getDocumentClass

public Class<? extends Document> getDocumentClass()

Gets the document class

Returns:

Class the document class.

setDocumentClass

public void setDocumentClass(Class<? extends Document> documentClass)

Sets the document class

Parameters:

documentClass -

isAllowsNoteAttachments

public boolean isAllowsNoteAttachments()

Gets boolean that indicates if the document view allows note attachments

Returns:

true if the document view allows note attachments

setAllowsNoteAttachments

public void setAllowsNoteAttachments(boolean allowsNoteAttachments)

Sets boolean that indicates if the document view allows note attachments

Parameters:

allowsNoteAttachments -

isAllowsNoteFYI

public boolean isAllowsNoteFYI()

Gets boolean that indicates if the document view allows note FYI

Returns:

true if the document view allows note FYI

setAllowsNoteFYI

public void setAllowsNoteFYI(boolean allowsNoteFYI)

Sets boolean that indicates if the document view allows note FYI

Parameters:

allowsNoteFYI -

isDisplayTopicFieldInNotes

public boolean isDisplayTopicFieldInNotes()

Gets boolean that indicates if the document view displays the topic field in notes

Returns:

true if the document view displays the topic field in notes

setDisplayTopicFieldInNotes

public void setDisplayTopicFieldInNotes(boolean displayTopicFieldInNotes)

Sets boolean that indicates if the document view displays the topic field in notes

Parameters:

displayTopicFieldInNotes -

getAttachmentTypesValuesFinderClass

public Class<? extends KeyValuesFinder> getAttachmentTypesValuesFinderClass()

Gets attachment types values finder classs

Returns:

attachment types values finder class

setAttachmentTypesValuesFinderClass

public void setAttachmentTypesValuesFinderClass(Class<? extends KeyValuesFinder> attachmentTypesValuesFinderClass)

Sets attachment types values finder classs

Parameters:

attachmentTypesValuesFinderClass -