org.kuali.rice.krad.uif.container

Interface Container

All Superinterfaces:

Component, Configurable, org.springframework.core.Ordered, ScriptEventSupport, Serializable

All Known Implementing Classes:

CollectionGroup, ContainerBase, DocumentView, FormView, Group, InquiryView, LinkGroup, LookupView, MaintenanceView, NavigationGroup, PageGroup, ReorderingGroup, TabGroup, TreeGroup, View

public interface Container
extends Component

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 MessageField
• 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
ErrorsField	getErrorsField() Field that contains the error messages for the container
Group	getFooter() Footer Group associated with the container
HeaderField	getHeader() HeaderField associated with the container
Help	getHelp() Help configuration object for the container
MessageField	getInstructionalMessageField() 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
boolean	isFieldContainer() This property is true if the container is used to display a group of fields that is visually a single field - this has an effect on where errors will show up for these fields.
void	setErrorsField(ErrorsField errorsField) Setter for the containers errors field
void	setFieldContainer(boolean fieldContainer)
void	setFooter(Group footer) Setter for the containers footer
void	setHeader(HeaderField header) Setter for the containers header field
void	setHelp(Help help) Setter for the containers help content
void	setInstructionalMessageField(MessageField summaryMessageField) Setter for the containers summary message field
void	setItems(List<? extends Component> items) Setter for the containers list of components
void	setLayoutManager(LayoutManager layoutManager) Setter for the containers layout manager

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

addStyleClass, appendToStyle, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentPrototypes, getComponentSecurity, getComponentsForLifecycle, getComponentTypeName, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRequired, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, performApplyModel, performFinalize, performInitialization, pushAllToContext, pushObjectToContext, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setComponentSecurity, setConditionalRefresh, setContext, setFactoryId, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setStyleClasses, setTemplate, setTitle

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

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

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

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, setOnBlurScript, setOnDocumentReadyScript, setOnLoadScript

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)

Setter for the containers layout manager

Parameters:

layoutManager -

getHeader

HeaderField 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(HeaderField header)

Setter for the containers header field

Parameters:

header -

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)

Setter for the containers footer

Parameters:

footer -

getInstructionalMessageField

MessageField getInstructionalMessageField()

Text for the container that provides a summary description or instructions

Text is encapsulated in a MessageField that contains rendering configuration.

Summary MessageField only rendered if this methods does not return null

Returns:

MessageField instance or Null

setInstructionalMessageField

void setInstructionalMessageField(MessageField summaryMessageField)

Setter for the containers summary message field

Parameters:

summaryMessageField -

getErrorsField

ErrorsField getErrorsField()

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 ErrorsField

Returns:

ErrorsField holding the container errors

setErrorsField

void setErrorsField(ErrorsField errorsField)

Setter for the containers errors field

Parameters:

errorsField -

getHelp

Help getHelp()

Help configuration object for the container

External help information can be configured for the container. The Help object can the configuration for rendering a link to that help information.

Returns:

Help for container

setHelp

void setHelp(Help help)

Setter for the containers help content

Parameters:

help -

isFieldContainer

boolean isFieldContainer()

This property is true if the container is used to display a group of fields that is visually a single field - this has an effect on where errors will show up for these fields.

Returns:

the fieldContainer

setFieldContainer

void setFieldContainer(boolean fieldContainer)

Parameters:

fieldContainer - the fieldContainer to set