Block

/**
 * Copyright By Grandsoft Company Limited.
 * 2014年4月22日 下午7:18:44
 */
package gboat2.base.view.components;

import gboat2.base.view.GboatViewUtil;

import java.io.Writer;

import javax.servlet.http.HttpServletRequest;

import org.apache.struts2.components.Component;
import org.apache.struts2.views.annotations.StrutsTag;
import org.apache.struts2.views.annotations.StrutsTagAttribute;

import com.opensymphony.xwork2.util.ValueStack;

/**
 * 定义一个代码块，用于在子页面中进行重写
 * <pre>
 * <b>父页面:（demo-parent.jsp）</b>
 * <code>
 * &lt;%@ taglib prefix="g2" uri="/g2-tags"%&gt;
 * &lt;g2:page comment="这是父页面：demo-parent.jsp" title="测试页面-父页面"&gt;
 *     &lt;p&gt;没有被包含在 block 标签中的代码在子页面中将无法被覆盖&lt;/p&gt;
 *     &lt;g2:block id="block_1"&gt;&lt;p&gt;这个是父页面中的代码块1，原样输出&lt;/p&gt;&lt;/g2:block&gt;
 *     &lt;g2:block id="block_2"&gt;&lt;div&gt;这个代码块在子页面中进行重写……&lt;/div&gt;&lt;/g2:block&gt;
 * &lt;/g2:page&gt;
 * </code>
 * <b>子页面（demo.jsp）</b>
 * <code>
 * &lt;%@ taglib prefix="g2" uri="/g2-tags"%&gt;
 * &lt;g2:page comment="这个是子页面：demo.jsp" title="测试页面-子页面" extend="demo-parent.jsp"&gt;
 *     &lt;g2:overlay id="block_2"&gt;
 *         &lt;g2:inheritBlock/&gt;
 *         &lt;div&gt;上面的 inheritBlock 标签是为了包含父页面中的代码，这一行是新增的，在下面再包含一次父页面中的代码，嘿嘿……&lt;/div&gt;
 *         &lt;g2:inheritBlock/&gt;&lt;br&gt;
 * &lt;/g2:page&gt;
 * </code>
 * <b>访问 demo.jsp 输出:</b>
 * <code>
 * …… ……
 * &lt;p&gt;没有被包含在 block 标签中的代码在子页面中将无法被覆盖&lt;/p&gt;
 * &lt;p&gt;这个是父页面中的代码块1，原样输出&lt;/p&gt;
 * &lt;div&gt;这个代码块在子页面中进行重写……&lt;/div&gt;
 * &lt;div&gt;上面的 inheritBlock 标签是为了包含父页面中的代码，这一行是新增的，在下面再包含一次父页面中的代码，嘿嘿……&lt;/div&gt;
 * &lt;div&gt;这个代码块在子页面中进行重写……&lt;/div&gt;
 * …… ……
 * </code>
 * 可以看到，demo.jsp 中 block_2 的输出内容被 &lt;g2:overlay/&gt; 重定义了，而 block_1 部分还是 demo-parent.jsp 的内容.
 * </pre>
 * @author <a href="mailto:[email protected]">何明旺</a>
 * @since 3.0
 * @date 2014年4月22日
 */
@StrutsTag(
        name="block",
        tldBodyContent="JSP",
        tldTagClass="gboat2.base.view.jsp.BlockTag",
        description="定义一个代码块，用于在子页面中进行重写")
public class Block extends Component {

    protected HttpServletRequest request;

    protected String id;

    public Block(ValueStack stack, HttpServletRequest request) {
        super(stack);
        this.request = request;
    }

    @Override
    public boolean start(Writer write) {
        // 没有被子页面覆盖时，需要缓冲 body
        return (getOverriedContent() == null);
    }

    @Override
    public boolean end(Writer writer, String body) {
        Object overriedContent = getOverriedContent();
        if(overriedContent != null) {
            body = overriedContent.toString();
        }
        return super.end(writer, body );
    }

    @StrutsTagAttribute(description="代码块的唯一标识")
    public void setId(String id) {
        this.id = id;
    }

    /**
     * 获取子页面中覆盖后的代码
     * @return
     */
    protected Object getOverriedContent() {
        String varName = GboatViewUtil.getOverrideVariableName(id);
        return this.request.getAttribute(varName);
    }
}