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

Serialized Form

Field Summary

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

templateOptions

Fields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

componentCode, namespaceCode

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

PageGroupBase()

Method Summary

void	completeValidation(ValidationTrace tracer) Validates different requirements of component compiling a series of reports detailing information on errors found in the component.
List<String>	getAdditionalTemplates() Gets additional templates that will be required during the rendering of this component.
BreadcrumbItem	getBreadcrumbItem() The breadcrumbItem for this page.
PageBreadcrumbOptions	getBreadcrumbOptions() The breadcrumbOptions specific to this page.
List<BreadcrumbItem>	getBreadcrumbOverrides() Gets the breadcrumb items overrides.
String	getFormPostUrl() Specifies the URL the view's form should post to
List<BreadcrumbItem>	getHomewardPathBreadcrumbs() Gets the breadcrumb items indicating a homeward path.
List<BreadcrumbItem>	getPrePageBreadcrumbs() Gets the breadcrumb items leading to the current page.
List<BreadcrumbItem>	getPreViewBreadcrumbs() Gets the breadcrumb items leading to the current view.
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.
boolean	isStickyFooter() When true, this page's footer will become sticky (fixed) at the bottom of the window
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
void	performInitialization(Object model) The following actions are performed: Sets the bindByNamePrefix if blank on any InputField and FieldGroup instances within the items List The following initialization is performed: Sorts the containers list of components Initializes the instructional field if necessary Initializes LayoutManager Initializes the component
void	setAutoFocus(boolean autoFocus)
void	setBreadcrumbItem(BreadcrumbItem breadcrumbItem) Set the breadcrumbItem for this PageGroup
void	setBreadcrumbOptions(PageBreadcrumbOptions breadcrumbOptions) Set the breadcrumbOptions
void	setFormPostUrl(String formPostUrl) Setter for the form post URL
void	setStickyFooter(boolean stickyFooter) Set to true to make this page's footer sticky

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

getComponentTypeName, getDisclosure, getFieldBindByNamePrefix, getFieldBindingObjectPath, getItems, getScrollpane, getSupportedComponents, getWrapperTag, isClosedAjaxDisclosure, isRenderLoading, setDisclosure, setFieldBindByNamePrefix, setFieldBindingObjectPath, setItems, setScrollpane, setWrapperTag

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

getDefaultItemPosition, getFooter, getHeader, getHeaderText, getHelp, getHelpTitle, getInstructionalMessage, getInstructionalText, getLayoutManager, getValidationMessages, isProcessRemoteFieldHolders, performApplyModel, setDefaultItemPosition, setFooter, setHeader, setHeaderText, setHelp, setInstructionalMessage, setInstructionalText, setLayoutManager, setRenderFooter, setRenderHeader, setTooltipOfComponent, setValidationMessages, sortItems

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

addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, checkMutable, clone, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, 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, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getViewPath, getViewStatus, getWidth, getWrapperCssClasses, getWrapperCssClassesAsString, getWrapperStyle, initializeComponentSecurity, initializePendingTasks, isDisableSessionPersistence, isDisclosedByAction, isEditAuthz, isFinal, isForceSessionPersistence, isHidden, isInitialized, isModelApplied, isMutable, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, isViewAuthz, notifyCompleted, preventModification, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setEditAuthz, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, 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, setRowSpan, setScriptDataAttributes, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewAuthz, setViewPath, setViewStatus, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle, skipLifecycle

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode, unwrap

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.krad.uif.container.Group

getDisclosure, getFieldBindByNamePrefix, getFieldBindingObjectPath, getHeaderText, getScrollpane, getWrapperTag, isRenderLoading, setDisclosure, setFieldBindByNamePrefix, setFieldBindingObjectPath, setHeaderText, setRenderFooter, setScrollpane, setWrapperTag

Methods inherited from interface org.kuali.rice.krad.uif.container.Container

getFooter, getHeader, getInstructionalMessage, getItems, getLayoutManager, getSupportedComponents, getValidationMessages, isProcessRemoteFieldHolders, setFooter, setHeader, setInstructionalMessage, setItems, setLayoutManager, setValidationMessages, sortItems

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

addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getComponentTypeName, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getLibraryCssClasses, getMethodToCallOnRefresh, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, getWrapperCssClasses, getWrapperStyle, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setLibraryCssClasses, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRowSpan, setScriptDataAttributes, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle

Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Methods inherited from interface org.kuali.rice.krad.uif.util.LifecycleElement

checkMutable, getContext, getId, getPhasePathMapping, getViewPath, getViewStatus, initializePendingTasks, isFinal, isInitialized, isModelApplied, isMutable, isRender, notifyCompleted, performApplyModel, pushAllToContext, pushObjectToContext, setContext, setId, setPhasePathMapping, setRender, setViewPath, setViewStatus, skipLifecycle

Methods inherited from interface org.kuali.rice.krad.datadictionary.Copyable

clone, copy, preventModification, unwrap

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

getOnBlurScript, 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, setOnUnloadScript

Methods inherited from interface org.kuali.rice.krad.uif.widget.Helpable

getHelp, getHelpTitle, setHelp, setTooltipOfComponent

Constructor Detail

PageGroupBase

public PageGroupBase()

Method Detail

performInitialization

public void performInitialization(Object model)

The following actions are performed:

• Sets the bindByNamePrefix if blank on any InputField and FieldGroup instances within the items List

The following initialization is performed:

• Sorts the containers list of components
• Initializes the instructional field if necessary
• Initializes LayoutManager

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:

ComponentDefaultInitializeTask

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

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

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

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

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

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

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