org.kuali.rice.krad.uif.container
Class PageGroup

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.Group
                      org.kuali.rice.krad.uif.container.PageGroup

All Implemented Interfaces:

Serializable, Cloneable, DictionaryBean, UifDictionaryBean, Component, ScriptEventSupport, Container, Helpable, org.springframework.core.Ordered

public class PageGroup
extends Group

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

PageGroup()

Method Summary

void	completeValidation(ValidationTrace tracer) Validates different requirements of component compiling a series of reports detailing information on errors found in the component.
protected <T> void	copyProperties(T component) Copies the properties over for the copy method
BreadcrumbItem	getBreadcrumbItem() The breadcrumbItem for this page.
PageBreadcrumbOptions	getBreadcrumbOptions() The breadcrumbOptions specific to this page.
List<Component>	getComponentsForLifecycle() List of components that are contained within the component and should be sent through the lifecycle
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(View view, Object model, Component parent) Perform finalize here adds to its document ready script the setupValidator js function for setting up the validator for this view.
void	performInitialization(View view, Object model) Setup various breadcrumbOptions inherited from view if not explicitly set.
void	setAutoFocus(boolean autoFocus)
void	setBreadcrumbItem(BreadcrumbItem breadcrumbItem) Set the breadcrumbItem for this PageGroup
void	setBreadcrumbOptions(PageBreadcrumbOptions breadcrumbOptions) Set the breadcrumbOptions
void	setStickyFooter(boolean stickyFooter) Set to true to make this page's footer sticky

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

getComponentTypeName, getDisclosure, getFieldBindByNamePrefix, getFieldBindingObjectPath, getItems, getScrollpane, getSupportedComponents, setDisclosure, setFieldBindByNamePrefix, setFieldBindingObjectPath, setItems, setScrollpane

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

getComponentPrototypes, getDefaultItemPosition, getFooter, getHeader, getHeaderText, getHelp, getHelpTitle, getInstructionalMessage, getInstructionalText, getLayoutManager, getValidationMessages, 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

addCellCssClass, addDataAttribute, addDataAttributeIfNonEmpty, addStyleClass, appendToStyle, copy, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellStyleClassesAsString, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getComponentSecurityClass, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, isUseAjaxCallForContent, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setUseAjaxCallForContent, setValign, setWidth

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

getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph

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

getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

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

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

addCellCssClass, addDataAttribute, addStyleClass, appendToStyle, copy, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isUseAjaxCallForContent, pushAllToContext, pushObjectToContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setUseAjaxCallForContent, setValign, setWidth

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

getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph

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

getComponentCode, getNamespaceCode

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

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript

Constructor Detail

PageGroup

public PageGroup()

Method Detail

performInitialization

public void performInitialization(View view,
                                  Object model)

Setup various breadcrumbOptions inherited from view if not explicitly set.

Specified by:

performInitialization in interface Component

Overrides:

performInitialization in class Group

Parameters:

view - - view instance in which the component belongs

model - - object instance containing the view data

See Also:

ComponentBase.performInitialization(org.kuali.rice.krad.uif.view.View, Object)

performFinalize

public void performFinalize(View view,
                            Object model,
                            Component parent)

Perform finalize here adds to its document ready script the setupValidator js function for setting up the validator for this view. Also setup various breadcrumb related settings for the page.

Specified by:

performFinalize in interface Component

Overrides:

performFinalize in class ContainerBase

Parameters:

view - - view instance that should be finalized for rendering

model - - top level object containing the data

parent - - parent component

See Also:

ContainerBase.performFinalize(org.kuali.rice.krad.uif.view.View, Object, org.kuali.rice.krad.uif.component.Component)

getComponentsForLifecycle

public List<Component> getComponentsForLifecycle()

Description copied from interface: Component

List of components that are contained within the component and should be sent through the lifecycle

Used by ViewHelperService for the various lifecycle callbacks

Specified by:

getComponentsForLifecycle in interface Component

Overrides:

getComponentsForLifecycle in class Group

Returns:

List child components

See Also:

ComponentBase.getComponentsForLifecycle()

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.

Returns:

the autoFocus

setAutoFocus

public void setAutoFocus(boolean autoFocus)

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.

Returns:

the BreadcrumbOptions

setBreadcrumbOptions

public void setBreadcrumbOptions(PageBreadcrumbOptions breadcrumbOptions)

Set the breadcrumbOptions

Parameters:

breadcrumbOptions -

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.

Returns:

the breadcrumbItem for this page

setBreadcrumbItem

public void setBreadcrumbItem(BreadcrumbItem breadcrumbItem)

Set the breadcrumbItem for this PageGroup

Parameters:

breadcrumbItem -

isStickyFooter

public 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

public void setStickyFooter(boolean stickyFooter)

Set to true to make this page's footer sticky

Parameters:

stickyFooter -

copyProperties

protected <T> void copyProperties(T component)

Description copied from class: ComponentBase

Copies the properties over for the copy method

Overrides:

copyProperties in class Group

Parameters:

component - base bean

See Also:

ComponentBase.copy()

completeValidation

public void completeValidation(ValidationTrace tracer)

Description copied from interface: Component

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 Group

Parameters:

tracer - Record of component's location

See Also:

Component.completeValidation(org.kuali.rice.krad.datadictionary.validator.ValidationTrace)