Package org.kuali.rice.krad.uif.container

Interface Container

All Superinterfaces:
Cloneable, Component, Copyable, DictionaryBean, Helpable, LifecycleElement, Ordered, org.springframework.core.Ordered, ScriptEventSupport, Serializable, UifDictionaryBean
All Known Subinterfaces:
CollectionGroup, Group, PageGroup
All Known Implementing Classes:
AccordionGroup, CollectionGroupBase, ContainerBase, DialogGroup, DocumentView, FormView, GroupBase, IframeView, InquiryView, LightTable, LinkGroup, LookupView, MaintenanceDocumentView, MessageView, MockView, PageGroupBase, SidebarNavigationGroup, TabGroup, TabNavigationGroup, 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:
  • 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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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: