org.kuali.rice.krad.uif.container

Interface Container

All Superinterfaces:

Cloneable, Component, Copyable, DictionaryBean, Helpable, LifecycleElement, org.springframework.core.Ordered, ScriptEventSupport, Serializable, UifDictionaryBean

All Known Subinterfaces:

CollectionGroup, Group, PageGroup

All Known Implementing Classes:

AccordionGroup, CollectionGroupBase, ComponentLibraryView, ContainerBase, DialogGroup, DocumentView, FormView, GroupBase, IframeView, InquiryView, LightTable, LinkGroup, LookupView, MaintenanceDocumentView, MessageView, PageGroupBase, SidebarNavigationGroup, TabGroup, TabNavigationGroup, TransactionalDocumentView, TreeGroup, View, WizardGroup

public interface Container
extends Component, Helpable

Type of component that contains a collection of other components. All templates for Container components must use a LayoutManager to render the contained components. Each container has the following parts in addition to the contained components:

• HeaderField
• Summary Message
• Help component
• Errors container
• Footer Group

Container implementations are free to add additional content as needed.

Author:

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

See Also:

Component

Field Summary

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

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Methods

Modifier and Type	Method and Description
String	getEnterKeyAction() Get the key of the action item to invoke upon pressing the enter key.
Group	getFooter() Footer Group associated with the container
Header	getHeader() HeaderField associated with the container
Message	getInstructionalMessage() Text for the container that provides a summary description or instructions
List<? extends Component>	getItems() List of Component instances that are held by the container
LayoutManager	getLayoutManager() LayoutManager that should be used to layout the components in the container
Set<Class<? extends Component>>	getSupportedComponents() Set of Component classes that may be placed into the container
ValidationMessages	getValidationMessages() Field that contains the error messages for the container
boolean	isProcessRemoteFieldHolders() Determine if remote field holders should be processed for this container.
void	setEnterKeyAction(String enterKeyAction)
void	setFooter(Group footer)
void	setHeader(Header header)
void	setInstructionalMessage(Message instructionalMessage)
void	setItems(List<? extends Component> items) Setter for the containers list of components
void	setLayoutManager(LayoutManager layoutManager)
void	setValidationMessages(ValidationMessages validationMessages)
void	sortItems() Performs sorting of the container items based on the order property.

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

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, afterEvaluateExpression, appendToStyle, completeValidation, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAdditionalTemplates, getAlign, getAriaAttributes, getAriaAttributesAsString, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getComponentTypeName, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getLibraryCssClasses, getMethodToCallOnRefresh, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getReadOnly, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRole, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, getWrapperCssClasses, getWrapperStyle, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setLibraryCssClasses, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRole, setRowSpan, setScriptDataAttributes, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle

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

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

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

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

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

checkMutable, getId, getPhasePathMapping, getViewPath, getViewStatus, initializePendingTasks, isFinal, isInitialized, isModelApplied, isMutable, isRender, notifyCompleted, performApplyModel, performFinalize, performInitialization, pushAllToContext, pushObjectToContext, setId, setPhasePathMapping, setRender, setViewPath, skipLifecycle

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

clone

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

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript

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

getHelp, getHelpTitle, setHelp, setTooltipOfComponent

Method Detail

getItems

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.

Returns:

List component instances

setItems

void setItems(List<? extends Component> items)

Setter for the containers list of components

Parameters:

items - list of components to set in container

getSupportedComponents

Set<Class<? extends Component>> getSupportedComponents()

Set 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

Returns:

Set component classes

getLayoutManager

LayoutManager getLayoutManager()

LayoutManager that should be used to layout the components in the container

The template associated with the layout manager will be invoked passing in the List of components from the container. This list is exported under the attribute name 'items'

Returns:

LayoutManager instance

setLayoutManager

void setLayoutManager(LayoutManager layoutManager)

See Also:

getLayoutManager()

getHeader

Header getHeader()

HeaderField associated with the container

Header fields are generally rendered at the beginning of the container to indicate a grouping, although this is determined by the template associated with the container. The actual rendering configuration (style and so on) is configured within the HeaderField instance

Header is only rendered if Container#isRenderHeader is true and getHeader() is not null

Returns:

HeaderField instance or Null

setHeader

void setHeader(Header header)

See Also:

getHeader()

getFooter

Group getFooter()

Footer Group associated with the container

The footer is usually rendered at the end of the container. Often this is a place to put actions (buttons) for the container.

Footer is only rendered if Container#isRenderFooter is true and getFooter is not null

Returns:

Group footer instance or Null

setFooter

void setFooter(Group footer)

See Also:

getFooter()

getInstructionalMessage

Message getInstructionalMessage()

Text for the container that provides a summary description or instructions

Text is encapsulated in a Message that contains rendering configuration.

Summary Message only rendered if this methods does not return null

Returns:

Message instance or Null

setInstructionalMessage

void setInstructionalMessage(Message instructionalMessage)

See Also:

getInstructionalMessage()

getValidationMessages

ValidationMessages getValidationMessages()

Field that contains the error messages for the container

Containers can collect the errors for the contained component and display either all the messages or counts. This Field is used to render those messages. Styling and other configuration is done through the ValidationMessages

Returns:

ValidationMessages holding the container errors

setValidationMessages

void setValidationMessages(ValidationMessages validationMessages)

See Also:

getValidationMessages()

sortItems

void sortItems()

Performs sorting of the container items based on the order property.

Note that the items may be modified by this method to assign order priority where it has not been previously assigned.

isProcessRemoteFieldHolders

boolean isProcessRemoteFieldHolders()

Determine if remote field holders should be processed for this container.

Returns:

True if remote field holders should be processed for this container.

getEnterKeyAction

String getEnterKeyAction()

Get the key of the action item to invoke upon pressing the enter key.

Returns:

String enterKeyAction

setEnterKeyAction

void setEnterKeyAction(String enterKeyAction)

See Also:

getEnterKeyAction()