View Javadoc
1   /**
2    * Copyright 2005-2014 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.krad.uif.lifecycle.finalize;
17  
18  import org.apache.commons.lang.StringUtils;
19  import org.kuali.rice.krad.uif.component.Component;
20  import org.kuali.rice.krad.uif.lifecycle.ViewLifecycle;
21  import org.kuali.rice.krad.uif.lifecycle.ViewLifecyclePhase;
22  import org.kuali.rice.krad.uif.lifecycle.ViewLifecycleTaskBase;
23  import org.kuali.rice.krad.uif.view.View;
24  
25  /**
26   * Add templates defined on this component to the view for rendering.
27   * 
28   * @author Kuali Rice Team (rice.collab@kuali.org)
29   */
30  public class AddViewTemplatesTask extends ViewLifecycleTaskBase<Component> {
31  
32      /**
33       * Constructor.
34       * 
35       * @param phase The finalize phase for the component.
36       */
37      public AddViewTemplatesTask(ViewLifecyclePhase phase) {
38          super(phase, Component.class);
39      }
40  
41      /**
42       * {@inheritDoc}
43       */
44      @Override
45      protected void performLifecycleTask() {
46          Component component = (Component) getElementState().getElement();
47          View view = ViewLifecycle.getView();
48  
49          // add the components template to the views list of components
50          if (!component.isSelfRendered() && StringUtils.isNotBlank(component.getTemplate())) {
51              String template = component.getTemplate();
52              view.addViewTemplate(template);
53              
54              for (String additionalTemplate : component.getAdditionalTemplates()) {
55                  view.addViewTemplate(additionalTemplate);
56              }
57          }
58      }
59  
60  }