DisplaySettings

Method Summary
	alertSignatureInfo(boolean alert) This method is used for displaying signature details on small form-factor (mobile) devices that are otherwise not capable of displaying the normal information for signatures.For mobile devices, by default this is true. This method is ignored for non-mobile browsers.
	filterDocumentData(Data data) Provides a different rendering of data within a document when displayed
int	getPage() Returns the adhoc page to display.
	hideElement(String id) This method is used for hiding a section of the XHTML-based document from the active user during rendering. This should be used carefully because it could make your documents un-enforceable. The element must be a div or span.
boolean	isHidePdfMenubar() Returns hidePdfMenubar setting
boolean	isHidePdfToolbar() Returns hidePdfToolbar setting
boolean	isHidePdfUI() Returns hidePdfUI setting
	positionSigning(String targetId) Positions the signing technology (audio, image) in the page inside the element identified by targetId.
	renderSmart(Payload payload) Tells the rendering engine to display this document in 'smart' mode using the supplied Payload. Applies only to PDF documents. The default Data of the payload should contain edit data. Any lists in the payload will be used to populate select boxes, if any.
boolean	replacePrintStyleSheet(String stylesheet) Replaces all styles of this document with this one.
	scrollToAnchor(String scroll) Default is false. If true, ContractPal document will scroll to the just signed signature. With PDF documents, should only be used when document scroll is true.
	setAudioSettings(int rate, int bit, String ext, String behavior) Overrides the default context for capturing audio settings.
	setAudioStyleSheet(String stylesheet) Overrides the default stylesheet for audio capture.
	setDisplaySettings(Data settings) Globally sets all the properties of this DisplaySettings based on information passed in the Data object. Keys in the Data object should match method signatures. For example: documentStyleSheet or pdfRejectButtonColors-textColor.
boolean	setDocumentScroll(boolean scroll) Default is true. If false, the frame containing the ContractPal document will be resized so the document does not have scrollbars. Returns false if unable to resize.
	setDocumentStyleSheet(String name) Sets the stylesheet (from the Pal) to be used for validation adornment. When this is set, the default Navigator stylesheet is removed.
	setHidePdfMenubar(boolean hide) Specifies whether or not PDF menu bar should be visible.
	setHidePdfToolbar(boolean hide) Specifies whether or not PDF tool bar should be visible.
	setHidePdfUI(boolean hide) Specifies whether or not PDF UI should be visible.
	setPage(int page) Sets the adhoc page to display.
	setPdfRejectButtonColors(String textColor, String backgroundColor) Sets the text and background colors of the reject button in a pdf. Either a color name or six digit hex number (#XXXXXX). Color names are listed in the Misc section: color names.
	setPdfSignButtonColors(String textColor, String backgroundColor) Sets the text and background colors of the sign button in a pdf. Either a color name or six digit hex number (#XXXXXX). Color names are listed in the Misc section: color names.
boolean	setPrintStyleSheet(String stylesheet) Sets the stylesheet (from the Pal) to be used any time this document is printed to PDF in the current session. Set this to null to remove it.
	setResetSignatureScroll(boolean scroll) Default is false. If true, ContractPal document will scroll to the just signed signature. With PDF documents, should only be used when document scroll is true.
	setSignatureScroll(boolean scroll) Default is false. If true, ContractPal document will scroll to the signature to be signed. With PDF documents, should only be used when document scroll is true.
	setSigningHandler(String function) Passes display responsibility of the signature capture to a client side function. When the signing function has completed capture it should submit to the workflow the same action used to enable signing.
	setSigningText(String signText, String signTitle, String rejectText, String rejectTitle) Sets custom captions and optional tooltips for Sign and Reject buttons
	setUsePalStyleSheet(boolean usePal) If true, removes the default Navigator styles for wizard validation. Calling this method assumes you will provide your own alternative CSS classes for [sample, answerRequiredValue, and answerIllegalFormat].
String	toString() Returns a description of this object.

Method Detail

---

alertSignatureInfo(boolean alert)

This method is used for displaying signature details on small form-factor (mobile) devices that are otherwise not capable of displaying the normal information for signatures.For mobile devices, by default this is true. This method is ignored for non-mobile browsers.

Parameters:

• boolean   alert Required parameter.

Since: 03-28-2011

---

filterDocumentData(Data data)

Provides a different rendering of data within a document when displayed

Parameters:

• Data   data Required parameter.

Since: 01-19-2018

---

int getPage()

Returns the adhoc page to display.

Returns:  int

Since: 01-27-2010

---

hideElement(String id)

This method is used for hiding a section of the XHTML-based document from the active user during rendering. This should be used carefully because it could make your documents un-enforceable. The element must be a div or span.

Parameters:

• String   id Required parameter.

Since: 06-08-2011

---

boolean isHidePdfMenubar()

Returns hidePdfMenubar setting

Returns:  boolean

Since: 02-23-2009

---

boolean isHidePdfToolbar()

Returns hidePdfToolbar setting

Returns:  boolean

Since: 02-23-2009

---

boolean isHidePdfUI()

Returns hidePdfUI setting

Returns:  boolean

Since: 02-13-2009

---

positionSigning(String targetId)

Positions the signing technology (audio, image) in the page inside the element identified by targetId.

Parameters:

• String   targetId

Since: 02-13-2009

---

renderSmart(Payload payload)

Tells the rendering engine to display this document in 'smart' mode using the supplied Payload. Applies only to PDF documents. The default Data of the payload should contain edit data. Any lists in the payload will be used to populate select boxes, if any.

Parameters:

• Payload   payload

Since: 04-30-2012

---

boolean replacePrintStyleSheet(String stylesheet)

Replaces all styles of this document with this one.

Parameters:

• String   stylesheet

Returns:  boolean

Since: 08-22-2018

---

scrollToAnchor(String scroll)

Default is false. If true, ContractPal document will scroll to the just signed signature. With PDF documents, should only be used when document scroll is true.

Parameters:

• String   scroll

Since: 02-13-2009

---

setAudioSettings(int rate, int bit, String ext, String behavior)

Overrides the default context for capturing audio settings.

Parameters:

• int   rate  - 8 is default. options 8,5,11,22,44.
• int   bit  - 16 is default. options are 8 and 16.
• String   ext  - wav is default. Required parameter. Allowed values: wav.
• String   behavior  - options are default, (future behaviors will be defined). Required parameter. Allowed values: default.

Since: 10-29-2018

---

setAudioStyleSheet(String stylesheet)

Overrides the default stylesheet for audio capture.

Parameters:

• String   stylesheet

Since: 10-29-2018

---

setDisplaySettings(Data settings)

Globally sets all the properties of this DisplaySettings based on information passed in the Data object. Keys in the Data object should match method signatures. For example: documentStyleSheet or pdfRejectButtonColors-textColor.

Parameters:

• Data   settings

Since: 02-13-2009

---

boolean setDocumentScroll(boolean scroll)

Default is true. If false, the frame containing the ContractPal document will be resized so the document does not have scrollbars. Returns false if unable to resize.

Parameters:

• boolean   scroll

Returns:  boolean

Since: 02-13-2009

---

setDocumentStyleSheet(String name)

Sets the stylesheet (from the Pal) to be used for validation adornment. When this is set, the default Navigator stylesheet is removed.

Parameters:

• String   name

Since: 02-13-2009

---

setHidePdfMenubar(boolean hide)

Specifies whether or not PDF menu bar should be visible.

Parameters:

• boolean   hide

Since: 02-23-2009

---

setHidePdfToolbar(boolean hide)

Specifies whether or not PDF tool bar should be visible.

Parameters:

• boolean   hide

Since: 02-23-2009

---

setHidePdfUI(boolean hide)

Specifies whether or not PDF UI should be visible.

Parameters:

• boolean   hide

Since: 02-13-2009

---

setPage(int page)

Sets the adhoc page to display.

Parameters:

• int   page

Since: 01-27-2010

---

setPdfRejectButtonColors(String textColor, String backgroundColor)

Sets the text and background colors of the reject button in a pdf. Either a color name or six digit hex number (#XXXXXX). Color names are listed in the Misc section: color names.

Parameters:

• String   textColor
• String   backgroundColor

Since: 02-13-2009

---

setPdfSignButtonColors(String textColor, String backgroundColor)

Sets the text and background colors of the sign button in a pdf. Either a color name or six digit hex number (#XXXXXX). Color names are listed in the Misc section: color names.

Parameters:

• String   textColor
• String   backgroundColor

Since: 02-13-2009

---

boolean setPrintStyleSheet(String stylesheet)

Sets the stylesheet (from the Pal) to be used any time this document is printed to PDF in the current session. Set this to null to remove it.

Parameters:

• String   stylesheet

Returns:  boolean

Since: 06-10-2011

---

setResetSignatureScroll(boolean scroll)

Default is false. If true, ContractPal document will scroll to the just signed signature. With PDF documents, should only be used when document scroll is true.

Parameters:

• boolean   scroll

Since: 02-13-2009

---

setSignatureScroll(boolean scroll)

Default is false. If true, ContractPal document will scroll to the signature to be signed. With PDF documents, should only be used when document scroll is true.

Parameters:

• boolean   scroll

Since: 02-13-2009

---

setSigningHandler(String function)

Passes display responsibility of the signature capture to a client side function. When the signing function has completed capture it should submit to the workflow the same action used to enable signing.

Parameters:

• String   function Required parameter.

Since: 07-23-2016

---

setSigningText(String signText, String signTitle, String rejectText, String rejectTitle)

Sets custom captions and optional tooltips for Sign and Reject buttons

Parameters:

• String   signText  - Caption for Sign button. Required parameter.
• String   signTitle  - Mouse-over tooltip for Sign button.
• String   rejectText  - Caption for Reject button. Required parameter.
• String   rejectTitle  - Mouse-over tooltip for Reject button.

Since: 03-12-2010

---

setUsePalStyleSheet(boolean usePal)

If true, removes the default Navigator styles for wizard validation. Calling this method assumes you will provide your own alternative CSS classes for [sample, answerRequiredValue, and answerIllegalFormat].

Parameters:

• boolean   usePal

Since: 02-13-2009

---

String toString()

Returns a description of this object.

Returns:  String

Since: 02-06-2009