freemarker.core

Class XHTMLOutputFormat

java.lang.Object

freemarker.core.OutputFormat

freemarker.core.MarkupOutputFormat<MO>

freemarker.core.CommonMarkupOutputFormat<TemplateXMLOutputModel>

freemarker.core.XMLOutputFormat

freemarker.core.XHTMLOutputFormat

public class XHTMLOutputFormat
extends XMLOutputFormat

Represents the XML output format (MIME type "application/xhtml+xml", name "XHTML"); this behaves identically to HTMLOutputFormat, except that the name an the MIME Type differs. Yet, it extends XMLOutputFormat, as XHTML documents is a subset of XML documents, but not of HTML documents.

This class was final before 2.3.29.

Since:

2.3.24

Field Summary

Fields

Modifier and Type	Field and Description
static XHTMLOutputFormat	INSTANCE The only instance (singleton) of this OutputFormat.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XHTMLOutputFormat()

Method Summary

Modifier and Type	Method and Description
java.lang.String	escapePlainText(java.lang.String plainTextContent) Should give the same result as MarkupOutputFormat.fromPlainTextByEscaping(String) and then MarkupOutputFormat.getMarkupString(TemplateMarkupOutputModel), but the implementation may uses a more efficient solution.
java.lang.String	getMimeType() Returns the MIME type of the output format.
java.lang.String	getName() The short name used to refer to this format (like in the #ftl header).
boolean	isLegacyBuiltInBypassed(java.lang.String builtInName) Tells if a string built-in that can't handle a TemplateMarkupOutputModel left hand operand can bypass this object as is.
protected TemplateXHTMLOutputModel	newTemplateMarkupOutputModel(java.lang.String plainTextContent, java.lang.String markupContent) Creates a new CommonTemplateMarkupOutputModel that's bound to this OutputFormat instance.
void	output(java.lang.String textToEsc, java.io.Writer out) Equivalent to calling MarkupOutputFormat.fromPlainTextByEscaping(String) and then MarkupOutputFormat.output(TemplateMarkupOutputModel, Writer), but the implementation may uses a more efficient solution.

Methods inherited from class freemarker.core.CommonMarkupOutputFormat

concat, fromMarkup, fromPlainTextByEscaping, getMarkupString, getSourcePlainText, isAutoEscapedByDefault, isEmpty, isOutputFormatMixingAllowed, output

Methods inherited from class freemarker.core.OutputFormat

toString, toStringExtraProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INSTANCE

public static final XHTMLOutputFormat INSTANCE

The only instance (singleton) of this OutputFormat.

Constructor Detail

XHTMLOutputFormat

protected XHTMLOutputFormat()

Since:

2.3.29

Method Detail

getName

public java.lang.String getName()

Description copied from class: OutputFormat

The short name used to refer to this format (like in the #ftl header).

Overrides:

getName in class XMLOutputFormat

getMimeType

public java.lang.String getMimeType()

Description copied from class: OutputFormat

Returns the MIME type of the output format. This might comes handy when generating a HTTP response. null null if this output format doesn't clearly corresponds to a specific MIME type.

Overrides:

getMimeType in class XMLOutputFormat

output

public void output(java.lang.String textToEsc,
                   java.io.Writer out)
            throws java.io.IOException,
                   TemplateModelException

Description copied from class: MarkupOutputFormat

Equivalent to calling MarkupOutputFormat.fromPlainTextByEscaping(String) and then MarkupOutputFormat.output(TemplateMarkupOutputModel, Writer), but the implementation may uses a more efficient solution.

Overrides:

output in class XMLOutputFormat

Throws:

java.io.IOException

TemplateModelException

escapePlainText

public java.lang.String escapePlainText(java.lang.String plainTextContent)

Description copied from class: MarkupOutputFormat

Should give the same result as MarkupOutputFormat.fromPlainTextByEscaping(String) and then MarkupOutputFormat.getMarkupString(TemplateMarkupOutputModel), but the implementation may uses a more efficient solution.

Overrides:

escapePlainText in class XMLOutputFormat

isLegacyBuiltInBypassed

public boolean isLegacyBuiltInBypassed(java.lang.String builtInName)

Description copied from class: MarkupOutputFormat

Tells if a string built-in that can't handle a TemplateMarkupOutputModel left hand operand can bypass this object as is. A typical such case would be when a TemplateHTMLOutputModel of "HTML" format bypasses ?html.

Overrides:

isLegacyBuiltInBypassed in class XMLOutputFormat

newTemplateMarkupOutputModel

protected TemplateXHTMLOutputModel newTemplateMarkupOutputModel(java.lang.String plainTextContent,
                                                                java.lang.String markupContent)

Description copied from class: CommonMarkupOutputFormat

Creates a new CommonTemplateMarkupOutputModel that's bound to this OutputFormat instance.

Overrides:

newTemplateMarkupOutputModel in class XMLOutputFormat