Package com.docusign.esign.model

Class DocumentHtmlDefinition

java.lang.Object

com.docusign.esign.model.DocumentHtmlDefinition

All Implemented Interfaces:

Serializable

public class DocumentHtmlDefinition
extends Object
implements Serializable

Holds the properties that define how to generate the responsive-formatted HTML for the document. See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/)..

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DocumentHtmlDefinition()

Method Summary

Modifier and Type	Method	Description
DocumentHtmlDefinition	addDisplayAnchorsItem(DocumentHtmlDisplayAnchor displayAnchorsItem)	addDisplayAnchorsItem.
DocumentHtmlDefinition	displayAnchorPrefix(String displayAnchorPrefix)	displayAnchorPrefix.
DocumentHtmlDefinition	displayAnchors(List<DocumentHtmlDisplayAnchor> displayAnchors)	displayAnchors.
DocumentHtmlDefinition	displayOrder(String displayOrder)	displayOrder.
DocumentHtmlDefinition	displayPageNumber(String displayPageNumber)	displayPageNumber.
DocumentHtmlDefinition	documentGuid(String documentGuid)	documentGuid.
DocumentHtmlDefinition	documentId(String documentId)	documentId.
boolean	equals(Object o)	Compares objects.
String	getDisplayAnchorPrefix()	.
List<DocumentHtmlDisplayAnchor>	getDisplayAnchors()	.
String	getDisplayOrder()	.
String	getDisplayPageNumber()	.
String	getDocumentGuid()	.
String	getDocumentId()	Specifies the document ID number that the tab is placed on.
String	getHeaderLabel()	.
String	getMaxScreenWidth()	.
String	getRemoveEmptyTags()	.
String	getShowMobileOptimizedToggle()	.
String	getSource()	.
int	hashCode()	Returns the HashCode.
DocumentHtmlDefinition	headerLabel(String headerLabel)	headerLabel.
DocumentHtmlDefinition	maxScreenWidth(String maxScreenWidth)	maxScreenWidth.
DocumentHtmlDefinition	removeEmptyTags(String removeEmptyTags)	removeEmptyTags.
void	setDisplayAnchorPrefix(String displayAnchorPrefix)	setDisplayAnchorPrefix.
void	setDisplayAnchors(List<DocumentHtmlDisplayAnchor> displayAnchors)	setDisplayAnchors.
void	setDisplayOrder(String displayOrder)	setDisplayOrder.
void	setDisplayPageNumber(String displayPageNumber)	setDisplayPageNumber.
void	setDocumentGuid(String documentGuid)	setDocumentGuid.
void	setDocumentId(String documentId)	setDocumentId.
void	setHeaderLabel(String headerLabel)	setHeaderLabel.
void	setMaxScreenWidth(String maxScreenWidth)	setMaxScreenWidth.
void	setRemoveEmptyTags(String removeEmptyTags)	setRemoveEmptyTags.
void	setShowMobileOptimizedToggle(String showMobileOptimizedToggle)	setShowMobileOptimizedToggle.
void	setSource(String source)	setSource.
DocumentHtmlDefinition	showMobileOptimizedToggle(String showMobileOptimizedToggle)	showMobileOptimizedToggle.
DocumentHtmlDefinition	source(String source)	source.
String	toString()	Converts the given object to string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentHtmlDefinition

public DocumentHtmlDefinition()

Method Detail

displayAnchorPrefix

public DocumentHtmlDefinition displayAnchorPrefix(String displayAnchorPrefix)

displayAnchorPrefix.

Returns:

DocumentHtmlDefinition

getDisplayAnchorPrefix

public String getDisplayAnchorPrefix()

.

Returns:

displayAnchorPrefix

setDisplayAnchorPrefix

public void setDisplayAnchorPrefix(String displayAnchorPrefix)

setDisplayAnchorPrefix.

displayAnchors

public DocumentHtmlDefinition displayAnchors(List<DocumentHtmlDisplayAnchor> displayAnchors)

displayAnchors.

Returns:

DocumentHtmlDefinition

addDisplayAnchorsItem

public DocumentHtmlDefinition addDisplayAnchorsItem(DocumentHtmlDisplayAnchor displayAnchorsItem)

addDisplayAnchorsItem.

Returns:

DocumentHtmlDefinition

getDisplayAnchors

public List<DocumentHtmlDisplayAnchor> getDisplayAnchors()

.

Returns:

displayAnchors

setDisplayAnchors

public void setDisplayAnchors(List<DocumentHtmlDisplayAnchor> displayAnchors)

setDisplayAnchors.

displayOrder

public DocumentHtmlDefinition displayOrder(String displayOrder)

displayOrder.

Returns:

DocumentHtmlDefinition

getDisplayOrder

public String getDisplayOrder()

.

Returns:

displayOrder

setDisplayOrder

public void setDisplayOrder(String displayOrder)

setDisplayOrder.

displayPageNumber

public DocumentHtmlDefinition displayPageNumber(String displayPageNumber)

displayPageNumber.

Returns:

DocumentHtmlDefinition

getDisplayPageNumber

public String getDisplayPageNumber()

.

Returns:

displayPageNumber

setDisplayPageNumber

public void setDisplayPageNumber(String displayPageNumber)

setDisplayPageNumber.

documentGuid

public DocumentHtmlDefinition documentGuid(String documentGuid)

documentGuid.

Returns:

DocumentHtmlDefinition

getDocumentGuid

public String getDocumentGuid()

.

Returns:

documentGuid

setDocumentGuid

public void setDocumentGuid(String documentGuid)

setDocumentGuid.

documentId

public DocumentHtmlDefinition documentId(String documentId)

documentId.

Returns:

DocumentHtmlDefinition

getDocumentId

public String getDocumentId()

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute..

Returns:

documentId

setDocumentId

public void setDocumentId(String documentId)

setDocumentId.

headerLabel

public DocumentHtmlDefinition headerLabel(String headerLabel)

headerLabel.

Returns:

DocumentHtmlDefinition

getHeaderLabel

public String getHeaderLabel()

.

Returns:

headerLabel

setHeaderLabel

public void setHeaderLabel(String headerLabel)

setHeaderLabel.

maxScreenWidth

public DocumentHtmlDefinition maxScreenWidth(String maxScreenWidth)

maxScreenWidth.

Returns:

DocumentHtmlDefinition

getMaxScreenWidth

public String getMaxScreenWidth()

.

Returns:

maxScreenWidth

setMaxScreenWidth

public void setMaxScreenWidth(String maxScreenWidth)

setMaxScreenWidth.

removeEmptyTags

public DocumentHtmlDefinition removeEmptyTags(String removeEmptyTags)

removeEmptyTags.

Returns:

DocumentHtmlDefinition

getRemoveEmptyTags

public String getRemoveEmptyTags()

.

Returns:

removeEmptyTags

setRemoveEmptyTags

public void setRemoveEmptyTags(String removeEmptyTags)

setRemoveEmptyTags.

showMobileOptimizedToggle

public DocumentHtmlDefinition showMobileOptimizedToggle(String showMobileOptimizedToggle)

showMobileOptimizedToggle.

Returns:

DocumentHtmlDefinition

getShowMobileOptimizedToggle

public String getShowMobileOptimizedToggle()

.

Returns:

showMobileOptimizedToggle

setShowMobileOptimizedToggle

public void setShowMobileOptimizedToggle(String showMobileOptimizedToggle)

setShowMobileOptimizedToggle.

source

public DocumentHtmlDefinition source(String source)

source.

Returns:

DocumentHtmlDefinition

getSource

public String getSource()

.

Returns:

source

setSource

public void setSource(String source)

setSource.

equals

public boolean equals(Object o)

Compares objects.

Overrides:

equals in class Object

Returns:

true or false depending on comparison result.

hashCode

public int hashCode()

Returns the HashCode.

Overrides:

hashCode in class Object

toString

public String toString()

Converts the given object to string.

Overrides:

toString in class Object