com.aspose.pdf.facades

Class DocumentPrivilege

  • All Implemented Interfaces:
    Comparable


    public final class DocumentPrivilege
    extends Object
    implements Comparable

    Represents the privileges for accessing Pdf file. Refer toPdfFileSecurity. There are 4 ways using this class: 1.Using predefined privilege directly. 2.Based on a predefined privilege and change some specifical permissions. 3.Based on a predefined privilege and change some specifical Adobe Professional permissions combination. 4.Mixes the way2 and way3.


      //Way1: Using predefined privilege directly.
      DocumentPrivilege privilege = DocumentPrivilege.getPrint();
      //Way2: Based on a predefined privilege and change some specifical permissions.
      DocumentPrivilege privilege = DocumentPrivilege.getAllowAll();
      privilege.setAllowPrint(false);
      privilege.setAllowModifyContents(false);
      //Way3: Based on a predefined privilege and change some specifical Adobe Professional permissions combination.
      DocumentPrivilege privilege = DocumentPrivilege.getForbidAll();
      privilege.setChangeAllowLevel(1);
      privilege.setPrintAllowLevel(2);
      //Way4: Mixes the way2 and way3
      DocumentPrivilege privilege = DocumentPrivilege.getForbidAll();
      privilege.setChangeAllowLevel(1);
      privilege.setAllowPrint(true);
      
      
    • Constructor Detail

      • DocumentPrivilege

        public DocumentPrivilege(int value)
        Constructor
        Parameters:
        value - int value
    • Method Detail

      • getValue

        public int getValue()

        Gets value

        Returns:
        int value
      • isAllowPrint

        public boolean isAllowPrint()

        Sets the permission which allow print or not. true is allow and false is forbidden.

        Returns:
        boolean value
      • setAllowPrint

        public void setAllowPrint(boolean value)

        Sets the permission which allow print or not. true is allow and false is forbidden.

        Parameters:
        value - boolean value
      • isAllowDegradedPrinting

        public boolean isAllowDegradedPrinting()

        Sets the permission which allow degraded printing or not. true is allow and false is forbidden.

        Returns:
        boolean value
      • setAllowDegradedPrinting

        public void setAllowDegradedPrinting(boolean value)

        Sets the permission which allow degraded printing or not. true is allow and false is forbidden.

        Parameters:
        value - boolean value
      • isAllowModifyContents

        public boolean isAllowModifyContents()

        Sets the permission which allow modify contents or not. true is allow and false is forbidden.

        Returns:
        boolean value
      • setAllowModifyContents

        public void setAllowModifyContents(boolean value)

        Sets the permission which allow modify contents or not. true is allow and false is forbidden.

        Parameters:
        value - boolean value
      • isAllowCopy

        public boolean isAllowCopy()

        Sets the permission which allow copy or not. true is allow and false is forbidden.

        Returns:
        boolean value
      • setAllowCopy

        public void setAllowCopy(boolean value)

        Sets the permission which allow copy or not. true is allow and false is forbidden.

        Parameters:
        value - boolean value
      • isAllowModifyAnnotations

        public boolean isAllowModifyAnnotations()

        Sets the permission which allow modify annotations or not. true is allow and false is forbidden.

        Returns:
        boolean value
      • setAllowModifyAnnotations

        public void setAllowModifyAnnotations(boolean value)

        Sets the permission which allow modify annotations or not. true is allow and false is forbidden.

        Parameters:
        value - boolean value
      • isAllowFillIn

        public boolean isAllowFillIn()

        Sets the permission which allow fill in forms or not. true is allow and false is forbidden.

        Returns:
        boolean value
      • setAllowFillIn

        public void setAllowFillIn(boolean value)

        Sets the permission which allow fill in forms or not. true is allow and false is forbidden.

        Parameters:
        value - boolean value
      • isAllowScreenReaders

        public boolean isAllowScreenReaders()

        Sets the permission which allow screen readers or not. true is allow and false is forbidden.

        Returns:
        boolean value
      • setAllowScreenReaders

        public void setAllowScreenReaders(boolean value)

        Sets the permission which allow screen readers or not. true is allow and false is forbidden.

        Parameters:
        value - boolean value
      • isAllowAssembly

        public boolean isAllowAssembly()

        Sets the permission which allow assembly or not. true is allow and false is forbidden.

        Returns:
        boolean value
      • setAllowAssembly

        public void setAllowAssembly(boolean value)

        Sets the permission which allow assembly or not. true is allow and false is forbidden.

        Parameters:
        value - boolean value
      • setPrintAllowLevel

        public void setPrintAllowLevel(int value)

        Sets the print level of document's privilege. Just as the Adobe Professional's Printing Allowed settings. 0: None. 1: Low Resolution (150 dpi). 2: High Resolution.

        Parameters:
        value - int value
      • setChangeAllowLevel

        public void setChangeAllowLevel(int value)

        Sets the change level of document's privilege. Just as the Adobe Professional's Changes Allowed settings. 0: None. 1: Inserting, Deleting and Rotating pages. 2: Filling in form fields and signing existing signature fields. 3: Commenting, filling in form fields, and signing existing signature fields. 4: Any except extracting pages.

        Parameters:
        value - int value
      • setCopyAllowLevel

        public void setCopyAllowLevel(int value)

        Sets the copy level of document's privilege. Just as the Adobe Professional's permission settings. 0: None. 1: Enable text access for screen reader devices for the visually impaired. 2: Enable copying of text, images and other content.

        Parameters:
        value - int value
      • compareTo

        public int compareTo(Object obj)

        Compares two DocumentPrivilege objects.

        Specified by:
        compareTo in interface Comparable
        Parameters:
        obj - The object to compare with.
        Returns:
        A signed integer that indicates the relative values of this instance and value. Less than zero this instance is less than value. Zero this instance is equal to value. Greater than zero this instance is greater than value.
      • hashCode

        public int hashCode()
        Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

        The general contract of hashCode is:

        • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
        • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
        • It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

        As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

        Overrides:
        hashCode in class Object
        Returns:
        a hash code value for this object.
        See Also:
        Object.equals(java.lang.Object), Hashtable
      • equals

        public boolean equals(Object obj)
        Indicates whether some other object is "equal to" this one.

        The equals method implements an equivalence relation on non-null object references:

        • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
        • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
        • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
        • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
        • For any non-null reference value x, x.equals(null) should return false.

        The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

        Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

        Overrides:
        equals in class Object
        Parameters:
        obj - the reference object with which to compare.
        Returns:
        true if this object is the same as the obj argument; false otherwise.
        See Also:
        hashCode(), Hashtable
      • getDegradedPrinting

        public static DocumentPrivilege getDegradedPrinting()

        Allows degraded printing.

        Returns:
        DocumentPrivilege element
      • getPrint

        public static DocumentPrivilege getPrint()

        Allows printing file.

        Returns:
        DocumentPrivilege element
      • getModifyContents

        public static DocumentPrivilege getModifyContents()

        Allows modifying file.

        Returns:
        DocumentPrivilege element
      • getCopy

        public static DocumentPrivilege getCopy()

        Allows copying file.

        Returns:
        DocumentPrivilege element
      • getModifyAnnotations

        public static DocumentPrivilege getModifyAnnotations()

        Allows modifying annotations of file.

        Returns:
        DocumentPrivilege element
      • getFillIn

        public static DocumentPrivilege getFillIn()

        Allows filling forms in file.

        Returns:
        DocumentPrivilege element
      • getScreenReaders

        public static DocumentPrivilege getScreenReaders()

        Allows to reader on screen only.

        Returns:
        DocumentPrivilege element
      • getAssembly

        public static DocumentPrivilege getAssembly()

        Allows assemblying file.

        Returns:
        DocumentPrivilege element
      • getAllowAll

        public static DocumentPrivilege getAllowAll()

        All allowed.

        Returns:
        DocumentPrivilege element
      • getForbidAll

        public static DocumentPrivilege getForbidAll()

        All Forbidded.

        Returns:
        DocumentPrivilege element