Uses of Class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfAttributes (Apache FOP 2.7 API)
Date: 2022-01-12

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

- Packages that use RtfAttributes
  Package | Description
  --- | ---
  org.apache.fop.render.rtf | RTF (Rich Text Format) Output Support
  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 RtfAttributes in org.apache.fop.render.rtf

    Subclasses of RtfAttributes in org.apache.fop.render.rtf
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FOPRtfAttributes` A RtfAttributes subclass that adds some helper set methods.

    Methods in org.apache.fop.render.rtf that return RtfAttributes
    Modifier and Type | Method and Description
    --- | ---
    `RtfAttributes` | FOPRtfAttributes.`set(java.lang.String name, java.awt.Color color)` Set an attribute that has a Color value.
    `RtfAttributes` | FOPRtfAttributes.`setHalfPoints(java.lang.String name, Length value)` Set an attribute that has a Length value (internal units in half-points)
    `RtfAttributes` | FOPRtfAttributes.`setTwips(java.lang.String name, int value)` Set an attribute using a value in millipoints (internal units in twips)
    `RtfAttributes` | FOPRtfAttributes.`setTwips(java.lang.String name, Length value)` Set an attribute that has a Length value (internal units in twips)

    Methods in org.apache.fop.render.rtf with parameters of type RtfAttributes
    Modifier and Type | Method and Description
    --- | ---
    `static void` | BorderAttributesConverter.`makeBorder(CommonBorderPaddingBackground border, int side, RtfAttributes attributes, java.lang.String controlWord)` Create a border control word in attributes, with border properties as specified in color, style and width.

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

    Fields in org.apache.fop.render.rtf.rtflib.rtfdoc declared as RtfAttributes
    Modifier and Type | Field and Description
    --- | ---
    `protected RtfAttributes` | RtfElement.`attrib` attributes of the element

    Methods in org.apache.fop.render.rtf.rtflib.rtfdoc that return RtfAttributes
    Modifier and Type | Method and Description
    --- | ---
    `RtfAttributes` | RtfPage.`getAttributes()` RtfPage - attributes accessor
    `RtfAttributes` | RtfTable.`getBorderAttributes()` Returns the RtfAttributes for the borders of the table.
    `RtfAttributes` | RtfSpaceSplitter.`getCommonAttributes()`
    `RtfAttributes` | RtfTable.`getHeaderAttribs()`
    `RtfAttributes` | RtfSpaceManager.`getLastInlineAttribute()` Peeks at inline-level attribute stack.
    `RtfAttributes` | RtfElement.`getRtfAttributes()` Added by Normand Masse Used for attribute inheritance
    `RtfAttributes` | RtfTable.`getRtfAttributes()` Added by Normand Masse
    `RtfAttributes` | RtfText.`getTextAttributes()`
    `RtfAttributes` | RtfParagraph.`getTextAttributes()` accessor for text attributes
    `RtfAttributes` | IRtfTextContainer.`getTextContainerAttributes()` Text containers usually provide default attributes for all texts that they contain.
    `RtfAttributes` | RtfText.`getTextContainerAttributes()` IRtfTextContainer requirement:
    `RtfAttributes` | RtfHyperLink.`getTextContainerAttributes()` IRtfTextContainer requirement:
    `RtfAttributes` | RtfParagraph.`getTextContainerAttributes()` IRtfTextContainer requirement: return a copy of our attributes
    `RtfAttributes` | RtfAttributes.`set(RtfAttributes attrs)` Set attributes from another attributes object
    `RtfAttributes` | RtfAttributes.`set(java.lang.String name)` set an attribute that has no value.
    `RtfAttributes` | RtfAttributes.`set(java.lang.String name, int value)` Set an attribute that has an integer value
    `RtfAttributes` | RtfAttributes.`set(java.lang.String name, RtfAttributes value)` Set an attribute that has nested attributes as value
    `RtfAttributes` | RtfAttributes.`set(java.lang.String name, java.lang.String type)` Set an attribute that has a String value
    `RtfAttributes` | RtfAttributes.`unset(java.lang.String name)` unset an attribute that has no value

    Methods in org.apache.fop.render.rtf.rtflib.rtfdoc with parameters of type RtfAttributes
    Modifier and Type | Method and Description
    --- | ---
    `RtfHyperLink` | RtfTextrun.`addHyperlink(RtfAttributes attr)` Inserts a hyperlink.
    `void` | RtfTextrun.`addLeader(RtfAttributes attrs)` Inserts a leader.
    `void` | RtfTextrun.`addPageNumber(RtfAttributes attr)` Inserts a page number.
    `void` | RtfStyleSheetTable.`addStyle(java.lang.String name, RtfAttributes attrs)` Adds a style to the table.
    `int` | RtfStyleSheetTable.`addStyleToAttributes(java.lang.String name, RtfAttributes attr)` Adds the style attributes to the given attributes.
    `static RtfTextrun` | RtfTextrun.`getTextrun(RtfContainer container, java.io.Writer writer, RtfAttributes attrs)` Adds a new RtfTextrun to the given container if necessary, and returns it.
    `RtfAfter` | IRtfAfterContainer.`newAfter(RtfAttributes attrs)`
    `RtfAfter` | RtfSection.`newAfter(RtfAttributes attrs)` IRtfAfterContainer
    `RtfBefore` | IRtfBeforeContainer.`newBefore(RtfAttributes attrs)`
    `RtfBefore` | RtfSection.`newBefore(RtfAttributes attrs)` IRtfBeforeContainer
    `RtfHyperLink` | IRtfHyperLinkContainer.`newHyperLink(java.lang.String str, RtfAttributes attr)` Creates a new hyperlink.
    `RtfHyperLink` | RtfParagraph.`newHyperLink(java.lang.String str, RtfAttributes attr)` Creates a new hyperlink.
    `RtfJforCmd` | IRtfJforCmdContainer.`newJforCmd(RtfAttributes attr)`
    `RtfJforCmd` | RtfSection.`newJforCmd(RtfAttributes attrs)`
    `RtfList` | RtfTableCell.`newList(RtfAttributes attrib)` Start a new list after closing current paragraph, list and table
    `RtfList` | IRtfListContainer.`newList(RtfAttributes attrs)` Close the current list, if any, and starts a new one
    `RtfList` | RtfListItem.`newList(RtfAttributes attrs)` Start a new list after closing current paragraph, list and table
    `RtfList` | RtfFootnote.`newList(RtfAttributes attrs)`
    `RtfList` | RtfSection.`newList(RtfAttributes attrs)` Start a new list after closing current paragraph, list and table
    `RtfPage` | IRtfPageContainer.`newPage(RtfAttributes attrs)` close current text run if any and start a new one with specified attributes
    `RtfPage` | RtfPageArea.`newPage(RtfAttributes attr)` Close current Rtfpage if any and create a new one
    `RtfParagraph` | RtfTableCell.`newParagraph(RtfAttributes attrs)` Start a new paragraph after closing current current paragraph, list and table
    `RtfParagraph` | IRtfParagraphContainer.`newParagraph(RtfAttributes attr)` Close current paragraph, if any, and start a new one with specified attributes
    `RtfParagraph` | RtfListItem.`newParagraph(RtfAttributes attrs)` Close current paragraph if any and start a new one
    `RtfParagraph` | RtfSection.`newParagraph(RtfAttributes attrs)` Start a new paragraph after closing current paragraph, list and table
    `RtfTable` | RtfTableCell.`newTable(RtfAttributes attrs, ITableColumnsInfo tc)` Start a new nested table after closing current paragraph, list and table
    `RtfTable` | IRtfTableContainer.`newTable(RtfAttributes attrs, ITableColumnsInfo tc)` Close current table, if any, and start a new one
    `RtfTable` | RtfSection.`newTable(RtfAttributes attrs, ITableColumnsInfo tc)` Start a new table after closing current paragraph, list and table
    `RtfTableCell` | RtfTableRow.`newTableCell(int cellWidth, RtfAttributes attrs)` Close current cell if any and start a new one
    `RtfTableCell` | RtfTableRow.`newTableCellMergedHorizontally(int cellWidth, RtfAttributes attrs)` Added by Boris POUDEROUS on 07/02/2002 in order to add an empty cell that is merged with the previous cell.
    `RtfTableCell` | RtfTableRow.`newTableCellMergedVertically(int cellWidth, RtfAttributes attrs)` Added by Boris POUDEROUS on 07/02/2002 in order to add an empty cell that is merged with the cell above.
    `RtfTableRow` | RtfTable.`newTableRow(RtfAttributes attrs)` Close current row if any and start a new one
    `RtfTemplate` | IrtfTemplateContainer.`newTemplate(java.lang.String str, RtfAttributes attr)` Creates a new Template.
    `RtfText` | IRtfTextContainer.`newText(java.lang.String str, RtfAttributes attr)` Close current text element, if any, and start a new one
    `RtfText` | RtfHyperLink.`newText(java.lang.String str, RtfAttributes attr)` close current text run if any and start a new one
    `RtfText` | RtfParagraph.`newText(java.lang.String str, RtfAttributes attr)` Close current text run if any and start a new one
    `void` | RtfTextrun.`pushBlockAttributes(RtfAttributes attrs)` Pushes block attributes, notifies all opened blocks about pushing block attributes, adds `OpenGroupMark` as a child.
    `void` | RtfTextrun.`pushInlineAttributes(RtfAttributes attrs)` Pushes inline attributes.
    `void` | RtfSpaceManager.`pushInlineAttributes(RtfAttributes attrs)` Pushes inline attributes to inline-level stack.
    `RtfSpaceSplitter` | RtfSpaceManager.`pushRtfSpaceSplitter(RtfAttributes attrs)` Builds RtfSpaceSplitter on `attrs` and adds it to the block-level stack.
    `RtfAttributes` | RtfAttributes.`set(RtfAttributes attrs)` Set attributes from another attributes object
    `RtfAttributes` | RtfAttributes.`set(java.lang.String name, RtfAttributes value)` Set an attribute that has nested attributes as value
    `void` | RtfTable.`setBorderAttributes(RtfAttributes attributes)` Sets the RtfAttributes for the borders of the table.
    `void` | RtfSpaceManager.`setCandidate(RtfAttributes attrs)` Set attributes as candidate for space attributes inheritance.
    `void` | RtfTable.`setHeaderAttribs(RtfAttributes attrs)` Added by Normand Masse Support for table-header attributes (used instead of table attributes)
    `void` | RtfSpaceSplitter.`setSpaceAfterCandidate(RtfAttributes candidate)` Sets a candidate for space-after property.
    `void` | RtfSpaceSplitter.`setSpaceBeforeCandidate(RtfAttributes candidate)` Sets a candidate for space-before property.
    `RtfListTable` | RtfFile.`startListTable(RtfAttributes attr)` Creates the list table.
    `protected void` | RtfElement.`writeAttributes(RtfAttributes attr, java.lang.String[] nameList)` Write given attribute values to our Writer

    Constructors in org.apache.fop.render.rtf.rtflib.rtfdoc with parameters of type RtfAttributes
    Constructor and Description
    `RtfExternalGraphic(RtfContainer container, java.io.Writer writer, RtfAttributes attributes)` Default constructor.
    `RtfHyperLink(IRtfTextContainer parent, java.io.Writer writer, java.lang.String str, RtfAttributes attr)` A constructor.
    `RtfHyperLink(RtfTextrun parent, java.io.Writer writer, RtfAttributes attr)` A constructor.
    `RtfListTable(RtfContainer parent, java.io.Writer w, java.lang.Integer num, RtfAttributes attrs)` RtfListTable Constructor: sets the number of the list, and allocates for the RtfAttributes
    `RtfSpaceSplitter(RtfAttributes attrs, int previousSpace)` Create RtfSpaceSplitter with given RtfAttributes.

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

    Methods in org.apache.fop.render.rtf.rtflib.tools that return RtfAttributes
    Modifier and Type | Method and Description
    --- | ---
    `RtfAttributes` | TableContext.`getColumnRowSpanningAttrs()`

    Methods in org.apache.fop.render.rtf.rtflib.tools with parameters of type RtfAttributes
    Modifier and Type | Method and Description
    --- | ---
    `void` | TableContext.`setCurrentColumnRowSpanning(java.lang.Integer iRowSpanning, RtfAttributes attrs)`
    `void` | TableContext.`setNextColumnRowSpanning(java.lang.Integer iRowSpanning, RtfAttributes attrs)`

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