au.com.codeka.carrot.helpers

Class HtmlHelper

java.lang.Object

au.com.codeka.carrot.helpers.HtmlHelper

public class HtmlHelper
extends java.lang.Object

Registered in the global Scope as "html", contains a bunch of functions you can call from your script related to HTML and HTML processing.

Constructor Summary

Constructors

Constructor and Description
HtmlHelper()

Method Summary

Modifier and Type	Method and Description
SafeString	escape(SafeString html) Escape the HTML.
SafeString	escape(java.lang.String html) Escape the HTML.
SafeString	safe(java.lang.String html) Mark the given string as "safe" for direct outputting.

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlHelper

public HtmlHelper()

Method Detail

safe

public SafeString safe(java.lang.String html)

Mark the given string as "safe" for direct outputting.

Parameters:

html - The string you want to mark as safe. The string will not be escaped on output, even if Configuration.getAutoEscape() is true.

Returns:

A SafeString.

escape

public SafeString escape(java.lang.String html)

Escape the HTML.

Parameters:

html - The string you want to HTML-escape.

Returns:

A SafeString (so that the string doesn't get double-escaped).

escape

public SafeString escape(SafeString html)

Escape the HTML. This variant takes a SafeString, and because we already know a safe string is safe to output, we won't escape it again.

Parameters:

html - The string you want to HTML-escape.

Returns:

The SafeString you passed in.