public class DocumentView extends FormView
Provides commons configuration and default behavior applicable to documents in the KRAD module.
applyDirtyCheck, viewIndextemplateOptionscomponentCodeINITIAL_ORDER_VALUE| Constructor and Description |
|---|
DocumentView() |
| Modifier and Type | Method and Description |
|---|---|
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 |
int |
getExplanationDataMaxLength()
Returns the maximum allowed length for explanation notes within the document
|
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
|
boolean |
isSuperUserView()
Indicates whether the view is a super user view, used for
KEW functionality
|
void |
performInitialization(Object model)
The following initialization is performed:
Retrieve the document entry
Makes sure that the header is set.
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
The following updates are done here:
Invoke performInitialize on component modifiers
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
|
void |
setSuperUserView(boolean superUserView) |
getAdditionalHiddenValues, getFormPostUrl, isRenderForm, isValidateClientSide, isValidateServerSide, performFinalize, setAdditionalHiddenValues, setFormPostUrl, setRenderForm, setValidateClientSide, setValidateServerSideaddViewTemplate, 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, 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, sortItemsgetAdditionalTemplates, getDefaultItemPosition, getEnterKeyAction, getFooter, getHeader, getHeaderText, getHelp, getHelpTitle, getInstructionalMessage, getInstructionalText, getLayoutManager, getValidationMessages, isProcessRemoteFieldHolders, setDefaultItemPosition, setEnterKeyAction, setFooter, setHeader, setHeaderText, setHelp, setInstructionalMessage, setInstructionalText, setLayoutManager, setRenderFooter, setRenderHeader, setTooltipOfComponent, setValidationMessagesaddAriaAttribute, 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, skipLifecyclegetExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressionscopy, dataDictionaryPostProcessing, getComponentCode, setComponentCodeequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddAriaAttribute, 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, setWrapperStylegetExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressionsdataDictionaryPostProcessing, getComponentCodecheckMutable, getContainerIdSuffix, getId, getPhasePathMapping, getViewPath, getViewStatus, isFinal, isInitialized, isModelApplied, isMutable, isRender, pushAllToContext, pushObjectToContext, setContainerIdSuffix, setId, setPhasePathMapping, setRender, setViewPath, skipLifecyclegetOnBlurScript, 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, setOnUnloadScriptpublic DocumentView()
public void performInitialization(Object model)
ViewSessionPolicy.enableTimeoutWarning is enabled add the session timeout dialogs to the
views list of dialog groupsWhere 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.
performInitialization in interface LifecycleElementperformInitialization in class Viewmodel - - object instance containing the view dataComponentDefaultInitializeTaskprotected DocumentEntry getDocumentEntryForView()
DocumentEntry for the document viewpublic int getExplanationDataMaxLength()
The max length for the explanation data is calculated as the difference between the max length of the entire note and the length of the introduction message plus a whitespace.
public Class<? extends Document> getDocumentClass()
public void setDocumentClass(Class<? extends Document> documentClass)
documentClass - public boolean isAllowsNoteAttachments()
public void setAllowsNoteAttachments(boolean allowsNoteAttachments)
allowsNoteAttachments - public boolean isAllowsNoteFYI()
public void setAllowsNoteFYI(boolean allowsNoteFYI)
allowsNoteFYI - public boolean isDisplayTopicFieldInNotes()
public void setDisplayTopicFieldInNotes(boolean displayTopicFieldInNotes)
displayTopicFieldInNotes - public Class<? extends KeyValuesFinder> getAttachmentTypesValuesFinderClass()
public void setAttachmentTypesValuesFinderClass(Class<? extends KeyValuesFinder> attachmentTypesValuesFinderClass)
attachmentTypesValuesFinderClass - public boolean isSuperUserView()
public void setSuperUserView(boolean superUserView)
isSuperUserView()Copyright © 2005–2016 The Kuali Foundation. All rights reserved.