com.google.gwt.uibinder.elementparsers

Class HtmlInterpreter

java.lang.Object

com.google.gwt.uibinder.elementparsers.HtmlInterpreter

All Implemented Interfaces:

XMLElement.Interpreter<String>

public class HtmlInterpreter
extends Object
implements XMLElement.Interpreter<String>

This is the most generally useful interpreter, and the most likely to be used by a custom parser when calling XMLElement.consumeInnerHtml(com.google.gwt.uibinder.rebind.XMLElement.Interpreter<java.lang.String>).

• Assigns computed values to element attributes (e.g. class="{style.pretty}")
• Generates fields to hold named dom elements (e.g. <div gwt:field="importantDiv">)
• Turns <ui:msg> and <ui:attr> elements into methods on a generated Messages interface
• Fails if any element encountered is a widget

Constructor Summary

Constructors

Constructor and Description
HtmlInterpreter(UiBinderWriter writer, String ancestorExpression, XMLElement.Interpreter<String> messageInterpreter) Rather than using this constructor, you probably want to use the newInterpreterForUiObject(com.google.gwt.uibinder.rebind.UiBinderWriter, java.lang.String) factory method.

Method Summary

Methods

Modifier and Type	Method and Description
String	interpretElement(XMLElement elem) Given an XMLElement, return its filtered value.
static HtmlInterpreter	newInterpreterForUiObject(UiBinderWriter writer, String uiExpression) A convenience factory method for the most common use of this class, to work with HTML that will eventually be rendered under a UIObject (or really, any object that responds to getElement()).

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Constructor Detail

HtmlInterpreter

public HtmlInterpreter(UiBinderWriter writer,
               String ancestorExpression,
               XMLElement.Interpreter<String> messageInterpreter)

Rather than using this constructor, you probably want to use the newInterpreterForUiObject(com.google.gwt.uibinder.rebind.UiBinderWriter, java.lang.String) factory method.

Parameters:

ancestorExpression - An expression that can be evaluated at runtime to find an Element that will be an ancestor of all Elements generated from the interpreted HTML.

messageInterpreter - an interpreter to handle msg and ph elements, typically an instance of HtmlMessageInterpreter. This interpreter gets last crack

Method Detail

newInterpreterForUiObject

public static HtmlInterpreter newInterpreterForUiObject(UiBinderWriter writer,
                                        String uiExpression)

A convenience factory method for the most common use of this class, to work with HTML that will eventually be rendered under a UIObject (or really, any object that responds to getElement()). Uses an instance of HtmlMessageInterpreter to process message elements.

Parameters:

uiExpression - An expression that can be evaluated at runtime to find an object whose getElement() method can be called to get an ancestor of all Elements generated from the interpreted HTML.

interpretElement

public String interpretElement(XMLElement elem)
                        throws com.google.gwt.core.ext.UnableToCompleteException

Description copied from interface: XMLElement.Interpreter

Given an XMLElement, return its filtered value.

Specified by:

interpretElement in interface XMLElement.Interpreter<String>

Throws:

com.google.gwt.core.ext.UnableToCompleteException - on error