edu.ucdavis.cstars.client.tasks

Class PrintTask

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.PrintTask

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

Class added v2.6 The PrintTask class generates a printer-ready version of the map using an Export Web Map Task available with ArGIS Server 10.1 and later. The PrintTask class is used when you want more granular control of the user interface for example, if you want to provide users the ability to define what appears on the printed page. View the Print widget for an out-of-the-box widget that provides a simple user interface for printing maps. The PrintTask requires an ArcGIS Server 10.1 Export Web Map Task. Requires Package.ESRI_TASKS_PRINTASK.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrintTask.PrintResult A json object that contains the url of the printed image.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCompleteHandler(PrintTaskHandler handler) Fired when the print job has completed.
void	addErrorHandler(ErrorHandler handler) Fired when an error occurs while executing the print task.
static boolean	assertLoaded() Check that the esri.layers.PrintTask has been loaded
static PrintTask	create(java.lang.String url) Creates a new PrintTask object.
Deferred	execute(PrintParameters params) Sends a request to the print service resource to create a print page using the information specified in the printParameters argument.
Deferred	execute(PrintParameters params, PrintTaskCallback callback) Sends a request to the print service resource to create a print page using the information specified in the printParameters argument.
java.lang.String	getUrl() The url to the Export Web Map Task.

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 PrintTask create(java.lang.String url)

Creates a new PrintTask object.

Parameters:

url - - The url to the Export Web Map Task. Requires ArcGIS Server 10.1 or later.

Returns:

PrintTask

assertLoaded

public static boolean assertLoaded()

Check that the esri.layers.PrintTask has been loaded

Returns:

boolean

getUrl

public final java.lang.String getUrl()

The url to the Export Web Map Task. Requires ArcGIS Server 10.1 or later.

Returns:

String

execute

public final Deferred execute(PrintParameters params,
               PrintTaskCallback callback)

Sends a request to the print service resource to create a print page using the information specified in the printParameters argument. On completion, the onComplete event is fired and the optional callback function is invoked.

Parameters:

params - - A PrintParameters object that defines the printing options.

callback - - The function to call when the method has completed.

Returns:

Deferred

execute

public final Deferred execute(PrintParameters params)

Sends a request to the print service resource to create a print page using the information specified in the printParameters argument. On completion, the onComplete event is fired and the optional callback function is invoked.

Parameters:

params - - A PrintParameters object that defines the printing options.

Returns:

Deferred

addCompleteHandler

public final void addCompleteHandler(PrintTaskHandler handler)

Fired when the print job has completed.

Parameters:

handler - - Fires when the print operation is complete.

addErrorHandler

public final void addErrorHandler(ErrorHandler handler)

Fired when an error occurs while executing the print task.

Parameters:

handler - - Error message returned in a JavaScript error object.