Package org.kuali.rice.krad.uif.container

Class PageGroupBase

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.container.GroupBase
org.kuali.rice.krad.uif.container.PageGroupBase
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, Container, Group, PageGroup, LifecycleElement, Helpable, org.springframework.core.Ordered
public class PageGroupBase extends GroupBase implements PageGroup
A PageGroup represents a page of a View.

PageGroups should only be used with a View component. The contain the main content that will be seen by the user using the View. Like all other groups, PageGroup can contain items, headers and footers. Pages also have their own BreadcrumbItem.

Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • PageGroupBase

      public PageGroupBase()

  • Method Details

    • performInitialization

      public void performInitialization(Object model)
      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 GroupBase
      Parameters:
      model - - object instance containing the view data
      See Also:

    • performFinalize

      public void performFinalize(Object model, LifecycleElement parent)
      Sets the section boolean to true if this group has a rendering header with text The following finalization is performed:
      • Sets the headerText of the header Group if it is blank
      • Set the messageText of the summary Message if it is blank
      • Finalizes LayoutManager
      The following finalization is done here:
      • progressiveRender and conditionalRefresh variables are processed if set
      • If any of the style properties were given, sets the style string on the style property
      • Set the skipInTabOrder flag for nested components
      The last phase before the view is rendered

      Here final preparations can be made based on the updated view state.

      Specified by:
      performFinalize in interface LifecycleElement
      Overrides:
      performFinalize in class GroupBase
      Parameters:
      model - - top level object containing the data
      parent - - parent component

    • getAdditionalTemplates

      public List<String> getAdditionalTemplates()
      Gets additional templates that will be required during the rendering of this component.

      If a parent or sibling component is referred to by this component's template, include that component's template here to ensure that it has been compiled already during bottom-up inline rendering.

      Specified by:
      getAdditionalTemplates in interface Component
      Overrides:
      getAdditionalTemplates in class ContainerBase
      Returns:
      additional templates required during rendering

    • isAutoFocus

      public boolean isAutoFocus()
      When this is true, the first field of the kualiForm will be focused by default, unless the parameter focusId is set on the form (by an actionField), then that field will be focused instead. When this setting if false, no field will be focused.
      Specified by:
      isAutoFocus in interface PageGroup
      Returns:
      the autoFocus

    • setAutoFocus

      public void setAutoFocus(boolean autoFocus)
      Specified by:
      setAutoFocus in interface PageGroup
      Parameters:
      autoFocus - the autoFocus to set

    • getBreadcrumbOptions

      public PageBreadcrumbOptions getBreadcrumbOptions()
      The breadcrumbOptions specific to this page.

      Important note: breadcrumbOptions for preViewBreadcrumbs, prePageBreadcrumbs, and breadcrumbOverrides are inherited from the View if not explicitly set from the PageGroup level's breadcrumbOptions (if they contain a value at the view level and the property is null at the page level - default behavior). Explicitly providing an empty list or setting these properties at the PageGroup level will override this inheritance.

      Specified by:
      getBreadcrumbOptions in interface PageGroup
      Returns:
      the BreadcrumbOptions

    • setBreadcrumbOptions

      public void setBreadcrumbOptions(PageBreadcrumbOptions breadcrumbOptions)
      Set the breadcrumbOptions
      Specified by:
      setBreadcrumbOptions in interface PageGroup
      Parameters:
      breadcrumbOptions -

    • getHomewardPathBreadcrumbs

      public List<BreadcrumbItem> getHomewardPathBreadcrumbs()
      Gets the breadcrumb items indicating a homeward path.
      Specified by:
      getHomewardPathBreadcrumbs in interface PageGroup
      Returns:
      breadcrumb items

    • getPreViewBreadcrumbs

      public List<BreadcrumbItem> getPreViewBreadcrumbs()
      Gets the breadcrumb items leading to the current view.
      Specified by:
      getPreViewBreadcrumbs in interface PageGroup
      Returns:
      breadcrumb items

    • getPrePageBreadcrumbs

      public List<BreadcrumbItem> getPrePageBreadcrumbs()
      Gets the breadcrumb items leading to the current page.
      Specified by:
      getPrePageBreadcrumbs in interface PageGroup
      Returns:
      breadcrumb items

    • getBreadcrumbOverrides

      public List<BreadcrumbItem> getBreadcrumbOverrides()
      Gets the breadcrumb items overrides.
      Specified by:
      getBreadcrumbOverrides in interface PageGroup
      Returns:
      breadcrumb items

    • getBreadcrumbItem

      public BreadcrumbItem getBreadcrumbItem()
      The breadcrumbItem for this page. This is the item that (generally) appears last in the breadcrumb list.

      If a label is not explicitly defined, the label is retrieved from the headerText of the PageGroup's header. If this is also not defined, the breadcrumbItem is NOT rendered. The url properties do not need to be provided for this breadcrumbItem because it is automatically determined based on the this PageGroup's pageId, viewId, and controllerMapping retrieved from the initial controller request.

      Specified by:
      getBreadcrumbItem in interface PageGroup
      Returns:
      the breadcrumbItem for this page

    • setBreadcrumbItem

      public void setBreadcrumbItem(BreadcrumbItem breadcrumbItem)
      Set the breadcrumbItem for this PageGroup
      Specified by:
      setBreadcrumbItem in interface PageGroup
      Parameters:
      breadcrumbItem -

    • isStickyFooter

      public boolean isStickyFooter()
      When true, this page's footer will become sticky (fixed) at the bottom of the window
      Specified by:
      isStickyFooter in interface PageGroup
      Returns:
      true if the page footer is sticky, false otherwise

    • setStickyFooter

      public void setStickyFooter(boolean stickyFooter)
      Set to true to make this page's footer sticky
      Specified by:
      setStickyFooter in interface PageGroup
      Parameters:
      stickyFooter -

    • 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.

      Specified by:
      getFormPostUrl in interface PageGroup
      Returns:
      post URL

    • setFormPostUrl

      public void setFormPostUrl(String formPostUrl)
      Setter for the form post URL
      Specified by:
      setFormPostUrl in interface PageGroup
      Parameters:
      formPostUrl -

    • completeValidation

      public void completeValidation(ValidationTrace tracer)
      Validates different requirements of component compiling a series of reports detailing information on errors found in the component. Used by the RiceDictionaryValidator.
      Specified by:
      completeValidation in interface Component
      Overrides:
      completeValidation in class GroupBase
      Parameters:
      tracer - Record of component's location