View Javadoc

1   /*
2    * $Id: ClosingUIBean.java 451544 2006-09-30 05:38:02Z mrdon $
3    *
4    * Copyright 2006 The Apache Software Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *      http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.struts2.components;
19  
20  import java.io.Writer;
21  
22  import javax.servlet.http.HttpServletRequest;
23  import javax.servlet.http.HttpServletResponse;
24  
25  import org.apache.commons.logging.Log;
26  import org.apache.commons.logging.LogFactory;
27  
28  import com.opensymphony.xwork2.util.ValueStack;
29  
30  /***
31   * ClosingUIBean is the standard superclass for UI components such as div etc.
32   */
33  public abstract class ClosingUIBean extends UIBean {
34      private static final Log LOG = LogFactory.getLog(ClosingUIBean.class);
35  
36      protected ClosingUIBean(ValueStack stack, HttpServletRequest request, HttpServletResponse response) {
37          super(stack, request, response);
38      }
39  
40      String openTemplate;
41  
42      public abstract String getDefaultOpenTemplate();
43  
44      /***
45       * Set template to use for opening the rendered html.
46       * @s.tagattribute required="false"
47       */
48      public void setOpenTemplate(String openTemplate) {
49          this.openTemplate = openTemplate;
50      }
51  
52      public boolean start(Writer writer) {
53          boolean result = super.start(writer);
54          try {
55              evaluateParams();
56  
57              mergeTemplate(writer, buildTemplateName(openTemplate, getDefaultOpenTemplate()));
58          } catch (Exception e) {
59              LOG.error("Could not open template", e);
60              e.printStackTrace();
61          }
62  
63          return result;
64      }
65  }