SmartDoc

Method Summary
Payload	createEmptyLayer() Creates a new empty Layer. Changes are not persistent. Use setLayer to save changes.
ImageFile	createPdfSprite(int spacing, int padding, float scale, boolean horizontal, boolean includePageNumbers) Creates (destroys any existing) a sprite image for the PDF.
	deleteOriginal() Deletes the original
	deletePdf() Deletes the PDF.
String	getCategory() Returns the category of this smart doc.
Data	getData() Returns information about the smart doc including details on sprit and the PDF (pageCount).
String	getDescription() Returns the description of this smart doc.
String	getId() Returns the ID of this smart doc.
Payload	getLayer() Returns the Layer. Changes are not persistent. Use setLayer to save changes.
String	getName() Returns the name of this smart doc.
File	getOriginal() Returns the content of the original file, which might be null.
int	getPageCount() Returns the number of pages in the PDF.
PdfFile	getPdf() Returns the content of the PDF file, which might be null.
ImageFile	getPdfSprite() Returns the sprite image for the PDF if one exists.
DataList	getSpriteMap(String name) Returns a DataList containing sprite coordinate information that can be used to create an HTML image map for the sprite.
String	getStatus() Returns the status of this smart doc.
	setCategory(String category) Sets the category of this smart doc.
	setDescription(String description) Sets the description of this smart doc.
	setLayer(Payload payload) Sets the Layer.
	setName(String name) Sets the name of this smart doc.
	setOriginal(File file) Sets the content of the original file. Do not set the original file as a PDF.
	setPdf(PdfFile pdf) Sets the content of the PDF.
	setStatus(String status) Sets the status of this smart doc.
String	toString() Returns a description of this object.

Method Detail

---

Payload createEmptyLayer()

Creates a new empty Layer. Changes are not persistent. Use setLayer to save changes.

Returns:  Payload

Since: 06-28-2012

---

ImageFile createPdfSprite(int spacing, int padding, float scale, boolean horizontal, boolean includePageNumbers)

Creates (destroys any existing) a sprite image for the PDF.

Parameters:

• int   spacing  - Spacing in px between pages.. Maximum allowed size of parameter: 255
• int   padding  - Padding in px around pages.. Maximum allowed size of parameter: 255
• float   scale  - Scale should be between 0 and .20..
• boolean   horizontal  - If true, sprite will be horizontal, else vertical.
• boolean   includePageNumbers  - If true, page numbers will be added..

Returns:  ImageFile

Since: 06-28-2012

---

deleteOriginal()

Deletes the original

Since: 06-28-2012

---

deletePdf()

Deletes the PDF.

Since: 06-28-2012

---

String getCategory()

Returns the category of this smart doc.

Returns:  String

Since: 06-28-2012

---

Data getData()

Returns information about the smart doc including details on sprit and the PDF (pageCount).

Returns:  Data

Since: 06-28-2012

---

String getDescription()

Returns the description of this smart doc.

Returns:  String

Since: 06-28-2012

---

String getId()

Returns the ID of this smart doc.

Returns:  String

Since: 06-28-2012

---

Payload getLayer()

Returns the Layer. Changes are not persistent. Use setLayer to save changes.

Returns:  Payload

Since: 06-28-2012

---

String getName()

Returns the name of this smart doc.

Returns:  String

Since: 06-28-2012

---

File getOriginal()

Returns the content of the original file, which might be null.

Returns:  File

Since: 06-28-2012

---

int getPageCount()

Returns the number of pages in the PDF.

Returns:  int

Since: 11-01-2012

---

PdfFile getPdf()

Returns the content of the PDF file, which might be null.

Returns:  PdfFile

Since: 06-28-2012

---

ImageFile getPdfSprite()

Returns the sprite image for the PDF if one exists.

Returns:  ImageFile

Since: 06-28-2012

---

DataList getSpriteMap(String name)

Returns a DataList containing sprite coordinate information that can be used to create an HTML image map for the sprite.

Parameters:

• String   name Required parameter.

Returns:  DataList

DataList Name: map
DataList Fields: page, coords, left, top, height, width

Since: 10-30-2012

---

String getStatus()

Returns the status of this smart doc.

Returns:  String

Since: 11-01-2012

---

setCategory(String category)

Sets the category of this smart doc.

Parameters:

• String   category Required parameter. Maximum allowed size of parameter: 80

Since: 07-07-2020

---

setDescription(String description)

Sets the description of this smart doc.

Parameters:

• String   description Required parameter. Maximum allowed size of parameter: 80

Since: 07-07-2020

---

setLayer(Payload payload)

Sets the Layer.

Parameters:

• Payload   payload Required parameter.

Since: 06-28-2012

---

setName(String name)

Sets the name of this smart doc.

Parameters:

• String   name Required parameter. Maximum allowed size of parameter: 80

Since: 07-07-2020

---

setOriginal(File file)

Sets the content of the original file. Do not set the original file as a PDF.

Parameters:

• File   file Required parameter.

Since: 06-28-2012

---

setPdf(PdfFile pdf)

Sets the content of the PDF.

Parameters:

• PdfFile   pdf Required parameter.

Since: 06-28-2012

---

setStatus(String status)

Sets the status of this smart doc.

Parameters:

• String   status Maximum allowed size of parameter: 80

Since: 11-01-2012

---

String toString()

Returns a description of this object.

Returns:  String

Since: 06-28-2012