Interface Group
- All Superinterfaces:
Cloneable,Component,Container,Copyable,DictionaryBean,Helpable,LifecycleElement,Ordered,org.springframework.core.Ordered,ScriptEventSupport,Serializable,UifDictionaryBean
- All Known Subinterfaces:
CollectionGroup,PageGroup
- All Known Implementing Classes:
AccordionGroup,CollectionGroupBase,DialogGroup,GroupBase,LightTable,LinkGroup,PageGroupBase,SidebarNavigationGroup,TabGroup,TabNavigationGroup,TreeGroup
Common interface for group components.
- Author:
- Kuali Rice Team (rice.collab@kuali.org)
-
Field Summary
Fields inherited from interface org.kuali.rice.krad.uif.component.Ordered
INITIAL_ORDER_VALUEFields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE -
Method Summary
Modifier and TypeMethodDescriptionDisclosure widget that provides collapse/expand functionality for the groupBinding prefix string to set on each of the groupsDataFieldinstancesObject binding path to set on each of the group'sInputFieldinstancesGetter for headerTextScrollpane widget that provides scrolling functionality for the groupbooleanDetermine the group should be rendered on initial load, or if a loading message should be rendered instead.voidsetDisclosure(Disclosure disclosure) Setter for the group's disclosure instancevoidsetFieldBindByNamePrefix(String fieldBindByNamePrefix) Setter for the field binding prefixvoidsetFieldBindingObjectPath(String fieldBindingObjectPath) Setter for the field object binding pathvoidsetHeaderText(String headerText) Setter for headerText.voidsetRenderFooter(boolean renderFooter) Setter for renderFooter.voidsetScrollpane(Scrollpane scrollpane) Setter for the group's scrollpane instancevoidsetWrapperTag(String footer) 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, 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, setWrapperStyleMethods 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, sortItemsMethods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean
dataDictionaryPostProcessing, getComponentCode, getNamespaceCodeMethods inherited from interface org.kuali.rice.krad.uif.widget.Helpable
getHelp, getHelpTitle, setHelp, setTooltipOfComponentMethods 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, skipLifecycleMethods 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, setOnUnloadScriptMethods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean
getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions
-
Method Details
-
getFieldBindByNamePrefix
String getFieldBindByNamePrefix()Binding prefix string to set on each of the groupsDataFieldinstancesAs opposed to setting the bindingPrefix on each attribute field instance, it can be set here for the group. During initialize the string will then be set on each attribute field instance if the bindingPrefix is blank and not a form field
- Returns:
- String binding prefix to set
-
setFieldBindByNamePrefix
Setter for the field binding prefix- Parameters:
fieldBindByNamePrefix-
-
getFieldBindingObjectPath
String getFieldBindingObjectPath()Object binding path to set on each of the group'sInputFieldinstancesWhen the attributes of the group belong to a object whose path is different from the default then this property can be given to set each of the attributes instead of setting the model path on each one. The object path can be overridden at the attribute level. The object path is set to the fieldBindingObjectPath during the initialize phase.
- Returns:
- String model path to set
- See Also:
-
setFieldBindingObjectPath
Setter for the field object binding path- Parameters:
fieldBindingObjectPath-
-
getDisclosure
Disclosure getDisclosure()Disclosure widget that provides collapse/expand functionality for the group- Returns:
- Disclosure instance
-
setDisclosure
Setter for the group's disclosure instance- Parameters:
disclosure-
-
getScrollpane
Scrollpane getScrollpane()Scrollpane widget that provides scrolling functionality for the group- Returns:
- Scrollpane instance
-
setScrollpane
Setter for the group's scrollpane instance- Parameters:
scrollpane-
-
isRenderLoading
boolean isRenderLoading()Determine the group should be rendered on initial load, or if a loading message should be rendered instead.- Returns:
- True if a loading message should be rendered, false if the group should be rendered now.
-
getHeaderText
String getHeaderText()Getter for headerText- Returns:
- headerText
-
setHeaderText
Setter for headerText.- Parameters:
headerText- value
-
getWrapperTag
String getWrapperTag() -
setWrapperTag
-