/**
    * Copyright 2005-2013 The Kuali Foundation
    *
    * Licensed under the Educational Community License, Version 2.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/ecl2.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.krad.uif.field;
  
  import java.util.List;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.rice.krad.datadictionary.parse.BeanTag;
  import org.kuali.rice.krad.datadictionary.parse.BeanTagAttribute;
  import org.kuali.rice.krad.datadictionary.parse.BeanTags;
  import org.kuali.rice.krad.uif.UifConstants;
  import org.kuali.rice.krad.uif.component.Component;
  import org.kuali.rice.krad.uif.container.Group;
  
  /**
   * Field that contains a nested <code>Group</code>. Can be used to group
   * together fields by providing a group without header and footer, or simply to
   * nest full groups. The items getter/setter provided is for convenience and
   * will set the items <code>List</code> in the nested <code>Group</code>
   *
   * @author Kuali Rice Team (rice.collab@kuali.org)
   */
  @BeanTags({@BeanTag(name = "fieldGroup-bean", parent = "Uif-FieldGroupBase"),
          @BeanTag(name = "verticalFieldGroup-bean", parent = "Uif-VerticalFieldGroup"),
          @BeanTag(name = "horizontalFieldGroup-bean", parent = "Uif-HorizontalFieldGroup")})
  public class FieldGroup extends FieldBase {
      private static final long serialVersionUID = -505654043702442196L;
  
      private Group group;
  
      public FieldGroup() {
          super();
      }
  
      /**
       * The following initialization is performed:
       *
       * <ul>
       * <li>Set the align on group if empty and the align has been set on the field</li>
       * </ul>
       *
       * @see org.kuali.rice.krad.uif.component.ComponentBase#performInitialization(org.kuali.rice.krad.uif.view.View,
       *      java.lang.Object)
       */
      @Override
      public void performInitialization(Object model) {
          super.performInitialization(model);
  
          if (StringUtils.isNotBlank(getAlign()) && group != null) {
              group.setAlign(getAlign());
          }
      }
  
      @Override
      public void performFinalize(Object model, Component parent) {
          super.performFinalize(model, parent);
  
          this.addDataAttribute(UifConstants.DataAttributes.PARENT, parent.getId());
          if (group != null) {
              this.addDataAttribute(UifConstants.DataAttributes.GROUP, group.getId());
          }
  
          setNestedComponentIdAndSuffix(getFieldLabel(), UifConstants.IdSuffixes.LABEL);
  
          if (this.getFieldLabel() != null) {
              this.getFieldLabel().setLabelForComponentId(this.getId() + UifConstants.IdSuffixes.FIELDSET);
          }
      }
  
      /**
       * @see org.kuali.rice.krad.uif.component.ComponentBase#getComponentsForLifecycle()
       */
      @Override
      public List<Component> getComponentsForLifecycle() {
          List<Component> components = super.getComponentsForLifecycle();
  
          components.add(group);
  
          return components;
      }
  
      /**
       * <code>Group</code> instance that is contained within in the field
       *
       * @return Group instance
       */
     @BeanTagAttribute(name = "group", type = BeanTagAttribute.AttributeType.SINGLEBEAN)
     public Group getGroup() {
         return this.group;
     }
 
     /**
      * Setter for the field's nested group
      *
      * @param group
      */
     public void setGroup(Group group) {
         this.group = group;
     }
 
     /**
      * List of <code>Component</code> instances contained in the nested group
      *
      * <p>
      * Convenience method for configuration to get the items List from the
      * field's nested group
      * </p>
      *
      * @return List<? extends Component> items
      */
     @BeanTagAttribute(name = "items", type = BeanTagAttribute.AttributeType.LISTBEAN)
     public List<? extends Component> getItems() {
         if (group != null) {
             return group.getItems();
         }
 
         return null;
     }
 
     /**
      * Setter for the field's nested group items
      *
      * <p>
      * Convenience method for configuration to set the items List for the
      * field's nested group
      * </p>
      *
      * @param items
      */
     public void setItems(List<? extends Component> items) {
         if (group != null) {
             group.setItems(items);
         }
     }
 
     /**
      * @see org.kuali.rice.krad.datadictionary.DictionaryBeanBase#copyProperties(Object)
      */
     @Override
     protected <T> void copyProperties(T component) {
         super.copyProperties(component);
 
         FieldGroup fieldGroupCopy = (FieldGroup) component;
 
         if (this.group != null) {
             fieldGroupCopy.setGroup((Group)this.group.copy());
         }
     }
 }