public class PageGroupBase extends GroupBase implements PageGroup
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.
GroupBase.ACTION_VALIDATION_COMPONENTStemplateOptionscomponentCode, namespaceCodeINITIAL_ORDER_VALUE| Constructor and Description |
|---|
PageGroupBase() |
| Modifier and Type | Method and Description |
|---|---|
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 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
|
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
|
afterEvaluateExpression, buildInputFieldValidationActionScript, getComponentTypeName, getDisclosure, getFieldBindByNamePrefix, getFieldBindingObjectPath, getItems, getScrollpane, getSupportedComponents, getWrapperTag, isAjaxDisclosureGroup, isRenderLoading, setDisclosure, setFieldBindByNamePrefix, setFieldBindingObjectPath, setItems, setNestedComponentId, setScrollpane, setupValidationScripts, setWrapperTag, validateInputFieldgetDefaultItemPosition, getEnterKeyAction, getFooter, getHeader, getHeaderText, getHelp, getHelpTitle, getInstructionalMessage, getInstructionalText, getLayoutManager, getValidationMessages, isProcessRemoteFieldHolders, performApplyModel, setDefaultItemPosition, setEnterKeyAction, setFooter, setHeader, setHeaderText, setHelp, setInstructionalMessage, setInstructionalText, setLayoutManager, setRenderFooter, setRenderHeader, setTooltipOfComponent, setValidationMessages, sortItemsaddAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, checkMutable, clone, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getAriaAttributes, getAriaAttributesAsString, getCanCopyOnReadOnly, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContainerIdSuffix, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getExcludeIf, getExcludeUnless, getFieldsToSendOnRefresh, 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, getReadOnly, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRole, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getViewPath, getViewStatus, getWidth, getWrapperCssClasses, getWrapperCssClassesAsString, getWrapperStyle, initializeComponentSecurity, isDisableSessionPersistence, isDisclosedByAction, isEditAuthz, isFinal, isForceSessionPersistence, isHidden, isInitialized, isModelApplied, isMutable, isOmitFromFormPost, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRender, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, isViewAuthz, notifyCompleted, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCanCopyOnReadOnly, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContainerIdSuffix, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setEditAuthz, setExcludeIf, setExcludeUnless, setFieldsToSendOnRefresh, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, setOmitFromFormPost, 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, setRole, setRowSpan, setScriptDataAttributes, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewAuthz, setViewPath, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle, skipLifecyclegetExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressionscopy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCodeequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetDisclosure, getFieldBindByNamePrefix, getFieldBindingObjectPath, getHeaderText, getScrollpane, getWrapperTag, isRenderLoading, setDisclosure, setFieldBindByNamePrefix, setFieldBindingObjectPath, setHeaderText, setRenderFooter, setScrollpane, setWrapperTaggetEnterKeyAction, getFooter, getHeader, getInstructionalMessage, getItems, getLayoutManager, getSupportedComponents, getValidationMessages, isProcessRemoteFieldHolders, setEnterKeyAction, setFooter, setHeader, setInstructionalMessage, setItems, setLayoutManager, setValidationMessages, sortItemsaddAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, afterEvaluateExpression, appendToStyle, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getAriaAttributes, getAriaAttributesAsString, getCanCopyOnReadOnly, 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, isOmitFromFormPost, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCanCopyOnReadOnly, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFieldsToSendOnRefresh, setForceSessionPersistence, setHidden, setLibraryCssClasses, setOmitFromFormPost, 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, setWrapperStylegetExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressionsdataDictionaryPostProcessing, getComponentCode, getNamespaceCodecheckMutable, getContainerIdSuffix, getId, getPhasePathMapping, getViewPath, getViewStatus, isFinal, isInitialized, isModelApplied, isMutable, isRender, notifyCompleted, performApplyModel, pushAllToContext, pushObjectToContext, setContainerIdSuffix, setId, setPhasePathMapping, setRender, setViewPath, skipLifecyclegetOnBlurScript, 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, setOnUnloadScriptgetHelp, getHelpTitle, setHelp, setTooltipOfComponentpublic PageGroupBase()
public void performInitialization(Object model)
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.
performInitialization in interface LifecycleElementperformInitialization in class GroupBasemodel - - object instance containing the view dataComponentDefaultInitializeTaskpublic void performFinalize(Object model, LifecycleElement parent)
Here final preparations can be made based on the updated view state.
performFinalize in interface LifecycleElementperformFinalize in class GroupBasemodel - - top level object containing the dataparent - - parent componentpublic List<String> getAdditionalTemplates()
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.
getAdditionalTemplates in interface ComponentgetAdditionalTemplates in class ContainerBasepublic boolean isAutoFocus()
isAutoFocus in interface PageGrouppublic void setAutoFocus(boolean autoFocus)
setAutoFocus in interface PageGroupautoFocus - the autoFocus to setpublic PageBreadcrumbOptions getBreadcrumbOptions()
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.
getBreadcrumbOptions in interface PageGroupBreadcrumbOptionspublic void setBreadcrumbOptions(PageBreadcrumbOptions breadcrumbOptions)
setBreadcrumbOptions in interface PageGrouppublic List<BreadcrumbItem> getHomewardPathBreadcrumbs()
getHomewardPathBreadcrumbs in interface PageGrouppublic List<BreadcrumbItem> getPreViewBreadcrumbs()
getPreViewBreadcrumbs in interface PageGrouppublic List<BreadcrumbItem> getPrePageBreadcrumbs()
getPrePageBreadcrumbs in interface PageGrouppublic List<BreadcrumbItem> getBreadcrumbOverrides()
getBreadcrumbOverrides in interface PageGrouppublic BreadcrumbItem getBreadcrumbItem()
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.
getBreadcrumbItem in interface PageGrouppublic void setBreadcrumbItem(BreadcrumbItem breadcrumbItem)
setBreadcrumbItem in interface PageGrouppublic boolean isStickyFooter()
isStickyFooter in interface PageGrouppublic void setStickyFooter(boolean stickyFooter)
setStickyFooter in interface PageGrouppublic String getFormPostUrl()
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.
getFormPostUrl in interface PageGrouppublic void setFormPostUrl(String formPostUrl)
setFormPostUrl in interface PageGrouppublic void completeValidation(ValidationTrace tracer)
completeValidation in interface ComponentcompleteValidation in class GroupBasetracer - Record of component's locationCopyright © 2005–2016 The Kuali Foundation. All rights reserved.