Uses of Class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfContainer (Apache FOP Core 2.11 API)
Date: 2025-04-24

## Uses of Class
org.apache.fop.render.rtf.rtflib.rtfdoc.RtfContainer

- Packages that use RtfContainer
  Package | Description
  --- | ---
  org.apache.fop.render.rtf.rtflib.rtfdoc | Independent subsystem (not specific to FOP) classes that are used to build RTF documents.
  org.apache.fop.render.rtf.rtflib.tools | Utility classes used in RTF file generation.

- - ### Uses of RtfContainer in org.apache.fop.render.rtf.rtflib.rtfdoc

    Subclasses of RtfContainer in org.apache.fop.render.rtf.rtflib.rtfdoc
    Modifier and Type | Class and Description
    --- | ---
    `class` | `RtfAfter` RtfContainer that encloses footers
    `class` | `RtfBefore` The opposite of RtfAfter
    `class` | `RtfBookmarkContainerImpl` RTF Bookmark container implementation.
    `class` | `RtfDocumentArea` The RTF document area, container for RtfSection objects.
    `class` | `RtfExtraRowSet` Used to add extra table rows after a row that contains a nested table:
    `class` | `RtfFile` Models the top-level structure of an RTF file.
    `class` | `RtfFootnote` Model of an RTF footnote.
    `class` | `RtfHyperLink` Creates an hyperlink.
    `class` | `RtfJforCmd` Process "jfor-cmd"
    `class` | `RtfLeader` Generates the leader in RTF.
    `class` | `RtfList` Model of an RTF list, which can contain RTF list items.
    `class` | `RtfListItem` Model of an RTF list item, which can contain RTF paragraphs.
    `class` | `RtfListItem.RtfListItemLabel` special RtfTextrun that is used as list item label
    `class` | `RtfListTable` RtfListTable: used to make the list table in the header section of the RtfFile.
    `class` | `RtfNull` Null container.
    `class` | `RtfPage` Specifies rtf control words.
    `class` | `RtfPageArea` Page area container.
    `class` | `RtfPageNumber` Page number container.
    `class` | `RtfPageNumberCitation` Page number citation container.
    `class` | `RtfParagraph` Model of an RTF paragraph, which can contain RTF text elements.
    `class` | `RtfParagraphKeepTogether` Models the keep together attributes of paragraphs
    `class` | `RtfSection` Models a section in an RTF document
    `class` | `RtfTable` Container for RtfRow elements.
    `class` | `RtfTableCell` A cell in an RTF table, container for paragraphs, lists, etc.
    `class` | `RtfTableRow` Container for RtfTableCell elements.
    `class` | `RtfTextrun` Class which contains a linear text run.

    Fields in org.apache.fop.render.rtf.rtflib.rtfdoc declared as RtfContainer
    Modifier and Type | Field and Description
    --- | ---
    `protected RtfContainer` | RtfElement.`parent` parent element

    Methods in org.apache.fop.render.rtf.rtflib.rtfdoc with parameters of type RtfContainer
    Modifier and Type | Method and Description
    --- | ---
    `static RtfTextrun` | RtfTextrun.`getTextrun(RtfContainer container, Writer writer, RtfAttributes attrs)` Adds a new RtfTextrun to the given container if necessary, and returns it.
    `boolean` | RtfOptions.`renderContainer(RtfContainer c)` If this returns false, RtfContainer will not generate any RTF

    Constructors in org.apache.fop.render.rtf.rtflib.rtfdoc with parameters of type RtfContainer
    Constructor and Description
    `RtfExternalGraphic(RtfContainer container, Writer writer)` Default constructor.
    `RtfExternalGraphic(RtfContainer container, Writer writer, RtfAttributes attributes)` Default constructor.
    `RtfListTable(RtfContainer parent, Writer w, Integer num, RtfAttributes attrs)` RtfListTable Constructor: sets the number of the list, and allocates for the RtfAttributes

  - ### Uses of RtfContainer in org.apache.fop.render.rtf.rtflib.tools

    Methods in org.apache.fop.render.rtf.rtflib.tools that return RtfContainer
    Modifier and Type | Method and Description
    --- | ---
    `RtfContainer` | BuilderContext.`getContainer(Class containerClass, boolean required, Object forWhichBuilder)` Find the "nearest" container that implements the given interface on our stack.

    Methods in org.apache.fop.render.rtf.rtflib.tools with parameters of type RtfContainer
    Modifier and Type | Method and Description
    --- | ---
    `void` | BuilderContext.`pushContainer(RtfContainer c)` Push an RtfContainer on our stack.
    `void` | BuilderContext.`replaceContainer(RtfContainer oldC, RtfContainer newC)` In some cases an RtfContainer must be replaced by another one on the stack.

Copyright © 2025 Apache Software Foundation. All rights reserved.