com.aspose.pdf.tagged

Constructor Detail

• TaggedContent

  public TaggedContent(IDocument document)

Method Detail

• getStructureTextState

  public final StructureTextState getStructureTextState()

  Get StructureTextState settings for whole document.

  Value: StructureTextState settings for whole document.

  Specified by:

  getStructureTextState in interface ITaggedContent

  Returns:

  Value: StructureTextState settings for whole document.

• getStructTreeRootElement

  public final StructTreeRootElement getStructTreeRootElement()

  Gets StructTreeRootElement of PDF document.

  Value: StructTreeRootElement of PDF document.

  Specified by:

  getStructTreeRootElement in interface ITaggedContent

  Returns:

  StructTreeRootElement of PDF document.

• getRootElement

  public final StructureElement getRootElement()

  Gets root StructureElement of logical structure of PDF document.

  Value: Root StructureElement of logical structure of PDF document.

  Specified by:

  getRootElement in interface ITaggedContent

  Returns:

  Root StructureElement of logical structure of PDF document.

• createMCRElementTextInternal

  public static MCRElement createMCRElementTextInternal(TaggedContext taggedContext,
                                                        String text)

• createMCRElementImageInternal

  public static MCRElement createMCRElementImageInternal(TaggedContext taggedContext,
                                                         String imageSrc)

• setLanguage

  public final void setLanguage(String lang)

  Description copied from interface: ITaggedContent

  Sets natural language for pdf document.

  A language identifier that shall specify the natural language for all text in the document except where overridden by language specifications for structure elements or marked content.

  Specified by:

  setLanguage in interface ITaggedContent

  Parameters:

  lang - A language identifier shall either be the empty text string, to indicate that the language is unknown, or a Language-Tag as defined in RFC 3066, Tags for the Identification of Languages.

• setTitle

  public final void setTitle(String title)

  Description copied from interface: ITaggedContent

  Sets title for PDF document.

  Specified by:

  setTitle in interface ITaggedContent

  Parameters:

  title - The title of PDF document.

• createDocumentElementInternal

  public static Element createDocumentElementInternal(TaggedContext taggedContext,
                                                      com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createPartElementInternal

  public static Element createPartElementInternal(TaggedContext taggedContext,
                                                  com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createPartElement

  public final PartElement createPartElement()

  Description copied from interface: ITaggedContent

  Creates PartElement.

  Specified by:

  createPartElement in interface ITaggedContent

  Returns:

  Created structure element.

• createArtElementInternal

  public static Element createArtElementInternal(TaggedContext taggedContext,
                                                 com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createArtElement

  public final ArtElement createArtElement()

  Description copied from interface: ITaggedContent

  Creates ArtElement.

  Specified by:

  createArtElement in interface ITaggedContent

  Returns:

  Created structure element.

• createSectElementInternal

  public static Element createSectElementInternal(TaggedContext taggedContext,
                                                  com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createSectElement

  public final SectElement createSectElement()

  Description copied from interface: ITaggedContent

  Creates SectElement.

  Specified by:

  createSectElement in interface ITaggedContent

  Returns:

  Created structure element.

• createDivElementInternal

  public static Element createDivElementInternal(TaggedContext taggedContext,
                                                 com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createDivElement

  public final DivElement createDivElement()

  Description copied from interface: ITaggedContent

  Creates DivElement.

  Specified by:

  createDivElement in interface ITaggedContent

  Returns:

  Created structure element.

• createBlockQuoteElementInternal

  public static Element createBlockQuoteElementInternal(TaggedContext taggedContext,
                                                        com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createBlockQuoteElement

  public final BlockQuoteElement createBlockQuoteElement()

  Description copied from interface: ITaggedContent

  Creates BlockQuoteElement.

  Specified by:

  createBlockQuoteElement in interface ITaggedContent

  Returns:

  Created structure element.

• createCaptionElementInternal

  public static Element createCaptionElementInternal(TaggedContext taggedContext,
                                                     com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createCaptionElement

  public final CaptionElement createCaptionElement()

  Description copied from interface: ITaggedContent

  Creates CaptionElement.

  Specified by:

  createCaptionElement in interface ITaggedContent

  Returns:

  Created structure element.

• createTOCElementInternal

  public static Element createTOCElementInternal(TaggedContext taggedContext,
                                                 com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createTOCElement

  public final TOCElement createTOCElement()

  Description copied from interface: ITaggedContent

  Creates TOCElement.

  Specified by:

  createTOCElement in interface ITaggedContent

  Returns:

  Created structure element.

• createTOCIElementInternal

  public static Element createTOCIElementInternal(TaggedContext taggedContext,
                                                  com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createTOCIElement

  public final TOCIElement createTOCIElement()

  Description copied from interface: ITaggedContent

  Creates TOCIElement.

  Specified by:

  createTOCIElement in interface ITaggedContent

  Returns:

  Created structure element.

• createIndexElementInternal

  public static Element createIndexElementInternal(TaggedContext taggedContext,
                                                   com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createIndexElement

  public final IndexElement createIndexElement()

  Description copied from interface: ITaggedContent

  Creates IndexElement.

  Specified by:

  createIndexElement in interface ITaggedContent

  Returns:

  Created structure element.

• createNonStructElementInternal

  public static Element createNonStructElementInternal(TaggedContext taggedContext,
                                                       com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createNonStructElement

  public final NonStructElement createNonStructElement()

  Description copied from interface: ITaggedContent

  Creates NonStructElement.

  Specified by:

  createNonStructElement in interface ITaggedContent

  Returns:

  Created structure element.

• createPrivateElementInternal

  public static Element createPrivateElementInternal(TaggedContext taggedContext,
                                                     com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createPrivateElement

  public final PrivateElement createPrivateElement()

  Description copied from interface: ITaggedContent

  Creates PrivateElement.

  Specified by:

  createPrivateElement in interface ITaggedContent

  Returns:

  Created structure element.

• createParagraphElementInternal

  public static Element createParagraphElementInternal(TaggedContext taggedContext,
                                                       com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createParagraphElement

  public final ParagraphElement createParagraphElement()

  Description copied from interface: ITaggedContent

  Creates ParagraphElement.

  Specified by:

  createParagraphElement in interface ITaggedContent

  Returns:

  Created structure element.

• createHeaderElementInternal

  public static Element createHeaderElementInternal(TaggedContext taggedContext,
                                                    com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createHeaderElement

  public final HeaderElement createHeaderElement()

  Description copied from interface: ITaggedContent

  Creates HeaderElement.

  Specified by:

  createHeaderElement in interface ITaggedContent

  Returns:

  Created structure element.

• createHeaderElement

  public final HeaderElement createHeaderElement(int level)

  Description copied from interface: ITaggedContent

  Creates HeaderElement with level.

  Specified by:

  createHeaderElement in interface ITaggedContent

  Parameters:

  level - The level of Header. Must be 1, 2, 3, 4, 5 or 6.

  Returns:

  Created structure element.

• createH1ElementInternal

  public static Element createH1ElementInternal(TaggedContext taggedContext,
                                                com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createH2ElementInternal

  public static Element createH2ElementInternal(TaggedContext taggedContext,
                                                com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createH3ElementInternal

  public static Element createH3ElementInternal(TaggedContext taggedContext,
                                                com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createH4ElementInternal

  public static Element createH4ElementInternal(TaggedContext taggedContext,
                                                com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createH5ElementInternal

  public static Element createH5ElementInternal(TaggedContext taggedContext,
                                                com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createH6ElementInternal

  public static Element createH6ElementInternal(TaggedContext taggedContext,
                                                com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createListElementInternal

  public static Element createListElementInternal(TaggedContext taggedContext,
                                                  com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createListElement

  public final ListElement createListElement()

  Description copied from interface: ITaggedContent

  Creates ListElement.

  Specified by:

  createListElement in interface ITaggedContent

  Returns:

  Created structure element.

• createListLIElementInternal

  public static Element createListLIElementInternal(TaggedContext taggedContext,
                                                    com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createListLblElementInternal

  public static Element createListLblElementInternal(TaggedContext taggedContext,
                                                     com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createListLBodyElementInternal

  public static Element createListLBodyElementInternal(TaggedContext taggedContext,
                                                       com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createTableElementInternal

  public static Element createTableElementInternal(TaggedContext taggedContext,
                                                   com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createTableElement

  public final TableElement createTableElement()

  Description copied from interface: ITaggedContent

  Creates TableElement.

  Specified by:

  createTableElement in interface ITaggedContent

  Returns:

  Created structure element.

• createTableTHeadElementInternal

  public static Element createTableTHeadElementInternal(TaggedContext taggedContext,
                                                        com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createTableTHeadElement

  public final TableTHeadElement createTableTHeadElement()

  Description copied from interface: ITaggedContent

  Creates TableTHeadElement.

  Specified by:

  createTableTHeadElement in interface ITaggedContent

  Returns:

  Created structure element.

• createTableTBodyElementInternal

  public static Element createTableTBodyElementInternal(TaggedContext taggedContext,
                                                        com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createTableTBodyElement

  public final TableTBodyElement createTableTBodyElement()

  Description copied from interface: ITaggedContent

  Creates TableTHeadElement.

  Specified by:

  createTableTBodyElement in interface ITaggedContent

  Returns:

  Created structure element.

• createTableTFootElementInternal

  public static Element createTableTFootElementInternal(TaggedContext taggedContext,
                                                        com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createTableTFootElement

  public final TableTFootElement createTableTFootElement()

  Description copied from interface: ITaggedContent

  Creates TableTFootElement.

  Specified by:

  createTableTFootElement in interface ITaggedContent

  Returns:

  Created structure element.

• createTableTRElementInternal

  public static Element createTableTRElementInternal(TaggedContext taggedContext,
                                                     com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createTableTRElement

  public final TableTRElement createTableTRElement()

  Description copied from interface: ITaggedContent

  Creates TableTRElement.

  Specified by:

  createTableTRElement in interface ITaggedContent

  Returns:

  Created structure element.

• createTableTHElementInternal

  public static Element createTableTHElementInternal(TaggedContext taggedContext,
                                                     com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createTableTHElement

  public final TableTHElement createTableTHElement()

  Description copied from interface: ITaggedContent

  Creates TableTHElement.

  Specified by:

  createTableTHElement in interface ITaggedContent

  Returns:

  Created structure element.

• createTableTDElementInternal

  public static Element createTableTDElementInternal(TaggedContext taggedContext,
                                                     com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createTableTDElement

  public final TableTDElement createTableTDElement()

  Description copied from interface: ITaggedContent

  Creates TableTDElement.

  Specified by:

  createTableTDElement in interface ITaggedContent

  Returns:

  Created structure element.

• createSpanElementInternal

  public static Element createSpanElementInternal(TaggedContext taggedContext,
                                                  com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createSpanElement

  public final SpanElement createSpanElement()

  Description copied from interface: ITaggedContent

  Creates SpanElement.

  Specified by:

  createSpanElement in interface ITaggedContent

  Returns:

  Created structure element.

• createQuoteElementInternal

  public static Element createQuoteElementInternal(TaggedContext taggedContext,
                                                   com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createQuoteElement

  public final QuoteElement createQuoteElement()

  Description copied from interface: ITaggedContent

  Creates QuoteElement.

  Specified by:

  createQuoteElement in interface ITaggedContent

  Returns:

  Created structure element.

• createNoteElementInternal

  public static Element createNoteElementInternal(TaggedContext taggedContext,
                                                  com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createNoteElement

  public final NoteElement createNoteElement()

  Description copied from interface: ITaggedContent

  Creates NoteElement.

  Specified by:

  createNoteElement in interface ITaggedContent

  Returns:

  Created structure element.

• createReferenceElementInternal

  public static Element createReferenceElementInternal(TaggedContext taggedContext,
                                                       com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createReferenceElement

  public final ReferenceElement createReferenceElement()

  Description copied from interface: ITaggedContent

  Creates ReferenceElement.

  Specified by:

  createReferenceElement in interface ITaggedContent

  Returns:

  Created structure element.

• createBibEntryElementInternal

  public static Element createBibEntryElementInternal(TaggedContext taggedContext,
                                                      com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createBibEntryElement

  public final BibEntryElement createBibEntryElement()

  Description copied from interface: ITaggedContent

  Creates BibEntryElement.

  Specified by:

  createBibEntryElement in interface ITaggedContent

  Returns:

  Created structure element.

• createCodeElementInternal

  public static Element createCodeElementInternal(TaggedContext taggedContext,
                                                  com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createCodeElement

  public final CodeElement createCodeElement()

  Description copied from interface: ITaggedContent

  Creates CodeElement.

  Specified by:

  createCodeElement in interface ITaggedContent

  Returns:

  Created structure element.

• createLinkElementInternal

  public static Element createLinkElementInternal(TaggedContext taggedContext,
                                                  com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createLinkElement

  public final LinkElement createLinkElement()

  Description copied from interface: ITaggedContent

  Creates LinkElement.

  Specified by:

  createLinkElement in interface ITaggedContent

  Returns:

  Created structure element.

• createAnnotElementInternal

  public static Element createAnnotElementInternal(TaggedContext taggedContext,
                                                   com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createAnnotElement

  public final AnnotElement createAnnotElement()

  Description copied from interface: ITaggedContent

  Creates AnnotElement.

  Specified by:

  createAnnotElement in interface ITaggedContent

  Returns:

  Created structure element.

• createRubyElementInternal

  public static Element createRubyElementInternal(TaggedContext taggedContext,
                                                  com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createRubyElement

  public final RubyElement createRubyElement()

  Description copied from interface: ITaggedContent

  Creates RubyElement.

  Specified by:

  createRubyElement in interface ITaggedContent

  Returns:

  Created structure element.

• createRubyRBElementInternal

  public static Element createRubyRBElementInternal(TaggedContext taggedContext,
                                                    com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createRubyRTElementInternal

  public static Element createRubyRTElementInternal(TaggedContext taggedContext,
                                                    com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createRubyRPElementInternal

  public static Element createRubyRPElementInternal(TaggedContext taggedContext,
                                                    com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createWarichuElementInternal

  public static Element createWarichuElementInternal(TaggedContext taggedContext,
                                                     com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createWarichuElement

  public final WarichuElement createWarichuElement()

  Description copied from interface: ITaggedContent

  Creates WarichuElement.

  Specified by:

  createWarichuElement in interface ITaggedContent

  Returns:

  Created structure element.

• createWarichuWTElementInternal

  public static Element createWarichuWTElementInternal(TaggedContext taggedContext,
                                                       com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createWarichuWPElementInternal

  public static Element createWarichuWPElementInternal(TaggedContext taggedContext,
                                                       com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createFigureElementInternal

  public static Element createFigureElementInternal(TaggedContext taggedContext,
                                                    com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createFigureElement

  public final FigureElement createFigureElement()

  Description copied from interface: ITaggedContent

  Creates FigureElement.

  Specified by:

  createFigureElement in interface ITaggedContent

  Returns:

  Created structure element.

• createFormulaElementInternal

  public static Element createFormulaElementInternal(TaggedContext taggedContext,
                                                     com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createFormulaElement

  public final FormulaElement createFormulaElement()

  Description copied from interface: ITaggedContent

  Creates FormulaElement.

  Specified by:

  createFormulaElement in interface ITaggedContent

  Returns:

  Created structure element.

• createFormElementInternal

  public static Element createFormElementInternal(TaggedContext taggedContext,
                                                  com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

• createFormElement

  public final FormElement createFormElement()

  Description copied from interface: ITaggedContent

  Creates FormElement.

  Specified by:

  createFormElement in interface ITaggedContent

  Returns:

  Created structure element.

• preSave

  public final void preSave()

• save

  public final void save()