Package org.kuali.rice.krad.uif.layout

Interface StackedLayoutManager

All Superinterfaces:
Cloneable, CollectionLayoutManager, Copyable, DictionaryBean, LayoutManager, LifecycleElement, Serializable, UifDictionaryBean
All Known Implementing Classes:
StackedLayoutManagerBase
public interface StackedLayoutManager extends CollectionLayoutManager
Layout manager interface for stacked collections.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Details

    • getSummaryTitle

      String getSummaryTitle()
      Text to appears in the header for each collection lines Group. Used in conjunction with getSummaryFields() to build up the final header text
      Returns:
      summary title text

    • setSummaryTitle

      void setSummaryTitle(String summaryTitle)
      Setter for the summary title text
      Parameters:
      summaryTitle -

    • getSummaryFields

      List<String> getSummaryFields()
      List of attribute names from the collection line class that should be used to build the line summary. To build the summary the value for each attribute is retrieved from the line instance. All the values are then placed together with a separator.
      Returns:
      summary field names
      See Also:

    • setSummaryFields

      void setSummaryFields(List<String> summaryFields)
      Setter for the summary field name list
      Parameters:
      summaryFields -

    • getLineGroupPrototype

      Group getLineGroupPrototype()
      Group instance that is used as a prototype for creating the collection line groups. For each line a copy of the prototype is made and then adjusted as necessary
      Returns:
      Group instance to use as prototype

    • setLineGroupPrototype

      void setLineGroupPrototype(Group lineGroupPrototype)
      Setter for the line group prototype
      Parameters:
      lineGroupPrototype -

    • getWrapperGroup

      Group getWrapperGroup()
      Group that will 'wrap' the generated collection lines so that they have a different layout from the general stacked layout

      By default (when the wrapper group is null), each collection line will become a group and the groups are rendered one after another. If the wrapper group is configured, the generated groups will be inserted as the items for the wrapper group, and the layout manager configured for the wrapper group will determine how they are rendered. For example, the layout manager could be a grid layout configured for three columns, which would layout the first three lines horizontally then break to a new row.

      Returns:
      Group instance whose items list should be populated with the generated groups, or null to use the default layout

    • setWrapperGroup

      void setWrapperGroup(Group wrapperGroup)
      Setter for the wrapper group that will receive the generated line groups
      Parameters:
      wrapperGroup -

    • getStackedGroups

      List<Group> getStackedGroups()
      Final List of Groups to render for the collection
      Returns:
      collection groups

    • getStackedGroupsNoWrapper

      List<Group> getStackedGroupsNoWrapper()
      Used by reflection during the lifecycle to get groups for the lifecycle when not using a wrapper group

      There are no references to this method in the code, this is intentional. DO NOT REMOVE.

      Returns:
      the stacked groups, if any

    • setStackedGroups

      void setStackedGroups(List<Group> stackedGroups)
      Setter for the collection groups
      Parameters:
      stackedGroups -

    • isRenderLineActionsInLineGroup

      boolean isRenderLineActionsInLineGroup()
      Flag that indicates whether actions will be added in the same group as the line items instead of in the footer of the line group
      Returns:
      boolean

    • setRenderLineActionsInLineGroup

      void setRenderLineActionsInLineGroup(boolean actionsInLineGroup)
      Set flag to add actions in the same group as the line items
      Parameters:
      actionsInLineGroup -

    • isRenderLineActionsInHeader

      boolean isRenderLineActionsInHeader()
      When true, actions specified in lineActions will appear to the very right of the header (appears in the corner of the stacked item) by placing the actions in the Header's rightGroup.
      Returns:
      true if rendering actions at the header level, false otherwise

    • setRenderLineActionsInHeader

      void setRenderLineActionsInHeader(boolean renderLineActionsInHeader)
      See Also:

    • getStyleClassesAsString

      String getStyleClassesAsString()
      Get a string representation of all style classes defined by this layout manager.
      Returns:
      string representing CSS classes