org.kuali.rice.krad.uif.view

Class DocumentView

java.lang.Object

org.kuali.rice.krad.uif.component.ConfigurableBase

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

Direct Known Subclasses:

MaintenanceView

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 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
DocumentView()

Method Summary

Modifier and Type	Method and Description
Class<? extends KeyValuesFinder>	getAttachmentTypesValuesFinderClass()
Class<? extends Document>	getDocumentClass()
protected DocumentEntry	getDocumentEntryForView() Retrieves the associated DocumentEntry for the document view
boolean	isAllowsNoteAttachments()
boolean	isAllowsNoteFYI()
boolean	isDisplayTopicFieldInNotes()
void	performInitialization(View view, Object model) The following initialization is performed: Retrieve the document entry Set up the document view authorizer and presentation controller
void	setAllowsNoteAttachments(boolean allowsNoteAttachments)
void	setAllowsNoteFYI(boolean allowsNoteFYI)
void	setAttachmentTypesValuesFinderClass(Class<? extends KeyValuesFinder> attachmentTypesValuesFinderClass)
void	setDisplayTopicFieldInNotes(boolean displayTopicFieldInNotes)
void	setDocumentClass(Class<? extends Document> documentClass)

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

getFormPostUrl, isRenderForm, isValidateClientSide, isValidateServerSide, setFormPostUrl, setRenderForm, setValidateClientSide, setValidateServerSide

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

addToClientSideState, assignComponentIds, getAbstractTypeClasses, getActionFlags, getAdditionalCssFiles, getAdditionalScriptFiles, getAppendOption, getApplicationFooter, getApplicationHeader, getAuthorizer, getBreadcrumbs, getClientSideState, getComponentPrototypes, getComponentsForLifecycle, getComponentTypeName, getCurrentPage, getCurrentPageId, getDefaultBindingObjectPath, getEditModes, getEntryPageId, getExpressionVariables, getFormClass, getGrowls, getIdSequence, getItems, getNavigation, getNextId, getPage, getPreLoadScript, getPresentationController, getSupportedComponents, getSupportsOnDocumentReady, getSupportsOnLoad, getSupportsOnSubmit, getTheme, getViewHelperService, getViewHelperServiceClassName, getViewIndex, getViewLabelFieldPropertyName, getViewMenuGrouping, getViewMenuLink, getViewName, getViewNamespaceCode, getViewRequestParameters, getViewStatus, getViewTypeName, index, isBreadcrumbsInApplicationHeader, isDialogMode, isFinal, isGrowlMessagingEnabled, isInitialized, isSinglePageView, isSupportsReadOnlyFieldsOverride, isTranslateCodes, isValidateDirty, performFinalize, setAbstractTypeClasses, setActionFlags, setAdditionalCssFiles, setAdditionalScriptFiles, setAppendOption, setApplicationFooter, setApplicationHeader, setAuthorizer, setAuthorizerClass, setBreadcrumbs, setBreadcrumbsInApplicationHeader, setClientSideState, setCurrentPageId, setDefaultBindingObjectPath, setDialogMode, setEditModes, setEntryPageId, setExpressionVariables, setFormClass, setGrowlMessagingEnabled, setGrowls, setIdSequence, setItems, setNavigation, setPage, setPreLoadScript, setPresentationController, setPresentationControllerClass, setSinglePageView, setSupportsReadOnlyFieldsOverride, setTheme, setTranslateCodes, setValidateDirty, setViewHelperServiceClassName, setViewLabelFieldPropertyName, setViewMenuGrouping, setViewMenuLink, setViewName, setViewNamespaceCode, setViewRequestParameters, setViewStatus, setViewTypeName

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

getAdditionalMessageKeys, getAllInputFields, getErrorsField, getFooter, getHeader, getHelp, getInputFields, getInstructionalMessageField, getInstructionalText, getItemOrderingSequence, getLayoutManager, isFieldContainer, performApplyModel, setAdditionalMessageKeys, setErrorsField, setFieldContainer, setFooter, setHeader, setHelp, setInstructionalMessageField, setInstructionalText, setItemOrderingSequence, setLayoutManager, setRenderFooter, setRenderHeader

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

addStyleClass, appendToStyle, getAlign, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentSecurity, getComponentSecurityClass, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getEventCode, getFactoryId, getFinalizeMethodAdditionalArguments, 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, getPropertyReplacerComponents, getPropertyReplacers, getRefreshDiscloseMethodToCall, 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, isPersistInSession, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setComponentSecurity, setConditionalRefresh, setContext, setFactoryId, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setHidden, setId, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPersistInSession, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshDiscloseMethodToCall, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setStyleClasses, setTemplate, setTitle, setValign, setWidth

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

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

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

addStyleClass, appendToStyle, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRequired, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isPersistInSession, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, pushAllToContext, pushObjectToContext, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setComponentSecurity, setConditionalRefresh, setContext, setFactoryId, setHidden, setId, setOrder, setPersistInSession, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setStyleClasses, setTemplate, setTitle

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

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

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, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnUnload, setOnBlurScript, setOnDocumentReadyScript, setOnLoadScript

Constructor Detail

DocumentView

public DocumentView()

Method Detail

performInitialization

public void performInitialization(View view,
                                  Object model)

The following initialization is performed:

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

Specified by:

performInitialization in interface Component

Overrides:

performInitialization in class View

Parameters:

view - - view instance in which the component belongs

model - - object instance containing the view data

See Also:

ContainerBase.performInitialization(org.kuali.rice.krad.uif.view.View, java.lang.Object)

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()

setDocumentClass

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

isAllowsNoteAttachments

public boolean isAllowsNoteAttachments()

setAllowsNoteAttachments

public void setAllowsNoteAttachments(boolean allowsNoteAttachments)

isAllowsNoteFYI

public boolean isAllowsNoteFYI()

setAllowsNoteFYI

public void setAllowsNoteFYI(boolean allowsNoteFYI)

isDisplayTopicFieldInNotes

public boolean isDisplayTopicFieldInNotes()

setDisplayTopicFieldInNotes

public void setDisplayTopicFieldInNotes(boolean displayTopicFieldInNotes)

getAttachmentTypesValuesFinderClass

public Class<? extends KeyValuesFinder> getAttachmentTypesValuesFinderClass()

setAttachmentTypesValuesFinderClass

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