XhtmlTag.java

/*
 * $Id: XhtmlTag.java 551067 2007-06-27 06:05:09Z pbenedict $
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache 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.apache.org/licenses/LICENSE-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.apache.struts.taglib.html;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.struts.Globals;
import org.apache.struts.taglib.TagUtils;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.TagSupport;

/**
 * This tag tells all other html taglib tags to render themselves in xhtml. 
 * Its presence in a page turns on xhtml. <p>
 * Example:<br/> <html:xhtml/> </p>
 */
public class XhtmlTag extends TagSupport {
    
    /**
     * Commons logging instance.
     */
    private static final Log log = LogFactory.getLog(XhtmlTag.class);

    /**
     * The scope within which to store the markup format.
     */
    private String scope;
    
    /**
     * Constructor for XhtmlTag.
     */
    public XhtmlTag() {
        super();
    }

    /**
     * @see javax.servlet.jsp.tagext.Tag#doEndTag()
     */
    public int doEndTag() throws JspException {
        int inScope = PageContext.PAGE_SCOPE;
        try {
            if (this.scope != null) {
                inScope = TagUtils.getInstance().getScope(this.scope);
            }
        } catch (JspException e) {
            log.warn("invalid scope name - defaulting to PAGE_SCOPE", e);
        }
        
        this.pageContext.setAttribute(Globals.XHTML_KEY, "true", inScope);
        return EVAL_PAGE;
    }

    public String getScope() {
        return this.scope;
    }

    public void setScope(String scope) {
        this.scope = scope;
    }
}