com.itextpdf.kernel.pdf.tagging 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.tagging Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.kernel.pdf.tagging 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 PdfNamespace 
  
 
  
 
  
    A wrapper for namespace dictionaries (ISO 32000-2 section 14.7.4). A namespace dictionary defines a namespace within the structure tree. 
     
    This pdf entity is meaningful only for the PDF documents of version 2.0 and higher. 
   
  
 Class PdfStructElem, void addAssociatedFile(PdfFileSpec) 
  
 
  
 
   
    Adds file associated with structure element 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 structure element dictionary.  
     
    For associated files their associated file specification dictionaries shall include the AFRelationship 
      key 
    key  @param fs file specification dictionary of associated file 
  
 Class PdfStructElem, void addAssociatedFile(String, PdfFileSpec) 
  
 
  
 
    
   Adds file associated with structure element 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 structure element dictionary. If description is provided, it also will add file description to catalog Names tree.  
     
    For associated files their associated file specification dictionaries shall include the AFRelationship 
      key 
    key  @param description the file description @param fs file specification dictionary of associated file 
  
 Class PdfStructElem, void addRef(PdfStructElem) 
  
 
  
 
  
    A PdfName.Ref identifies the structure element to which the item of content, contained within this structure element, refers (e.g. footnotes, endnotes, sidebars, etc.). 
    This value has meaning only for the PDF documents of version 2.0 and higher. @param ref a PdfStructElem to which the item of content, contained within this structure element, refers. 
  
 Class PdfStructElem, void setNamespace(PdfNamespace) 
  
 
  
 
  
    A namespace this element belongs to (see ISO 32000-2 14.7.4, "Namespaces"). 
    This value has meaning only for the PDF documents of version 2.0 and higher. @param namespace a PdfNamespace this element belongs to, or null if element is desired to be considered in the default standard structure namespace. 
  
 Class PdfStructElem, void setPhoneme(PdfString) 
  
 
  
 
  
    Attribute for a structure element that may be used as pronunciation hint. It is an exact replacement for content enclosed by the structure element and its children. 
    This value has meaning only for the PDF documents of version 2.0 and higher. @param elementPhoneme a PdfString which defines an exact replacement for content enclosed by the structure element and its children. This value is to be interpreted based on the PhoneticAlphabet attribute in effect. 
  
 Class PdfStructElem, void setPhoneticAlphabet(PdfName) 
  
 
  
 
  
    Attribute for a structure element that indicates the phonetic alphabet used by a PdfName.Phoneme attribute. Applies to the structure element and its children, except where overridden by a child structure element. 
    This value has meaning only for the PDF documents of version 2.0 and higher. @param phoneticAlphabet the PdfName which defines phonetic alphabet used by a PdfName.Phoneme attribute. Possible values are:  
    
    PdfName.ipa for the International Phonetic Alphabet by the International Phonetic Association;  
    PdfName.x_sampa for Extended Speech Assessment Methods Phonetic Alphabet (X-SAMPA);  
    PdfName.zh_Latn_pinyin for Pinyin Latin romanization (Mandarin);  
    PdfName.zh_Latn_wadegile for Wade-Giles romanization (Mandarin).  
    Other values may be used. 
   
  
 Class PdfStructTreeRoot, void addAssociatedFile(PdfFileSpec) 
  
 
  
 
   
    Adds file associated with structure tree root 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 structure tree root dictionary.  
     
    For associated files their associated file specification dictionaries shall include the AFRelationship 
      key 
    key  @param fs file specification dictionary of associated file 
  
 Class PdfStructTreeRoot, void addAssociatedFile(String, PdfFileSpec) 
  
 
  
 
    
   Adds file associated with structure tree root 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 structure tree root dictionary. If description is provided, it also will add file description to catalog Names tree.  
     
    For associated files their associated file specification dictionaries shall include the AFRelationship 
      key 
    key  @param description the file description @param fs file specification dictionary of associated file 
  
 Class PdfStructTreeRoot, void addNamespace(PdfNamespace) 
  
 
  
 
  
    Adds a PdfNamespace to the list of the namespaces used within the document. 
    This value has meaning only for the PDF documents of version 2.0 and higher. @param namespace a PdfNamespace to be added. 
  
 Class PdfStructTreeRoot, void addPronunciationLexicon(PdfFileSpec) 
  
 
  
 
  
    Adds a single PdfFileSpec object, which specifies XML file conforming to PLS. For more info see .getPronunciationLexiconsList(). 
    This value has meaning only for the PDF documents of version 2.0 and higher. @param pronunciationLexiconFileSpec a PdfFileSpec object, which specifies XML file conforming to PLS. 
   
  
 Class StandardNamespaces 
  
 
  
 
  
    This class encapsulates information about the standard structure namespaces and provides some utility methods connected to them. The main purpose of this class is to determine if the given role in the specified namespace belongs to the standard or known domain-specific namespace. 
     
    See ISO 32000-2 14.8.6, "Standard structure namespaces"