/**
    * 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.mvc;
  
  import java.util.List;
  
  import org.kuali.student.common.ui.client.security.AuthorizationCallback;
  import org.kuali.student.common.ui.client.security.RequiresAuthorization;
  import org.kuali.student.core.rice.authorization.PermissionType;
  
  
  /**
   * This is a simple view composite that delegates all view operations to nested
   * controller. Use of this view allows you to nest controllers in the view
   * hierarchy.
   * 
   * @author Kuali Student Team
   *
   */
  public class DelegatingViewComposite extends ViewComposite implements RequiresAuthorization {
      Controller childController;
      
      /**
       * @param controller
       * @param name
       */
      public DelegatingViewComposite(Controller parentController, Controller childController, Enum<?> viewType) {
          super(parentController, "DelegatingViewComposite", viewType);
          initWidget(childController);
          this.childController = childController;
      }
  
      /**
       * Delegates beforeHide to the nested controllers current view
       * 
       * @see org.kuali.student.common.ui.client.mvc.View#beforeHide()
       */
      @Override
      public boolean beforeHide() {
          return childController.getCurrentView().beforeHide();
      }
  
      /**
       * @see org.kuali.student.common.ui.client.mvc.View#beforeShow()
       */
      @Override
      public void beforeShow(final Callback<Boolean> onReadyCallback) {
          if (childController.getCurrentView() == null){
              childController.showDefaultView(onReadyCallback);
          } else {
              childController.getCurrentView().beforeShow(onReadyCallback);
          }
      }
      
      public Controller getChildController(){
          return childController;
      }
      
      public void setChildController(Controller controller){
          this.childController = controller;
      }
      
      @Override
  	public String collectHistory(String historyStack) {
  		return childController.collectHistory(historyStack);
  	}
  
  	@Override
  	public void onHistoryEvent(String historyStack) {
  		childController.onHistoryEvent(historyStack);
  	}
  
  	@Override
      public void clear() {
      	childController.resetCurrentView();
      }
  
  	@Override
  	public void checkAuthorization(PermissionType permissionType, AuthorizationCallback callback) {
  		if (childController instanceof RequiresAuthorization){
  			((RequiresAuthorization)childController).checkAuthorization(permissionType, callback);
  		}				
  	}
  
  	@Override
  	public boolean isAuthorizationRequired() {
 		if (childController instanceof RequiresAuthorization){
 			return ((RequiresAuthorization)childController).isAuthorizationRequired();
 		} else {
 			return false;
 		}
 	}
 
 	@Override
 	public void setAuthorizationRequired(boolean required) {
 		if (childController instanceof RequiresAuthorization){
 			((RequiresAuthorization)childController).setAuthorizationRequired(required);
 		}		
 	}
 
 	@Override
 	public void collectBreadcrumbNames(List<String> names) {
 		childController.collectBreadcrumbNames(names);
 		
 	}
 
 }