Class: PDFPrintFactory

Cadcorp.UI.PrintUI.PDFPrintFactory

new PDFPrintFactory(config)

Factory to handle the search functionality.
Parameters:
Name Type Description
config Object Configuration for this object. The config supplied directly extends the control

Members

events

Properties:
Name Type Description
events Cadcorp.Util.Events event object

geognoSISLayer

Properties:
Name Type Description
geognoSISLayer Cadcorp.OpenLayers.Layer.GeognoSISRest geognoSIS layer the printing is derived from.

labels

Properties:
Name Type Description
labels Object object holding label text.

landScape

Properties:
Name Type Description
landScape bool Indicates whether the print is in landscape, as opposed to portrait.

legends

Properties:
Name Type Description
legends Array.<Object> Legend items.

map

Properties:
Name Type Description
map Object current map

printItems

Properties:
Name Type Description
printItems Array.<Cadcorp.UI.PrintUI.PrintItem> Prompts to populate with text.

printTemplate

Properties:
Name Type Description
printTemplate string Print template name.

Methods

(protected) annotationLayerCreated_handler(e)

Handles the successful creation of the annotation layer.
Parameters:
Name Type Description
e Object event args

(protected) annotationsInitialCleared_handler()

Callback for when intial clear of annotation layer succeeds.
Returns:

(protected) annotationsInitialClearFailed_handler(jqXHR, textStatus, errorThrown)

Fired when initial clear of annotations layer fails.
Parameters:
Name Type Description
jqXHR Object response object.
textStatus string text status
errorThrown Object exception
Returns:

clearAnnotationOverlay()

Clears the annotation overlay.

(protected) clearAnnotationOverlayFailed_handler(e)

Logs failures of the clear annotation layer method.
Parameters:
Name Type Description
e Object event args.

(protected) clearAnnotationOverlaySuccess_handler(e)

Handles the success of the clear annotation layer method.
Parameters:
Name Type Description
e Object event args.

(protected) createPrintSession()

Creates a print session.

(protected) createPrintSessionFailed_handler(e)

Print session creation failed.
Parameters:
Name Type Description
e Object event args

(protected) createPrintSessionSuccess_handler(e)

Print session creation succeeded.
Parameters:
Name Type Description
e Object event args

deletePrintSession()

Returns:

(protected) deletePrintSessionFailed_handler(e)

Parameters:
Name Type Description
e Object event args
Returns:

(protected) deletePrintSessionSuccess_handler(e)

Parameters:
Name Type Description
e Object event args
Returns:

(protected) featuresAdded_handler(e)

Triggered when the features (if any) have been successfully added.
Parameters:
Name Type Description
e Object event args.

(protected) featuresAddedFailed_handler(e)

Handles feature added failed handler.
Parameters:
Name Type Description
e Cadcorp.UI.PrintUI.PrintError print error
Returns:

getAnnotationLayer() → {Cadcorp.GeognoSIS.Overlay}

Returns the annotation layer.
Returns:
Type
Cadcorp.GeognoSIS.Overlay

(protected) layersPopulatedFailed_handler(jqXHR, textStatus, errorThrown)

Handles the layer populated failed event.
Parameters:
Name Type Description
jqXHR Object response object.
textStatus string text status
errorThrown Object exception

(protected) layersPopulatedSuccess_handler(e)

Handles the layers populated event.
Parameters:
Name Type Description
e Object event args.

(protected) legendAddingComplete_handler(e)

Handles the completion of the legend handler.
Parameters:
Name Type Description
e Object event arguments

(protected) legendAddingFailed_handler(e)

Handles failure of legend addition.
Parameters:
Name Type Description
e Cadcorp.UI.PrintUI.PrintError error object
Returns:

print()

Handles the pre-save pdf creation functionality.

(protected) printFurnitureSet_handler(e)

Handles the completion of the print furniture handler.
Parameters:
Name Type Description
e Object event arguments

processLayers(visible, useAnnotation)

Parameters:
Name Type Description
visible bool will they be set to visible.
useAnnotation bool will the annoation layer be used/populated?

(protected) setExtentsFailed_handler(jqXHR, textStatus, errorThrown)

Set Extents failed
Parameters:
Name Type Description
jqXHR Object response object.
textStatus string text status
errorThrown Object exception

(protected) setExtentsSuccess_handler(e)

Set Extents Succeeded, create print session if necessary, otherwise use existing session to set items.
Parameters:
Name Type Description
e Object event args

(protected) updateAnnotationLayerScaleFailed_handler(jqXHR, textStatus, errorThrown)

Handles the failure of the update annotation layer scale failed method.
Parameters:
Name Type Description
jqXHR Object response object.
textStatus string text status
errorThrown Object exception

(protected) updateAnnotationLayerScaleSuccessful_handler(e)

Handles the successful setting of the annotation layer scale.
Parameters:
Name Type Description
e Object event args.

Events

AnnotationsCleared

Event indicating that the annotation layer has been cleared
Type:
  • Object

Error

Event indicating that an error has occurred.
Type:
  • Object

FeatureAddingComplete

Event indicating that the the feature addition methodology is complete.
Type:
  • Object

PDFReady

Event indicating that the PDF is ready to be saved.
Type:
  • Object

PrintSessionDestroyed

Event indicating that print session was destroyed.
Type:
  • Object