public class Group extends ContainerBase
Field or other Group
instances
Groups can exist at different levels of the View, providing
conceptual groupings such as the page, section, and group. In addition, other
group types can be created to add behavior like collection support
Group implementation has properties for defaulting the binding
information (such as the parent object path and a binding prefix) for the
fields it contains. During the phase these properties (if given) are set on
the fields contained in the Group that implement
DataBinding, unless they have already been set on the field.
INITIAL_ORDER_VALUE| Constructor and Description |
|---|
Group()
Default Constructor
|
| 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.
|
protected <T> void |
copyProperties(T component)
Copies the properties over for the copy method
|
List<Component> |
getComponentsForLifecycle()
List of components that are contained within the component and should be sent through
the lifecycle
|
String |
getComponentTypeName()
The name for the component type
|
Disclosure |
getDisclosure()
Disclosure widget that provides collapse/expand functionality for the
group
|
String |
getFieldBindByNamePrefix()
Binding prefix string to set on each of the groups
DataField instances |
String |
getFieldBindingObjectPath()
Object binding path to set on each of the group's
InputField instances |
List<? extends Component> |
getItems()
List of Component instances that are held by
the container |
Scrollpane |
getScrollpane()
Scrollpane widget that provides scrolling functionality for the
group
|
Set<Class<? extends Component>> |
getSupportedComponents()
Set of Component classes that may be placed
into the container |
boolean |
isRenderLoading()
Determine the group should be rendered on initial load, or if a loading message should be rendered instead.
|
void |
performInitialization(View view,
Object model)
The following actions are performed:
Sets the bindByNamePrefix if blank on any InputField and
FieldGroup instances within the items List
|
void |
setDisclosure(Disclosure disclosure)
Setter for the group's disclosure instance
|
void |
setFieldBindByNamePrefix(String fieldBindByNamePrefix)
Setter for the field binding prefix
|
void |
setFieldBindingObjectPath(String fieldBindingObjectPath)
Setter for the field object binding path
|
void |
setItems(List<? extends Component> items)
Setter for the Group's list of components
|
void |
setScrollpane(Scrollpane scrollpane)
Setter for the group's scrollpane instance
|
getComponentPrototypes, getDefaultItemPosition, getFooter, getHeader, getHeaderText, getHelp, getHelpTitle, getInstructionalMessage, getInstructionalText, getLayoutManager, getValidationMessages, performApplyModel, performFinalize, setDefaultItemPosition, setFooter, setHeader, setHeaderText, setHelp, setInstructionalMessage, setInstructionalText, setLayoutManager, setRenderFooter, setRenderHeader, setTooltipOfComponent, setValidationMessages, sortItemsaddCellCssClass, 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, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, 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, setRetrieveViaAjax, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setWidthgetExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraphgetComponentCode, getNamespaceCode, setComponentCode, setNamespaceCodeclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddCellCssClass, 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, isRetrieveViaAjax, isSelfRendered, 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, setRetrieveViaAjax, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setWidthgetExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraphgetComponentCode, getNamespaceCodegetOnBlurScript, 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, setOnUnloadScriptpublic Group()
public void performInitialization(View view, Object model)
performInitialization in interface ComponentperformInitialization in class ContainerBaseview - - view instance in which the component belongsmodel - - object instance containing the view dataComponentBase.performInitialization(org.kuali.rice.krad.uif.view.View,
java.lang.Object)public List<Component> getComponentsForLifecycle()
Component
Used by ViewHelperService for the various lifecycle callbacks
getComponentsForLifecycle in interface ComponentgetComponentsForLifecycle in class ContainerBaseComponentBase.getComponentsForLifecycle()public Set<Class<? extends Component>> getSupportedComponents()
ContainerSet of Component classes that may be placed
into the container
If an empty or null list is returned, it is assumed the container supports all components. The returned set will be used by dictionary validators and allows renders to make assumptions about the contained components
Container.getSupportedComponents()public String getComponentTypeName()
ComponentThis is used within the rendering layer to pass the component instance into the template. The component instance is exported under the name given by this method.
Component.getComponentTypeName()public String getFieldBindByNamePrefix()
DataField instances
As 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
public void setFieldBindByNamePrefix(String fieldBindByNamePrefix)
fieldBindByNamePrefix - public String getFieldBindingObjectPath()
InputField instances
When 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.
BindingInfo.getBindingObjectPath()public void setFieldBindingObjectPath(String fieldBindingObjectPath)
fieldBindingObjectPath - public Disclosure getDisclosure()
public void setDisclosure(Disclosure disclosure)
disclosure - public Scrollpane getScrollpane()
public void setScrollpane(Scrollpane scrollpane)
scrollpane - public List<? extends Component> getItems()
ContainerList of Component instances that are held by
the container
Contained components are rendered within the section template by calling
the associated LayoutManager.
getItems in interface ContainergetItems in class ContainerBaseContainerBase.getItems()public void setItems(List<? extends Component> items)
setItems in interface ContainersetItems in class ContainerBaseitems - protected <T> void copyProperties(T component)
ComponentBasecopyProperties in class ContainerBasecomponent - base beanComponentBase.copy()public void completeValidation(ValidationTrace tracer)
ComponentcompleteValidation in interface ComponentcompleteValidation in class ContainerBasetracer - Record of component's locationComponent.completeValidation(org.kuali.rice.krad.datadictionary.validator.ValidationTrace)public boolean isRenderLoading()
Copyright © 2005-2015 The Kuali Foundation. All Rights Reserved.