Package 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, Ordered, 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:

  • Constructor Details

    • DocumentView

      public DocumentView()

  • Method Details

    • performInitialization

      public 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

      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:

    • getDocumentEntryForView

      protected DocumentEntry getDocumentEntryForView()
      Retrieves the associated DocumentEntry for the document view
      Returns:
      DocumentEntry entry (exception thrown if one is not found)

    • getExplanationDataMaxLength

      public int getExplanationDataMaxLength()
      Returns the maximum allowed length for explanation notes within the document

      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.

      Returns:
      int

    • getDocumentClass

      public Class<? extends Document> getDocumentClass()
      Gets the document class
      Returns:
      Classinvalid input: '<'? extends Document> 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 org.kuali.rice.krad.keyvalues.KeyValuesFinder> getAttachmentTypesValuesFinderClass()
      Gets attachment types values finder classs
      Returns:
      attachment types values finder class

    • setAttachmentTypesValuesFinderClass

      public void setAttachmentTypesValuesFinderClass(Class<? extends org.kuali.rice.krad.keyvalues.KeyValuesFinder> attachmentTypesValuesFinderClass)
      Sets attachment types values finder classs
      Parameters:
      attachmentTypesValuesFinderClass -

    • isSuperUserView

      public boolean isSuperUserView()
      Indicates whether the view is a super user view, used for KEW functionality
      Returns:
      true if the view is a super user viwe

    • setSuperUserView

      public void setSuperUserView(boolean superUserView)
      See Also: