CollectionGroupBase (Rice 2.5.5 API)

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.GroupBase
        
        org.kuali.rice.krad.uif.container.CollectionGroupBase

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, DataBinding, ScriptEventSupport, CollectionGroup, Container, Group, LifecycleElement, Helpable, org.springframework.core.Ordered
```
public class CollectionGroupBase
extends GroupBase
implements CollectionGroup
```
Group that holds a collection of objects and configuration for presenting the collection in the UI. Supports functionality such as add line, line actions, and nested collections.
Note the standard header/footer can be used to give a header to the collection as a whole, or to provide actions that apply to the entire collection

For binding purposes the binding path of each row field is indexed. The name property inherited from ComponentBase is used as the collection name. The collectionObjectClass property is used to lookup attributes from the data dictionary.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.kuali.rice.krad.uif.container.GroupBase
  GroupBase.ACTION_VALIDATION_COMPONENTS

Field Summary
- Fields inherited from class org.kuali.rice.krad.uif.component.ComponentBase
  templateOptions
- Fields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase
  componentCode, namespaceCode
- 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

Constructors
Constructor and Description

CollectionGroupBase()

Constructors
Constructor and Description
`CollectionGroupBase()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addCollectionPostMetadata()` Add the metadata about this collection to the ViewPostMetadata that is to be kept in memory between posts for use by other methods
`void`	`completeValidation(ValidationTrace tracer)` Validates different requirements of component compiling a series of reports detailing information on errors found in the component.
`CollectionFilter`	`getActiveCollectionFilter()` Collection filter instance for filtering the collection data when the showInactive flag is set to false
`Action`	`getAddBlankLineAction()` The add blank line `Action` field rendered when renderAddBlankLineButton is true
`String`	`getAddItemCssClass()` The css style class that will be added on the add item group or row
`String`	`getAddLabel()` Convenience getter for the add line label field text.
`List<? extends Component>`	`getAddLineActions()` Component fields that should be rendered for the add line.
`BindingInfo`	`getAddLineBindingInfo()` `BindingInfo` instance for the add line property used to determine the full binding path.
`DialogGroup`	`getAddLineDialog()` Dialog group to use for the add line when `CollectionGroup.isAddWithDialog()` is true.
`String`	`getAddLineEnterKeyAction()` Get the id of the add line action to invoke when the enter key is pressed.
`List<? extends Component>`	`getAddLineItems()` List of `Component` instances that should be rendered for the collection add line (if enabled).
`Message`	`getAddLineLabel()` `Message` instance for the add line label
`String`	`getAddLinePlacement()` Indicates the add line placement
`String`	`getAddLinePropertyName()` Name of the property that contains an instance for the add line.
`Action`	`getAddWithDialogAction()` The `Action` that will be displayed that will open the add line group in a dialog.
`BindingInfo`	`getBindingInfo()` Returns the `BindingInfo` instance that is configured for the component
`CollectionGroupBuilder`	`getCollectionGroupBuilder()` `CollectionGroupBuilder` instance that will build the components dynamically for the collection instance
`CollectionGroupSecurity`	`getCollectionGroupSecurity()` Collection Security object that indicates what authorization (permissions) exist for the collection
`protected String`	`getCollectionLabel()` Gets the label for the collection in a human-friendly format.
`QuickFinder`	`getCollectionLookup()` Instance of the `QuickFinder` widget that configures a multi-value lookup for the collection
`Class<?>`	`getCollectionObjectClass()` Object class the collection maintains.
`int`	`getDisplayCollectionSize()` The number of records to display for a collection
`int`	`getDisplayLength()` Gets the displayLength, the number of items to display on the page (assuming useServerPaging is enabled).
`int`	`getDisplayStart()` Gets the displayStart, the index of the first item to display on the page (assuming useServerPaging is enabled).
`protected String`	`getDuplicateLineLabelString(List<String> duplicateLinePropertyNames)` Gets a comma-separated list of the data field labels that are keyed a duplicates.
`List<String>`	`getDuplicateLinePropertyNames()` List of property names that should be checked for duplicates in the collection.
`Action`	`getEditInDialogSaveActionPrototype()` The `Action` that will be displayed within the edit line group in a dialog.
`DialogGroup`	`getEditLineDialogPrototype()` Dialog group prototype to use to create the edit line dialog when `CollectionGroup.isEditWithDialog()` is true.
`Action`	`getEditWithDialogActionPrototype()` The `Action` that will be displayed that will open the edit line group in a dialog.
`int`	`getFilteredCollectionSize()` Gets the number of un-filtered elements from the model collection.
`List<CollectionFilter>`	`getFilters()` List of `CollectionFilter` instances that should be invoked to filter the collection before displaying
`List<? extends Component>`	`getItems()` `List` of `Component` instances that are held by the container
`List<? extends Component>`	`getLineActions()` Action fields that should be rendered for each collection line.
`List<DialogGroup>`	`getLineDialogs()` List of dialog groups that are configured for a line in the collection.
`String`	`getLineEnterKeyAction()` Get the id of the nonAdd line action to invoke when the enter key is pressed.
`String`	`getLineSelectPropertyName()` When `CollectionGroup.isIncludeLineSelectionField()` is true, gives the name of the property the select field should bind to
`String`	`getNewItemsCssClass()` The css style class that will be added on new items
`int`	`getPageSize()`
`String`	`getPropertyName()` Name of the property (relative to the parent object) the component binds to
`List<CollectionGroup>`	`getSubCollections()` List of `CollectionGroup` instances that are sub-collections of the collection represented by this collection group
`int`	`getTotalCollectionSize()`
`protected List<String>`	`getTotalColumns()`
`List<BindingInfo>`	`getUnauthorizedLineBindingInfos()` List of `BindingInfo` instances that represent lines not authorized to be viewed or edited by the user.
`protected void`	`initializeComponentSecurity()` Initializes (if necessary) the component security instance for the component type
`void`	`initializeNewCollectionLine(View view, Object model, CollectionGroup collectionGroup, boolean clearExistingLine)` New collection lines are handled in the framework by maintaining a map on the form.
`boolean`	`isAddWithDialog()` Indicates that a add action should be rendered and that the add group be displayed in a model dialog.
`boolean`	`isCustomEditLineDialog()` Indicates that a custom edit line dialog is provided by the user.
`boolean`	`isEditLineAuthz()`
`boolean`	`isEditWithDialog()` Indicates that an edit action should be rendered and that the edit group be displayed in a model dialog.
`boolean`	`isHighlightAddItem()` Indicates whether the add item group or row should be styled with the #addItemCssClass
`boolean`	`isHighlightNewItems()` Indicates whether new items should be styled with the #newItemsCssClass
`boolean`	`isIncludeLineSelectionField()` Indicates whether lines of the collection group should be selected by rendering a field for each line that will allow selection
`boolean`	`isProcessRemoteFieldHolders()` Do not process remote field holders for collections.
`boolean`	`isRenderAddBlankLineButton()` Indicates that a button will be rendered that allows the user to add blank lines to the collection
`boolean`	`isRenderAddLine()` Indicates whether an add line should be rendered for the collection
`boolean`	`isRenderInactiveToggleButton()`
`boolean`	`isRenderLineActions()` Indicates whether the action column for the collection should be rendered
`boolean`	`isRenderSaveLineActions()` Indicates whether the save line actions should be rendered
`boolean`	`isShowInactiveLines()` Indicates whether inactive collections lines should be displayed
`boolean`	`isUseServerPaging()` Gets useServerPaging, the flag that indicates whether server side paging is enabled.
`boolean`	`isViewLineAuthz()`
`void`	`performApplyModel(Object model, LifecycleElement parent)` The following updates are done here: Evaluate the progressive render condition (if set) and combine with the current render status to set the render status Called after the initialize phase to perform conditional logic based on the model data
`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`	`pushCollectionGroupToReference()` Sets a reference in the context map for all nested components in the collection group instance, and sets selected collection path and id data attributes on nested actions of this group.
`void`	`setActiveCollectionFilter(CollectionFilter activeCollectionFilter)` Setter for the collection filter to use for filter inactive records from the collection
`void`	`setAddBlankLineAction(Action addBlankLineAction)` Setter for the add blank line `Action` field
`void`	`setAddItemCssClass(String addItemCssClass)` Setter for the add item css style class
`void`	`setAddLabel(String addLabelText)` Setter for the add line label text
`void`	`setAddLineActions(List<? extends Component> addLineActions)` Setter for the add line action components fields
`void`	`setAddLineBindingInfo(BindingInfo addLineBindingInfo)` Setter for the add line binding info
`void`	`setAddLineDialog(DialogGroup addLineDialog)`
`void`	`setAddLineEnterKeyAction(String addLineEnterKeyAction)`
`void`	`setAddLineItems(List<? extends Component> addLineItems)` Setter for the add line field list
`void`	`setAddLineLabel(Message addLineLabel)` Setter for the `Message` instance for the add line label
`void`	`setAddLinePlacement(String addLinePlacement)` Setter for the add line placement
`void`	`setAddLinePropertyName(String addLinePropertyName)` Setter for the add line property name
`void`	`setAddWithDialog(boolean addWithDialog)`
`void`	`setAddWithDialogAction(Action addWithDialogAction)`
`void`	`setBindingInfo(BindingInfo bindingInfo)` Setter for the binding info instance
`void`	`setCollectionGroupBuilder(CollectionGroupBuilder collectionGroupBuilder)` Setter for the collection group building instance
`void`	`setCollectionLookup(QuickFinder collectionLookup)` Setter for the collection lookup quickfinder instance
`void`	`setCollectionObjectClass(Class<?> collectionObjectClass)` Setter for the collection object class
`void`	`setComponentSecurity(ComponentSecurity componentSecurity)` Setter for the components security object
`void`	`setCustomEditLineDialog(boolean customEditLineDialog)`
`void`	`setDisplayCollectionSize(int displayCollectionSize)` Setter for the display collection size
`void`	`setDisplayLength(int displayLength)` Sets the displayLength, the number of items to display on the page (assuming useServerPaging is enabled).
`void`	`setDisplayStart(int displayStart)` Sets the displayStart, the index of the first item to display on the page (assuming useServerPaging is enabled).
`void`	`setDuplicateLinePropertyNames(List<String> duplicateLinePropertyNames)`
`void`	`setEditInDialogSaveActionPrototype(Action editInDialogSaveActionPrototype)`
`void`	`setEditLineAuthz(boolean editLineAuthz)`
`void`	`setEditLineDialogPrototype(DialogGroup editLineDialogPrototype)`
`void`	`setEditWithDialog(boolean editWithDialog)`
`void`	`setEditWithDialogActionPrototype(Action editWithDialogActionPrototype)`
`void`	`setFilteredCollectionSize(int filteredCollectionSize)` Sets the number of un-filtered elements from the model collection.
`void`	`setFilters(List<CollectionFilter> filters)` Setter for the List of collection filters for which the collection will be filtered against
`void`	`setHighlightAddItem(boolean highlightAddItem)` Setter for the flag that allows for different styling of the add item group or row
`void`	`setHighlightNewItems(boolean highlightNewItems)` Setter for the flag that allows for different styling of new items
`void`	`setIncludeLineSelectionField(boolean includeLineSelectionField)` Setter for the render selected field indicator
`void`	`setLineActions(List<? extends Component> lineActions)` Setter for the line action fields list
`void`	`setLineDialogs(List<DialogGroup> dialogGroups)`
`void`	`setLineEnterKeyAction(String lineEnterKeyAction)`
`void`	`setLineSelectPropertyName(String lineSelectPropertyName)` Setter for the property name that will bind to the select field
`void`	`setNewItemsCssClass(String newItemsCssClass)` Setter for the new items css style class
`void`	`setPageSize(int pageSize)`
`void`	`setPropertyName(String propertyName)` Setter for the collections property name
`void`	`setRenderAddBlankLineButton(boolean renderAddBlankLineButton)` Setter for the flag indicating that the add blank line button must be rendered
`void`	`setRenderAddLine(boolean renderAddLine)` Setter for the render add line indicator
`void`	`setRenderInactiveToggleButton(boolean renderInactiveToggleButton)`
`void`	`setRenderLineActions(boolean renderLineActions)` Setter for the render line actions indicator
`void`	`setRenderSaveLineActions(boolean renderSaveLineActions)` Setter for the flag indicating whether the save actions should be rendered
`void`	`setShowInactiveLines(boolean showInactiveLines)` Setter for the show inactive indicator
`void`	`setSubCollections(List<CollectionGroup> subCollections)` Setter for the sub collection list
`void`	`setTotalCollectionSize(int totalCollectionSize)`
`protected void`	`setTotalColumns(List<String> totalColumns)` Setter for the total columns
`void`	`setUnauthorizedLineBindingInfos(List<BindingInfo> unauthorizedLineBindingInfos)`
`protected void`	`setupAddLineDialog()` When add via dialog is true, initialize the add with dialog action (if necessary) and sets up the action script for opening the dialog.
`protected void`	`setupLineActionValidationScripts(List<Component> components, List<Component> actionComponents)` Helper method to set action validation script for every action component provided to validate every input field component.
`void`	`setUseServerPaging(boolean useServerPaging)` Sets useServerPaging, the flag indicating whether server side paging is enabled.
`void`	`setViewLineAuthz(boolean viewLineAuthz)`

Methods inherited from class org.kuali.rice.krad.uif.container.GroupBase
afterEvaluateExpression, buildInputFieldValidationActionScript, getComponentTypeName, getDisclosure, getFieldBindByNamePrefix, getFieldBindingObjectPath, getScrollpane, getSupportedComponents, getWrapperTag, isAjaxDisclosureGroup, isRenderLoading, setDisclosure, setFieldBindByNamePrefix, setFieldBindingObjectPath, setItems, setNestedComponentId, setScrollpane, setupValidationScripts, setWrapperTag, validateInputField

Methods inherited from class org.kuali.rice.krad.uif.container.ContainerBase
getAdditionalTemplates, getDefaultItemPosition, getEnterKeyAction, getFooter, getHeader, getHeaderText, getHelp, getHelpTitle, getInstructionalMessage, getInstructionalText, getLayoutManager, getValidationMessages, setDefaultItemPosition, setEnterKeyAction, setFooter, setHeader, setHeaderText, setHelp, setInstructionalMessage, setInstructionalText, setLayoutManager, setRenderFooter, setRenderHeader, setTooltipOfComponent, setValidationMessages, sortItems

Methods inherited from class org.kuali.rice.krad.uif.component.ComponentBase
addAriaAttribute, 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, 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, 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, skipLifecycle

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase
getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase
copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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, getLayoutManager, getSupportedComponents, getValidationMessages, 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, 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, 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, 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, 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

- Constructor Detail
  - CollectionGroupBase
```
public CollectionGroupBase()
```
- Method Detail
  - performInitialization
```
public void performInitialization(Object model)
```
    Description copied from class: GroupBase
    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
    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.
    Specified by:
    
    performInitialization in interface LifecycleElement
    
    Overrides:
    
    performInitialization in class GroupBase
    
    Parameters:
    model - - object instance containing the view data
    See Also:
    ComponentDefaultInitializeTask
  - performApplyModel
```
public void performApplyModel(Object model,
                     LifecycleElement parent)
```
    The following updates are done here:
    - Evaluate the progressive render condition (if set) and combine with the current render status to set the render status
    Called after the initialize phase to perform conditional logic based on the model data
    Where components can perform conditional logic such as dynamically generating new fields or setting field state based on the given data
    Specified by:
    
    performApplyModel in interface LifecycleElement
    
    Overrides:
    
    performApplyModel in class ContainerBase
    
    Parameters:
    model - - Top level object containing the data (could be the form or a top level business object, dto)
    parent - parent lifecycle element
  - setupLineActionValidationScripts
```
protected void setupLineActionValidationScripts(List<Component> components,
                                    List<Component> actionComponents)
```
    Helper method to set action validation script for every action component provided to validate every input field component.
    
    Parameters:
    components - the components with input fields
    actionComponents - the components with actions
  - setupAddLineDialog
```
protected void setupAddLineDialog()
```
    When add via dialog is true, initialize the add with dialog action (if necessary) and sets up the action script for opening the dialog.
  - performFinalize
```
public 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
    Here final preparations can be made based on the updated view state.
    Specified by:
    
    performFinalize in interface LifecycleElement
    
    Overrides:
    
    performFinalize in class GroupBase
    
    Parameters:
    model - - top level object containing the data
    parent - - parent component
  - addCollectionPostMetadata
```
protected void addCollectionPostMetadata()
```
    Add the metadata about this collection to the ViewPostMetadata that is to be kept in memory between posts for use by other methods
  - pushCollectionGroupToReference
```
public void pushCollectionGroupToReference()
```
    Sets a reference in the context map for all nested components in the collection group instance, and sets selected collection path and id data attributes on nested actions of this group.
    
    Specified by:
    
    pushCollectionGroupToReference in interface CollectionGroup
  - getCollectionLabel
```
protected String getCollectionLabel()
```
    Gets the label for the collection in a human-friendly format.
    
    Returns:
    a human-friendly collection label
  - getDuplicateLineLabelString
```
protected String getDuplicateLineLabelString(List<String> duplicateLinePropertyNames)
```
    Gets a comma-separated list of the data field labels that are keyed a duplicates.
    
    Parameters:
    duplicateLinePropertyNames - the property names to check for duplicates
    
    Returns:
    a comma-separated list of labels
  - initializeNewCollectionLine
```
public void initializeNewCollectionLine(View view,
                               Object model,
                               CollectionGroup collectionGroup,
                               boolean clearExistingLine)
```
    New collection lines are handled in the framework by maintaining a map on the form. The map contains as a key the collection name, and as value an instance of the collection type. An entry is created here for the collection represented by the CollectionGroup if an instance is not available (clearExistingLine will force a new instance). The given model must be a subclass of UifFormBase in order to find the Map.
    
    Specified by:
    
    initializeNewCollectionLine in interface CollectionGroup
    
    Parameters:
    model - Model instance that contains the new collection lines Map
    clearExistingLine - boolean that indicates whether the line should be set to a new instance if it already exists
  - isProcessRemoteFieldHolders
```
public boolean isProcessRemoteFieldHolders()
```
    Do not process remote field holders for collections. Collection items will be processed as the lines are built. Determine if remote field holders should be processed for this container.
    
    Specified by:
    
    isProcessRemoteFieldHolders in interface Container
    
    Overrides:
    
    isProcessRemoteFieldHolders in class ContainerBase
    
    Returns:
    True if remote field holders should be processed for this container.
  - getItems
```
@ViewLifecycleRestriction(value="INITIALIZE")
public List<? extends Component> getItems()
```
    List of Component instances that are held by the container
    Contained components are rendered within the section template by calling the associated LayoutManager.
    
    Specified by:
    
    getItems in interface Container
    
    Overrides:
    
    getItems in class GroupBase
    
    Returns:
    List component instances
  - getCollectionObjectClass
```
public Class<?> getCollectionObjectClass()
```
    Object class the collection maintains. Used to get dictionary information in addition to creating new instances for the collection when necessary
    
    Specified by:
    
    getCollectionObjectClass in interface CollectionGroup
    
    Returns:
    collection object class
  - setCollectionObjectClass
```
public void setCollectionObjectClass(Class<?> collectionObjectClass)
```
    Setter for the collection object class
    
    Specified by:
    
    setCollectionObjectClass in interface CollectionGroup
  - getPropertyName
```
public String getPropertyName()
```
    Name of the property (relative to the parent object) the component binds to
    
    Specified by:
    
    getPropertyName in interface DataBinding
    
    Returns:
    String property name
  - setPropertyName
```
public void setPropertyName(String propertyName)
```
    Setter for the collections property name
    
    Specified by:
    
    setPropertyName in interface CollectionGroup
  - getBindingInfo
```
public BindingInfo getBindingInfo()
```
    Returns the BindingInfo instance that is configured for the component
    
    Specified by:
    
    getBindingInfo in interface DataBinding
    
    Returns:
    BindingInfo
    See Also:
    BindingInfo
  - setBindingInfo
```
public void setBindingInfo(BindingInfo bindingInfo)
```
    Setter for the binding info instance
    
    Specified by:
    
    setBindingInfo in interface DataBinding
  - getLineActions
```
@ViewLifecycleRestriction(value="INITIALIZE")
public List<? extends Component> getLineActions()
```
    Action fields that should be rendered for each collection line. Example line action is the delete action
    
    Specified by:
    
    getLineActions in interface CollectionGroup
    
    Returns:
    line action fields
  - setLineActions
```
public void setLineActions(List<? extends Component> lineActions)
```
    Setter for the line action fields list
    
    Specified by:
    
    setLineActions in interface CollectionGroup
  - getAddLineEnterKeyAction
```
public String getAddLineEnterKeyAction()
```
    Get the id of the add line action to invoke when the enter key is pressed.
    Use '@DEFAULT' if supposed to use first action where 'defaultEnterKeyAction' property is set to true.
    
    Specified by:
    
    getAddLineEnterKeyAction in interface CollectionGroup
    
    Returns:
    id or '@DEFAULT'
  - setAddLineEnterKeyAction
```
public void setAddLineEnterKeyAction(String addLineEnterKeyAction)
```
    Specified by:
    
    setAddLineEnterKeyAction in interface CollectionGroup
    
    See Also:
    CollectionGroup.getAddLineEnterKeyAction()
  - getLineEnterKeyAction
```
public String getLineEnterKeyAction()
```
    Get the id of the nonAdd line action to invoke when the enter key is pressed.
    Use '@DEFAULT' if supposed to use first action where 'defaultEnterKeyAction' property is set to true. In a collection may have to use SpringEL to identify line ID values. Here is a sample value: DemoButton@{#lineSuffix}. Notice the use of '@{#lineSuffix}' to help append line suffix information.
    
    Specified by:
    
    getLineEnterKeyAction in interface CollectionGroup
    
    Returns:
    id or '@DEFAULT'
  - setLineEnterKeyAction
```
public void setLineEnterKeyAction(String lineEnterKeyAction)
```
    Specified by:
    
    setLineEnterKeyAction in interface CollectionGroup
    
    See Also:
    CollectionGroup.getLineEnterKeyAction()
  - isRenderLineActions
```
public boolean isRenderLineActions()
```
    Indicates whether the action column for the collection should be rendered
    
    Specified by:
    
    isRenderLineActions in interface CollectionGroup
    
    Returns:
    true if the actions should be rendered, false if not
    See Also:
    CollectionGroup.getLineActions()
  - setRenderLineActions
```
public void setRenderLineActions(boolean renderLineActions)
```
    Setter for the render line actions indicator
    
    Specified by:
    
    setRenderLineActions in interface CollectionGroup
  - isRenderAddLine
```
public boolean isRenderAddLine()
```
    Indicates whether an add line should be rendered for the collection
    
    Specified by:
    
    isRenderAddLine in interface CollectionGroup
    
    Returns:
    true if add line should be rendered, false if it should not be
  - setRenderAddLine
```
public void setRenderAddLine(boolean renderAddLine)
```
    Setter for the render add line indicator
    
    Specified by:
    
    setRenderAddLine in interface CollectionGroup
  - getAddLabel
```
public String getAddLabel()
```
    Convenience getter for the add line label field text. The text is used to label the add line when rendered and its placement depends on the LayoutManager
    For the TableLayoutManager the label appears in the sequence column to the left of the add line fields. For the StackedLayoutManager the label is placed into the group header for the line.
    
    Specified by:
    
    getAddLabel in interface CollectionGroup
    
    Returns:
    add line label
  - setAddLabel
```
public void setAddLabel(String addLabelText)
```
    Setter for the add line label text
    
    Specified by:
    
    setAddLabel in interface CollectionGroup
  - getAddLineLabel
```
public Message getAddLineLabel()
```
    Message instance for the add line label
    
    Specified by:
    
    getAddLineLabel in interface CollectionGroup
    
    Returns:
    add line Message
    See Also:
    CollectionGroup.getAddLabel()
  - setAddLineLabel
```
public void setAddLineLabel(Message addLineLabel)
```
    Setter for the Message instance for the add line label
    
    Specified by:
    
    setAddLineLabel in interface CollectionGroup
    
    See Also:
    CollectionGroup.getAddLabel()
  - getAddLinePropertyName
```
public String getAddLinePropertyName()
```
    Name of the property that contains an instance for the add line. If set this is used with the binding info to create the path to the add line. Can be left blank in which case the framework will manage the add line instance in a generic map.
    
    Specified by:
    
    getAddLinePropertyName in interface CollectionGroup
    
    Returns:
    add line property name
  - setAddLinePropertyName
```
public void setAddLinePropertyName(String addLinePropertyName)
```
    Setter for the add line property name
    
    Specified by:
    
    setAddLinePropertyName in interface CollectionGroup
  - getAddLineBindingInfo
```
public BindingInfo getAddLineBindingInfo()
```
    BindingInfo instance for the add line property used to determine the full binding path. If add line name given CollectionGroup.getAddLabel() then it is set as the binding name on the binding info. Add line label and binding info are not required, in which case the framework will manage the new add line instances through a generic map (model must extend UifFormBase)
    
    Specified by:
    
    getAddLineBindingInfo in interface CollectionGroup
    
    Returns:
    BindingInfo add line binding info
  - setAddLineBindingInfo
```
public void setAddLineBindingInfo(BindingInfo addLineBindingInfo)
```
    Setter for the add line binding info
    
    Specified by:
    
    setAddLineBindingInfo in interface CollectionGroup
  - getAddLineItems
```
@ViewLifecycleRestriction(value="INITIALIZE")
public List<? extends Component> getAddLineItems()
```
    List of Component instances that should be rendered for the collection add line (if enabled). If not set, the default group's items list will be used
    
    Specified by:
    
    getAddLineItems in interface CollectionGroup
    
    Returns:
    add line field list
    See Also:
    LifecycleElement.performInitialization(Object)
  - setAddLineItems
```
public void setAddLineItems(List<? extends Component> addLineItems)
```
    Setter for the add line field list
    
    Specified by:
    
    setAddLineItems in interface CollectionGroup
  - getAddLineActions
```
@ViewLifecycleRestriction(value="INITIALIZE")
public List<? extends Component> getAddLineActions()
```
    Component fields that should be rendered for the add line.
    This is generally the add action (button) but can be configured to contain additional components
    
    Specified by:
    
    getAddLineActions in interface CollectionGroup
    
    Returns:
    add line action fields
  - setAddLineActions
```
public void setAddLineActions(List<? extends Component> addLineActions)
```
    Setter for the add line action components fields
    
    Specified by:
    
    setAddLineActions in interface CollectionGroup
  - isIncludeLineSelectionField
```
public boolean isIncludeLineSelectionField()
```
    Indicates whether lines of the collection group should be selected by rendering a field for each line that will allow selection
    For example, having the select field enabled could allow selecting multiple lines from a search to return (multi-value lookup)
    
    Specified by:
    
    isIncludeLineSelectionField in interface CollectionGroup
    
    Returns:
    true if select field should be rendered, false if not
  - setIncludeLineSelectionField
```
public void setIncludeLineSelectionField(boolean includeLineSelectionField)
```
    Setter for the render selected field indicator
    
    Specified by:
    
    setIncludeLineSelectionField in interface CollectionGroup
  - getLineSelectPropertyName
```
public String getLineSelectPropertyName()
```
    When CollectionGroup.isIncludeLineSelectionField() is true, gives the name of the property the select field should bind to
    Note if no prefix is given in the property name, such as 'form.', it is assumed the property is contained on the collection line. In this case the binding path to the collection line will be appended. In other cases, it is assumed the property is a list or set of String that will hold the selected identifier strings
    
    This property is not required. If not the set the framework will use a property contained on UifFormBase
    
    Specified by:
    
    getLineSelectPropertyName in interface CollectionGroup
    
    Returns:
    property name for select field
  - setLineSelectPropertyName
```
public void setLineSelectPropertyName(String lineSelectPropertyName)
```
    Setter for the property name that will bind to the select field
    
    Specified by:
    
    setLineSelectPropertyName in interface CollectionGroup
  - getCollectionLookup
```
public QuickFinder getCollectionLookup()
```
    Instance of the QuickFinder widget that configures a multi-value lookup for the collection
    If the collection lookup is enabled (by the render property of the quick finder), CollectionGroup.getCollectionObjectClass() will be used as the data object class for the lookup (if not set). Field conversions need to be set as usual and will be applied for each line returned
    
    Specified by:
    
    getCollectionLookup in interface CollectionGroup
    
    Returns:
    instance configured for the collection lookup
  - setCollectionLookup
```
public void setCollectionLookup(QuickFinder collectionLookup)
```
    Setter for the collection lookup quickfinder instance
    
    Specified by:
    
    setCollectionLookup in interface CollectionGroup
  - isShowInactiveLines
```
public boolean isShowInactiveLines()
```
    Indicates whether inactive collections lines should be displayed
    Setting only applies when the collection line type implements the Inactivatable interface. If true and showInactive is set to false, the collection will be filtered to remove any items whose active status returns false
    
    Specified by:
    
    isShowInactiveLines in interface CollectionGroup
    
    Returns:
    true to show inactive records, false to not render inactive records
  - setShowInactiveLines
```
public void setShowInactiveLines(boolean showInactiveLines)
```
    Setter for the show inactive indicator
    
    Specified by:
    
    setShowInactiveLines in interface CollectionGroup
    
    Parameters:
    showInactiveLines - boolean show inactive
  - getActiveCollectionFilter
```
public CollectionFilter getActiveCollectionFilter()
```
    Collection filter instance for filtering the collection data when the showInactive flag is set to false
    
    Specified by:
    
    getActiveCollectionFilter in interface CollectionGroup
    
    Returns:
    CollectionFilter
  - setActiveCollectionFilter
```
public void setActiveCollectionFilter(CollectionFilter activeCollectionFilter)
```
    Setter for the collection filter to use for filter inactive records from the collection
    
    Specified by:
    
    setActiveCollectionFilter in interface CollectionGroup
    
    Parameters:
    activeCollectionFilter - CollectionFilter instance
  - getFilters
```
public List<CollectionFilter> getFilters()
```
    List of CollectionFilter instances that should be invoked to filter the collection before displaying
    
    Specified by:
    
    getFilters in interface CollectionGroup
    
    Returns:
    List
  - setFilters
```
public void setFilters(List<CollectionFilter> filters)
```
    Setter for the List of collection filters for which the collection will be filtered against
    
    Specified by:
    
    setFilters in interface CollectionGroup
  - getDuplicateLinePropertyNames
```
public List<String> getDuplicateLinePropertyNames()
```
    List of property names that should be checked for duplicates in the collection.
    
    Specified by:
    
    getDuplicateLinePropertyNames in interface CollectionGroup
    
    Returns:
    the list of property names that should be checked for duplicates in the collection
  - setDuplicateLinePropertyNames
```
public void setDuplicateLinePropertyNames(List<String> duplicateLinePropertyNames)
```
    Specified by:
    
    setDuplicateLinePropertyNames in interface CollectionGroup
    
    See Also:
    CollectionGroup.getDuplicateLinePropertyNames()
  - getUnauthorizedLineBindingInfos
```
public List<BindingInfo> getUnauthorizedLineBindingInfos()
```
    List of BindingInfo instances that represent lines not authorized to be viewed or edited by the user.
    
    Specified by:
    
    getUnauthorizedLineBindingInfos in interface CollectionGroup
  - setUnauthorizedLineBindingInfos
```
public void setUnauthorizedLineBindingInfos(List<BindingInfo> unauthorizedLineBindingInfos)
```
    Specified by:
    
    setUnauthorizedLineBindingInfos in interface CollectionGroup
    
    See Also:
    CollectionGroup.getUnauthorizedLineBindingInfos()
  - getSubCollections
```
@ViewLifecycleRestriction(value="INITIALIZE")
public List<CollectionGroup> getSubCollections()
```
    List of CollectionGroup instances that are sub-collections of the collection represented by this collection group
    
    Specified by:
    
    getSubCollections in interface CollectionGroup
    
    Returns:
    sub collections
  - setSubCollections
```
public void setSubCollections(List<CollectionGroup> subCollections)
```
    Setter for the sub collection list
    
    Specified by:
    
    setSubCollections in interface CollectionGroup
  - getCollectionGroupSecurity
```
public CollectionGroupSecurity getCollectionGroupSecurity()
```
    Collection Security object that indicates what authorization (permissions) exist for the collection
    
    Specified by:
    
    getCollectionGroupSecurity in interface CollectionGroup
    
    Returns:
    CollectionGroupSecurity instance
  - setComponentSecurity
```
public void setComponentSecurity(ComponentSecurity componentSecurity)
```
    Setter for the components security object
    
    Specified by:
    
    setComponentSecurity in interface Component
    
    Specified by:
    
    setComponentSecurity in interface CollectionGroup
    
    Overrides:
    
    setComponentSecurity in class ComponentBase
    
    Parameters:
    componentSecurity - instance of CollectionGroupSecurity
  - initializeComponentSecurity
```
protected void initializeComponentSecurity()
```
    Initializes (if necessary) the component security instance for the component type
    
    Overrides:
    
    initializeComponentSecurity in class ComponentBase
  - isEditLineAuthz
```
public boolean isEditLineAuthz()
```
    Specified by:
    
    isEditLineAuthz in interface CollectionGroup
    
    See Also:
    CollectionGroupSecurity.isEditLineAuthz()
  - setEditLineAuthz
```
public void setEditLineAuthz(boolean editLineAuthz)
```
    Specified by:
    
    setEditLineAuthz in interface CollectionGroup
    
    See Also:
    CollectionGroupSecurity.setEditLineAuthz(boolean)
  - isViewLineAuthz
```
public boolean isViewLineAuthz()
```
    Specified by:
    
    isViewLineAuthz in interface CollectionGroup
    
    See Also:
    CollectionGroupSecurity.isViewLineAuthz()
  - setViewLineAuthz
```
public void setViewLineAuthz(boolean viewLineAuthz)
```
    Specified by:
    
    setViewLineAuthz in interface CollectionGroup
    
    See Also:
    CollectionGroupSecurity.setViewLineAuthz(boolean)
  - getCollectionGroupBuilder
```
public CollectionGroupBuilder getCollectionGroupBuilder()
```
    CollectionGroupBuilder instance that will build the components dynamically for the collection instance
    
    Specified by:
    
    getCollectionGroupBuilder in interface CollectionGroup
    
    Returns:
    CollectionGroupBuilder instance
  - setCollectionGroupBuilder
```
public void setCollectionGroupBuilder(CollectionGroupBuilder collectionGroupBuilder)
```
    Setter for the collection group building instance
    
    Specified by:
    
    setCollectionGroupBuilder in interface CollectionGroup
  - isRenderInactiveToggleButton
```
public boolean isRenderInactiveToggleButton()
```
    Specified by:
    
    isRenderInactiveToggleButton in interface CollectionGroup
    
    Returns:
    the showHideInactiveButton
  - setRenderInactiveToggleButton
```
public void setRenderInactiveToggleButton(boolean renderInactiveToggleButton)
```
    Specified by:
    
    setRenderInactiveToggleButton in interface CollectionGroup
    
    Parameters:
    renderInactiveToggleButton - the showHideInactiveButton to set
  - getDisplayCollectionSize
```
public int getDisplayCollectionSize()
```
    The number of records to display for a collection
    
    Specified by:
    
    getDisplayCollectionSize in interface CollectionGroup
    
    Returns:
    int
  - setDisplayCollectionSize
```
public void setDisplayCollectionSize(int displayCollectionSize)
```
    Setter for the display collection size
    
    Specified by:
    
    setDisplayCollectionSize in interface CollectionGroup
  - isHighlightNewItems
```
public boolean isHighlightNewItems()
```
    Indicates whether new items should be styled with the #newItemsCssClass
    
    Specified by:
    
    isHighlightNewItems in interface CollectionGroup
    
    Returns:
    true if new items must be highlighted
  - setHighlightNewItems
```
public void setHighlightNewItems(boolean highlightNewItems)
```
    Setter for the flag that allows for different styling of new items
    
    Specified by:
    
    setHighlightNewItems in interface CollectionGroup
  - getNewItemsCssClass
```
public String getNewItemsCssClass()
```
    The css style class that will be added on new items
    
    Specified by:
    
    getNewItemsCssClass in interface CollectionGroup
    
    Returns:
    the new items css style class
  - setNewItemsCssClass
```
public void setNewItemsCssClass(String newItemsCssClass)
```
    Setter for the new items css style class
    
    Specified by:
    
    setNewItemsCssClass in interface CollectionGroup
  - getAddItemCssClass
```
public String getAddItemCssClass()
```
    The css style class that will be added on the add item group or row
    
    Specified by:
    
    getAddItemCssClass in interface CollectionGroup
    
    Returns:
    the add item group or row css style class
  - setAddItemCssClass
```
public void setAddItemCssClass(String addItemCssClass)
```
    Setter for the add item css style class
    
    Specified by:
    
    setAddItemCssClass in interface CollectionGroup
  - isHighlightAddItem
```
public boolean isHighlightAddItem()
```
    Indicates whether the add item group or row should be styled with the #addItemCssClass
    
    Specified by:
    
    isHighlightAddItem in interface CollectionGroup
    
    Returns:
    true if add item group or row must be highlighted
  - setHighlightAddItem
```
public void setHighlightAddItem(boolean highlightAddItem)
```
    Setter for the flag that allows for different styling of the add item group or row
    
    Specified by:
    
    setHighlightAddItem in interface CollectionGroup
  - isRenderAddBlankLineButton
```
public boolean isRenderAddBlankLineButton()
```
    Indicates that a button will be rendered that allows the user to add blank lines to the collection
    The button will be added separately from the collection items. The default add line wil not be rendered. The action of the button will call the controller, add the blank line to the collection and do a component refresh.
    
    Specified by:
    
    isRenderAddBlankLineButton in interface CollectionGroup
    
    Returns:
    boolean
  - setRenderAddBlankLineButton
```
public void setRenderAddBlankLineButton(boolean renderAddBlankLineButton)
```
    Setter for the flag indicating that the add blank line button must be rendered
    
    Specified by:
    
    setRenderAddBlankLineButton in interface CollectionGroup
  - getAddBlankLineAction
```
public Action getAddBlankLineAction()
```
    The add blank line Action field rendered when renderAddBlankLineButton is true
    
    Specified by:
    
    getAddBlankLineAction in interface CollectionGroup
    
    Returns:
    boolean
  - setAddBlankLineAction
```
public void setAddBlankLineAction(Action addBlankLineAction)
```
    Setter for the add blank line Action field
    
    Specified by:
    
    setAddBlankLineAction in interface CollectionGroup
  - getAddLinePlacement
```
public String getAddLinePlacement()
```
    Indicates the add line placement
    Valid values are 'TOP' or 'BOTTOM'. The default is 'TOP'. When the value is 'BOTTOM' the blank line will be added to the end of the collection.
    
    Specified by:
    
    getAddLinePlacement in interface CollectionGroup
    
    Returns:
    the add blank line action placement
  - setAddLinePlacement
```
public void setAddLinePlacement(String addLinePlacement)
```
    Setter for the add line placement
    
    Specified by:
    
    setAddLinePlacement in interface CollectionGroup
    
    Parameters:
    addLinePlacement - add line placement string
  - isRenderSaveLineActions
```
public boolean isRenderSaveLineActions()
```
    Indicates whether the save line actions should be rendered
    
    Specified by:
    
    isRenderSaveLineActions in interface CollectionGroup
    
    Returns:
    boolean
  - setRenderSaveLineActions
```
public void setRenderSaveLineActions(boolean renderSaveLineActions)
```
    Setter for the flag indicating whether the save actions should be rendered
    
    Specified by:
    
    setRenderSaveLineActions in interface CollectionGroup
  - isAddWithDialog
```
public boolean isAddWithDialog()
```
    Indicates that a add action should be rendered and that the add group be displayed in a model dialog.
    
    Specified by:
    
    isAddWithDialog in interface CollectionGroup
    
    Returns:
    boolean true if add should be through model dialog, false if not
  - setAddWithDialog
```
public void setAddWithDialog(boolean addWithDialog)
```
    Specified by:
    
    setAddWithDialog in interface CollectionGroup
    
    See Also:
    CollectionGroup.isAddWithDialog()
  - getAddWithDialogAction
```
public Action getAddWithDialogAction()
```
    The Action that will be displayed that will open the add line group in a dialog.
    
    Specified by:
    
    getAddWithDialogAction in interface CollectionGroup
    
    Returns:
    Action
  - setAddWithDialogAction
```
public void setAddWithDialogAction(Action addWithDialogAction)
```
    Specified by:
    
    setAddWithDialogAction in interface CollectionGroup
    
    See Also:
    CollectionGroup.getAddWithDialogAction()
  - getAddLineDialog
```
public DialogGroup getAddLineDialog()
```
    Dialog group to use for the add line when CollectionGroup.isAddWithDialog() is true.
    If dialog group is not set by add with dialog is true, a default dialog group will be created.
    
    The add line items and actions are still used as usual, unless the items and footer items have been explicity set in the dialog group
    
    Specified by:
    
    getAddLineDialog in interface CollectionGroup
    
    Returns:
    dialog group instance for add line
  - setAddLineDialog
```
public void setAddLineDialog(DialogGroup addLineDialog)
```
    Specified by:
    
    setAddLineDialog in interface CollectionGroup
    
    See Also:
    CollectionGroup.getAddLineDialog()
  - isUseServerPaging
```
public boolean isUseServerPaging()
```
    Gets useServerPaging, the flag that indicates whether server side paging is enabled. Defaults to false.
    
    Specified by:
    
    isUseServerPaging in interface CollectionGroup
    
    Returns:
    true if server side paging is enabled.
  - setUseServerPaging
```
public void setUseServerPaging(boolean useServerPaging)
```
    Sets useServerPaging, the flag indicating whether server side paging is enabled.
    
    Specified by:
    
    setUseServerPaging in interface CollectionGroup
    
    Parameters:
    useServerPaging - the useServerPaging value to set
  - getPageSize
```
public int getPageSize()
```
    Specified by:
    
    getPageSize in interface CollectionGroup
  - setPageSize
```
public void setPageSize(int pageSize)
```
    Specified by:
    
    setPageSize in interface CollectionGroup
  - getDisplayStart
```
public int getDisplayStart()
```
    Gets the displayStart, the index of the first item to display on the page (assuming useServerPaging is enabled).
    if this field has not been set, the returned value will be -1
    
    Specified by:
    
    getDisplayStart in interface CollectionGroup
    
    Returns:
    the index of the first item to display, or -1 if unset
  - setDisplayStart
```
public void setDisplayStart(int displayStart)
```
    Sets the displayStart, the index of the first item to display on the page (assuming useServerPaging is enabled).
    
    Specified by:
    
    setDisplayStart in interface CollectionGroup
    
    Parameters:
    displayStart - the displayStart to set
  - getDisplayLength
```
public int getDisplayLength()
```
    Gets the displayLength, the number of items to display on the page (assuming useServerPaging is enabled).
    if this field has not been set, the returned value will be -1
    
    Specified by:
    
    getDisplayLength in interface CollectionGroup
    
    Returns:
    the number of items to display on the page, or -1 if unset
  - setDisplayLength
```
public void setDisplayLength(int displayLength)
```
    Sets the displayLength, the number of items to display on the page (assuming useServerPaging is enabled).
    
    Specified by:
    
    setDisplayLength in interface CollectionGroup
    
    Parameters:
    displayLength - the displayLength to set
  - getFilteredCollectionSize
```
public int getFilteredCollectionSize()
```
    Gets the number of un-filtered elements from the model collection.
    if this field has not been set, the returned value will be -1
    
    Specified by:
    
    getFilteredCollectionSize in interface CollectionGroup
    
    Returns:
    the filtered collection size, or -1 if unset
  - setFilteredCollectionSize
```
public void setFilteredCollectionSize(int filteredCollectionSize)
```
    Sets the number of un-filtered elements from the model collection.
    This value is used for display and rendering purposes, it has no effect on the model collection
    
    Specified by:
    
    setFilteredCollectionSize in interface CollectionGroup
    
    Parameters:
    filteredCollectionSize - the filtered collection size
  - getTotalCollectionSize
```
public int getTotalCollectionSize()
```
  - setTotalCollectionSize
```
public void setTotalCollectionSize(int totalCollectionSize)
```
  - getTotalColumns
```
protected List<String> getTotalColumns()
```
    Returns:
    list of total columns
  - setTotalColumns
```
protected void setTotalColumns(List<String> totalColumns)
```
    Setter for the total columns
  - completeValidation
```
public void completeValidation(ValidationTrace tracer)
```
    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
    
    Specified by:
    
    completeValidation in interface CollectionGroup
    
    Overrides:
    
    completeValidation in class GroupBase
    
    Parameters:
    tracer - Record of component's location
    See Also:
    Component.completeValidation(org.kuali.rice.krad.datadictionary.validator.ValidationTrace)
  - isEditWithDialog
```
public boolean isEditWithDialog()
```
    Indicates that an edit action should be rendered and that the edit group be displayed in a model dialog.
    
    Specified by:
    
    isEditWithDialog in interface CollectionGroup
    
    Returns:
    boolean true if edit should be through model dialog, false if not
  - setEditWithDialog
```
public void setEditWithDialog(boolean editWithDialog)
```
    Specified by:
    
    setEditWithDialog in interface CollectionGroup
    
    See Also:
    CollectionGroup.isEditWithDialog()
  - isCustomEditLineDialog
```
public boolean isCustomEditLineDialog()
```
    Indicates that a custom edit line dialog is provided by the user.
    
    Specified by:
    
    isCustomEditLineDialog in interface CollectionGroup
    
    Returns:
    boolean true if custom edit line dialog
  - setCustomEditLineDialog
```
public void setCustomEditLineDialog(boolean customEditLineDialog)
```
    Specified by:
    
    setCustomEditLineDialog in interface CollectionGroup
    
    See Also:
    CollectionGroup.isCustomEditLineDialog()
  - getEditLineDialogPrototype
```
public DialogGroup getEditLineDialogPrototype()
```
    Dialog group prototype to use to create the edit line dialog when CollectionGroup.isEditWithDialog() is true.
    If not specified a default prototype edit line dialog will be created with the items from the collection.
    
    Specified by:
    
    getEditLineDialogPrototype in interface CollectionGroup
    
    Returns:
    dialog group prototype for edit line
  - setEditLineDialogPrototype
```
public void setEditLineDialogPrototype(DialogGroup editLineDialogPrototype)
```
    Specified by:
    
    setEditLineDialogPrototype in interface CollectionGroup
    
    See Also:
    CollectionGroup.getEditLineDialogPrototype()
  - getEditWithDialogActionPrototype
```
public Action getEditWithDialogActionPrototype()
```
    The Action that will be displayed that will open the edit line group in a dialog.
    
    Specified by:
    
    getEditWithDialogActionPrototype in interface CollectionGroup
    
    Returns:
    Action
  - setEditWithDialogActionPrototype
```
public void setEditWithDialogActionPrototype(Action editWithDialogActionPrototype)
```
    Specified by:
    
    setEditWithDialogActionPrototype in interface CollectionGroup
    
    See Also:
    CollectionGroup.getEditWithDialogActionPrototype()
  - getEditInDialogSaveActionPrototype
```
public Action getEditInDialogSaveActionPrototype()
```
    The Action that will be displayed within the edit line group in a dialog.
    
    Specified by:
    
    getEditInDialogSaveActionPrototype in interface CollectionGroup
    
    Returns:
    Action
  - setEditInDialogSaveActionPrototype
```
public void setEditInDialogSaveActionPrototype(Action editInDialogSaveActionPrototype)
```
    Specified by:
    
    setEditInDialogSaveActionPrototype in interface CollectionGroup
    
    See Also:
    CollectionGroup.getEditInDialogSaveActionPrototype()
  - getLineDialogs
```
public List<DialogGroup> getLineDialogs()
```
    List of dialog groups that are configured for a line in the collection.
    
    Specified by:
    
    getLineDialogs in interface CollectionGroup
    
    Returns:
    list of dialog group instances
  - setLineDialogs
```
public void setLineDialogs(List<DialogGroup> dialogGroups)
```
    Specified by:
    
    setLineDialogs in interface CollectionGroup
    
    See Also:
    CollectionGroup.getLineDialogs()

Class CollectionGroupBase

Nested Class Summary

Nested classes/interfaces inherited from class org.kuali.rice.krad.uif.container.GroupBase

Field Summary

Fields inherited from class org.kuali.rice.krad.uif.component.ComponentBase

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

Fields inherited from interface org.kuali.rice.krad.uif.component.Ordered

Fields inherited from interface org.springframework.core.Ordered

Constructor Summary

Method Summary

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

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

Methods inherited from class org.kuali.rice.krad.uif.component.ComponentBase

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.uif.container.Container

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

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

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

Methods inherited from interface org.kuali.rice.krad.uif.util.LifecycleElement

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

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

Methods inherited from interface org.kuali.rice.krad.uif.widget.Helpable

Constructor Detail

CollectionGroupBase

Method Detail

performInitialization

performApplyModel

setupLineActionValidationScripts

setupAddLineDialog

performFinalize

addCollectionPostMetadata

pushCollectionGroupToReference

getCollectionLabel

getDuplicateLineLabelString

initializeNewCollectionLine

isProcessRemoteFieldHolders

getItems

getCollectionObjectClass

setCollectionObjectClass

getPropertyName

setPropertyName

getBindingInfo

setBindingInfo

getLineActions

setLineActions

getAddLineEnterKeyAction

setAddLineEnterKeyAction

getLineEnterKeyAction

setLineEnterKeyAction

isRenderLineActions

setRenderLineActions

isRenderAddLine

setRenderAddLine

getAddLabel

setAddLabel

getAddLineLabel

setAddLineLabel

getAddLinePropertyName

setAddLinePropertyName

getAddLineBindingInfo

setAddLineBindingInfo

getAddLineItems

setAddLineItems

getAddLineActions

setAddLineActions

isIncludeLineSelectionField

setIncludeLineSelectionField

getLineSelectPropertyName

setLineSelectPropertyName

getCollectionLookup

setCollectionLookup

isShowInactiveLines

setShowInactiveLines

getActiveCollectionFilter

setActiveCollectionFilter

getFilters

setFilters