com.adobe.livecycle.formsservice.client.ReaderExtensionSpec (Livecycle)

Public Methods

	Method		Defined by
		ReaderExtensionSpec() A standard constructor.	ReaderExtensionSpec
		ReaderExtensionSpec(String reCredentialAlias, String reCredentialPassword, 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.	ReaderExtensionSpec
		String getReCredentialAlias() Returns the alias value of the credential that grants usage rights.	ReaderExtensionSpec
		String getReCredentialPassword() Returns the credential password value that grants usage rights.	ReaderExtensionSpec
		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.	ReaderExtensionSpec
		boolean isAllowREInvocation() Specifies whether you can invoke the Reader Extensions service.	ReaderExtensionSpec
		boolean isRe2DBarcode() Returns a Boolean value that specifies whether the `re2DBarcode` option is set.	ReaderExtensionSpec
		boolean isReCommenting() Returns a Boolean value that specifies whether the `reCommenting` option is set.	ReaderExtensionSpec
		boolean isReCreatePages() Returns a Boolean value that specifies whether the `reCreatePages` option is set.	ReaderExtensionSpec
		boolean isReDigSig() Returns a Boolean value that specifies whether the `reDigSig` option is set.	ReaderExtensionSpec
		boolean isReEmbeddedAttachments() Returns a Boolean value that specifies whether the `reEmbeddedAttachments` option is set.	ReaderExtensionSpec
		boolean isReExpImp() Returns a Boolean value that specifies whether the `reExpImp` option is set.	ReaderExtensionSpec
		boolean isReFillIn() Returns a Boolean value that specifies whether the `reFillIn` option is set.	ReaderExtensionSpec
		boolean isReFormFieldMod() Returns a Boolean value that specifies whether the `reFormFieldMod` option is set.	ReaderExtensionSpec
		boolean isReOnlineCommenting() Returns a Boolean value that specifies whether the `reOnlineCommenting` option is set.	ReaderExtensionSpec
		boolean isReOnlineForms() Returns a Boolean value that specifies whether the `reOnlineForms` option is set.	ReaderExtensionSpec
		boolean isReStandaloneSubmit() Returns a Boolean value that specifies whether the `reStandaloneSubmit` option is set.	ReaderExtensionSpec
		void setAllowREInvocation(boolean allowREInvocation) For internal use use only.	ReaderExtensionSpec
		void setRe2DBarcode(boolean re2DBarcode) Sets the `re2DBarcode` option that enables the Forms service to render forms that contain 2D barcodes and enables a user to fill in the form using Adobe Reader.	ReaderExtensionSpec
		void setReCommenting(boolean reCommenting) Sets the `reCommenting` option that enables the Forms service to render forms that allow users to add comments to the PDF form using Adobe Reader.	ReaderExtensionSpec
		void setReCreatePages(boolean reCreatePages) Sets the `reCreatePages` option that enables the Forms service to render forms that allow users to dynamically add pages within Adobe Reader.	ReaderExtensionSpec
		void setReCredentialAlias(String reCredentialAlias) Sets the alias value of the credential that grants usage rights.	ReaderExtensionSpec
		void setReCredentialPassword(String reCredentialPassword) Sets the credential password value that grants usage rights.	ReaderExtensionSpec
		void setReDigSig(boolean reDigSig) Sets the `reDigSig` option that enables the Forms service to render PDF forms that allow users to digitally sign the form using Adobe Reader.	ReaderExtensionSpec
		void setReEmbeddedAttachments(boolean reEmbeddedAttachments) Sets the `reEmbeddedAttachments` option that enables the Forms service to render PDF forms that allow users to add attachments to the form using Adobe Reader.	ReaderExtensionSpec
		void setReExpImp(boolean reExpImp) Sets the `reExpImp` option that enables the Forms service to render PDF forms that allow users to import and export form data using Adobe Reader.	ReaderExtensionSpec
		void setReFillIn(boolean reFillIn) Sets the `reFillIn` option that enables the Forms service to render PDF forms that allow users to fill in form fields and save the PDF form from within Adobe Reader.	ReaderExtensionSpec
		void setReFormFieldMod(boolean reFormFieldMod) Sets the `reFormFieldMod` option that enables the Forms service to render PDF forms that allow users to modify form fields and save the PDF form from within Adobe Reader.	ReaderExtensionSpec
		void setReOnlineCommenting(boolean reOnlineCommenting) Sets the `reOnlineCommenting` option that enables the Forms service to render PDF forms that allow users to add comments within Adobe Reader while online.	ReaderExtensionSpec
		void setReOnlineForms(boolean reOnlineForms) Sets the `reOnlineForms` option that enables the Forms service to render PDF forms that allow users to interact with a form while online from within Adobe Reader.	ReaderExtensionSpec
		void setReReaderMessage(String reReaderMessage) Sets the message that is displayed within Adobe Reader to inform users that the form contains usage rights.	ReaderExtensionSpec
		void setReStandaloneSubmit(boolean reStandaloneSubmit) Sets the `reStandaloneSubmit` option that enables the Forms service to render PDF forms that allows users to submit information from within Adobe Reader.	ReaderExtensionSpec

Constructor Detail

ReaderExtensionSpec

()

public ReaderExtensionSpec()

A standard constructor.

ReaderExtensionSpec

()

public ReaderExtensionSpec(String reCredentialAlias, String reCredentialPassword, 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.

Parameters

	`reCredentialAlias`

	`reCredentialPassword`

	`reReaderMessage`

	`re2DBarcode`

	`reCommenting`

	`reCreatePages`

	`reDigSig`

	`reEmbeddedAttachments`

	`reExpImp`

	`reFillIn`

	`reFormFieldMod`

	`reOnlineCommenting`

	`reOnlineForms`

	`reStandaloneSubmit`

Method Detail

getReCredentialAlias

()

public String getReCredentialAlias()

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

Returns

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

See also

setReCredentialAlias()

getReCredentialPassword

()

public String getReCredentialPassword()

Returns the credential password value that grants usage rights. In order to set Reader 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()

getReReaderMessage

()

public 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

setReReaderMessage(String)

isAllowREInvocation

()

public boolean isAllowREInvocation()

Specifies whether you can invoke the Reader Extensions service. If you are unable to invoke this service, then the Forms service is unable to render rights-enabled forms.

Returns

A Boolean value that specifies whether you can invoke the Reader Extensions service.

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()

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()

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()

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()

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()

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()

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()

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()

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()

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()

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()

setAllowREInvocation

()

public void setAllowREInvocation(boolean allowREInvocation)

For internal use use only.

Parameters

allowREInvocation

setRe2DBarcode

()

public void setRe2DBarcode(boolean re2DBarcode)

Sets the re2DBarcode option that enables the 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 Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

re2DBarcode — A Boolean value that sets the re2DBarcode option.

setReCommenting

()

public void setReCommenting(boolean reCommenting)

Sets the reCommenting option that enables the 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 Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

reCommenting — A Boolean value that sets the reCommenting option.

setReCreatePages

()

public void setReCreatePages(boolean reCreatePages)

Sets the reCreatePages option that enables the 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 Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

reCreatePages — A Boolean value that sets the reCreatePages option.

setReCredentialAlias

()

public void setReCredentialAlias(String reCredentialAlias)

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

Parameters

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

setReCredentialPassword

()

public void setReCredentialPassword(String reCredentialPassword)

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

Parameters

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

setReDigSig

()

public void setReDigSig(boolean reDigSig)

Sets the reDigSig option that enables the 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 Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

reDigSig — A Boolean value that sets the reDigSig option.

setReEmbeddedAttachments

()

public void setReEmbeddedAttachments(boolean reEmbeddedAttachments)

Sets the reEmbeddedAttachments option that enables the 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 Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

reEmbeddedAttachments — A Boolean value that sets the reEmbeddedAttachments option.

setReExpImp

()

public void setReExpImp(boolean reExpImp)

Sets the reExpImp option that enables the 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 Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

reExpImp — A Boolean value that sets the reExpImp option.

setReFillIn

()

public void setReFillIn(boolean reFillIn)

Sets the reFillIn option that enables the 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 Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

reFillIn — A Boolean value that sets the reFillIn option.

setReFormFieldMod

()

public void setReFormFieldMod(boolean reFormFieldMod)

Sets the reFormFieldMod option that enables the 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 Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

reFormFieldMod — A Boolean value that sets the reFormFieldMod option.

setReOnlineCommenting

()

public void setReOnlineCommenting(boolean reOnlineCommenting)

Sets the reOnlineCommenting option that enables the 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 Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

reOnlineCommenting — A Boolean value that sets the reOnlineCommenting option.

setReOnlineForms

()

public void setReOnlineForms(boolean reOnlineForms)

Sets the reOnlineForms option that enables the 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 Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

reOnlineForms — A Boolean value that sets the reOnlineForms option.

setReReaderMessage

()

public void setReReaderMessage(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.

setReStandaloneSubmit

()

public void setReStandaloneSubmit(boolean reStandaloneSubmit)

Sets the reStandaloneSubmit option that enables the 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 Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

reStandaloneSubmit — A Boolean value that sets the reStandaloneSubmit option.

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/livecycle/formsservice/client/ReaderExtensionSpec.html

LiveCycle ES Java API Reference	All Packages \| All Classes \| Index \| Frames No Frames
Class ReaderExtensionSpec	Methods

Package	com.adobe.livecycle.formsservice.client
Class	public class ReaderExtensionSpec
Inheritance	ReaderExtensionSpec Object