Interface Group

All Superinterfaces:
Cloneable, Component, Container, Copyable, DictionaryBean, Helpable, LifecycleElement, Ordered, org.springframework.core.Ordered, ScriptEventSupport, Serializable, UifDictionaryBean
All Known Subinterfaces:
CollectionGroup, PageGroup
All Known Implementing Classes:
AccordionGroup, CollectionGroupBase, DialogGroup, GroupBase, LightTable, LinkGroup, PageGroupBase, SidebarNavigationGroup, TabGroup, TabNavigationGroup, TreeGroup

public interface Group extends Container
Common interface for group components.
Author:
Kuali Rice Team (rice.collab@kuali.org)
  • Method Details

    • getFieldBindByNamePrefix

      String getFieldBindByNamePrefix()
      Binding prefix string to set on each of the groups DataField instances

      As opposed to setting the bindingPrefix on each attribute field instance, it can be set here for the group. During initialize the string will then be set on each attribute field instance if the bindingPrefix is blank and not a form field

      Returns:
      String binding prefix to set
    • setFieldBindByNamePrefix

      void setFieldBindByNamePrefix(String fieldBindByNamePrefix)
      Setter for the field binding prefix
      Parameters:
      fieldBindByNamePrefix -
    • getFieldBindingObjectPath

      String getFieldBindingObjectPath()
      Object binding path to set on each of the group's InputField instances

      When the attributes of the group belong to a object whose path is different from the default then this property can be given to set each of the attributes instead of setting the model path on each one. The object path can be overridden at the attribute level. The object path is set to the fieldBindingObjectPath during the initialize phase.

      Returns:
      String model path to set
      See Also:
    • setFieldBindingObjectPath

      void setFieldBindingObjectPath(String fieldBindingObjectPath)
      Setter for the field object binding path
      Parameters:
      fieldBindingObjectPath -
    • getDisclosure

      Disclosure getDisclosure()
      Disclosure widget that provides collapse/expand functionality for the group
      Returns:
      Disclosure instance
    • setDisclosure

      void setDisclosure(Disclosure disclosure)
      Setter for the group's disclosure instance
      Parameters:
      disclosure -
    • getScrollpane

      Scrollpane getScrollpane()
      Scrollpane widget that provides scrolling functionality for the group
      Returns:
      Scrollpane instance
    • setScrollpane

      void setScrollpane(Scrollpane scrollpane)
      Setter for the group's scrollpane instance
      Parameters:
      scrollpane -
    • isRenderLoading

      boolean isRenderLoading()
      Determine the group should be rendered on initial load, or if a loading message should be rendered instead.
      Returns:
      True if a loading message should be rendered, false if the group should be rendered now.
    • getHeaderText

      String getHeaderText()
      Getter for headerText
      Returns:
      headerText
    • setHeaderText

      void setHeaderText(String headerText)
      Setter for headerText.
      Parameters:
      headerText - value
    • setRenderFooter

      void setRenderFooter(boolean renderFooter)
      Setter for renderFooter.
      Parameters:
      renderFooter - value
    • getWrapperTag

      String getWrapperTag()
    • setWrapperTag

      void setWrapperTag(String footer)