com.google.gwt.uibinder.client.impl

Class AbstractUiRenderer

java.lang.Object

com.google.gwt.uibinder.client.impl.AbstractUiRenderer

All Implemented Interfaces:

UiRenderer

public abstract class AbstractUiRenderer
extends Object
implements UiRenderer

Abstract implementation of a safe HTML binder to make implementation of generated rendering simpler.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractUiRenderer.UiRendererDispatcher<T> Helps handle method dispatch to classes that use UiRenderer.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RENDERED_ATTRIBUTE Marker attribute for DOM structures previously generated by UiRenderer.
static String	ROOT_FAKE_NAME Field name used to identify the root element while dispatching events.
static String	UI_ID_SEPARATOR
protected String	uiId Holds the part of the id attribute common to all elements being rendered.

Constructor Summary

Constructors

Constructor and Description
AbstractUiRenderer()

Method Summary

Methods

Modifier and Type	Method and Description
protected static String	buildInnerId(String fieldName, String uiId) Build id strings used to identify DOM elements related to ui:fields.
protected static Element	findInnerField(Element parent, String fieldName, String attribute) Retrieves a specific element within a previously rendered element.
protected static Element	findRootElement(Element parent, String attribute) Retrieves the root of a previously rendered element contained within the parent.
boolean	isParentOrRenderer(Element parent) Checks whether parent is a valid element to use as an argument for field getters.
protected static SafeHtml	stampUiRendererAttribute(SafeHtml safeHtml, String attributeName, String attributeValue) Inserts an attribute into the first tag found in a safeHtml template.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Field Detail

RENDERED_ATTRIBUTE

public static final String RENDERED_ATTRIBUTE

Marker attribute for DOM structures previously generated by UiRenderer.

See Also:

Constant Field Values

ROOT_FAKE_NAME

public static final String ROOT_FAKE_NAME

Field name used to identify the root element while dispatching events.

See Also:

Constant Field Values

UI_ID_SEPARATOR

public static final String UI_ID_SEPARATOR

See Also:

Constant Field Values

uiId

protected String uiId

Holds the part of the id attribute common to all elements being rendered.

Constructor Detail

AbstractUiRenderer

public AbstractUiRenderer()

Method Detail

buildInnerId

protected static String buildInnerId(String fieldName,
                  String uiId)

Build id strings used to identify DOM elements related to ui:fields.

Parameters:

fieldName - name of the field that identifies the element

uiId - common part of the identifier for all elements in the rendered DOM structure

findInnerField

protected static Element findInnerField(Element parent,
                     String fieldName,
                     String attribute)

Retrieves a specific element within a previously rendered element.

Parameters:

parent - parent element containing the element of interest

fieldName - name of the field to retrieve

attribute - that identifies the root element as such

Returns:

the element identified by fieldName

Throws:

IllegalArgumentException - if the parent does not point to or contains a previously rendered element. In DevMode also when the root element is not attached to the DOM

IllegalStateException - parent does not contain an element matching filedName

RuntimeException - if the root element is not attached to the DOM and not running in DevMode

NullPointerException - if parent == null

findRootElement

protected static Element findRootElement(Element parent,
                      String attribute)

Retrieves the root of a previously rendered element contained within the parent. The parent must either contain the previously rendered DOM structure as its only child, or point directly to the rendered element root.

Parameters:

parent - element containing, or pointing to, a previously rendered DOM structure

attribute - attribute name that identifies the root of the DOM structure

Returns:

the root element of the previously rendered DOM structure

Throws:

NullPointerException - if parent == null

IllegalArgumentException - if parent does not contain a previously rendered element

stampUiRendererAttribute

protected static SafeHtml stampUiRendererAttribute(SafeHtml safeHtml,
                                String attributeName,
                                String attributeValue)

Inserts an attribute into the first tag found in a safeHtml template. This method assumes that the safeHtml template begins with an open HTML tag. SafeHtml templates produced by UiBinder always meet these conditions.

This method does not attempt to ensure atributeName and attributeValue contain safe values.

isParentOrRenderer

public boolean isParentOrRenderer(Element parent)

Description copied from interface: UiRenderer

Checks whether parent is a valid element to use as an argument for field getters.

Specified by:

isParentOrRenderer in interface UiRenderer

Returns:

true if parent contains or directly points to a previously rendered element. In DevMode it also checks whether the parent is attached to the DOM