com.esri.android.map
Class InfoTemplate

java.lang.Object
  extended by com.esri.android.map.InfoTemplate
All Implemented Interfaces:
Serializable

public class InfoTemplate
extends Object
implements Serializable

An InfoTemplate is an object containing a title template and a content template.

These title and content templates can contain references to values by using the token prototype ${[key]}.
These tokens are replaced with the appropriate values when content and title are requested through the methods getContent(Graphic) and getTitle(Graphic) respectively, using the attributes contained in the Graphic provided.

Example:

 InfoTemplate infoTemplate = new InfoTemplate();
 infoTemplate.setTitleTemplate("I am a title for ${graphicName}");
 infoTemplate.setContentTemplate("My geometry type is ${geometryType}");
 
 

See Also:
Serialized Form

Constructor Summary
InfoTemplate()
          Default constructor.
InfoTemplate(String title, String content)
          Instantiates an InfoTemplate with the given content and title.
 
Method Summary
 String getContent(Graphic graphic)
          Gets the content populated with the attribute values of the provided graphic.
 String getContentTemplate()
          Gets the content without replacing the tokens.
 String getTitle(Graphic graphic)
          Gets the title populated with the attribute values of the provided graphic.
 String getTitleTemplate()
          Gets the title without replacing the tokens.
 void setContentTemplate(String content)
          Sets the content template.
 void setTitleTemplate(String title)
          Sets the title template.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InfoTemplate

public InfoTemplate()
Default constructor.


InfoTemplate

public InfoTemplate(String title,
                    String content)
Instantiates an InfoTemplate with the given content and title.

Parameters:
title - the title of the InfoTemplate.
content - the content of the InfoTemplate.
Method Detail

getTitleTemplate

public String getTitleTemplate()
Gets the title without replacing the tokens.

Returns:
the title template

setTitleTemplate

public void setTitleTemplate(String title)
Sets the title template.

Parameters:
title - the title template.

getContentTemplate

public String getContentTemplate()
Gets the content without replacing the tokens.

Returns:
the content template

getContent

public String getContent(Graphic graphic)
Gets the content populated with the attribute values of the provided graphic.

Parameters:
graphic - the graphic containing the attributes to be used to populate the content.
Returns:
the content populated with the graphic's attributes values

getTitle

public String getTitle(Graphic graphic)
Gets the title populated with the attribute values of the provided graphic.

Parameters:
graphic - the graphic containing the attributes to be used to populate the title.
Returns:
the title populated with the graphic's attributes values

setContentTemplate

public void setContentTemplate(String content)
Sets the content template.

Parameters:
content - the content template.


Copyright © 2012. All Rights Reserved.