com.google.gwt.uibinder.rebind.messages

Class MessagesWriter

java.lang.Object

com.google.gwt.uibinder.rebind.messages.MessagesWriter

public class MessagesWriter
extends Object

TemplateWriter for messages.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
MessagesWriter(com.google.gwt.core.ext.typeinfo.TypeOracle oracle, String nameSpaceUri, MortalLogger mortalLogger, String generatedFrom, String packageName, String uiBinderImplClassName)

Method Summary

Methods

Modifier and Type	Method and Description
void	consumeAndStoreMessageAttributesFor(XMLElement elem) Call consumeAttributeMessages(com.google.gwt.uibinder.rebind.XMLElement), but instead of returning the results store them for retrieval by a later call to retrieveMessageAttributesFor(com.google.gwt.uibinder.rebind.XMLElement).
Collection<AttributeMessage>	consumeAttributeMessages(XMLElement elem) Examine the children of the given element.
String	consumeMessageAttribute(String attName, XMLElement elem) Consume an m:blah attribute on a non-message element, e.g.
String	consumeMessageAttribute(String attName, XMLElement elem, String defaultValue) Consume an m:blah attribute on a non-message element, e.g.
String	declareMessage(MessageWriter newMessage) Declares a message created by a previous call to newMessage(com.google.gwt.uibinder.rebind.XMLElement), and returns its invocation expression to be stitched into an innerHTML block.
void	findMessagesConfig(XMLElement elem) Expected to be called with the root element, to allow configuration from various messages related attributes.
String	getDeclaration() Returns the expression that will instantiate the Messages interface.
String	getMessagesClassName()
String	getMessagesPrefix() Returns the namespace prefix (not including :) declared by the template for message elements and attributes.
boolean	hasMessageAttribute(String attName, XMLElement elem) Confirm existence of an m:blah attribute on a non-message element, e.g.
boolean	hasMessages() Returns true iff any messages have been declared.
boolean	isMessage(XMLElement elem)
MessageWriter	newMessage(XMLElement elem) Creates a new MessageWriter instance with description, key and meaning values consumed from the given XMLElement.
Collection<AttributeMessage>	retrieveMessageAttributesFor(XMLElement elem) Returns the set of AttributeMessages that were found in elem and stored by a previous call to consumeAndStoreMessageAttributesFor(com.google.gwt.uibinder.rebind.XMLElement).
void	write(PrintWriter printWriter)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Field Detail

ATTRIBUTE

public static final String ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

MessagesWriter

public MessagesWriter(com.google.gwt.core.ext.typeinfo.TypeOracle oracle,
              String nameSpaceUri,
              MortalLogger mortalLogger,
              String generatedFrom,
              String packageName,
              String uiBinderImplClassName)

Method Detail

consumeAndStoreMessageAttributesFor

public void consumeAndStoreMessageAttributesFor(XMLElement elem)
                                         throws com.google.gwt.core.ext.UnableToCompleteException

Call consumeAttributeMessages(com.google.gwt.uibinder.rebind.XMLElement), but instead of returning the results store them for retrieval by a later call to retrieveMessageAttributesFor(com.google.gwt.uibinder.rebind.XMLElement).

Throws:

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

consumeAttributeMessages

public Collection<AttributeMessage> consumeAttributeMessages(XMLElement elem)
                                                      throws com.google.gwt.core.ext.UnableToCompleteException

Examine the children of the given element. Consume those tagged m:attribute and return a set of AttributeMessage instances. E.g.:

 <img src="blueSky.jpg" alt="A blue sky">
   <ui:attribute name="alt" description="blue sky image alt text"/>
 </img>
 

Throws:

com.google.gwt.core.ext.UnableToCompleteException

consumeMessageAttribute

public String consumeMessageAttribute(String attName,
                             XMLElement elem)

Consume an m:blah attribute on a non-message element, e.g. <span m:ph="fnord"/>

Parameters:

attName - name of the attribute (to be prefixed with "msgprefix:")

elem - element to search

Returns:

attribute value, or an empty string if not found

consumeMessageAttribute

public String consumeMessageAttribute(String attName,
                             XMLElement elem,
                             String defaultValue)

Consume an m:blah attribute on a non-message element, e.g. <span m:ph="fnord"/>

Parameters:

attName - name of the attribute (to be prefixed with "msgprefix:")

elem - element to search

defaultValue - default value to return if the attribute is not present

Returns:

attribute value, or defaultValue if not found

declareMessage

public String declareMessage(MessageWriter newMessage)

Declares a message created by a previous call to newMessage(com.google.gwt.uibinder.rebind.XMLElement), and returns its invocation expression to be stitched into an innerHTML block.

findMessagesConfig

public void findMessagesConfig(XMLElement elem)
                        throws com.google.gwt.core.ext.UnableToCompleteException

Expected to be called with the root element, to allow configuration from various messages related attributes.

Throws:

com.google.gwt.core.ext.UnableToCompleteException

getDeclaration

public String getDeclaration()

Returns the expression that will instantiate the Messages interface.

getMessagesClassName

public String getMessagesClassName()

getMessagesPrefix

public String getMessagesPrefix()

Returns the namespace prefix (not including :) declared by the template for message elements and attributes.

hasMessageAttribute

public boolean hasMessageAttribute(String attName,
                          XMLElement elem)

Confirm existence of an m:blah attribute on a non-message element, e.g. <span ui:ph="fnord"/>

hasMessages

public boolean hasMessages()

Returns true iff any messages have been declared.

isMessage

public boolean isMessage(XMLElement elem)

newMessage

public MessageWriter newMessage(XMLElement elem)

Creates a new MessageWriter instance with description, key and meaning values consumed from the given XMLElement. Note that this message will not be written in the generated code unless it is later declared via declareMessage(MessageWriter)

retrieveMessageAttributesFor

public Collection<AttributeMessage> retrieveMessageAttributesFor(XMLElement elem)

Returns the set of AttributeMessages that were found in elem and stored by a previous call to consumeAndStoreMessageAttributesFor(com.google.gwt.uibinder.rebind.XMLElement).

write

public void write(PrintWriter printWriter)