com.google.gwt.uibinder.rebind

Class FieldWriterOfLazyDomElement

java.lang.Object

com.google.gwt.uibinder.rebind.FieldWriterOfLazyDomElement

All Implemented Interfaces:

FieldWriter

public class FieldWriterOfLazyDomElement
extends Object

Implementation of FieldWriter for a LazyDomElement.

Constructor Summary

Constructors

Constructor and Description
FieldWriterOfLazyDomElement(FieldManager manager, com.google.gwt.core.ext.typeinfo.JClassType templateFieldType, OwnerField ownerField, MortalLogger logger)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttachStatement(String format, Object... args) Add a statement to be executed right after the current field is attached.
void	addDetachStatement(String format, Object... args) Add a statement to be executed right after the current field is detached.
void	addStatement(String format, Object... args) Add a statement for the given field, executed right after its creation.
com.google.gwt.core.ext.typeinfo.JClassType	getAssignableType() Returns the type of this field, or for generated types the type it extends.
int	getBuildPrecedence() Gets this field builder precedence.
FieldWriterType	getFieldType() Gets the type of this field.
String	getHtml() Returns the string html representation of the field.
String	getInitializer() Returns the custom initializer for this field, or null if it is not set.
com.google.gwt.core.ext.typeinfo.JClassType	getInstantiableType() Returns the type of this field, or null if this field is of a type that has not yet been generated.
String	getName() Get the name of the field.
static String	getNextAttachVar()
String	getNextReference() Returns the expression that to evaluate to get the contents of this field.
String	getQualifiedSourceName() Returns the qualified source name of this type.
com.google.gwt.core.ext.typeinfo.JType	getReturnType(String[] path, MonitoredLogger logger) Returns the return type found at the end of the given method call path, which must begin with the receiver's name, or null if the path is invalid.
String	getSafeHtml() Returns the string SafeHtml representation of the field.
void	needs(FieldWriter f) Declares that the receiver depends upon the given field.
void	setBuildPrecedence(int precedence) Sets the precedence of this field builder.
void	setHtml(String html) Sets the html representation of the field for applicable field types.
void	setInitializer(String initializer) Used to provide an initializer string to use instead of a GWT.create(java.lang.Class<?>) call.
String	toString()
void	write(IndentedWriter w) Write the field declaration.
void	writeFieldBuilder(IndentedWriter w, int getterCount, OwnerField ownerField) Write this field builder in the Widgets inner class.
void	writeFieldDefinition(IndentedWriter w, com.google.gwt.core.ext.typeinfo.TypeOracle typeOracle, OwnerField ownerField, DesignTimeUtils designTime, int getterCount, boolean useLazyWidgetBuilders) Output the getter and builder definitions for the given field.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode

Constructor Detail

FieldWriterOfLazyDomElement

public FieldWriterOfLazyDomElement(FieldManager manager,
                           com.google.gwt.core.ext.typeinfo.JClassType templateFieldType,
                           OwnerField ownerField,
                           MortalLogger logger)
                            throws com.google.gwt.core.ext.UnableToCompleteException

Throws:

com.google.gwt.core.ext.UnableToCompleteException

Method Detail

getAssignableType

public com.google.gwt.core.ext.typeinfo.JClassType getAssignableType()

Description copied from interface: FieldWriter

Returns the type of this field, or for generated types the type it extends.

getInstantiableType

public com.google.gwt.core.ext.typeinfo.JClassType getInstantiableType()

Description copied from interface: FieldWriter

Returns the type of this field, or null if this field is of a type that has not yet been generated.

getQualifiedSourceName

public String getQualifiedSourceName()

Description copied from interface: FieldWriter

Returns the qualified source name of this type.

getNextAttachVar

public static String getNextAttachVar()

addAttachStatement

public void addAttachStatement(String format,
                      Object... args)

Description copied from interface: FieldWriter

Add a statement to be executed right after the current field is attached.

   HTMLPanel panel = new HTMLPanel(
      "...");

   // statement section.
   widgetX.setStyleName("someCss");
   widgetX.setVisible(true);

   // attach section.
   UiBinderUtil.TempAttachment attachRecord =
      UiBinderUtil.attachToDom(panel.getElement());
   get_domId0Element().get();
   get_domId1Element().get();

   // detach section.
   attachRecord.detach();
   panel.addAndReplaceElement(get_someWidget(), get_domId0Element().get());
   panel.addAndReplaceElement(get_otherWidget(), get_domId1Element().get());
 

Specified by:

addAttachStatement in interface FieldWriter

addDetachStatement

public void addDetachStatement(String format,
                      Object... args)

Description copied from interface: FieldWriter

Add a statement to be executed right after the current field is detached. FieldWriter.addAttachStatement(java.lang.String, java.lang.Object...).

Specified by:

addDetachStatement in interface FieldWriter

addStatement

public void addStatement(String format,
                Object... args)

Description copied from interface: FieldWriter

Add a statement for the given field, executed right after its creation. Example:

   WidgetX widgetX = GWT.create(WidgetX.class);

   // statement section.
   widgetX.setStyleName("someCss");
   widgetX.setVisible(true);
 

Specified by:

addStatement in interface FieldWriter

getBuildPrecedence

public int getBuildPrecedence()

Description copied from interface: FieldWriter

Gets this field builder precedence.

Specified by:

getBuildPrecedence in interface FieldWriter

getFieldType

public FieldWriterType getFieldType()

Description copied from interface: FieldWriter

Gets the type of this field.

Specified by:

getFieldType in interface FieldWriter

getHtml

public String getHtml()

Description copied from interface: FieldWriter

Returns the string html representation of the field.

Specified by:

getHtml in interface FieldWriter

getInitializer

public String getInitializer()

Description copied from interface: FieldWriter

Returns the custom initializer for this field, or null if it is not set.

Specified by:

getInitializer in interface FieldWriter

getName

public String getName()

Description copied from interface: FieldWriter

Get the name of the field.

Specified by:

getName in interface FieldWriter

getNextReference

public String getNextReference()

Description copied from interface: FieldWriter

Returns the expression that to evaluate to get the contents of this field. Keeps a reference count, so if the field is to be used more than once it is important to call this method each time.

Specified by:

getNextReference in interface FieldWriter

getReturnType

public com.google.gwt.core.ext.typeinfo.JType getReturnType(String[] path,
                                                   MonitoredLogger logger)

Description copied from interface: FieldWriter

Returns the return type found at the end of the given method call path, which must begin with the receiver's name, or null if the path is invalid.

Specified by:

getReturnType in interface FieldWriter

getSafeHtml

public String getSafeHtml()

Description copied from interface: FieldWriter

Returns the string SafeHtml representation of the field.

Specified by:

getSafeHtml in interface FieldWriter

needs

public void needs(FieldWriter f)

Description copied from interface: FieldWriter

Declares that the receiver depends upon the given field.

Specified by:

needs in interface FieldWriter

setBuildPrecedence

public void setBuildPrecedence(int precedence)

Description copied from interface: FieldWriter

Sets the precedence of this field builder. Field with higher values are written first. This is automatically set by FieldManager when the field is created. You should only change it somewhere else if you really know what you are doing.

Specified by:

setBuildPrecedence in interface FieldWriter

setHtml

public void setHtml(String html)

Description copied from interface: FieldWriter

Sets the html representation of the field for applicable field types.

Specified by:

setHtml in interface FieldWriter

setInitializer

public void setInitializer(String initializer)

Description copied from interface: FieldWriter

Used to provide an initializer string to use instead of a GWT.create(java.lang.Class<?>) call. Note that this is an RHS expression. Don't include the leading '=', and don't end it with ';'.

Specified by:

setInitializer in interface FieldWriter

toString

public String toString()

Overrides:

toString in class Object

write

public void write(IndentedWriter w)
           throws com.google.gwt.core.ext.UnableToCompleteException

Description copied from interface: FieldWriter

Write the field declaration.

Specified by:

write in interface FieldWriter

Throws:

com.google.gwt.core.ext.UnableToCompleteException

writeFieldBuilder

public void writeFieldBuilder(IndentedWriter w,
                     int getterCount,
                     OwnerField ownerField)

Description copied from interface: FieldWriter

Write this field builder in the Widgets inner class. There are 3 possible situations:

getter never called

write builder only if there's a ui:field associated

getter called only once

don't need to write the builder since the getter fallback to the builder when called

getter called more than once

in this case a field class is created, the builder is written and the getter returns the field class

com.google.gwt.uibinder.rebind.FieldWriter#writeFieldGetter.

Specified by:

writeFieldBuilder in interface FieldWriter

writeFieldDefinition

public void writeFieldDefinition(IndentedWriter w,
                        com.google.gwt.core.ext.typeinfo.TypeOracle typeOracle,
                        OwnerField ownerField,
                        DesignTimeUtils designTime,
                        int getterCount,
                        boolean useLazyWidgetBuilders)
                          throws com.google.gwt.core.ext.UnableToCompleteException

Description copied from interface: FieldWriter

Output the getter and builder definitions for the given field.

Example for widgets called only once:

  private WidgetX get_widgetX() {
    return build_widgetX();
  }
  private WidgetX build_widgetX() {
   widget = GWT.create(WidgetX.class);
   widget.setStyleName("css");
   return widgetX;
  }
  

Notice that there's no field and the getter just fallback to the builder.

Example for widgets called more than once:

  private WidgetX widgetX;
  private WidgetX get_widgetX() {
    return widgetX;
  }
  private WidgetX build_widgetX() {
   widget = GWT.create(WidgetX.class);
   widget.setStyleName("css");
   return widgetX;
  }
 

Notice that the getter just returns the field. The builder is called in the Widgets ctor.

Specified by:

writeFieldDefinition in interface FieldWriter

Throws:

com.google.gwt.core.ext.UnableToCompleteException