com.adobe.livecycle.formsservice.client
Class ReaderExtensionSpec

java.lang.Object
  com.adobe.livecycle.formsservice.client.ReaderExtensionSpec

All Implemented Interfaces:

java.io.Serializable

public class ReaderExtensionSpec
extends java.lang.Object
implements java.io.Serializable

Allows you to define run-time options that control how the PDF forms service renders rights-enabled forms. Usage rights pertain to functionality that is available by default in Acrobat but not in Adobe Reader, such as the ability to add comments to a form or to fill in form fields and save the form. A PDF form that has usage rights applied to it is called a rights-enabled form. An object of this type is passed to the FormsServiceClient object's renderPDFFormWithUsageRights method.

To see an object of this type used in a code example, see the Rendering a rights-enabled form using the Java API quick start in Programming with Adobe Experience Manager forms.

See Also:

renderPDFFormWithUsageRights(), Serialized Form

Constructor Summary

ReaderExtensionSpec()
A standard constructor.

ReaderExtensionSpec(java.lang.String reCredentialAlias, java.lang.String reCredentialPassword, java.lang.String reReaderMessage, boolean re2DBarcode, boolean reCommenting, boolean reCreatePages, boolean reDigSig, boolean reEmbeddedAttachments, boolean reExpImp, boolean reFillIn, boolean reFormFieldMod, boolean reOnlineCommenting, boolean reOnlineForms, boolean reStandaloneSubmit)
A constructor that enables you to set all options.

Method Summary

java.lang.String	getReCredentialAlias() Returns the alias value of the credential that grants usage rights.
java.lang.String	getReCredentialPassword() Returns the credential password value that grants usage rights.
java.lang.String	getReReaderMessage() Return a string value that represents the message that is displayed within Adobe Reader to inform users that the form contains usage rights.
boolean	isRe2DBarcode() Returns a Boolean value that specifies whether the re2DBarcode option is set.
boolean	isReCommenting() Returns a Boolean value that specifies whether the reCommenting option is set.
boolean	isReCreatePages() Returns a Boolean value that specifies whether the reCreatePages option is set.
boolean	isReDigSig() Returns a Boolean value that specifies whether the reDigSig option is set.
boolean	isReEmbeddedAttachments() Returns a Boolean value that specifies whether the reEmbeddedAttachments option is set.
boolean	isReExpImp() Returns a Boolean value that specifies whether the reExpImp option is set.
boolean	isReFillIn() Returns a Boolean value that specifies whether the reFillIn option is set.
boolean	isReFormFieldMod() Returns a Boolean value that specifies whether the reFormFieldMod option is set.
boolean	isReOnlineCommenting() Returns a Boolean value that specifies whether the reOnlineCommenting option is set.
boolean	isReOnlineForms() Returns a Boolean value that specifies whether the reOnlineForms option is set.
boolean	isReStandaloneSubmit() Returns a Boolean value that specifies whether the reStandaloneSubmit option is set.
void	setRe2DBarcode(boolean re2DBarcode) Sets the re2DBarcode option that enables the PDF forms service to render forms that contain 2D barcodes and enables a user to fill in the form using Adobe Reader.
void	setReCommenting(boolean reCommenting) Sets the reCommenting option that enables the PDF forms service to render forms that allow users to add comments to the PDF form using Adobe Reader.
void	setReCreatePages(boolean reCreatePages) Sets the reCreatePages option that enables the PDF forms service to render forms that allow users to dynamically add pages within Adobe Reader.
void	setReCredentialAlias(java.lang.String reCredentialAlias) Sets the alias value of the credential that grants usage rights.
void	setReCredentialPassword(java.lang.String reCredentialPassword) Sets the credential password value that grants usage rights.
void	setReDigSig(boolean reDigSig) Sets the reDigSig option that enables the PDF forms service to render PDF forms that allow users to digitally sign the form using Adobe Reader.
void	setReEmbeddedAttachments(boolean reEmbeddedAttachments) Sets the reEmbeddedAttachments option that enables the PDF forms service to render PDF forms that allow users to add attachments to the form using Adobe Reader.
void	setReExpImp(boolean reExpImp) Sets the reExpImp option that enables the PDF forms service to render PDF forms that allow users to import and export form data using Adobe Reader.
void	setReFillIn(boolean reFillIn) Sets the reFillIn option that enables the PDF forms service to render PDF forms that allow users to fill in form fields and save the PDF form from within Adobe Reader.
void	setReFormFieldMod(boolean reFormFieldMod) Sets the reFormFieldMod option that enables the PDF forms service to render PDF forms that allow users to modify form fields and save the PDF form from within Adobe Reader.
void	setReOnlineCommenting(boolean reOnlineCommenting) Sets the reOnlineCommenting option that enables the PDF forms service to render PDF forms that allow users to add comments within Adobe Reader while online.
void	setReOnlineForms(boolean reOnlineForms) Sets the reOnlineForms option that enables the PDF forms service to render PDF forms that allow users to interact with a form while online from within Adobe Reader.
void	setReReaderMessage(java.lang.String reReaderMessage) Sets the message that is displayed within Adobe Reader to inform users that the form contains usage rights.
void	setReStandaloneSubmit(boolean reStandaloneSubmit) Sets the reStandaloneSubmit option that enables the PDF forms service to render PDF forms that allows users to submit information from within Adobe Reader.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReaderExtensionSpec

public ReaderExtensionSpec()

A standard constructor.

ReaderExtensionSpec

public ReaderExtensionSpec(java.lang.String reCredentialAlias,
                           java.lang.String reCredentialPassword,
                           java.lang.String reReaderMessage,
                           boolean re2DBarcode,
                           boolean reCommenting,
                           boolean reCreatePages,
                           boolean reDigSig,
                           boolean reEmbeddedAttachments,
                           boolean reExpImp,
                           boolean reFillIn,
                           boolean reFormFieldMod,
                           boolean reOnlineCommenting,
                           boolean reOnlineForms,
                           boolean reStandaloneSubmit)

A constructor that enables you to set all options.

Method Detail

isReFillIn

public boolean isReFillIn()

Returns a Boolean value that specifies whether the reFillIn option is set.

Returns:

A Boolean value that specifies whether the reFillIn option is set.

See Also:

setReFillIn()

setReFillIn

public void setReFillIn(boolean reFillIn)

Sets the reFillIn option that enables the PDF forms service to render PDF forms that allow users to fill in form fields and save the PDF form from within Adobe Reader. In order to set this option, you must have the Acrobat Reader DC Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:

reFillIn - A Boolean value that sets the reFillIn option.

See Also:

setReCredentialAlias(), setReCredentialPassword()

isReExpImp

public boolean isReExpImp()

Returns a Boolean value that specifies whether the reExpImp option is set.

Returns:

A Boolean value that specifies whether the reExpImp option is set.

See Also:

setReExpImp()

setReExpImp

public void setReExpImp(boolean reExpImp)

Sets the reExpImp option that enables the PDF forms service to render PDF forms that allow users to import and export form data using Adobe Reader. In order to set this option, you must have the Acrobat Reader DC Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:

reExpImp - A Boolean value that sets the reExpImp option.

See Also:

setReCredentialAlias(), setReCredentialPassword()

isReStandaloneSubmit

public boolean isReStandaloneSubmit()

Returns a Boolean value that specifies whether the reStandaloneSubmit option is set.

Returns:

A Boolean value that specifies whether the reStandaloneSubmit option is set.

See Also:

setReStandaloneSubmit()

setReStandaloneSubmit

public void setReStandaloneSubmit(boolean reStandaloneSubmit)

Sets the reStandaloneSubmit option that enables the PDF forms service to render PDF forms that allows users to submit information from within Adobe Reader. In order to set this option, you must have the Acrobat Reader DC Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:

reStandaloneSubmit - A Boolean value that sets the reStandaloneSubmit option.

See Also:

setReCredentialAlias(), setReCredentialPassword()

isReOnlineForms

public boolean isReOnlineForms()

Returns a Boolean value that specifies whether the reOnlineForms option is set.

Returns:

A Boolean value that specifies whether the reOnlineForms option is set.

See Also:

setReOnlineForms()

setReOnlineForms

public void setReOnlineForms(boolean reOnlineForms)

Sets the reOnlineForms option that enables the PDF forms service to render PDF forms that allow users to interact with a form while online from within Adobe Reader. In order to set this option, you must have the Acrobat Reader DC Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:

reOnlineForms - A Boolean value that sets the reOnlineForms option.

See Also:

setReCredentialAlias(), setReCredentialPassword()

isReFormFieldMod

public boolean isReFormFieldMod()

Returns a Boolean value that specifies whether the reFormFieldMod option is set.

Returns:

A Boolean value that specifies whether the reFormFieldMod option is set.

See Also:

setReFormFieldMod()

setReFormFieldMod

public void setReFormFieldMod(boolean reFormFieldMod)

Sets the reFormFieldMod option that enables the PDF forms service to render PDF forms that allow users to modify form fields and save the PDF form from within Adobe Reader. In order to set this option, you must have the Acrobat Reader DC Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:

reFormFieldMod - A Boolean value that sets the reFormFieldMod option.

See Also:

setReCredentialAlias(), setReCredentialPassword()

isReCreatePages

public boolean isReCreatePages()

Returns a Boolean value that specifies whether the reCreatePages option is set.

Returns:

A Boolean value that specifies whether the reCreatePages option is set.

See Also:

setReCreatePages()

setReCreatePages

public void setReCreatePages(boolean reCreatePages)

Sets the reCreatePages option that enables the PDF forms service to render forms that allow users to dynamically add pages within Adobe Reader. In order to set this option, you must have the Acrobat Reader DC Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:

reCreatePages - A Boolean value that sets the reCreatePages option.

See Also:

setReCredentialAlias(), setReCredentialPassword()

isRe2DBarcode

public boolean isRe2DBarcode()

Returns a Boolean value that specifies whether the re2DBarcode option is set.

Returns:

A Boolean value that specifies whether the re2DBarcode option is set.

See Also:

setRe2DBarcode()

setRe2DBarcode

public void setRe2DBarcode(boolean re2DBarcode)

Sets the re2DBarcode option that enables the PDF forms service to render forms that contain 2D barcodes and enables a user to fill in the form using Adobe Reader. When a user fills in an interactive form that contains a barcoded, the barcode is updated automatically to encode the user-supplied data. For information, see Working With the Barcoded Forms Service. In order to set this option, you must have the Acrobat Reader DC Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:

re2DBarcode - A Boolean value that sets the re2DBarcode option.

See Also:

setReCredentialAlias(), setReCredentialPassword()

isReDigSig

public boolean isReDigSig()

Returns a Boolean value that specifies whether the reDigSig option is set.

Returns:

A Boolean value that specifies whether the reDigSig option is set.

See Also:

setReDigSig()

setReDigSig

public void setReDigSig(boolean reDigSig)

Sets the reDigSig option that enables the PDF forms service to render PDF forms that allow users to digitally sign the form using Adobe Reader. In order to set this option, you must have the Acrobat Reader DC Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:

reDigSig - A Boolean value that sets the reDigSig option.

See Also:

setReCredentialAlias(), setReCredentialPassword()

isReCommenting

public boolean isReCommenting()

Returns a Boolean value that specifies whether the reCommenting option is set.

Returns:

A Boolean value that specifies whether the reCommenting option is set.

See Also:

setReCommenting()

setReCommenting

public void setReCommenting(boolean reCommenting)

Sets the reCommenting option that enables the PDF forms service to render forms that allow users to add comments to the PDF form using Adobe Reader. In order to set this option, you must have the Acrobat Reader DC Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:

reCommenting - A Boolean value that sets the reCommenting option.

See Also:

setReCredentialAlias(), setReCredentialPassword()

isReOnlineCommenting

public boolean isReOnlineCommenting()

Returns a Boolean value that specifies whether the reOnlineCommenting option is set.

Returns:

A Boolean value that specifies whether the reOnlineCommenting option is set.

See Also:

setReOnlineCommenting()

setReOnlineCommenting

public void setReOnlineCommenting(boolean reOnlineCommenting)

Sets the reOnlineCommenting option that enables the PDF forms service to render PDF forms that allow users to add comments within Adobe Reader while online. In order to set this option, you must have the Acrobat Reader DC Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:

reOnlineCommenting - A Boolean value that sets the reOnlineCommenting option.

See Also:

setReCredentialAlias(), setReCredentialPassword()

isReEmbeddedAttachments

public boolean isReEmbeddedAttachments()

Returns a Boolean value that specifies whether the reEmbeddedAttachments option is set.

Returns:

A Boolean value that specifies whether the reEmbeddedAttachments option is set.

See Also:

setReEmbeddedAttachments()

setReEmbeddedAttachments

public void setReEmbeddedAttachments(boolean reEmbeddedAttachments)

Sets the reEmbeddedAttachments option that enables the PDF forms service to render PDF forms that allow users to add attachments to the form using Adobe Reader. In order to set this option, you must have the Acrobat Reader DC Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:

reEmbeddedAttachments - A Boolean value that sets the reEmbeddedAttachments option.

See Also:

setReCredentialAlias(), setReCredentialPassword()

getReCredentialAlias

public java.lang.String getReCredentialAlias()

Returns the alias value of the credential that grants usage rights. In order to set Acrobat Reader DC Extensions usage rights, you must specify the alias of a Acrobat Reader DC Extensions credential.

Returns:

A string value that specifies the alias value of the credential that grants usage rights.

See Also:

setReCredentialAlias()

setReCredentialAlias

public void setReCredentialAlias(java.lang.String reCredentialAlias)

Sets the alias value of the credential that grants usage rights. In order to set Acrobat Reader DC Extensions usage rights, you must specify the alias of a Acrobat Reader DC Extensions credential. For information, see Applying Usage Rights.

Parameters:

reCredentialAlias - A string value that specifies the alias value of the credential that grants usage rights.

getReCredentialPassword

public java.lang.String getReCredentialPassword()

Returns the credential password value that grants usage rights. In order to set Acrobat Reader DC Extensions usage rights, you must specify a valid credential password value.

Returns:

A string value that specifies a valid credential password value.

See Also:

setReCredentialPassword()

setReCredentialPassword

public void setReCredentialPassword(java.lang.String reCredentialPassword)

Sets the credential password value that grants usage rights. In order to set Acrobat Reader DC Extensions usage rights, you must specify a valid credential password value.

Parameters:

reCredentialPassword - A string value that specifies a valid credential password value.

getReReaderMessage

public java.lang.String getReReaderMessage()

Return a string value that represents the message that is displayed within Adobe Reader to inform users that the form contains usage rights.

Returns:

A string value that represents the message that is displayed within Adobe Reader.

See Also:

ReaderExtensionSpec.setReReaderMessage(String)

setReReaderMessage

public void setReReaderMessage(java.lang.String reReaderMessage)

Sets the message that is displayed within Adobe Reader to inform users that the form contains usage rights.

Parameters:

reReaderMessage - A string value that represents the message that is displayed within Adobe Reader.