/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Xalan" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 1999, Lotus
* Development Corporation., http://www.lotus.com. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.xalan.templates;
//import org.w3c.dom.*;
import org.apache.xml.dtm.DTM;
import org.xml.sax.*;
import org.apache.xalan.res.XSLTErrorResources;
import org.apache.xalan.transformer.TransformerImpl;
import java.io.*;
import java.util.*;
/**
* <meta name="usage" content="advanced"/>
* Implement xsl:template.
* This primarily acts as a marker on the element
* stack to signal that whitespace should be preserved.
* <pre>
* <!ELEMENT xsl:text (#PCDATA)>
* <!ATTLIST xsl:text
* disable-output-escaping (yes|no) "no"
* >
* </pre>
* @see <a href="http://www.w3.org/TR/xslt#section-Creating-Text">section-Creating-Text in XSLT Specification</a>
*/
public class ElemText extends ElemTemplateElement
{
/**
* Tells if this element should disable escaping.
* @serial
*/
private boolean m_disableOutputEscaping = false;
/**
* Set the "disable-output-escaping" attribute.
* Normally, the xml output method escapes & and < (and
* possibly other characters) when outputting text nodes.
* This ensures that the output is well-formed XML. However,
* it is sometimes convenient to be able to produce output
* that is almost, but not quite well-formed XML; for
* example, the output may include ill-formed sections
* which are intended to be transformed into well-formed
* XML by a subsequent non-XML aware process. For this reason,
* XSLT provides a mechanism for disabling output escaping.
* An xsl:value-of or xsl:text element may have a
* disable-output-escaping attribute; the allowed values
* are yes or no; the default is no; if the value is yes,
* then a text node generated by instantiating the xsl:value-of
* or xsl:text element should be output without any escaping.
* @see <a href="http://www.w3.org/TR/xslt#disable-output-escaping">disable-output-escaping in XSLT Specification</a>
*
* @param v Boolean flag indicating whether this element should disable escaping
*/
public void setDisableOutputEscaping(boolean v)
{
m_disableOutputEscaping = v;
}
/**
* Get the "disable-output-escaping" attribute.
* Normally, the xml output method escapes & and < (and
* possibly other characters) when outputting text nodes.
* This ensures that the output is well-formed XML. However,
* it is sometimes convenient to be able to produce output
* that is almost, but not quite well-formed XML; for
* example, the output may include ill-formed sections
* which are intended to be transformed into well-formed
* XML by a subsequent non-XML aware process. For this reason,
* XSLT provides a mechanism for disabling output escaping.
* An xsl:value-of or xsl:text element may have a
* disable-output-escaping attribute; the allowed values
* are yes or no; the default is no; if the value is yes,
* then a text node generated by instantiating the xsl:value-of
* or xsl:text element should be output without any escaping.
* @see <a href="http://www.w3.org/TR/xslt#disable-output-escaping">disable-output-escaping in XSLT Specification</a>
*
* @return Boolean flag indicating whether this element should disable escaping
*/
public boolean getDisableOutputEscaping()
{
return m_disableOutputEscaping;
}
/**
* Get an integer representation of the element type.
*
* @return An integer representation of the element, defined in the
* Constants class.
* @see org.apache.xalan.templates.Constants
*/
public int getXSLToken()
{
return Constants.ELEMNAME_TEXT;
}
/**
* Return the node name.
*
* @return The element's name
*/
public String getNodeName()
{
return Constants.ELEMNAME_TEXT_STRING;
}
/**
* Add a child to the child list.
*
* @param newChild Child to add to children list
*
* @return Child added to children list
*
* @throws DOMException
*/
public ElemTemplateElement appendChild(ElemTemplateElement newChild)
{
int type = ((ElemTemplateElement) newChild).getXSLToken();
switch (type)
{
case Constants.ELEMNAME_TEXTLITERALRESULT :
break;
default :
error(XSLTErrorResources.ER_CANNOT_ADD,
new Object[]{ newChild.getNodeName(),
this.getNodeName() }); //"Can not add " +((ElemTemplateElement)newChild).m_elemName +
//" to " + this.m_elemName);
}
return super.appendChild(newChild);
}
}