com.itextpdf.kernel.pdf.tagutils Documentation Differences

iText7 7.1.12 Overview Package Class Text Changes Statistics Help

Generated by
JDiff

PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES

com.itextpdf.kernel.pdf.tagutils Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.kernel.pdf.tagutils 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 TagStructureContext, TagStructureContext flushPageTags(PdfPage) 
  
 
  
 
  
    Flushes the tags which are considered to belong to the given page. The logic that defines if the given tag (structure element) belongs to the page is the following: if all the marked content references (dictionary or number references), that are the descendants of the given structure element, belong to the current page - the tag is considered to belong to the page. If tag has descendants from several pages - it is flushed, if all other pages except the current one are flushed. 
   
 
   
 If some of the page's tags have waiting state (see WaitingTagsManager these tags are considered as not yet finished ones, and they and their children won't be flushed. 
     @param page a page which tags will be 
     flushed. 
   flushed @return current TagStructureContext instance 
  
 Class TagStructureContext, TagTreePointer removeAnnotationTag(PdfAnnotation) 
  
 
  
 
  
    Removes annotation content item from the tag structure. If annotation is not added to the document or is not tagged, nothing will happen. 
    @param annotation the PdfAnnotation that will be removed from the tag structure @return TagTreePointer instance which points at annotation tag parent if annotation was removed, otherwise returns null
     . 
    
  
 Class TagStructureContext, TagStructureContext removePageTags(PdfPage) 
  
 
  
 
  
    Removes all tags that belong only to this page. The logic which defines if tag belongs to the page is described at .flushPageTags(PdfPage). 
     @param page page that defines which tags are to be removed @return current TagStructureContext instance
     . 
    
   
  
 Class TagTreePointer, TagTreePointer setContentStreamForTagging(PdfStream) 
  
 
  
 
  
    Sometimes, tags are desired to be connected with the content that resides not in the page's content stream, but rather in the some appearance stream or in the form xObject stream. In that case, to have a valid tag structure, one shall set not only the page, on which the content will be rendered, but also the content stream in which the tagged content will reside. 
   
 
   
 NOTE: It's important to set a {@code null} for this value, when tagging of this stream content is finished. @param contentStream the content stream which content will be tagged with this instance of {@code TagTreePointer} or {@code null} if content stream tagging is 
     finished. 
   finished @return current TagTreePointer instance