HtmlImpl (Portal 7.3.10-ep4)

java.lang.Object
- com.liferay.portal.util.HtmlImpl

All Implemented Interfaces:

Html
```
public class HtmlImpl
extends java.lang.Object
implements Html
```
Provides the implementation of the HTML utility interface for escaping, rendering, replacing, and stripping HTML text. This class uses XSS recommendations from http://www.owasp.org/index.php/Cross_Site_Scripting#How_to_Protect_Yourself when escaping HTML text.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ESCAPE_MODE_ATTRIBUTE` Deprecated. As of Mueller (7.2.x), replaced by `escapeAttribute(String)`
`static int`	`ESCAPE_MODE_CSS` Deprecated. As of Mueller (7.2.x), replaced by `escapeCSS(String)`
`static int`	`ESCAPE_MODE_JS` Deprecated. As of Mueller (7.2.x), replaced by `escapeJS(String)`
`static int`	`ESCAPE_MODE_TEXT` Deprecated. As of Mueller (7.2.x), replaced by `escape(String)`
`static int`	`ESCAPE_MODE_URL` Deprecated. As of Mueller (7.2.x), replaced by `escapeURL(String)`

Constructor Summary

Constructors
Constructor and Description

HtmlImpl()

Constructors
Constructor and Description
`HtmlImpl()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`buildData(java.util.Map<java.lang.String,java.lang.Object> data)` Generates a string with the data-* attributes generated from the keys and values of a map.
`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 mode)` Deprecated. As of Mueller (7.2.x), replaced by `escapeAttribute(String)`, `escapeCSS(String)`, `escapeJS(String)`, `escape(String)`, `escapeURL(String)`
`java.lang.String`	`escapeAttribute(java.lang.String attribute)` Escapes the attribute value so that it is safe to use within a quoted attribute.
`java.lang.String`	`escapeCSS(java.lang.String css)` Escapes the CSS value so that it is safe to use in a CSS context.
`java.lang.String`	`escapeHREF(java.lang.String href)` Escapes the HREF attribute so that it is safe to use as an HREF attribute.
`java.lang.String`	`escapeJS(java.lang.String js)` Escapes the JavaScript value so that it is safe to use in a JavaScript context.
`java.lang.String`	`escapeJSLink(java.lang.String link)`
`java.lang.String`	`escapeURL(java.lang.String url)` Escapes the URL value so that it is safe to use as a 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)` Extracts the raw text from the HTML input, compressing its whitespace and removing all attributes, scripts, and styles.
`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)` Renders the HTML content into text.
`java.lang.String`	`replaceNewLine(java.lang.String html)` Replaces all new lines or carriage returns with the HTML tag.
`java.lang.String`	`stripBetween(java.lang.String text, java.lang.String tag)` Strips all content delimited by the tag out of the text.
`java.lang.String`	`stripComments(java.lang.String text)` Strips all XML comments out of the 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)` Encodes the text so that it's safe to use as an HTML input field value.
`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
```
@Deprecated
public static final int ESCAPE_MODE_ATTRIBUTE
```
    Deprecated. As of Mueller (7.2.x), replaced by escapeAttribute(String)
    
    See Also:
    
    Constant Field Values
  - ESCAPE_MODE_CSS
```
@Deprecated
public static final int ESCAPE_MODE_CSS
```
    Deprecated. As of Mueller (7.2.x), replaced by escapeCSS(String)
    
    See Also:
    
    Constant Field Values
  - ESCAPE_MODE_JS
```
@Deprecated
public static final int ESCAPE_MODE_JS
```
    Deprecated. As of Mueller (7.2.x), replaced by escapeJS(String)
    
    See Also:
    
    Constant Field Values
  - ESCAPE_MODE_TEXT
```
@Deprecated
public static final int ESCAPE_MODE_TEXT
```
    Deprecated. As of Mueller (7.2.x), replaced by escape(String)
    
    See Also:
    
    Constant Field Values
  - ESCAPE_MODE_URL
```
@Deprecated
public static final int ESCAPE_MODE_URL
```
    Deprecated. As of Mueller (7.2.x), replaced by escapeURL(String)
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HtmlImpl
```
public HtmlImpl()
```
- Method Detail
  - buildData
```
public java.lang.String buildData(java.util.Map<java.lang.String,java.lang.Object> data)
```
    Generates a string with the data-* attributes generated from the keys and values of a map. For example, a map containing {key1=value1;key2=value2} is returned as the string data-key1=value1 data-key2=value2.
    
    Specified by:
    
    buildData in interface Html
    
    Parameters:
    
    data - the map of values to convert to data-* attributes
    
    Returns:
    
    a string with the data attributes, or null if the map is null
  - 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 Html
    
    Parameters:
    
    text - the text to escape
    
    Returns:
    
    the escaped HTML text, or null if the text is null
  - escape
```
@Deprecated
public java.lang.String escape(java.lang.String text,
                                           int mode)
```
    Deprecated. As of Mueller (7.2.x), replaced by escapeAttribute(String), escapeCSS(String), escapeJS(String), escape(String), escapeURL(String)
    
    Escapes the input text as a hexadecimal value, based on the mode (type). The encoding types include: ESCAPE_MODE_ATTRIBUTE, ESCAPE_MODE_CSS, ESCAPE_MODE_JS, ESCAPE_MODE_TEXT, and ESCAPE_MODE_URL.
    Note that escape(text, ESCAPE_MODE_TEXT) returns the same as escape(text).
    
    Specified by:
    
    escape in interface Html
    
    Parameters:
    
    text - the text to escape
    
    mode - the encoding type
    
    Returns:
    
    the escaped hexadecimal value of the input text, based on the mode, or null if the text is null
  - escapeAttribute
```
public java.lang.String escapeAttribute(java.lang.String attribute)
```
    Escapes the attribute value so that it is safe to use within a quoted attribute.
    
    Specified by:
    
    escapeAttribute in interface Html
    
    Parameters:
    
    attribute - the attribute to escape
    
    Returns:
    
    the escaped attribute value, or null if the attribute value is null
  - escapeCSS
```
public java.lang.String escapeCSS(java.lang.String css)
```
    Escapes the CSS value so that it is safe to use in a CSS context.
    
    Specified by:
    
    escapeCSS in interface Html
    
    Parameters:
    
    css - the CSS value to escape
    
    Returns:
    
    the escaped CSS value, or null if the CSS value is null
  - escapeHREF
```
public java.lang.String escapeHREF(java.lang.String href)
```
    Escapes the HREF attribute so that it is safe to use as an HREF attribute.
    
    Specified by:
    
    escapeHREF in interface Html
    
    Parameters:
    
    href - the HREF attribute to escape
    
    Returns:
    
    the escaped HREF attribute, or null if the HREF attribute is null
  - escapeJS
```
public java.lang.String escapeJS(java.lang.String js)
```
    Escapes the JavaScript value so that it is safe to use in a JavaScript context.
    
    Specified by:
    
    escapeJS in interface Html
    
    Parameters:
    
    js - the JavaScript value to escape
    
    Returns:
    
    the escaped JavaScript value, or null if the JavaScript value is null
  - escapeJSLink
```
public java.lang.String escapeJSLink(java.lang.String link)
```
    Specified by:
    
    escapeJSLink in interface Html
  - escapeURL
```
public java.lang.String escapeURL(java.lang.String url)
```
    Escapes the URL value so that it is safe to use as a URL.
    
    Specified by:
    
    escapeURL in interface Html
    
    Parameters:
    
    url - the URL value to escape
    
    Returns:
    
    the escaped URL value, or null if the URL value is null
  - escapeXPath
```
public java.lang.String escapeXPath(java.lang.String xPath)
```
    Specified by:
    
    escapeXPath in interface Html
  - escapeXPathAttribute
```
public java.lang.String escapeXPathAttribute(java.lang.String xPathAttribute)
```
    Specified by:
    
    escapeXPathAttribute in interface Html
  - extractText
```
public java.lang.String extractText(java.lang.String html)
```
    Extracts the raw text from the HTML input, compressing its whitespace and removing all attributes, scripts, and styles.
    For example, raw text returned by this method can be stored in a search index.
    
    Specified by:
    
    extractText in interface Html
    
    Parameters:
    
    html - the HTML text
    
    Returns:
    
    the raw text from the HTML input, or null if the HTML input is null
  - fromInputSafe
```
public java.lang.String fromInputSafe(java.lang.String text)
```
    Specified by:
    
    fromInputSafe in interface Html
  - getAUICompatibleId
```
public java.lang.String getAUICompatibleId(java.lang.String text)
```
    Specified by:
    
    getAUICompatibleId in interface Html
  - render
```
public java.lang.String render(java.lang.String html)
```
    Renders the HTML content into text. This provides a human readable version of the content that is modeled on the way Mozilla Thunderbird® and other email clients provide an automatic conversion of HTML content to text in their alternative MIME encoding of emails.
    Using the default settings, the output complies with the Text/Plain; Format=Flowed (DelSp=No) protocol described in RFC-3676.
    
    Specified by:
    
    render in interface Html
    
    Parameters:
    
    html - the HTML text
    
    Returns:
    
    the rendered HTML text, or null if the HTML text is null
  - replaceNewLine
```
public java.lang.String replaceNewLine(java.lang.String html)
```
    Replaces all new lines or carriage returns with the HTML tag.
    
    Specified by:
    
    replaceNewLine in interface Html
    
    Parameters:
    
    html - the text
    
    Returns:
    
    the converted text, or null if the text is null
  - stripBetween
```
public java.lang.String stripBetween(java.lang.String text,
                                     java.lang.String tag)
```
    Strips all content delimited by the tag out of the text.
    If the tag appears multiple times, all occurrences (including the tag) are stripped. The tag may have attributes. In order for this method to recognize the tag, it must consist of a separate opening and closing tag. Self-closing tags remain in the result.
    
    Specified by:
    
    stripBetween in interface Html
    
    Parameters:
    
    text - the text
    
    tag - the tag used for delimiting, which should only be the tag's name (e.g. no <)
    
    Returns:
    
    the text, without the stripped tag and its contents, or null if the text is null
  - stripComments
```
public java.lang.String stripComments(java.lang.String text)
```
    Strips all XML comments out of the text.
    
    Specified by:
    
    stripComments in interface Html
    
    Parameters:
    
    text - the text
    
    Returns:
    
    the text, without the stripped XML comments, or null if the text is null
  - stripHtml
```
public java.lang.String stripHtml(java.lang.String text)
```
    Specified by:
    
    stripHtml in interface Html
  - toInputSafe
```
public java.lang.String toInputSafe(java.lang.String text)
```
    Encodes the text so that it's safe to use as an HTML input field value.
    For example, the & character is replaced by &.
    
    Specified by:
    
    toInputSafe in interface Html
    
    Parameters:
    
    text - the text
    
    Returns:
    
    the encoded text that is safe to use as an HTML input field value, or null if the text is null
  - unescape
```
public java.lang.String unescape(java.lang.String text)
```
    Specified by:
    
    unescape in interface Html
  - unescapeCDATA
```
public java.lang.String unescapeCDATA(java.lang.String text)
```
    Specified by:
    
    unescapeCDATA in interface Html
  - wordBreak
```
public java.lang.String wordBreak(java.lang.String text,
                                  int columns)
```
    Specified by:
    
    wordBreak in interface 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)
```

Class HtmlImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ESCAPE_MODE_ATTRIBUTE

ESCAPE_MODE_CSS

ESCAPE_MODE_JS

ESCAPE_MODE_TEXT

ESCAPE_MODE_URL

Constructor Detail

HtmlImpl

Method Detail

buildData

escape

escape

escapeAttribute

escapeCSS

escapeHREF

escapeJS

escapeJSLink

escapeURL

escapeXPath

escapeXPathAttribute

extractText

fromInputSafe

getAUICompatibleId

render

replaceNewLine

stripBetween

stripComments

stripHtml

toInputSafe

unescape

unescapeCDATA

wordBreak

isTag

stripTag