edu.ucdavis.cstars.client

Class InfoTemplate

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.InfoTemplate

public class InfoTemplate
extends com.google.gwt.core.client.JavaScriptObject

An InfoTemplate contains a title and content template string used to transform Graphic.attributes into an HTML representation. The Dojo syntax ${} performs the parameter substitution. In addition, a wildcard ${*} can be used as the template string. The wildcard prints out all of the attribute's name value pairs. The default behavior on a Graphic is to show the Map's InfoWindow after a click on the Graphic. An InfoTemplate is required for this default behavior.

Author:

Justin Merz

Method Summary

Methods

Modifier and Type	Method and Description
static InfoTemplate	create() Creates a new empty InfoTemplate object.
static InfoTemplate	create(com.google.gwt.core.client.JavaScriptObject json) JSON object representing the InfoTemplate.
static InfoTemplate	create(java.lang.String title, java.lang.String content) Creates a new InfoTemplate object.
java.lang.String	getContent() The template for defining how to format the content used in an InfoWindow.
com.google.gwt.core.client.JavaScriptObject	getContentAsFunction() The template for defining how to format the content used in an InfoWindow.
java.lang.String	getTitle() The template for defining how to format the title used in an InfoWindow.
com.google.gwt.core.client.JavaScriptObject	getTitleAsFunction()
void	setContent(com.google.gwt.core.client.JavaScriptObject contentFunction) Sets the content template.
void	setContent(java.lang.String content) Sets the content template.
void	setTitle(com.google.gwt.core.client.JavaScriptObject titleFunction) Sets the title template.
void	setTitle(java.lang.String title) Sets the title template.
com.google.gwt.core.client.JavaScriptObject	toJson() Converts object to its ArcGIS Server JSON representation.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static InfoTemplate create()

Creates a new empty InfoTemplate object.

Returns:

InfoTemplate

create

public static InfoTemplate create(java.lang.String title,
                  java.lang.String content)

Creates a new InfoTemplate object. All parameters are required and must be specified in the order given.

Parameters:

title - - The template for defining how to format the title used in an InfoWindow.

content - - The template for defining how to format the content used in an InfoWindow.

Returns:

InfoTemplate

create

public static InfoTemplate create(com.google.gwt.core.client.JavaScriptObject json)

JSON object representing the InfoTemplate.

Parameters:

json - - Creates a new InfoTemplate object using a JSON object.

Returns:

InfoTemplate

getTitle

public final java.lang.String getTitle()

The template for defining how to format the title used in an InfoWindow.

Returns:

String

getTitleAsFunction

public final com.google.gwt.core.client.JavaScriptObject getTitleAsFunction()

getContent

public final java.lang.String getContent()

The template for defining how to format the content used in an InfoWindow.

Returns:

String

getContentAsFunction

public final com.google.gwt.core.client.JavaScriptObject getContentAsFunction()

The template for defining how to format the content used in an InfoWindow.

Returns:

JavaScriptObject

setContent

public final void setContent(java.lang.String content)

Sets the content template.

Parameters:

content - - The template for the content.

setContent

public final void setContent(com.google.gwt.core.client.JavaScriptObject contentFunction)

Sets the content template.

Parameters:

content - - The template for the content.

setTitle

public final void setTitle(java.lang.String title)

Sets the title template.

Parameters:

title - - The template for the title.

setTitle

public final void setTitle(com.google.gwt.core.client.JavaScriptObject titleFunction)

Sets the title template.

Parameters:

title - - The template for the title.

toJson

public final com.google.gwt.core.client.JavaScriptObject toJson()

Converts object to its ArcGIS Server JSON representation.

Returns:

JavaScriptObject