Package net.webpdf.wsclient.schema.operation

Class BlackenType

  • public class BlackenType
extends Object
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this element is set, all redact annotations placed in the document will be converted into actual content redactions. Content obscured by such an annotation will be irretrievably removed from the page content.</p>

    Java class for BlackenType complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
 <complexType name="BlackenType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="collisionRatio" default="30">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <maxInclusive value="100"/>
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="redactTexts" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="redactImages" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="redactAnnotations" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="redactPaths" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • collisionRatio

        protected Integer collisionRatio
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies a percentage value by which a letter must be obscured at least to be considered blackened and thus removed.</p>

      • redactTexts

        protected Boolean redactTexts
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to "true", all texts are blackened letter by letter.</p>

      • redactImages

        protected Boolean redactImages
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, all blackened image data will be removed. For images, the entire image is not removed, but the obscured area is replaced by the redaction.</p>

      • redactAnnotations

        protected Boolean redactAnnotations
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to "true", all blackened annotations will be removed. Annotations are removed completely even if they are only truncated.</p>

      • redactPaths

        protected Boolean redactPaths
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, all blackened character paths are removed. The paths are adjusted so that the blackened section is removed from the path construction.</p>

    • Constructor Detail

      • BlackenType

        public BlackenType()

    • Method Detail

      • getCollisionRatio

        public int getCollisionRatio()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies a percentage value by which a letter must be obscured at least to be considered blackened and thus removed.</p>
        Returns:
        possible object is Integer

      • setCollisionRatio

        public void setCollisionRatio​(int value)
        Sets the value of the collisionRatio property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getCollisionRatio()

      • isSetCollisionRatio

        public boolean isSetCollisionRatio()

      • unsetCollisionRatio

        public void unsetCollisionRatio()

      • isRedactTexts

        public boolean isRedactTexts()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to "true", all texts are blackened letter by letter.</p>
        Returns:
        possible object is Boolean

      • setRedactTexts

        public void setRedactTexts​(boolean value)
        Sets the value of the redactTexts property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isRedactTexts()

      • isSetRedactTexts

        public boolean isSetRedactTexts()

      • unsetRedactTexts

        public void unsetRedactTexts()

      • isRedactImages

        public boolean isRedactImages()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, all blackened image data will be removed. For images, the entire image is not removed, but the obscured area is replaced by the redaction.</p>
        Returns:
        possible object is Boolean

      • setRedactImages

        public void setRedactImages​(boolean value)
        Sets the value of the redactImages property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isRedactImages()

      • isSetRedactImages

        public boolean isSetRedactImages()

      • unsetRedactImages

        public void unsetRedactImages()

      • isRedactAnnotations

        public boolean isRedactAnnotations()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to "true", all blackened annotations will be removed. Annotations are removed completely even if they are only truncated.</p>
        Returns:
        possible object is Boolean

      • setRedactAnnotations

        public void setRedactAnnotations​(boolean value)
        Sets the value of the redactAnnotations property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isRedactAnnotations()

      • isSetRedactAnnotations

        public boolean isSetRedactAnnotations()

      • unsetRedactAnnotations

        public void unsetRedactAnnotations()

      • isRedactPaths

        public boolean isRedactPaths()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, all blackened character paths are removed. The paths are adjusted so that the blackened section is removed from the path construction.</p>
        Returns:
        possible object is Boolean

      • setRedactPaths

        public void setRedactPaths​(boolean value)
        Sets the value of the redactPaths property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isRedactPaths()

      • isSetRedactPaths

        public boolean isSetRedactPaths()

      • unsetRedactPaths

        public void unsetRedactPaths()