HtmlContext (Closure Templates)

java.lang.Object
- java.lang.Enum<HtmlContext>
- - com.google.template.soy.soytree.HtmlContext

All Implemented Interfaces:

Serializable, Comparable<HtmlContext>
```
public enum HtmlContext
extends Enum<HtmlContext>
```
The type of HTML (or non-HTML) that contains a Soy node. This is primarily used by the contextual auto-escaper to add escaping directives. It's also used by incremental DOM's HTML parser to mark nodes for other passes to consume.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CSS` In CSS content outside a comment, string, or URI.
`CSS_COMMENT` In CSS inside a comment.
`CSS_DQ_STRING` In CSS inside a double quoted string.
`CSS_DQ_URI` In CSS in a URI terminated by the first double quote.
`CSS_SQ_STRING` In CSS inside a single quoted string.
`CSS_SQ_URI` In CSS in a URI terminated by the first single quote.
`CSS_URI` In CSS in a URI terminated by the first close parenthesis.
`HTML_ATTRIBUTE_NAME` Inside an HTML attribute name.
`HTML_BEFORE_CLOSE_TAG_NAME` Just before a tag name on an close tag.
`HTML_BEFORE_OPEN_TAG_NAME` Just before a tag name on an open tag.
`HTML_COMMENT` Inside an HTML comment.
`HTML_NORMAL_ATTR_VALUE` Inside a normal (non-CSS, JS, or URI) HTML attribute value.
`HTML_PCDATA` Outside an HTML tag, directive, or comment.
`HTML_RCDATA` Inside an element whose content is RCDATA where text and entities can appear but where nested elements cannot.
`HTML_TAG` Before an HTML attribute or the end of a tag.
`HTML_TAG_NAME` Just after a tag name, e.g.
`JS` In JavaScript, outside a comment, string, or Regexp literal.
`JS_BLOCK_COMMENT` In JavaScript inside a block comment.
`JS_DQ_STRING` In JavaScript inside a double quoted string.
`JS_LINE_COMMENT` In JavaScript inside a line comment.
`JS_REGEX` In JavaScript inside a regular expression literal.
`JS_SQ_STRING` In JavaScript inside a single quoted string.
`JS_TEMPLATE_LITERAL` In JavaScript inside a template literal string.
`TEXT` Plain text; no escaping.
`URI` In a URI, which may or may not be in an HTML attribute.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getErrorMessage()` Error message to show when trying to print a dynamic value inside of this state.
`EscapingMode`	`getEscapingMode()` The escaping mode appropriate for dynamic content inserted at this state.
`static HtmlContext`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static HtmlContext[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - HTML_PCDATA
```
public static final HtmlContext HTML_PCDATA
```
    Outside an HTML tag, directive, or comment. (Parsed character data).
  - HTML_RCDATA
```
public static final HtmlContext HTML_RCDATA
```
    Inside an element whose content is RCDATA where text and entities can appear but where nested elements cannot. The content of <title> and <textarea> fall into this category since they cannot contain nested elements in HTML.
  - HTML_BEFORE_OPEN_TAG_NAME
```
public static final HtmlContext HTML_BEFORE_OPEN_TAG_NAME
```
    Just before a tag name on an open tag.
  - HTML_BEFORE_CLOSE_TAG_NAME
```
public static final HtmlContext HTML_BEFORE_CLOSE_TAG_NAME
```
    Just before a tag name on an close tag.
  - HTML_TAG_NAME
```
public static final HtmlContext HTML_TAG_NAME
```
    Just after a tag name, e.g. in ^ in or .
    Note tag names must be printed all at once since we can't otherwise easily handle .
  - HTML_TAG
```
public static final HtmlContext HTML_TAG
```
    Before an HTML attribute or the end of a tag.
  - HTML_ATTRIBUTE_NAME
```
public static final HtmlContext HTML_ATTRIBUTE_NAME
```
    Inside an HTML attribute name.
  - HTML_COMMENT
```
public static final HtmlContext HTML_COMMENT
```
    Inside an HTML comment.
  - HTML_NORMAL_ATTR_VALUE
```
public static final HtmlContext HTML_NORMAL_ATTR_VALUE
```
    Inside a normal (non-CSS, JS, or URI) HTML attribute value.
  - CSS
```
public static final HtmlContext CSS
```
    In CSS content outside a comment, string, or URI.
  - CSS_COMMENT
```
public static final HtmlContext CSS_COMMENT
```
    In CSS inside a comment.
  - CSS_DQ_STRING
```
public static final HtmlContext CSS_DQ_STRING
```
    In CSS inside a double quoted string.
  - CSS_SQ_STRING
```
public static final HtmlContext CSS_SQ_STRING
```
    In CSS inside a single quoted string.
  - CSS_URI
```
public static final HtmlContext CSS_URI
```
    In CSS in a URI terminated by the first close parenthesis.
  - CSS_DQ_URI
```
public static final HtmlContext CSS_DQ_URI
```
    In CSS in a URI terminated by the first double quote.
  - CSS_SQ_URI
```
public static final HtmlContext CSS_SQ_URI
```
    In CSS in a URI terminated by the first single quote.
  - JS
```
public static final HtmlContext JS
```
    In JavaScript, outside a comment, string, or Regexp literal.
  - JS_LINE_COMMENT
```
public static final HtmlContext JS_LINE_COMMENT
```
    In JavaScript inside a line comment.
  - JS_BLOCK_COMMENT
```
public static final HtmlContext JS_BLOCK_COMMENT
```
    In JavaScript inside a block comment.
  - JS_DQ_STRING
```
public static final HtmlContext JS_DQ_STRING
```
    In JavaScript inside a double quoted string.
  - JS_SQ_STRING
```
public static final HtmlContext JS_SQ_STRING
```
    In JavaScript inside a single quoted string.
  - JS_REGEX
```
public static final HtmlContext JS_REGEX
```
    In JavaScript inside a regular expression literal.
  - JS_TEMPLATE_LITERAL
```
public static final HtmlContext JS_TEMPLATE_LITERAL
```
    In JavaScript inside a template literal string.
    See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals
  - URI
```
public static final HtmlContext URI
```
    In a URI, which may or may not be in an HTML attribute.
  - TEXT
```
public static final HtmlContext TEXT
```
    Plain text; no escaping.
- Method Detail
  - values
```
public static HtmlContext[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (HtmlContext c : HtmlContext.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static HtmlContext valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getEscapingMode
```
public EscapingMode getEscapingMode()
```
    The escaping mode appropriate for dynamic content inserted at this state. Null if there is no appropriate escaping convention to use as for comments or plain text which do not have escaping conventions.
  - getErrorMessage
```
public String getErrorMessage()
```
    Error message to show when trying to print a dynamic value inside of this state.

Enum HtmlContext

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

HTML_PCDATA

HTML_RCDATA

HTML_BEFORE_OPEN_TAG_NAME

HTML_BEFORE_CLOSE_TAG_NAME

HTML_TAG_NAME

HTML_TAG

HTML_ATTRIBUTE_NAME

HTML_COMMENT

HTML_NORMAL_ATTR_VALUE

CSS

CSS_COMMENT

CSS_DQ_STRING

CSS_SQ_STRING

CSS_URI

CSS_DQ_URI

CSS_SQ_URI

JS

JS_LINE_COMMENT

JS_BLOCK_COMMENT

JS_DQ_STRING

JS_SQ_STRING

JS_REGEX

JS_TEMPLATE_LITERAL

URI

TEXT

Method Detail

values

valueOf

getEscapingMode

getErrorMessage