Package net.webpdf.parameter.schema.extraction.info

Class AnnotationType

  • public class AnnotationType
extends Object
     <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">An element of this type describes an Annotation placed on a page of the document.</p>

    Java class for AnnotationType complex type

    .

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

    
 <complexType name="AnnotationType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence minOccurs="0">
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="rectangle" type="{http://schema.webpdf.de/1.0/extraction/info}AnnotationRectangleType"/>
           <element name="point" type="{http://schema.webpdf.de/1.0/extraction/info}AnnotationPointType"/>
         </choice>
         <element name="markup" type="{http://schema.webpdf.de/1.0/extraction/info}MarkupType" minOccurs="0"/>
         <element name="popup" type="{http://schema.webpdf.de/1.0/extraction/info}PopupType" minOccurs="0"/>
         <element name="appearance" type="{http://schema.webpdf.de/1.0/extraction/info}AppearanceType" minOccurs="0"/>
         <element name="line" type="{http://schema.webpdf.de/1.0/extraction/info}LineType" minOccurs="0"/>
         <element name="border" type="{http://schema.webpdf.de/1.0/extraction/info}BorderStyle" minOccurs="0"/>
         <element name="drawStyle" type="{http://schema.webpdf.de/1.0/extraction/info}DrawStyleType" minOccurs="0"/>
         <element name="field" type="{http://schema.webpdf.de/1.0/extraction/info}FieldAnnotationType" minOccurs="0"/>
       </sequence>
       <attGroup ref="{http://schema.webpdf.de/1.0/extraction/info}FlagsAnnotationGroup"/>
       <attribute name="objectKey" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="subType" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="contents" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="page" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="color" type="{http://schema.webpdf.de/1.0/extraction/info}RgbColorType" default="#4800FF" />
       <attribute name="rotation" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
       <attribute name="iconName" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • objectKey

        protected String objectKey
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The object ID of the annotation.
 
                         <b>Info:</b>
                         A PDF object ID consists of two numbers, where the first number selects the object's number and the second the "generation" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.
                     </p>

      • subType

        protected String subType
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The type of an annotation is always "Annot", this is the sub type of the annotation determining the actual behavior and function of the annotation. (i.e. Text, Link, Widget etc.)</p>

      • name

        protected String name
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The annotation's name.</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         This name is optional and in the best case unique in the annotation's page context only. Don't use the name to select an annotation, always prefer selecting objects by object ID, when possible.
                     </p>

      • contents

        protected String contents
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The annotation's textual contents or (should an annotation of this type not have such contents) it's description.</p>

      • page

        protected Integer page
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The number of the page the annotation is placed on.</p>

      • color

        protected String color
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The main color of visible annotations. The color will be specified as a hexadecimal RGB value with a number sign before it.</p>

      • rotation

        protected Integer rotation
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The annotation's rotation.</p>

      • iconName

        protected String iconName
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If the annotation selects an icon (Text annotations), this is the name of that icon.</p>

      • locked

        protected Boolean locked
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the annotation will be locked so that no changes can be made to it.</p>

      • printable

        protected Boolean printable
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the annotation will be included when the page is printed out.</p>

      • rotatable

        protected Boolean rotatable
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the annotation shall be rotatable according to the displayed page rotation.</p>

      • viewable

        protected Boolean viewable
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the annotation will be shown on the document's page.</p>

      • writable

        protected Boolean writable
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, it will be possible to change the annotation's contents later on.</p>

      • zoomable

        protected Boolean zoomable
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the annotation will adjust its own zoom factor as required for the page in order to always be clearly readable / recognizable.</p>

      • invisible

        protected Boolean invisible
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the annotation will be visible on the page only when printed, and provided it is a PDF standard annotation.</p>

      • hidden

        protected Boolean hidden
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the annotation will not be shown on the page and will not be printed either.</p>

    • Constructor Detail

      • AnnotationType

        public AnnotationType()

    • Method Detail

      • getPositions

        public List<PositionsType> getPositions()
        Gets the value of the positions property.

        This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the positions property.

        For example, to add a new item, do as follows: 

         getPositions().add(newItem);

        Objects of the following type(s) are allowed in the list AnnotationPointType AnnotationRectangleType

        Returns:
        The value of the positions property.

      • getMarkup

        public MarkupType getMarkup()
        Gets the value of the markup property.
        Returns:
        possible object is MarkupType

      • setMarkup

        public void setMarkup​(MarkupType value)
        Sets the value of the markup property.
        Parameters:
        value - allowed object is MarkupType

      • getPopup

        public PopupType getPopup()
        Gets the value of the popup property.
        Returns:
        possible object is PopupType

      • setPopup

        public void setPopup​(PopupType value)
        Sets the value of the popup property.
        Parameters:
        value - allowed object is PopupType

      • getAppearance

        public AppearanceType getAppearance()
        Gets the value of the appearance property.
        Returns:
        possible object is AppearanceType

      • setAppearance

        public void setAppearance​(AppearanceType value)
        Sets the value of the appearance property.
        Parameters:
        value - allowed object is AppearanceType

      • getLine

        public LineType getLine()
        Gets the value of the line property.
        Returns:
        possible object is LineType

      • setLine

        public void setLine​(LineType value)
        Sets the value of the line property.
        Parameters:
        value - allowed object is LineType

      • getBorder

        public BorderStyle getBorder()
        Gets the value of the border property.
        Returns:
        possible object is BorderStyle

      • setBorder

        public void setBorder​(BorderStyle value)
        Sets the value of the border property.
        Parameters:
        value - allowed object is BorderStyle

      • getDrawStyle

        public DrawStyleType getDrawStyle()
        Gets the value of the drawStyle property.
        Returns:
        possible object is DrawStyleType

      • setDrawStyle

        public void setDrawStyle​(DrawStyleType value)
        Sets the value of the drawStyle property.
        Parameters:
        value - allowed object is DrawStyleType

      • getObjectKey

        public String getObjectKey()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The object ID of the annotation.
 
                         <b>Info:</b>
                         A PDF object ID consists of two numbers, where the first number selects the object's number and the second the "generation" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.
                     </p>
        Returns:
        possible object is String

      • setObjectKey

        public void setObjectKey​(String value)
        Sets the value of the objectKey property.
        Parameters:
        value - allowed object is String
        See Also:
        getObjectKey()

      • getSubType

        public String getSubType()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The type of an annotation is always "Annot", this is the sub type of the annotation determining the actual behavior and function of the annotation. (i.e. Text, Link, Widget etc.)</p>
        Returns:
        possible object is String

      • setSubType

        public void setSubType​(String value)
        Sets the value of the subType property.
        Parameters:
        value - allowed object is String
        See Also:
        getSubType()

      • getName

        public String getName()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The annotation's name.</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         This name is optional and in the best case unique in the annotation's page context only. Don't use the name to select an annotation, always prefer selecting objects by object ID, when possible.
                     </p>
        Returns:
        possible object is String

      • setName

        public void setName​(String value)
        Sets the value of the name property.
        Parameters:
        value - allowed object is String
        See Also:
        getName()

      • getContents

        public String getContents()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The annotation's textual contents or (should an annotation of this type not have such contents) it's description.</p>
        Returns:
        possible object is String

      • setContents

        public void setContents​(String value)
        Sets the value of the contents property.
        Parameters:
        value - allowed object is String
        See Also:
        getContents()

      • getPage

        public int getPage()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The number of the page the annotation is placed on.</p>
        Returns:
        possible object is Integer

      • setPage

        public void setPage​(Integer value)
        Sets the value of the page property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getPage()

      • getColor

        public String getColor()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The main color of visible annotations. The color will be specified as a hexadecimal RGB value with a number sign before it.</p>
        Returns:
        possible object is String

      • setColor

        public void setColor​(String value)
        Sets the value of the color property.
        Parameters:
        value - allowed object is String
        See Also:
        getColor()

      • getRotation

        public int getRotation()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The annotation's rotation.</p>
        Returns:
        possible object is Integer

      • setRotation

        public void setRotation​(Integer value)
        Sets the value of the rotation property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getRotation()

      • getIconName

        public String getIconName()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If the annotation selects an icon (Text annotations), this is the name of that icon.</p>
        Returns:
        possible object is String

      • setIconName

        public void setIconName​(String value)
        Sets the value of the iconName property.
        Parameters:
        value - allowed object is String
        See Also:
        getIconName()

      • isLocked

        public boolean isLocked()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the annotation will be locked so that no changes can be made to it.</p>
        Returns:
        possible object is Boolean

      • setLocked

        public void setLocked​(Boolean value)
        Sets the value of the locked property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isLocked()

      • isPrintable

        public boolean isPrintable()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the annotation will be included when the page is printed out.</p>
        Returns:
        possible object is Boolean

      • setPrintable

        public void setPrintable​(Boolean value)
        Sets the value of the printable property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isPrintable()

      • isRotatable

        public boolean isRotatable()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the annotation shall be rotatable according to the displayed page rotation.</p>
        Returns:
        possible object is Boolean

      • setRotatable

        public void setRotatable​(Boolean value)
        Sets the value of the rotatable property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isRotatable()

      • isViewable

        public boolean isViewable()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the annotation will be shown on the document's page.</p>
        Returns:
        possible object is Boolean

      • setViewable

        public void setViewable​(Boolean value)
        Sets the value of the viewable property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isViewable()

      • isWritable

        public boolean isWritable()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, it will be possible to change the annotation's contents later on.</p>
        Returns:
        possible object is Boolean

      • setWritable

        public void setWritable​(Boolean value)
        Sets the value of the writable property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isWritable()

      • isZoomable

        public boolean isZoomable()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the annotation will adjust its own zoom factor as required for the page in order to always be clearly readable / recognizable.</p>
        Returns:
        possible object is Boolean

      • setZoomable

        public void setZoomable​(Boolean value)
        Sets the value of the zoomable property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isZoomable()

      • isInvisible

        public boolean isInvisible()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the annotation will be visible on the page only when printed, and provided it is a PDF standard annotation.</p>
        Returns:
        possible object is Boolean

      • setInvisible

        public void setInvisible​(Boolean value)
        Sets the value of the invisible property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isInvisible()

      • isHidden

        public boolean isHidden()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the annotation will not be shown on the page and will not be printed either.</p>
        Returns:
        possible object is Boolean

      • setHidden

        public void setHidden​(Boolean value)
        Sets the value of the hidden property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isHidden()