com.itextpdf.kernel.pdf.annot Documentation Differences

iText7 7.1.8 Overview Package Class Text Changes Statistics Help
Generated by
JDiff
PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
com.itextpdf.kernel.pdf.annot Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.kernel.pdf.annot as colored differences. Deletions are shown ~~like this~~ , and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a tag will cause all subsequent paragraphs to be displayed differently.
 
  
 Class PdfAnnotation, void addAssociatedFile(PdfFileSpec) 
  
 
  
 
   
    Adds file associated with PDF annotation and identifies the relationship between them.  
     
    Associated files may be used in Pdf/A-3 and Pdf 2.0 documents. The method adds file to array value of the AF key in the annotation dictionary.  
     
    For associated files their associated file specification dictionaries shall include the AFRelationship 
      key 
    key  @param fs file specification dictionary of associated file 
  
 Class PdfAnnotation, PdfArray getBorder() 
  
 
  
 
    
   An array specifying the characteristics of the annotation#s border. The array consists of three numbers defining the horizontal corner radius, vertical corner radius, and border width, all in default user space units. If the corner radii are 0, the border has square (not rounded) corners; if the border width is 0, no border is drawn. 
    The array may have a fourth element, an optional dash array (see ISO-320001 8.4.3.6, "Line Dash Pattern"). @return an PdfArray specifying the characteristics of the annotation#s border. 
  
 Class PdfAnnotation, PdfArray getColorObject() 
  
 
  
 
  
    An array of numbers in the range 0.0 to 1.0, representing a colour used for the following purposes: 
    
    The background of the annotation#s icon when 
       closed 
     closed   
    The title bar of the annotation#s pop-up 
       window 
     window   
    The border of a link 
       annotation 
     annotation   
    The number of array elements determines the colour space in which the colour shall be defined: 
    
    0 - No colour; 
       transparent 
     transparent   
    1 - 
       DeviceGray 
     DeviceGray   
    3 - 
       DeviceRGB 
     DeviceRGB   
    4 - 
       DeviceCMYK 
     DeviceCMYK   
    @return An array of numbers in the range 0.0 to 1.0, representing an annotation colour. 
  
 Class PdfAnnotation, PdfAnnotation setFlag(int) 
  
 
  
 
  
    Sets a flag that specifies a characteristic of the annotation to enabled state (see ISO-320001 12.5.3, "Annotation Flags"). On the contrary from PdfAnnotation.setFlags(int), this method sets only specified flags to enabled state, but doesn't disable other flags. Possible flags: 
    
    PdfAnnotation.INVISIBLE - If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such unknown annotation using an appearance stream specified by its appearance dictionary, if any. 
        
    PdfAnnotation.HIDDEN - If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available. 
        
    PdfAnnotation.PRINT - If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen. 
        
    PdfAnnotation.NO_ZOOM - If set, do not scale the annotation#s appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper-left corner of its annotation rectangle) shall remain fixed, regardless of the page magnification.} 
        
    PdfAnnotation.NO_ROTATE - If set, do not rotate the annotation#s appearance to match the rotation of the page. The upper-left corner of the annotation rectangle shall remain in a fixed location on the page, regardless of the page rotation. 
        
    PdfAnnotation.NO_VIEW - If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction. 
        
    PdfAnnotation.READ_ONLY - If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse clicks or change its appearance in response to mouse motions. 
        
    PdfAnnotation.LOCKED - If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation#s contents, such as the value of a form field. 
        
    PdfAnnotation.TOGGLE_NO_VIEW - If set, invert the interpretation of the NoView flag for certain events. 
        
    PdfAnnotation.LOCKED_CONTENTS - If set, do not allow the contents of the annotation to be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size. 
        
   
 @param flag - an integer interpreted as set of one-bit flags which will be enabled for this annotation. @return this PdfAnnotation instance. 
   
  
 Class PdfCircleAnnotation, PdfCircleAnnotation setBorderStyle(PdfName) 
  
 
  
 
  
    Setter for the annotation's preset border style. Possible values are 
    
    PdfAnnotation.STYLE_SOLID - A solid rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_DASHED - A dashed rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_BEVELED - A simulated embossed rectangle that appears to be raised above the surface of the page.  
    PdfAnnotation.STYLE_INSET - A simulated engraved rectangle that appears to be recessed below the surface of the page.  
    PdfAnnotation.STYLE_UNDERLINE - A single line along the bottom of the annotation rectangle.  
   
 See also ISO-320001, Table 166. @param style The new value for the annotation's border style. @return this PdfCircleAnnotation instance. @see #getBorderStyle() 
   
  
 Class PdfFileAttachmentAnnotation, PdfFileAttachmentAnnotation setIconName(PdfName) 
  
 
  
 
  
    The name of an icon that is used in displaying the annotation. @param name a PdfName that specifies the icon for displaying annotation. Possible values are different for different annotation types: 
    
     
       GraphPushPin 
     GraphPushPin   
     
       PaperclipTag 
     PaperclipTag   
   
 Additional names may be supported as well. @return this PdfFileAttachmentAnnotation instance. 
   
  
 Class PdfFreeTextAnnotation, PdfFreeTextAnnotation setBorderStyle(PdfName) 
  
 
  
 
  
    Setter for the annotation's preset border style. Possible values are 
    
    PdfAnnotation.STYLE_SOLID - A solid rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_DASHED - A dashed rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_BEVELED - A simulated embossed rectangle that appears to be raised above the surface of the page.  
    PdfAnnotation.STYLE_INSET - A simulated engraved rectangle that appears to be recessed below the surface of the page.  
    PdfAnnotation.STYLE_UNDERLINE - A single line along the bottom of the annotation rectangle.  
   
 See also ISO-320001, Table 166. @param style The new value for the annotation's border style. @return this PdfFreeTextAnnotation instance. @see #getBorderStyle() 
   
  
 Class PdfInkAnnotation, PdfInkAnnotation setBorderStyle(PdfName) 
  
 
  
 
  
    Setter for the annotation's preset border style. Possible values are 
    
    PdfAnnotation.STYLE_SOLID - A solid rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_DASHED - A dashed rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_BEVELED - A simulated embossed rectangle that appears to be raised above the surface of the page.  
    PdfAnnotation.STYLE_INSET - A simulated engraved rectangle that appears to be recessed below the surface of the page.  
    PdfAnnotation.STYLE_UNDERLINE - A single line along the bottom of the annotation rectangle.  
   
 See also ISO-320001, Table 166. @param style The new value for the annotation's border style. @return this PdfInkAnnotation instance. @see #getBorderStyle() 
   
  
 Class PdfLineAnnotation, PdfLineAnnotation setBorderStyle(PdfName) 
  
 
  
 
  
    Setter for the annotation's preset border style. Possible values are 
    
    PdfAnnotation.STYLE_SOLID - A solid rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_DASHED - A dashed rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_BEVELED - A simulated embossed rectangle that appears to be raised above the surface of the page.  
    PdfAnnotation.STYLE_INSET - A simulated engraved rectangle that appears to be recessed below the surface of the page.  
    PdfAnnotation.STYLE_UNDERLINE - A single line along the bottom of the annotation rectangle.  
   
 See also ISO-320001, Table 166. @param style The new value for the annotation's border style. @return this PdfLineAnnotation instance. @see #getBorderStyle() 
  
 Class PdfLineAnnotation, PdfLineAnnotation setLineEndingStyles(PdfArray) 
  
 
  
 
  
    Sets the line ending styles that are used in drawing the line. The first and second elements of the array shall specify the line ending styles for the endpoints defined, respectively, by the first and second pairs of coordinates, (x1, y1) and (x2, y2), in the PdfName.L array (see .getLine(). Possible values for styles are: 
    
    PdfName.Square - A square filled with the annotation's interior color, if any; 
       
    PdfName.Circle - A circle filled with the annotation's interior color, if any; 
       
    PdfName.Diamond - A diamond shape filled with the annotation's interior color, if any; 
       
    PdfName.OpenArrow - Two short lines meeting in an acute angle to form an open arrowhead; 
       
    PdfName.ClosedArrow - Two short lines meeting in an acute angle as in the PdfName.OpenArrow style and connected by a third line to form a triangular closed arrowhead filled with the annotation's interior color, if any; 
       
    PdfName.None - No line ending; 
       
    PdfName.Butt - A short line at the endpoint perpendicular to the line itself; 
       
    PdfName.ROpenArrow - Two short lines in the reverse direction from PdfName.OpenArrow; 
       
    PdfName.RClosedArrow - A triangular closed arrowhead in the reverse direction from PdfName.ClosedArrow; 
       
    PdfName.Slash - A short line at the endpoint approximately 30 degrees clockwise from perpendicular to the line itself; 
       
   
 see also ISO-320001, Table 176 "Line ending styles". @param lineEndingStyles An array of two names specifying the line ending styles that is used in drawing the line. @return this PdfLineAnnotation instance. 
   
  
 Class PdfLinkAnnotation, PdfLinkAnnotation setBorderStyle(PdfName) 
  
 
  
 
  
    Setter for the annotation's preset border style. Possible values are 
    
    PdfAnnotation.STYLE_SOLID - A solid rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_DASHED - A dashed rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_BEVELED - A simulated embossed rectangle that appears to be raised above the surface of the page.  
    PdfAnnotation.STYLE_INSET - A simulated engraved rectangle that appears to be recessed below the surface of the page.  
    PdfAnnotation.STYLE_UNDERLINE - A single line along the bottom of the annotation rectangle.  
   
 See also ISO-320001, Table 166. @param style The new value for the annotation's border style. @return this PdfLinkAnnotation instance. @see #getBorderStyle() 
   
  
 Class PdfMarkupAnnotation, PdfDictionary getExternalData() 
  
 
  
 
  
    An external data dictionary specifying data that shall be associated with the annotation. This dictionary contains the following entries: 
    
    PdfName.Type - (optional) If present, shall be PdfName.ExData.  
    PdfName.Subtype - (required) a name specifying the type of data that the markup annotation shall be associated with. The only defined value is PdfName.Markup3D. Table 298 (ISO-320001) lists the values that correspond to a subtype of Markup3D (See also Pdf3DAnnotation).  
   
 @return An external data PdfDictionary, or null if not specified. 
  
 Class PdfMarkupAnnotation, PdfName getReplyType() 
  
 
  
 
  
    A name specifying the relationship (the "reply type") between this annotation and one specified by IRT entry (see .getInReplyTo()). Valid values are: 
    
    PdfName.R - The annotation shall be considered a reply to the annotation specified by IRT. Conforming readers shall not display replies to an annotation individually but together in the form of threaded comments.  
    PdfName.Group - The annotation shall be grouped with the annotation specified by IRT.  
   
 @return a PdfName specifying relationship with the specified by the IRT entry; or null if reply type is not specified, in this case the default value is PdfName.R. 
  
 Class PdfMarkupAnnotation, PdfMarkupAnnotation setExternalData(PdfName) 
  
 
  
 
  
    Sets an external data dictionary specifying data that shall be associated with the annotation. This dictionary should contain the following entries: 
    
    PdfName.Type - (optional) If present, shall be PdfName.ExData.  
    PdfName.Subtype - (required) a name specifying the type of data that the markup annotation shall be associated with. The only defined value is PdfName.Markup3D. Table 298 (ISO-320001) lists the values that correspond to a subtype of Markup3D (See also Pdf3DAnnotation).  
   
 @return this PdfMarkupAnnotation instance. 
  
 Class PdfMarkupAnnotation, PdfMarkupAnnotation setIntent(PdfName) 
  
 
  
 
  
    Sets a name describing the intent of the markup annotation. Intents allow conforming readers to distinguish between different uses and behaviors of a single markup annotation type. If this entry is not present or its value is the same as the annotation type, the annotation shall have no explicit intent and should behave in a generic manner in a conforming reader. 
    See ISO-320001, free text annotations (Table 174), line annotations (Table 175), polygon annotations (Table 178), and polyline annotations (Table 178) for the specific intent values for those types. 
      @param intent a PdfName describing the intent of the markup annotation. @return this PdfMarkupAnnotation instance. 
   
  
 Class PdfPolyGeomAnnotation, PdfPolyGeomAnnotation setBorderStyle(PdfName) 
  
 
  
 
  
    Setter for the annotation's preset border style. Possible values are 
    
    PdfAnnotation.STYLE_SOLID - A solid rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_DASHED - A dashed rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_BEVELED - A simulated embossed rectangle that appears to be raised above the surface of the page.  
    PdfAnnotation.STYLE_INSET - A simulated engraved rectangle that appears to be recessed below the surface of the page.  
    PdfAnnotation.STYLE_UNDERLINE - A single line along the bottom of the annotation rectangle.  
   
 See also ISO-320001, Table 166. @param style The new value for the annotation's border style. @return this PdfPolyGeomAnnotation instance. @see #getBorderStyle() 
  
 Class PdfPolyGeomAnnotation, PdfName Polygon 
  
 
  
 
   
     Subtypes 
   @deprecated , use PdfName.Polygon instead. 
   
  
 Class PdfSoundAnnotation, PdfSoundAnnotation setIconName(PdfName) 
  
 
  
 
  
    The name of an icon that is used in displaying the annotation. @param name a PdfName that specifies the icon for displaying annotation. Possible values are different for different annotation types: 
    
     
       Speaker 
     Speaker   
     
       Mic 
     Mic   
   
 Additional names may be supported as well. @return this PdfSoundAnnotation instance. 
   
  
 Class PdfSquareAnnotation, PdfSquareAnnotation setBorderStyle(PdfName) 
  
 
  
 
  
    Setter for the annotation's preset border style. Possible values are 
    
    PdfAnnotation.STYLE_SOLID - A solid rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_DASHED - A dashed rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_BEVELED - A simulated embossed rectangle that appears to be raised above the surface of the page.  
    PdfAnnotation.STYLE_INSET - A simulated engraved rectangle that appears to be recessed below the surface of the page.  
    PdfAnnotation.STYLE_UNDERLINE - A single line along the bottom of the annotation rectangle.  
   
 See also ISO-320001, Table 166. @param style The new value for the annotation's border style. @return this PdfSquareAnnotation instance. @see #getBorderStyle() 
   
  
 Class PdfStampAnnotation, PdfName getIconName() 
  
 
  
 
  
    The name of an icon that is used in displaying the annotation. Possible values are described in .setIconName(PdfName). 
     @return a PdfName that specifies the icon for displaying annotation, or null if icon name is not specified. 
  
 Class PdfStampAnnotation, PdfStampAnnotation setIconName(PdfName) 
  
 
  
 
  
    The name of an icon that is used in displaying the annotation. @param name a PdfName that specifies the icon for displaying annotation. Possible values are: 
    
     
       Approved 
     Approved   
     
       Experimental 
     Experimental   
     
       NotApproved 
     NotApproved   
     
       AsIs 
     AsIs   
     
       Expired 
     Expired   
     
       NotForPublicRelease 
     NotForPublicRelease   
     
       Confidential 
     Confidential   
     
       Final 
     Final   
     
       Sold 
     Sold   
     
       Departmental 
     Departmental   
     
       ForComment 
     ForComment   
     
       TopSecret 
     TopSecret   
     
       Draft 
     Draft   
    ForPublicRelease.  
   
 @return this PdfStampAnnotation instance. 
   
  
 Class PdfTextAnnotation, PdfTextAnnotation setIconName(PdfName) 
  
 
  
 
  
    The name of an icon that is used in displaying the annotation. @param name a PdfName that specifies the icon for displaying annotation. Possible values are: 
    
     
       Comment 
     Comment   
     
       Key 
     Key   
     
       Note 
     Note   
     
       Help 
     Help   
     
       NewParagraph 
     NewParagraph   
     
       Paragraph 
     Paragraph   
     
       Insert 
     Insert   
   
 @return this PdfTextAnnotation instance. 
   
  
 Class PdfTrapNetworkAnnotation, PdfTrapNetworkAnnotation setVersion(PdfArray) 
  
 
  
 
  
    An unordered array of all objects present in the page description at the time the trap networks were generated and that, if changed, could affect the appearance of the page. 
     
    This entry is required if /AnnotStates (.getAnnotStates()) is present; shall be absent if /LastModified (.getLastModified()) is present. @param version an unordered PdfArray of all objects present in the page description at the time the trap networks were generated. If present, the array shall include the following objects:  
    
    all page content streams;  
    all page resource objects (other than procedure sets);  
    all resource objects (other than procedure sets) of any form XObjects on the page;  
    all OPI dictionaries associated with XObjects on the page (see ISO-320001 14.11.7, "Open Prepress Interface (OPI)")  
   
 @return this PdfTrapNetworkAnnotation instance. 
   
  
 Class PdfWidgetAnnotation, PdfWidgetAnnotation setBorderStyle(PdfName) 
  
 
  
 
  
    Setter for the annotation's preset border style. Possible values are 
    
    PdfAnnotation.STYLE_SOLID - A solid rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_DASHED - A dashed rectangle surrounding the annotation.  
    PdfAnnotation.STYLE_BEVELED - A simulated embossed rectangle that appears to be raised above the surface of the page.  
    PdfAnnotation.STYLE_INSET - A simulated engraved rectangle that appears to be recessed below the surface of the page.  
    PdfAnnotation.STYLE_UNDERLINE - A single line along the bottom of the annotation rectangle.  
   
 See also ISO-320001, Table 166. @param style The new value for the annotation's border style. @return this PdfWidgetAnnotation instance. @see #getBorderStyle() 
  
 Class PdfWidgetAnnotation, PdfWidgetAnnotation setHighlightMode(PdfName) 
  
 
  
 
  
    Setter for the annotation's highlighting mode. Possible values are 
    
    PdfAnnotation.HIGHLIGHT_NONE - No highlighting.  
    PdfAnnotation.HIGHLIGHT_INVERT - Invert the contents of the annotation rectangle.  
    PdfAnnotation.HIGHLIGHT_OUTLINE - Invert the annotation's border.  
    PdfAnnotation.HIGHLIGHT_PUSH - Display the annotation?s down appearance, if any.  
    PdfAnnotation.HIGHLIGHT_TOGGLE - Same as P.  
    @param mode The new value for the annotation's highlighting mode. @return The widget annotation which this method was called on.