/*

  * Copyright 2011 The Kuali Foundation

  *

  * Licensed under the Educational Community License, Version 1.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  *

  * http://www.opensource.org/licenses/ecl1.php

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package org.kuali.rice.kns.uif.layout;

 import java.util.List;

 import org.kuali.rice.kns.uif.container.CollectionGroup;

 import org.kuali.rice.kns.uif.container.View;

 import org.kuali.rice.kns.uif.field.ActionField;

 import org.kuali.rice.kns.uif.field.Field;

 import org.kuali.rice.kns.uif.field.GroupField;

 /**

  * Layout manager implementations that work with a collection (such as a table

  * layout) should implement this interface for building the collection

  * <code>Component</code> instances

  * 

  * <p>

  * Unlike other <code>Group</code> instances, <code>CollectionGroup</code>

  * instances need to generate new instances of the configured components for

  * each line of the collection. The <code>Field</code> instances for each line

  * are wrapped differently depending on what <code>LayoutManager</code> is being

  * applied. Therefore as the collection lines are being built (during the

  * applyModel phase) this method will be invoked on the manager so that it may

  * setup the line as needed.

  * </p>

  * 

  * @author Kuali Rice Team (rice.collab@kuali.org)

  * @see org.kuali.rice.kns.uif.container.CollectionGroupBuilder

  */

 public interface CollectionLayoutManager extends LayoutManager {

         /**

          * Call to the layout manager to build the components necessary for the

          * given collection line

          * 

          * <p>

          * As the collection is being iterated over by the

          * <code>CollectionGroupBuilder</code> this method is invoked for each line.

          * The builder will create copies of the configured fields and actions for

          * the line and pass into the layout manager so they can be assembled

          * </p>

          * 

          * @param view

          *            - view instance the collection belongs to

          * @param model

          *            - object containing the data

          * @param collectionGroup

          *            - collection group the layout manager applies to

          * @param lineFields

          *            - the field instances for the collection line which were

          *            copied from the collection groups items, id and binding

          *            already updated

          * @param subCollectionFields

          *            - group field instances for each sub collection of the current

          *            line

          * @param bindingPath

          *            - binding path for the groups items (if DataBinding)

          * @param actions

          *            - list of action instances for the collection line, with id

          *            and binding updated

          * @param idSuffix

          *            - suffix to use for any generated items

          * @param currentLine

          *            - object instance for the current line, or null if add line

          * @param lineIndex

          *            - index of the collection line being iterated over, or -1 if

          *            the add line

          */

         public void buildLine(View view, Object model, CollectionGroup collectionGroup, List<Field> lineFields,

                         List<GroupField> subCollectionFields, String bindingPath, List<ActionField> actions, String idSuffix,

                         Object currentLine, int lineIndex);

         /**

          * Field group instance that is used as a prototype for creating the

          * sub-collection field groups. For each sub-collection a copy of the

          * prototype is made and the list will be passed to the layout manager

          * buildLine method

          * 

          * @return GroupField instance to use as prototype

          */

         public GroupField getSubCollectionGroupFieldPrototype();

 }