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

Class LineBuilderContext

java.lang.Object
org.kuali.rice.krad.uif.container.collections.LineBuilderContext
All Implemented Interfaces:
Serializable
public class LineBuilderContext extends Object implements Serializable
Holds components and configuration for a line during the build process.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • LineBuilderContext

      public LineBuilderContext()
      Empty constructor.

    • LineBuilderContext

      public LineBuilderContext(int lineIndex, Object currentLine, String bindingPath, boolean bindToForm, ViewModel model, CollectionGroup collectionGroup, List<? extends Component> lineActions)
      Constructor.
      Parameters:
      lineIndex - index of line
      currentLine - object containing the line data
      bindingPath - path to the line in the model
      bindToForm - indicates if the line fields bind to the form (not the default object path)
      model - object containing the views data
      collectionGroup - collection group instance the line is being built for
      lineActions - list of components for the lines action column

    • LineBuilderContext

      public LineBuilderContext(int lineIndex, Object currentLine, String bindingPath, boolean bindToForm, ViewModel model, CollectionGroup collectionGroup, List<? extends Component> lineActions, List<DialogGroup> lineDialogs)
      Constructor.
      Parameters:
      lineIndex - index of line
      currentLine - object containing the line data
      bindingPath - path to the line in the model
      bindToForm - indicates if the line fields bind to the form (not the default object path)
      model - object containing the views data
      collectionGroup - collection group instance the line is being built for
      lineActions - list of components for the lines action column
      lineDialogs - list of dialogs configured on the line

  • Method Details

    • getIdSuffix

      public String getIdSuffix()
      Suffix to use for adjusting the ids on components within the line.
      Returns:
      String id suffix

    • isAddLine

      public boolean isAddLine()
      Indicates whether the line is the add line, or an existing collection line.
      Returns:
      boolean true if the line is the add line, false if not

    • getLayoutManager

      public CollectionLayoutManager getLayoutManager()
      Returns the CollectionLayoutManager configured on the collection group.
      Returns:
      collection layout manager instance

    • getLineIndex

      public int getLineIndex()
      Index for the line within the collection, or -1 for the add line.
      Returns:
      line index

    • setLineIndex

      public void setLineIndex(int lineIndex)
      See Also:

    • getCurrentLine

      public Object getCurrentLine()
      Object containing the line's data.
      Returns:
      object instance

    • setCurrentLine

      public void setCurrentLine(Object currentLine)
      See Also:

    • getBindingPath

      public String getBindingPath()
      Path to the line in the full model.
      Returns:
      binding path

    • setBindingPath

      public void setBindingPath(String bindingPath)
      See Also:

    • isBindToForm

      public boolean isBindToForm()
      Indicates if the line fields bind to the form (not the default object path).
      Returns:
      boolean true if line fields bindi to the form, false if not

    • setBindToForm

      public void setBindToForm(boolean bindToForm)
      See Also:

    • getModel

      public ViewModel getModel()
      Object containing the view's data.
      Returns:
      model instance

    • setModel

      public void setModel(ViewModel model)
      See Also:

    • getCollectionGroup

      public CollectionGroup getCollectionGroup()
      Collection group the line is being built for.
      Returns:
      collection group instance

    • setCollectionGroup

      public void setCollectionGroup(CollectionGroup collectionGroup)
      See Also:

    • getLineActions

      public List<? extends Component> getLineActions()
      List of components to render in the lines action column.
      Returns:
      list of component instances

    • setLineActions

      public void setLineActions(List<? extends Component> lineActions)
      See Also:

    • getLineFields

      public List<Field> getLineFields()
      List of field instances that make up the lines columns.
      Returns:
      list of field instances.

    • setLineFields

      public void setLineFields(List<Field> lineFields)
      See Also:

    • getSubCollectionFields

      public List<FieldGroup> getSubCollectionFields()
      List of field groups that wrap the sub-collections for the line.
      Returns:
      list of field groups instances

    • setSubCollectionFields

      public void setSubCollectionFields(List<FieldGroup> subCollectionFields)
      See Also:

    • getLineDialogs

      public List<DialogGroup> getLineDialogs()
      List of dialog groups that make up the lines dialogs.
      Returns:
      list of field instances.

    • setLineDialogs

      public void setLineDialogs(List<DialogGroup> dialogGroups)
      See Also:
      • invalid reference 
        org.kuali.rice.krad.uif.container.collections.LineBuilderContext#getDialogGroups()