freemarker.core

Class HTMLOutputFormat

java.lang.Object

freemarker.core.OutputFormat

freemarker.core.MarkupOutputFormat<MO>

freemarker.core.CommonMarkupOutputFormat<TemplateHTMLOutputModel>

freemarker.core.HTMLOutputFormat

public class HTMLOutputFormat
extends CommonMarkupOutputFormat<TemplateHTMLOutputModel>

Represents the HTML output format (MIME type "text/html", name "HTML"). This format escapes by default (via StringUtil.XHTMLEnc(String)). The ?html, ?xhtml and ?xml built-ins silently bypass template output values of the type produced by this output format (TemplateHTMLOutputModel).

This class was final before 2.3.29.

Since:

2.3.24

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HTMLOutputFormat()

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 use 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 TemplateHTMLOutputModel	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 use 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.MarkupOutputFormat

outputForeign

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 HTMLOutputFormat INSTANCE

The only instance (singleton) of this OutputFormat.

Constructor Detail

HTMLOutputFormat

protected HTMLOutputFormat()

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).

Specified by:

getName in class OutputFormat

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.

Specified by:

getMimeType in class OutputFormat

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 use a more efficient solution.

Specified by:

output in class CommonMarkupOutputFormat<TemplateHTMLOutputModel>

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 use a more efficient solution.

Specified by:

escapePlainText in class MarkupOutputFormat<TemplateHTMLOutputModel>

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.

Specified by:

isLegacyBuiltInBypassed in class MarkupOutputFormat<TemplateHTMLOutputModel>

newTemplateMarkupOutputModel

protected TemplateHTMLOutputModel 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. When this is called from CommonMarkupOutputFormat, exactly one of the parameters will be non-null.

Specified by:

newTemplateMarkupOutputModel in class CommonMarkupOutputFormat<TemplateHTMLOutputModel>

Parameters:

plainTextContent - null if the content is markup that possibly can be described as plain text without loss.

markupContent - Typically will be null if plainTextContent is not null. While the plain text always can be converted to markup via MarkupOutputFormat.escapePlainText(String), it's up to the implementation if it wants to do that now and store the markup, or later on demand (like each time when CommonMarkupOutputFormat.getMarkupString(CommonTemplateMarkupOutputModel) is called).