edu.ucdavis.cstars.client.tasks

Class PrintTemplate.LayoutOptions

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.PrintTemplate.LayoutOptions

Enclosing class:

PrintTemplate

public static class PrintTemplate.LayoutOptions
extends com.google.gwt.core.client.JavaScriptObject

Method Summary

Methods

Modifier and Type	Method and Description
static PrintTemplate.LayoutOptions	create()
void	setAuthorText(java.lang.String authorText) Set the authorText parameter.
void	setCopyrightText(java.lang.String copyrightText) Set the copyrightText parameter.
void	setCustomTextElement(java.lang.String parameter, java.lang.String value)
void	setLegendLayers(java.lang.String[] legendLayers) Set the legendLayers parameter.
void	setScalebarUnit(java.lang.String scalebarUnit) Set the scalebarUnit parameter.
void	setTitleText(java.lang.String titleText) Set the titleText parameter.

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 PrintTemplate.LayoutOptions create()

setTitleText

public final void setTitleText(java.lang.String titleText)

Set the titleText parameter.

Parameters:

titleText - - The text used for the map title if the specified layout contains a title text element.

setAuthorText

public final void setAuthorText(java.lang.String authorText)

Set the authorText parameter.

Parameters:

authorText - - The text used for the author if the specified layout contains an author text element.

setCopyrightText

public final void setCopyrightText(java.lang.String copyrightText)

Set the copyrightText parameter.

Parameters:

copyrightText - - The text used for the copyright if the specified layout contains an copyright text element.

setScalebarUnit

public final void setScalebarUnit(java.lang.String scalebarUnit)

Set the scalebarUnit parameter.

Parameters:

scalebarUnit - - The units used for the scalebar. Valid values are 'Miles' | 'Kilometers' | 'Meters' | 'Feet'

setCustomTextElement

public final void setCustomTextElement(java.lang.String parameter,
                        java.lang.String value)

setLegendLayers

public final void setLegendLayers(java.lang.String[] legendLayers)

Set the legendLayers parameter.

Parameters:

legendLayers - - An array of strings containing the id's of the layers that will be included in the legend. If legendLayers is not specified, all operational layers will be present in the legend. To specify that no layers will be included in the legend set legendLayers to an empty array.