com.foxit.sdk.pdf.CustomEncryptData Class Reference

Public Member Functions

 CustomEncryptData (boolean is_encrypt_metadata, String filter, String sub_filter)
 Constructor, with parameters.
More...
 
 CustomEncryptData ()
 Constructor.

 
 CustomEncryptData (CustomEncryptData other)
 Constructor, with another custom encrypt data object.
More...
 
String getFilter ()
 Get the filter of PDF document for encryption. More...
 
boolean getIs_encrypt_metadata ()
 Get a boolean value to decide whether to encrypt metadata or not. More...
 
String getSub_filter ()
 Get the sub filter of PDF document for encryption. More...
 
void set (boolean is_encrypt_metadata, String filter, String sub_filter)
 Set value.
More...
 
void setFilter (String value)
 Set the filter of PDF document for encryption. More...
 
void setIs_encrypt_metadata (boolean value)
 Set a boolean value to decide whether to encrypt metadata or not. More...
 
void setSub_filter (String value)
 Set the sub filter of PDF document for encryption. More...
 

Detailed Description

This class represents some data used for class CustomSecurityHandler .

Constructor & Destructor Documentation

◆ CustomEncryptData() [1/2]

com.foxit.sdk.pdf.CustomEncryptData.CustomEncryptData ( boolean  is_encrypt_metadata,
String  filter,
String  sub_filter 
)

Constructor, with parameters.

Parameters
[in]is_encrypt_metadatatrue means to encrypt metadata, and false means not to encrypt metadata.
[in]filterThe filter of PDF document for encryption. It should not be an empty string.
[in]sub_filterThe sub filter of PDF document for encryption. It should not be an empty string.

◆ CustomEncryptData() [2/2]

com.foxit.sdk.pdf.CustomEncryptData.CustomEncryptData ( CustomEncryptData  other)

Constructor, with another custom encrypt data object.

Parameters
[in]otherAnother custom encrypt data object.

Member Function Documentation

◆ getFilter()

com.foxit.sdk.pdf.CustomEncryptData.getFilter ( )

Get the filter of PDF document for encryption.

Returns
The filter of PDF document for encryption. It should not be an empty string.

◆ getIs_encrypt_metadata()

com.foxit.sdk.pdf.CustomEncryptData.getIs_encrypt_metadata ( )

Get a boolean value to decide whether to encrypt metadata or not.

Returns
A boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata, and false means not to encrypt metadata.

◆ getSub_filter()

com.foxit.sdk.pdf.CustomEncryptData.getSub_filter ( )

Get the sub filter of PDF document for encryption.

Returns
The sub filter of PDF document for encryption. It should not be an empty string.

◆ set()

void com.foxit.sdk.pdf.CustomEncryptData.set ( boolean  is_encrypt_metadata,
String  filter,
String  sub_filter 
)

Set value.

Parameters
[in]is_encrypt_metadatatrue means to encrypt metadata, and false means not to encrypt metadata.
[in]filterThe filter of PDF document for encryption. It should not be an empty string.
[in]sub_filterThe sub filter of PDF document for encryption. It should not be an empty string.
Returns
None.

◆ setFilter()

com.foxit.sdk.pdf.CustomEncryptData.setFilter ( String  value)

Set the filter of PDF document for encryption.

Parameters
[in]valueThe filter of PDF document for encryption. It should not be an empty string.
Returns
None.

◆ setIs_encrypt_metadata()

com.foxit.sdk.pdf.CustomEncryptData.setIs_encrypt_metadata ( boolean  value)

Set a boolean value to decide whether to encrypt metadata or not.

Parameters
[in]valueA boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata, and false means not to encrypt metadata.
Returns
None.

◆ setSub_filter()

com.foxit.sdk.pdf.CustomEncryptData.setSub_filter ( String  value)

Set the sub filter of PDF document for encryption.

Parameters
[in]valueThe sub filter of PDF document for encryption. It should not be an empty string.
Returns
None.