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

Interface PageGroup

All Superinterfaces:
Cloneable, Component, Container, Copyable, DictionaryBean, Group, Helpable, LifecycleElement, Ordered, org.springframework.core.Ordered, ScriptEventSupport, Serializable, UifDictionaryBean
All Known Implementing Classes:
PageGroupBase
public interface PageGroup extends Group
Interface for top-level page components, to be used as items in a multi-page view.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Details

    • isAutoFocus

      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.
      Returns:
      the autoFocus

    • setAutoFocus

      void setAutoFocus(boolean autoFocus)
      Parameters:
      autoFocus - the autoFocus to set

    • getBreadcrumbOptions

      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.

      Returns:
      the BreadcrumbOptions

    • setBreadcrumbOptions

      void setBreadcrumbOptions(PageBreadcrumbOptions breadcrumbOptions)
      Set the breadcrumbOptions
      Parameters:
      breadcrumbOptions -

    • getHomewardPathBreadcrumbs

      List<BreadcrumbItem> getHomewardPathBreadcrumbs()
      Gets the breadcrumb items indicating a homeward path.
      Returns:
      breadcrumb items

    • getPreViewBreadcrumbs

      List<BreadcrumbItem> getPreViewBreadcrumbs()
      Gets the breadcrumb items leading to the current view.
      Returns:
      breadcrumb items

    • getPrePageBreadcrumbs

      List<BreadcrumbItem> getPrePageBreadcrumbs()
      Gets the breadcrumb items leading to the current page.
      Returns:
      breadcrumb items

    • getBreadcrumbOverrides

      List<BreadcrumbItem> getBreadcrumbOverrides()
      Gets the breadcrumb items overrides.
      Returns:
      breadcrumb items

    • getBreadcrumbItem

      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.

      Returns:
      the breadcrumbItem for this page

    • setBreadcrumbItem

      void setBreadcrumbItem(BreadcrumbItem breadcrumbItem)
      Set the breadcrumbItem for this PageGroup
      Parameters:
      breadcrumbItem -

    • isStickyFooter

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

    • setStickyFooter

      void setStickyFooter(boolean stickyFooter)
      Set to true to make this page's footer sticky
      Parameters:
      stickyFooter -

    • getFormPostUrl

      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.

      Returns:
      post URL

    • setFormPostUrl

      void setFormPostUrl(String formPostUrl)
      Setter for the form post URL
      Parameters:
      formPostUrl -