com.adobe.livecycle.readerextensions.client
Class ReaderExtensionsOptionSpec

java.lang.Object
  com.adobe.livecycle.readerextensions.client.ReaderExtensionsOptionSpec

All Implemented Interfaces:

java.io.Serializable

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

Represents run-time options that are available when applying usage rights to a PDF document. Using this object, you can set the individual usage rights that are applied to a PDF document and the message that appears when the rights-enabled PDF document is opened in Adobe Reader.

See Also:

Serialized Form

Constructor Summary

ReaderExtensionsOptionSpec()

ReaderExtensionsOptionSpec(UsageRights rights, java.lang.String message)
A constructor that creates a ReaderExtensionsOptions instance.

Method Summary

java.lang.String	getMessage() Returns the message that is displayed within Adobe Reader when the rights enabled PDF document is opened.
UsageRights	getUsageRights() Returns a UsageRights object that represents usage rights applied to the PDF document.
boolean	isModeFinal() Returns true if the mode is set to final.
void	setMessage(java.lang.String message) Sets the message that is displayed within Adobe Reader when the rights enabled PDF document is opened.
void	setModeFinal(boolean modeFinal) Sets the usage-rights mode.
void	setUsageRights(UsageRights usageRights) Sets a UsageRights object that represents usage rights applied to the PDF document.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReaderExtensionsOptionSpec

public ReaderExtensionsOptionSpec()

ReaderExtensionsOptionSpec

public ReaderExtensionsOptionSpec(UsageRights rights,
                                  java.lang.String message)

A constructor that creates a ReaderExtensionsOptions instance.

Parameters:

rights - A UsageRights object that represents usage rights applied to the PDF document.

message - A message that the rights-enabled PDF document displays within Adobe Reader.

Method Detail

getMessage

public java.lang.String getMessage()

Returns the message that is displayed within Adobe Reader when the rights enabled PDF document is opened.

Returns:

The message that is displayed.

setMessage

public void setMessage(java.lang.String message)

Sets the message that is displayed within Adobe Reader when the rights enabled PDF document is opened.

Parameters:

message - The message that is displayed.

getUsageRights

public UsageRights getUsageRights()

Returns a UsageRights object that represents usage rights applied to the PDF document.

Returns:

A UsageRights object.

setUsageRights

public void setUsageRights(UsageRights usageRights)

Sets a UsageRights object that represents usage rights applied to the PDF document.

Parameters:

usageRights - A UsageRights object.

isModeFinal

public boolean isModeFinal()

Returns true if the mode is set to final. If true, the count of the credential used to apply usage rights to a PDF document is incremented. By default the mode is final.

Returns:

A Boolean value that specifies if the mode is set to final.

setModeFinal

public void setModeFinal(boolean modeFinal)

Sets the usage-rights mode. If the mode is set to true, the count of the credential used to apply usage rights to a PDF document is incremented. By default the mode is final.

Parameters:

modeFinal - A Boolean value that specifies if the mode is set to final.