Class AnnotationType

  • All Implemented Interfaces:
    ParameterInterface

    public class AnnotationType
    extends BaseToolboxType
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p443889_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p538622_="https://jakarta.ee/xml/ns/jaxb" xmlns:p701498_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The annotation operation can be used to remove, edit or add markup annotations of/to a document.</p>
     

    Java class for AnnotationType complex type

    .

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

    
     <complexType name="AnnotationType">
       <complexContent>
         <extension base="{http://schema.webpdf.de/1.0/operation}BaseToolboxType">
           <choice>
             <element name="add" minOccurs="0">
               <complexType>
                 <complexContent>
                   <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                     <choice maxOccurs="unbounded">
                       <element name="text" type="{http://schema.webpdf.de/1.0/operation}TextAnnotationType"/>
                       <element name="markup" type="{http://schema.webpdf.de/1.0/operation}MarkupAnnotationType"/>
                       <element name="redact" type="{http://schema.webpdf.de/1.0/operation}RedactAnnotationType"/>
                       <element name="freetext" type="{http://schema.webpdf.de/1.0/operation}FreeTextAnnotationType"/>
                       <element name="rubberstamp" type="{http://schema.webpdf.de/1.0/operation}RubberStampAnnotationType"/>
                       <element name="circle" type="{http://schema.webpdf.de/1.0/operation}CircleAnnotationType"/>
                       <element name="square" type="{http://schema.webpdf.de/1.0/operation}SquareAnnotationType"/>
                       <element name="line" type="{http://schema.webpdf.de/1.0/operation}LineAnnotationType"/>
                     </choice>
                   </restriction>
                 </complexContent>
               </complexType>
             </element>
             <element name="remove" minOccurs="0">
               <complexType>
                 <complexContent>
                   <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                     <all>
                       <element name="selection">
                         <complexType>
                           <complexContent>
                             <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                               <choice maxOccurs="unbounded" minOccurs="0">
                                 <element name="select" type="{http://schema.webpdf.de/1.0/operation}SelectionAnnotationType"/>
                               </choice>
                             </restriction>
                           </complexContent>
                         </complexType>
                       </element>
                     </all>
                   </restriction>
                 </complexContent>
               </complexType>
             </element>
             <element name="edit" minOccurs="0">
               <complexType>
                 <complexContent>
                   <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                     <all>
                       <element name="selection">
                         <complexType>
                           <complexContent>
                             <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                               <choice maxOccurs="unbounded" minOccurs="0">
                                 <element name="select" type="{http://schema.webpdf.de/1.0/operation}SelectionAnnotationType"/>
                               </choice>
                             </restriction>
                           </complexContent>
                         </complexType>
                       </element>
                       <element name="text" type="{http://schema.webpdf.de/1.0/operation}TextAnnotationType" minOccurs="0"/>
                       <element name="markup" type="{http://schema.webpdf.de/1.0/operation}MarkupAnnotationType" minOccurs="0"/>
                       <element name="redact" type="{http://schema.webpdf.de/1.0/operation}RedactAnnotationType" minOccurs="0"/>
                       <element name="freetext" type="{http://schema.webpdf.de/1.0/operation}FreeTextAnnotationType" minOccurs="0"/>
                       <element name="rubberstamp" type="{http://schema.webpdf.de/1.0/operation}RubberStampAnnotationType" minOccurs="0"/>
                       <element name="circle" type="{http://schema.webpdf.de/1.0/operation}CircleAnnotationType" minOccurs="0"/>
                       <element name="square" type="{http://schema.webpdf.de/1.0/operation}SquareAnnotationType" minOccurs="0"/>
                       <element name="line" type="{http://schema.webpdf.de/1.0/operation}LineAnnotationType" minOccurs="0"/>
                     </all>
                   </restriction>
                 </complexContent>
               </complexType>
             </element>
             <element name="clear" minOccurs="0">
               <complexType>
                 <complexContent>
                   <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                     <attribute name="pages" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
                     <attribute name="flatten" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
                   </restriction>
                 </complexContent>
               </complexType>
             </element>
             <element name="comment" minOccurs="0">
               <complexType>
                 <complexContent>
                   <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                     <choice minOccurs="0">
                       <element name="add">
                         <complexType>
                           <complexContent>
                             <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                               <choice maxOccurs="unbounded">
                                 <element name="replyTo" type="{http://schema.webpdf.de/1.0/operation}ReplyToAnnotationType"/>
                                 <element name="changeAnnotationState" type="{http://schema.webpdf.de/1.0/operation}ReplyStateAnnotationType"/>
                                 <element name="markAnnotation" type="{http://schema.webpdf.de/1.0/operation}MarkedStateAnnotationType"/>
                               </choice>
                             </restriction>
                           </complexContent>
                         </complexType>
                       </element>
                       <element name="edit">
                         <complexType>
                           <complexContent>
                             <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                               <choice maxOccurs="unbounded">
                                 <element name="replyTo" type="{http://schema.webpdf.de/1.0/operation}ReplyToAnnotationEditType"/>
                               </choice>
                             </restriction>
                           </complexContent>
                         </complexType>
                       </element>
                     </choice>
                   </restriction>
                 </complexContent>
               </complexType>
             </element>
           </choice>
         </extension>
       </complexContent>
     </complexType>
     
    • Field Detail

      • add

        protected AnnotationType.Add add
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p443889_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p538622_="https://jakarta.ee/xml/ns/jaxb" xmlns:p701498_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The add element can be used to define one or multiple annotations, that shall be added to the document.</p>
         
      • remove

        protected AnnotationType.Remove remove
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p443889_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p538622_="https://jakarta.ee/xml/ns/jaxb" xmlns:p701498_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to select annotations for removal.</p>
         
      • edit

        protected AnnotationType.Edit edit
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p443889_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p538622_="https://jakarta.ee/xml/ns/jaxb" xmlns:p701498_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to change properties of selected, already existing annotations.</p>
         
      • clear

        protected AnnotationType.Clear clear
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p443889_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p538622_="https://jakarta.ee/xml/ns/jaxb" xmlns:p701498_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to remove the annotations of the selected pages.</p>
         
      • comment

        protected AnnotationType.Comment comment
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p443889_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p538622_="https://jakarta.ee/xml/ns/jaxb" xmlns:p701498_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to add/edit comment/replies to and of existing annotations.</p>
         
    • Constructor Detail

      • AnnotationType

        public AnnotationType()
    • Method Detail

      • getAdd

        public AnnotationType.Add getAdd()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p443889_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p538622_="https://jakarta.ee/xml/ns/jaxb" xmlns:p701498_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The add element can be used to define one or multiple annotations, that shall be added to the document.</p>
         
        Returns:
        possible object is AnnotationType.Add
      • isSetAdd

        public boolean isSetAdd()
      • getRemove

        public AnnotationType.Remove getRemove()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p443889_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p538622_="https://jakarta.ee/xml/ns/jaxb" xmlns:p701498_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to select annotations for removal.</p>
         
        Returns:
        possible object is AnnotationType.Remove
      • isSetRemove

        public boolean isSetRemove()
      • getEdit

        public AnnotationType.Edit getEdit()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p443889_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p538622_="https://jakarta.ee/xml/ns/jaxb" xmlns:p701498_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to change properties of selected, already existing annotations.</p>
         
        Returns:
        possible object is AnnotationType.Edit
      • isSetEdit

        public boolean isSetEdit()
      • getClear

        public AnnotationType.Clear getClear()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p443889_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p538622_="https://jakarta.ee/xml/ns/jaxb" xmlns:p701498_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to remove the annotations of the selected pages.</p>
         
        Returns:
        possible object is AnnotationType.Clear
      • isSetClear

        public boolean isSetClear()
      • getComment

        public AnnotationType.Comment getComment()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p443889_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p538622_="https://jakarta.ee/xml/ns/jaxb" xmlns:p701498_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to add/edit comment/replies to and of existing annotations.</p>
         
        Returns:
        possible object is AnnotationType.Comment
      • isSetComment

        public boolean isSetComment()