public interface Container extends Component, Helpable
Container components must use a
LayoutManager to render the contained components.
Each container has the following parts in addition to the contained components:
HeaderFieldMessageGroupComponentINITIAL_ORDER_VALUE| Modifier and Type | Method and Description |
|---|---|
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
|
addCellCssClass, addDataAttribute, addStyleClass, appendToStyle, completeValidation, copy, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellWidth, getColSpan, getComponentModifiers, getComponentPrototypes, getComponentSecurity, getComponentsForLifecycle, getComponentTypeName, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, performApplyModel, performFinalize, performInitialization, pushAllToContext, pushObjectToContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setWidthgetExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraphgetComponentCode, getNamespaceCodegetOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScriptgetHelp, getHelpTitle, setHelp, setTooltipOfComponentList<? 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.
void setItems(List<? extends Component> items)
items - list of components to set in containerSet<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
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'
void setLayoutManager(LayoutManager layoutManager)
layoutManager - 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
Group getFooter()
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
Message getInstructionalMessage()
Text is encapsulated in a Message that contains
rendering configuration.
Summary Message only rendered if this methods does not
return null
void setInstructionalMessage(Message instructionalMessage)
instructionalMessage - ValidationMessages getValidationMessages()
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
void setValidationMessages(ValidationMessages validationMessages)
validationMessages - Copyright © 2005-2015 The Kuali Foundation. All Rights Reserved.