001/*
002 * Copyright 2002-2013 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.web.servlet.tags;
018
019import javax.servlet.jsp.JspException;
020
021/**
022 * Sets default HTML escape value for the current page. The actual value
023 * can be overridden by escaping-aware tags. The default is "false".
024 *
025 * <p>Note: You can also set a "defaultHtmlEscape" web.xml context-param.
026 * A page-level setting overrides a context-param.
027 *
028 * @author Juergen Hoeller
029 * @since 04.03.2003
030 * @see HtmlEscapingAwareTag#setHtmlEscape
031 */
032@SuppressWarnings("serial")
033public class HtmlEscapeTag extends RequestContextAwareTag {
034
035        private boolean defaultHtmlEscape;
036
037
038        /**
039         * Set the default value for HTML escaping,
040         * to be put into the current PageContext.
041         */
042        public void setDefaultHtmlEscape(boolean defaultHtmlEscape) {
043                this.defaultHtmlEscape = defaultHtmlEscape;
044        }
045
046
047        @Override
048        protected int doStartTagInternal() throws JspException {
049                getRequestContext().setDefaultHtmlEscape(this.defaultHtmlEscape);
050                return EVAL_BODY_INCLUDE;
051        }
052
053}