com.google.gwt.uibinder.rebind

Class FieldManager

java.lang.Object

com.google.gwt.uibinder.rebind.FieldManager

public class FieldManager
extends Object

This class handles all FieldWriter instances created for the current template.

Constructor Summary

Constructors

Constructor and Description
FieldManager(com.google.gwt.core.ext.typeinfo.TypeOracle typeOracle, MortalLogger logger, boolean useLazyWidgetBuilders)

Method Summary

Methods

Modifier and Type	Method and Description
String	convertFieldToGetter(String fieldName) Converts the given field to its getter.
void	disableOptimization(String fieldName) Prevent a field from being optimized as only being referenced once (and therefore constant for all intents).
FieldReference	findFieldReference(String expressionIn)
static String	getFieldBuilder(String fieldName)
static String	getFieldGetter(String fieldName)
void	initializeWidgetsInnerClass(IndentedWriter w, OwnerClass ownerClass) Initialize with field builders the generated Widgets inner class.
FieldWriter	lookup(String fieldName)
void	pop() Remove the field at the top of the parsedFieldStack.
void	push(XMLElement source, FieldWriter fieldWriter)
FieldWriter	registerField(FieldWriterType fieldWriterType, com.google.gwt.core.ext.typeinfo.JClassType fieldType, String fieldName) Used to declare fields of an existing type.
FieldWriter	registerField(com.google.gwt.core.ext.typeinfo.JClassType fieldType, String fieldName)
FieldWriter	registerField(String type, String fieldName)
FieldWriter	registerFieldForGeneratedCssResource(ImplicitCssResource cssResource) Used to declare fields that will hold generated instances generated CssResource interfaces.
FieldWriter	registerFieldForLazyDomElement(com.google.gwt.core.ext.typeinfo.JClassType templateFieldType, OwnerField ownerField) Register a new field for LazyDomElement types.
FieldWriter	registerFieldOfGeneratedType(com.google.gwt.core.ext.typeinfo.JClassType assignableType, String typePackage, String typeName, String fieldName) Used to declare fields of a type (other than CssResource) that is to be generated.
void	registerFieldReference(XMLElement source, String fieldReferenceString, com.google.gwt.core.ext.typeinfo.JType... types) Called to register a {field.reference} encountered during parsing, to be validated against the type oracle once parsing is complete.
FieldWriter	require(String fieldName) Gets a FieldWriter given its name or throws a RuntimeException if not found.
static String	stripFieldGetter(String fieldName)
void	validate() To be called after parsing is complete.
void	writeFieldDefinitions(IndentedWriter writer, com.google.gwt.core.ext.typeinfo.TypeOracle typeOracle, OwnerClass ownerClass, DesignTimeUtils designTime) Outputs the getter and builder definitions for all fields.
void	writeGwtFieldsDeclaration(IndentedWriter writer) Writes all stored gwt fields.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Constructor Detail

FieldManager

public FieldManager(com.google.gwt.core.ext.typeinfo.TypeOracle typeOracle,
            MortalLogger logger,
            boolean useLazyWidgetBuilders)

Method Detail

getFieldBuilder

public static String getFieldBuilder(String fieldName)

getFieldGetter

public static String getFieldGetter(String fieldName)

stripFieldGetter

public static String stripFieldGetter(String fieldName)

convertFieldToGetter

public String convertFieldToGetter(String fieldName)

Converts the given field to its getter. Example:

myWidgetX = get_myWidgetX() f_html1 = get_f_html1()

disableOptimization

public void disableOptimization(String fieldName)

Prevent a field from being optimized as only being referenced once (and therefore constant for all intents). This is necessary for UiRenderer fields passed as parameters to render() calls. Those fields are modified every time a template is rendered with the parameter values.

findFieldReference

public FieldReference findFieldReference(String expressionIn)

initializeWidgetsInnerClass

public void initializeWidgetsInnerClass(IndentedWriter w,
                               OwnerClass ownerClass)
                                 throws com.google.gwt.core.ext.UnableToCompleteException

Initialize with field builders the generated Widgets inner class. FieldWriter.writeFieldBuilder(com.google.gwt.uibinder.rebind.IndentedWriter, int, com.google.gwt.uibinder.rebind.model.OwnerField).

Throws:

com.google.gwt.core.ext.UnableToCompleteException

lookup

public FieldWriter lookup(String fieldName)

Parameters:

fieldName - the name of the FieldWriter to find

Returns:

the FieldWriter instance indexed by fieldName or null in case fieldName is not found

pop

public void pop()

Remove the field at the top of the parsedFieldStack.

push

public void push(XMLElement source,
        FieldWriter fieldWriter)

Parameters:

source - the element this field was parsed from

fieldWriter - the field to push on the top of the parsedFieldStack

registerField

public FieldWriter registerField(FieldWriterType fieldWriterType,
                        com.google.gwt.core.ext.typeinfo.JClassType fieldType,
                        String fieldName)
                          throws com.google.gwt.core.ext.UnableToCompleteException

Used to declare fields of an existing type. If your field will hold a type that is being generated, see registerFieldOfGeneratedType(com.google.gwt.core.ext.typeinfo.JClassType, java.lang.String, java.lang.String, java.lang.String).

When making a field we peek at the parsedFieldStack to make sure that the field that holds the widget currently being parsed will depended upon the field being declared. This ensures, for example, that dom id fields (see UiBinderWriter#declareDomIdHolder()) used by an HTMLPanel will be declared before it is.

Parameters:

fieldWriterType - the field writer type associated

fieldType - the type of the new field

fieldName - the name of the new field

Returns:

a new FieldWriter instance

Throws:

com.google.gwt.core.ext.UnableToCompleteException - on duplicate name

registerField

public FieldWriter registerField(com.google.gwt.core.ext.typeinfo.JClassType fieldType,
                        String fieldName)
                          throws com.google.gwt.core.ext.UnableToCompleteException

Throws:

com.google.gwt.core.ext.UnableToCompleteException

registerField

public FieldWriter registerField(String type,
                        String fieldName)
                          throws com.google.gwt.core.ext.UnableToCompleteException

Throws:

com.google.gwt.core.ext.UnableToCompleteException

registerFieldForGeneratedCssResource

public FieldWriter registerFieldForGeneratedCssResource(ImplicitCssResource cssResource)
                                                 throws com.google.gwt.core.ext.UnableToCompleteException

Used to declare fields that will hold generated instances generated CssResource interfaces. If your field will hold a reference of an existing type, see registerField(com.google.gwt.uibinder.rebind.FieldWriterType, com.google.gwt.core.ext.typeinfo.JClassType, java.lang.String). For other generated types, use registerFieldOfGeneratedType(com.google.gwt.core.ext.typeinfo.JClassType, java.lang.String, java.lang.String, java.lang.String) registerFieldForGeneratedCssResource(com.google.gwt.uibinder.rebind.model.ImplicitCssResource).

When making a field we peek at the parsedFieldStack to make sure that the field that holds the widget currently being parsed will depended upon the field being declared. This ensures, for example, that dom id fields (see UiBinderWriter#declareDomIdHolder()) used by an HTMLPanel will be declared before it is.

Returns:

a new FieldWriter instance

Throws:

com.google.gwt.core.ext.UnableToCompleteException - on duplicate name

registerFieldForLazyDomElement

public FieldWriter registerFieldForLazyDomElement(com.google.gwt.core.ext.typeinfo.JClassType templateFieldType,
                                         OwnerField ownerField)
                                           throws com.google.gwt.core.ext.UnableToCompleteException

Register a new field for LazyDomElement types. LazyDomElement fields can only be associated with html elements. Example:

LazyDomElement<DivElement> -> <div> LazyDomElement<Element> -> <div> LazyDomElement<SpanElement> -> <span>