# Package org.apache.fop.render.rtf.rtflib.rtfdoc

Independent subsystem (not specific to FOP) classes that are used to build RTF documents.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  IBorderAttributes | Constants for RTF border attribute names.
  IRtfAfterContainer | interface for RTF objects that can contain footers
  IRtfBeforeContainer | Interface for classes containing headers.
  IRtfBookmarkContainer | RTF Bookmark container interface.
  IRtfExternalGraphicContainer | Interface for classes containing images.
  IRtfHyperLinkContainer | Interface for RtfElements that can contain RtfHyperLinks.
  IRtfJforCmdContainer | Interface for objects containing Commands
  IRtfListContainer | Interface for RtfElements that can contain RtfLists.
  IRtfOptions | Options for configuring the rtf elements.
  IRtfPageBreakContainer | Interface for RtfElements that can contain RtfPageBreaks.
  IRtfPageContainer | Interface for RtfElements that can contain RtfText elements.
  IRtfPageNumberCitationContainer | Interface for classes containing page number citations
  IRtfPageNumberContainer | Interface for objects containing page numbers
  IRtfParagraphContainer | Interface for RtfElements that can contain RtfParagraphs.
  IRtfParagraphKeepTogetherContainer | Interface for classes containing Paragraphs with Keep Together
  IRtfTableContainer | Interface for RtfElements that can contain RtfTables.
  IrtfTemplateContainer | Interface for classes containing templates.
  IRtfTextContainer | Interface for RtfElements that can contain RtfText elements.
  IRtfTextrunContainer | Interface which enables an implementing class to contain linear text runs.
  ITableAttributes | Constants for RTF table attribute names.
  ITableColumnsInfo | Used to get information about tables, for example when handling nested tables.

- Class Summary
  Class | Description
  --- | ---
  ParagraphKeeptogetherContext | This context is used to manage the "keepn" RTF attribute Used by ParagraphBuilder and JforCmd
  RtfAfter | RtfContainer that encloses footers
  RtfAttributes | Attributes for RtfText.
  RtfBefore | The opposite of RtfAfter
  RtfBookmark | RTF Bookmark.
  RtfBookmarkContainerImpl | RTF Bookmark container implementation.
  RtfColorTable | Singelton of the RTF color table.
  RtfContainer | An RtfElement that can contain other elements.
  RtfDocumentArea | The RTF document area, container for RtfSection objects.
  RtfElement | Base class for all elements of an RTF file.
  RtfExternalGraphic | Creates an RTF image from an external graphic file.
  RtfExtraRowSet | Used to add extra table rows after a row that contains a nested table: created by RtfTableRow before generating RTF code an RtfTableCell that contains a nested table can ask this to put some of its children in extra rows that after the current row once RtfTableRow is done rendering its children, it renders this, causing extra rows to be generated, with content that can come from several RtfTableCells See org.apache.fop.rtf.rtflib.testdocs.NestedTable for an example of usage.
  RtfFile | Models the top-level structure of an RTF file.
  RtfFontManager | RTF font table.
  RtfFootnote | Model of an RTF footnote.
  RtfGenerator | Represents a generator element which says who generated the RTF document.
  RtfHyperLink | Creates an hyperlink.
  RtfJforCmd | Process "jfor-cmd"
  RtfLeader | Generates the leader in RTF.
  RtfLineBreak | Model of an RTF line break.
  RtfList | Model of an RTF list, which can contain RTF list items.
  RtfListItem | Model of an RTF list item, which can contain RTF paragraphs.
  RtfListStyle | Class to handle list styles.
  RtfListStyleBullet | Class to handle bullet list style.
  RtfListStyleNumber | Class to handle number list style.
  RtfListStyleText | Class to handle text list style.
  RtfListTable | RtfListTable: used to make the list table in the header section of the RtfFile.
  RtfNull | Null container.
  RtfOptions | Simplistic options definitions for RTF generation.
  RtfPage | Specifies rtf control words.
  RtfPageArea | Page area container.
  RtfPageBreak | Model of an RTF page break.
  RtfPageNumber | Page number container.
  RtfPageNumberCitation | Page number citation container.
  RtfParagraph | Model of an RTF paragraph, which can contain RTF text elements.
  RtfParagraphBreak | Class which represents a paragraph break.
  RtfParagraphKeepTogether | Models the keep together attributes of paragraphs
  RtfSection | Models a section in an RTF document This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).
  RtfSpaceManager | This class is responsible for saving space-before/space-after attributes history and adding spacing to established candidates (i.e. attributes) or accumulation spacing in case of candidate absence.
  RtfSpaceSplitter | This class splits block attributes into space-before attribute, space-after attribute and common attributes.
  RtfString | Plain text in a RTF file, without any formatings.
  RtfStringConverter | Converts java Strings according to RTF conventions.
  RtfStyleSheetTable | Singelton of the RTF style sheet table.
  RtfTable | Container for RtfRow elements.
  RtfTableCell | A cell in an RTF table, container for paragraphs, lists, etc.
  RtfTableRow | Container for RtfTableCell elements.
  RtfTemplate | Singelton of the RTF style template This class belongs to the jfor:style-template tag processing.
  RtfText | Model of a text run (a piece of text with attributes) in an RTF document.
  RtfTextrun | Class which contains a linear text run.

- Exception Summary
  Exception | Description
  --- | ---
  RtfExternalGraphic.ExternalGraphicException | Exception thrown when an image file/URL cannot be read

## Package org.apache.fop.render.rtf.rtflib.rtfdoc Description

Independent subsystem (not specific to FOP) classes that are used to build RTF documents.

Copyright 1999-2020 The Apache Software Foundation. All Rights Reserved.