/**

  * Copyright 2010 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.osedu.org/licenses/ECL-2.0

  *

  * 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.student.common.ui.client.configurable.mvc.views;

 import org.kuali.student.common.ui.client.configurable.mvc.SectionTitle;

 import org.kuali.student.common.ui.client.widgets.field.layout.layouts.VerticalFieldLayout;

 import com.google.gwt.user.client.ui.Widget;

 /**

  * The vertical layout implementation of SectionView.  The ui layout behaves exactly the same as

  * VerticalSection.

  * 

  * A model id can be passed in to specify a model this particular view uses.

  * 

  * @author Brian Smith

  *

  */

 public class VerticalSectionView extends SectionView {

     /**

      * Same as VerticalSectionView(Enum<?> viewEnum, String name, String modelId, true)

      */

     public VerticalSectionView(Enum<?> viewEnum, String name, String modelId) {

         this(viewEnum, name, modelId, true);

     }

     /**

      * @param viewEnum Enumeration of this view - id used for navigation, history, and showing a view

      * @param name Name of this view - what this view is called in the breadcrumb

      * @param modelId id of the model to be used for this view when a requestModel call is made on its parent controller

      * @param showTitle if true, show the view's name as an H2 header

      */

     public VerticalSectionView(Enum<?> viewEnum, String name, String modelId, boolean showTitle) {

         super(viewEnum, name);

         this.modelId = modelId;

         if (name != null && !name.isEmpty()) {

             SectionTitle sectionTitle = SectionTitle.generateH2Title(getName());

             if (showTitle) {

                 layout = new VerticalFieldLayout(sectionTitle);

             } else {

                 layout = new VerticalFieldLayout();

             }

         } else {

             layout = new VerticalFieldLayout();

         }

         this.add(layout);

     }

     /**

      * VerticalSectionView with a custom titleWidget defined

      * @param viewEnum

      * @param name

      * @param modelId

      * @param titleWidget

      */

     public VerticalSectionView(Enum<?> viewEnum, String name, String modelId, Widget titleWidget) {

         super(viewEnum, name);

         this.modelId = modelId;

         layout = new VerticalFieldLayout(titleWidget);

         this.add(layout);

     }

     /**

      * This updates the model

      *

      * @see org.kuali.student.common.ui.client.mvc.View#updateModel()

      */

     @Override

     @SuppressWarnings("unchecked")

     public void updateModel() {

         if (model != null && isValidationEnabled()) {

             super.updateModel(model);

         }

     }

     @Override

     public void clear() {

         // TODO Auto-generated method stub

     }

     public void setSectionTitle(String title) {

         layout.setLayoutTitle(SectionTitle.generateH2Title(title));

     }

 }