org.kuali.rice.krad.uif.container

Interface PageGroup

All Superinterfaces:

Cloneable, Component, Container, Copyable, DictionaryBean, Group, Helpable, LifecycleElement, 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)

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

Method Summary

Methods

Modifier and Type	Method and Description
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	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 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

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

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

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, afterEvaluateExpression, appendToStyle, completeValidation, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAdditionalTemplates, getAlign, getAriaAttributes, getAriaAttributesAsString, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getComponentTypeName, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getExcludeIf, getExcludeUnless, getFieldsToSendOnRefresh, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getLibraryCssClasses, getMethodToCallOnRefresh, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getReadOnly, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRole, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, getWrapperCssClasses, getWrapperStyle, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFieldsToSendOnRefresh, setForceSessionPersistence, setHidden, setLibraryCssClasses, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRole, 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, getContainerIdSuffix, getId, getPhasePathMapping, getViewPath, getViewStatus, isFinal, isInitialized, isModelApplied, isMutable, isRender, notifyCompleted, performApplyModel, performFinalize, performInitialization, pushAllToContext, pushObjectToContext, setContainerIdSuffix, setId, setPhasePathMapping, setRender, setViewPath, skipLifecycle

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

clone

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

Method Detail

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 -