ITaggedContent

public interface ITaggedContent

Represents interface for work with TaggedPdf content of document.

Methods

MethodDescription
getStructureTextState()Get StructureTextState settings for whole document.
getStructTreeRootElement()Gets StructTreeRootElement of PDF document.
getRootElement()Gets root StructureElement of logical structure of PDF document.
setLanguage(String lang)Sets natural language for pdf document.
setTitle(String title)Sets title for PDF document.
createPartElement()Creates PartElement.
createArtElement()Creates ArtElement.
createSectElement()Creates SectElement.
createDivElement()Creates DivElement.
createBlockQuoteElement()Creates BlockQuoteElement.
createCaptionElement()Creates CaptionElement.
createTOCElement()Creates TOCElement.
createTOCIElement()Creates TOCIElement.
createIndexElement()Creates IndexElement.
createNonStructElement()Creates NonStructElement.
createPrivateElement()Creates PrivateElement.
createParagraphElement()Creates ParagraphElement.
createHeaderElement()Creates HeaderElement.
createHeaderElement(int level)Creates HeaderElement with level.
createListElement()Creates ListElement.
createTableElement()Creates TableElement.
createTableTHeadElement()Creates TableTHeadElement.
createTableTBodyElement()Creates TableTHeadElement.
createTableTFootElement()Creates TableTFootElement.
createTableTRElement()Creates TableTRElement.
createTableTHElement()Creates TableTHElement.
createTableTDElement()Creates TableTDElement.
createSpanElement()Creates SpanElement.
createQuoteElement()Creates QuoteElement.
createNoteElement()Creates NoteElement.
createReferenceElement()Creates ReferenceElement.
createBibEntryElement()Creates BibEntryElement.
createCodeElement()Creates CodeElement.
createLinkElement()Creates LinkElement.
createAnnotElement()Creates AnnotElement.
createRubyElement()Creates RubyElement.
createWarichuElement()Creates WarichuElement.
createFigureElement()Creates FigureElement.
createFormulaElement()Creates FormulaElement.
createFormElement()Creates FormElement.

getStructureTextState()

public abstract StructureTextState getStructureTextState()

Get StructureTextState settings for whole document.

Returns: StructureTextState - Value: StructureTextState settings for whole document.

getStructTreeRootElement()

public abstract StructTreeRootElement getStructTreeRootElement()

Gets StructTreeRootElement of PDF document.

Returns: StructTreeRootElement - StructTreeRootElement of PDF document.

getRootElement()

public abstract StructureElement getRootElement()

Gets root StructureElement of logical structure of PDF document.

Returns: StructureElement - Root StructureElement of logical structure of PDF document.

setLanguage(String lang)

public abstract void setLanguage(String lang)

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.

Parameters:

ParameterTypeDescription
langjava.lang.StringA 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(String title)

public abstract void setTitle(String title)

Sets title for PDF document.

Parameters:

ParameterTypeDescription
titlejava.lang.StringThe title of PDF document.

createPartElement()

public abstract PartElement createPartElement()

Creates PartElement.

Returns: PartElement - Created structure element.

createArtElement()

public abstract ArtElement createArtElement()

Creates ArtElement.

Returns: ArtElement - Created structure element.

createSectElement()

public abstract SectElement createSectElement()

Creates SectElement.

Returns: SectElement - Created structure element.

createDivElement()

public abstract DivElement createDivElement()

Creates DivElement.

Returns: DivElement - Created structure element.

createBlockQuoteElement()

public abstract BlockQuoteElement createBlockQuoteElement()

Creates BlockQuoteElement.

Returns: BlockQuoteElement - Created structure element.

createCaptionElement()

public abstract CaptionElement createCaptionElement()

Creates CaptionElement.

Returns: CaptionElement - Created structure element.

createTOCElement()

public abstract TOCElement createTOCElement()

Creates TOCElement.

Returns: TOCElement - Created structure element.

createTOCIElement()

public abstract TOCIElement createTOCIElement()

Creates TOCIElement.

Returns: TOCIElement - Created structure element.

createIndexElement()

public abstract IndexElement createIndexElement()

Creates IndexElement.

Returns: IndexElement - Created structure element.

createNonStructElement()

public abstract NonStructElement createNonStructElement()

Creates NonStructElement.

Returns: NonStructElement - Created structure element.

createPrivateElement()

public abstract PrivateElement createPrivateElement()

Creates PrivateElement.

Returns: PrivateElement - Created structure element.

createParagraphElement()

public abstract ParagraphElement createParagraphElement()

Creates ParagraphElement.

Returns: ParagraphElement - Created structure element.

createHeaderElement()

public abstract HeaderElement createHeaderElement()

Creates HeaderElement.

Returns: HeaderElement - Created structure element.

createHeaderElement(int level)

public abstract HeaderElement createHeaderElement(int level)

Creates HeaderElement with level.

Parameters:

ParameterTypeDescription
levelintThe level of Header. Must be 1, 2, 3, 4, 5 or 6.

Returns: HeaderElement - Created structure element.

createListElement()

public abstract ListElement createListElement()

Creates ListElement.

Returns: ListElement - Created structure element.

createTableElement()

public abstract TableElement createTableElement()

Creates TableElement.

Returns: TableElement - Created structure element.

createTableTHeadElement()

public abstract TableTHeadElement createTableTHeadElement()

Creates TableTHeadElement.

Returns: TableTHeadElement - Created structure element.

createTableTBodyElement()

public abstract TableTBodyElement createTableTBodyElement()

Creates TableTHeadElement.

Returns: TableTBodyElement - Created structure element.

createTableTFootElement()

public abstract TableTFootElement createTableTFootElement()

Creates TableTFootElement.

Returns: TableTFootElement - Created structure element.

createTableTRElement()

public abstract TableTRElement createTableTRElement()

Creates TableTRElement.

Returns: TableTRElement - Created structure element.

createTableTHElement()

public abstract TableTHElement createTableTHElement()

Creates TableTHElement.

Returns: TableTHElement - Created structure element.

createTableTDElement()

public abstract TableTDElement createTableTDElement()

Creates TableTDElement.

Returns: TableTDElement - Created structure element.

createSpanElement()

public abstract SpanElement createSpanElement()

Creates SpanElement.

Returns: SpanElement - Created structure element.

createQuoteElement()

public abstract QuoteElement createQuoteElement()

Creates QuoteElement.

Returns: QuoteElement - Created structure element.

createNoteElement()

public abstract NoteElement createNoteElement()

Creates NoteElement.

Returns: NoteElement - Created structure element.

createReferenceElement()

public abstract ReferenceElement createReferenceElement()

Creates ReferenceElement.

Returns: ReferenceElement - Created structure element.

createBibEntryElement()

public abstract BibEntryElement createBibEntryElement()

Creates BibEntryElement.

Returns: BibEntryElement - Created structure element.

createCodeElement()

public abstract CodeElement createCodeElement()

Creates CodeElement.

Returns: CodeElement - Created structure element.

createLinkElement()

public abstract LinkElement createLinkElement()

Creates LinkElement.

Returns: LinkElement - Created structure element.

createAnnotElement()

public abstract AnnotElement createAnnotElement()

Creates AnnotElement.

Returns: AnnotElement - Created structure element.

createRubyElement()

public abstract RubyElement createRubyElement()

Creates RubyElement.

Returns: RubyElement - Created structure element.

createWarichuElement()

public abstract WarichuElement createWarichuElement()

Creates WarichuElement.

Returns: WarichuElement - Created structure element.

createFigureElement()

public abstract FigureElement createFigureElement()

Creates FigureElement.

Returns: FigureElement - Created structure element.

createFormulaElement()

public abstract FormulaElement createFormulaElement()

Creates FormulaElement.

Returns: FormulaElement - Created structure element.

createFormElement()

public abstract FormElement createFormElement()

Creates FormElement.

Returns: FormElement - Created structure element.