org.kuali.rice.krad.uif.container
Interface Container

All Superinterfaces:
Component, DictionaryBean, Helpable, org.springframework.core.Ordered, ScriptEventSupport, Serializable, UifDictionaryBean
All Known Implementing Classes:
AccordionGroup, CollectionGroup, ComponentLibraryView, ContainerBase, DialogGroup, DocumentView, FormView, Group, InquiryView, LinkGroup, LookupView, MaintenanceDocumentView, MessageView, NavigationGroup, PageGroup, ReorderingGroup, TabGroup, TransactionalDocumentView, TreeGroup, View

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:

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
 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
 void setFooter(Group footer)
          Setter for the containers footer
 void setHeader(Header header)
          Setter for the containers header field
 void setInstructionalMessage(Message instructionalMessage)
          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
 void setValidationMessages(ValidationMessages validationMessages)
          Setter for the containers errors field
 
Methods inherited from interface org.kuali.rice.krad.uif.component.Component
addCellCssClass, addDataAttribute, addStyleClass, appendToStyle, completeValidation, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAlign, getAllDataAttributesJs, getBaseId, getCellCssClasses, getCellStyle, getCellWidth, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentPrototypes, getComponentSecurity, getComponentsForLifecycle, getComponentTypeName, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, performApplyModel, performFinalize, performInitialization, pushAllToContext, pushObjectToContext, setAdditionalComponentsToRefresh, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setWidth
 
Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean
getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph
 
Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean
getComponentCode, getNamespaceCode
 
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, setOnBlurScript, setOnLoadScript
 
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)
Setter for the containers layout manager

Parameters:
layoutManager -

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)
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 -

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)
Setter for the containers summary message field

Parameters:
instructionalMessage -

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)
Setter for the containers errors field

Parameters:
validationMessages -


Copyright © 2005-2013 The Kuali Foundation. All Rights Reserved.