edu.ucdavis.cstars.client.tasks

Class PrintTemplate

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.PrintTemplate

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

Class added v2.6 Define the layout template options used by the PrintTask and Print widget to generate the print page.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrintTemplate.ExportOptions
static class	PrintTemplate.Format
static class	PrintTemplate.Layout
static class	PrintTemplate.LayoutOptions

Method Summary

Methods

Modifier and Type	Method and Description
static PrintTemplate	create() Creates a new PrintTemplate object.
PrintTemplate.ExportOptions	getExportOptions() Define the map width, height and dpi.
PrintTemplate.Format	getFormat() The print output format.
java.lang.String	getLabel() The text that appears on the PrintWidget's print button.
PrintTemplate.Layout	getLayout() The layout used for the print output.
java.lang.String	getLayoutAsString() The layout used for the print output.
PrintTemplate.LayoutOptions	getLayoutOptions() Define the layout elements.
boolean	preserveScale() Define whether the printed map will preserve the map scale or the map extent.
void	setExportOptions(PrintTemplate.ExportOptions exportOptions) Set the exportOptions parameter.
void	setFormat(PrintTemplate.Format format) Set the format parameter.
void	setFormat(java.lang.String format) Set the format parameter.
void	setLabel(java.lang.String label) Set the label parameter.
void	setLayout(PrintTemplate.Layout layout) Set the layout parameter.
void	setLayout(java.lang.String layout) Set the layout parameter.
void	setLayoutOptions(PrintTemplate.LayoutOptions layoutOptions) Set the layoutOptions parameter.
void	setPreserveScale(boolean preserveScale) Set the preserveScale 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 create()

Creates a new PrintTemplate object.

Returns:

getExportOptions

public final PrintTemplate.ExportOptions getExportOptions()

Define the map width, height and dpi. Required when the layoutTemplate is set to 'MAP_ONLY'.

Returns:

ExportOptions

setExportOptions

public final void setExportOptions(PrintTemplate.ExportOptions exportOptions)

Set the exportOptions parameter.

Parameters:

exportOptions - - Define the map width, height and dpi. Required when the layoutTemplate is set to 'MAP_ONLY'.

getFormat

public final PrintTemplate.Format getFormat()

The print output format.

Returns:

Format

setFormat

public final void setFormat(PrintTemplate.Format format)

Set the format parameter.

Parameters:

format - - The print output format.

setFormat

public final void setFormat(java.lang.String format)

Set the format parameter.

Parameters:

format - - The print output format.

getLabel

public final java.lang.String getLabel()

The text that appears on the PrintWidget's print button.

Returns:

String

setLabel

public final void setLabel(java.lang.String label)

Set the label parameter.

Parameters:

label - - The text that appears on the PrintWidget's print button.

getLayout

public final PrintTemplate.Layout getLayout()

The layout used for the print output.

Returns:

Layout

getLayoutAsString

public final java.lang.String getLayoutAsString()

The layout used for the print output.

Returns:

String

setLayout

public final void setLayout(PrintTemplate.Layout layout)

Set the layout parameter.

Parameters:

layout - - The layout used for the print output.

setLayout

public final void setLayout(java.lang.String layout)

Set the layout parameter.

Parameters:

layout - - The layout used for the print output.

getLayoutOptions

public final PrintTemplate.LayoutOptions getLayoutOptions()

Define the layout elements.

Returns:

LayoutOptions

setLayoutOptions

public final void setLayoutOptions(PrintTemplate.LayoutOptions layoutOptions)

Set the layoutOptions parameter.

Parameters:

layoutOptions - - Define the layout elements.

preserveScale

public final boolean preserveScale()

Define whether the printed map will preserve the map scale or the map extent. Only one of these properties can be preserved to produce a high-resolution map for printing. If preserveScale is set to true, the map displayed in the print window will match the current scale of the map in the application. If preserveScale is false, the current extent of the map in the application displays in the printed map but the scale may change. The default value is true.

Returns:

boolean

setPreserveScale

public final void setPreserveScale(boolean preserveScale)

Set the preserveScale parameter.

Parameters:

preserveScale - - Define whether the printed map will preserve the map scale or the map extent. Only one of these properties can be preserved to produce a high-resolution map for printing. If preserveScale is set to true, the map displayed in the print window will match the current scale of the map in the application. If preserveScale is false, the current extent of the map in the application displays in the printed map but the scale may change. The default value is true.