com.liferay.portal.util

Class HtmlImpl

java.lang.Object

com.liferay.portal.util.HtmlImpl

All Implemented Interfaces:

com.liferay.portal.kernel.util.Html

public class HtmlImpl
extends java.lang.Object
implements com.liferay.portal.kernel.util.Html

Author:

Brian Wing Shun Chan, Clarence Shen, Harry Mark, Samuel Kong, Connor McKay, Shuyang Zhou

Field Summary

Fields

Modifier and Type	Field and Description
static int	ESCAPE_MODE_ATTRIBUTE
static int	ESCAPE_MODE_CSS
static int	ESCAPE_MODE_JS
static int	ESCAPE_MODE_TEXT
static int	ESCAPE_MODE_URL

Constructor Summary

Constructors

Constructor and Description
HtmlImpl()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	escape(java.lang.String text) Escapes the text so that it is safe to use in an HTML context.
java.lang.String	escape(java.lang.String text, int type)
java.lang.String	escapeAttribute(java.lang.String attribute)
java.lang.String	escapeCSS(java.lang.String css)
java.lang.String	escapeHREF(java.lang.String href)
java.lang.String	escapeJS(java.lang.String js)
java.lang.String	escapeURL(java.lang.String url)
java.lang.String	escapeXPath(java.lang.String xPath)
java.lang.String	escapeXPathAttribute(java.lang.String xPathAttribute)
java.lang.String	extractText(java.lang.String html)
java.lang.String	fromInputSafe(java.lang.String text)
java.lang.String	getAUICompatibleId(java.lang.String text)
protected boolean	isTag(char[] tag, java.lang.String text, int pos)
java.lang.String	render(java.lang.String html) Deprecated.
java.lang.String	replaceMsWordCharacters(java.lang.String text)
java.lang.String	replaceNewLine(java.lang.String text)
java.lang.String	stripBetween(java.lang.String text, java.lang.String tag)
java.lang.String	stripComments(java.lang.String text)
java.lang.String	stripHtml(java.lang.String text)
protected int	stripTag(char[] tag, java.lang.String text, int pos)
java.lang.String	toInputSafe(java.lang.String text)
java.lang.String	unescape(java.lang.String text)
java.lang.String	unescapeCDATA(java.lang.String text)
java.lang.String	wordBreak(java.lang.String text, int columns)

Methods inherited from class java.lang.Object

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

Field Detail

ESCAPE_MODE_ATTRIBUTE

public static final int ESCAPE_MODE_ATTRIBUTE

See Also:

Constant Field Values

ESCAPE_MODE_CSS

public static final int ESCAPE_MODE_CSS

See Also:

Constant Field Values

ESCAPE_MODE_JS

public static final int ESCAPE_MODE_JS

See Also:

Constant Field Values

ESCAPE_MODE_TEXT

public static final int ESCAPE_MODE_TEXT

See Also:

Constant Field Values

ESCAPE_MODE_URL

public static final int ESCAPE_MODE_URL

See Also:

Constant Field Values

Constructor Detail

HtmlImpl

public HtmlImpl()

Method Detail

escape

public java.lang.String escape(java.lang.String text)

Escapes the text so that it is safe to use in an HTML context.

Specified by:

escape in interface com.liferay.portal.kernel.util.Html

Parameters:

text - the text to escape

Returns:

the escaped HTML text, or null if the text is null

escape

public java.lang.String escape(java.lang.String text,
                      int type)

Specified by:

escape in interface com.liferay.portal.kernel.util.Html

escapeAttribute

public java.lang.String escapeAttribute(java.lang.String attribute)

Specified by:

escapeAttribute in interface com.liferay.portal.kernel.util.Html

escapeCSS

public java.lang.String escapeCSS(java.lang.String css)

Specified by:

escapeCSS in interface com.liferay.portal.kernel.util.Html

escapeHREF

public java.lang.String escapeHREF(java.lang.String href)

Specified by:

escapeHREF in interface com.liferay.portal.kernel.util.Html

escapeJS

public java.lang.String escapeJS(java.lang.String js)

Specified by:

escapeJS in interface com.liferay.portal.kernel.util.Html

escapeURL

public java.lang.String escapeURL(java.lang.String url)

Specified by:

escapeURL in interface com.liferay.portal.kernel.util.Html

escapeXPath

public java.lang.String escapeXPath(java.lang.String xPath)

Specified by:

escapeXPath in interface com.liferay.portal.kernel.util.Html

escapeXPathAttribute

public java.lang.String escapeXPathAttribute(java.lang.String xPathAttribute)

Specified by:

escapeXPathAttribute in interface com.liferay.portal.kernel.util.Html

extractText

public java.lang.String extractText(java.lang.String html)

Specified by:

extractText in interface com.liferay.portal.kernel.util.Html

fromInputSafe

public java.lang.String fromInputSafe(java.lang.String text)

Specified by:

fromInputSafe in interface com.liferay.portal.kernel.util.Html

getAUICompatibleId

public java.lang.String getAUICompatibleId(java.lang.String text)

Specified by:

getAUICompatibleId in interface com.liferay.portal.kernel.util.Html

render

@Deprecated
public java.lang.String render(java.lang.String html)

Deprecated.

Specified by:

render in interface com.liferay.portal.kernel.util.Html

replaceMsWordCharacters

public java.lang.String replaceMsWordCharacters(java.lang.String text)

Specified by:

replaceMsWordCharacters in interface com.liferay.portal.kernel.util.Html

replaceNewLine

public java.lang.String replaceNewLine(java.lang.String text)

Specified by:

replaceNewLine in interface com.liferay.portal.kernel.util.Html

stripBetween

public java.lang.String stripBetween(java.lang.String text,
                            java.lang.String tag)

Specified by:

stripBetween in interface com.liferay.portal.kernel.util.Html

stripComments

public java.lang.String stripComments(java.lang.String text)

Specified by:

stripComments in interface com.liferay.portal.kernel.util.Html

stripHtml

public java.lang.String stripHtml(java.lang.String text)

Specified by:

stripHtml in interface com.liferay.portal.kernel.util.Html

toInputSafe

public java.lang.String toInputSafe(java.lang.String text)

Specified by:

toInputSafe in interface com.liferay.portal.kernel.util.Html

unescape

public java.lang.String unescape(java.lang.String text)

Specified by:

unescape in interface com.liferay.portal.kernel.util.Html

unescapeCDATA

public java.lang.String unescapeCDATA(java.lang.String text)

Specified by:

unescapeCDATA in interface com.liferay.portal.kernel.util.Html

wordBreak

public java.lang.String wordBreak(java.lang.String text,
                         int columns)

Specified by:

wordBreak in interface com.liferay.portal.kernel.util.Html

isTag

protected boolean isTag(char[] tag,
            java.lang.String text,
            int pos)

stripTag

protected int stripTag(char[] tag,
           java.lang.String text,
           int pos)