com.adobe.xfa.text.markup

Class MarkupRtfOut

java.lang.Object

com.adobe.xfa.text.TextMarkupBase

com.adobe.xfa.text.markup.MarkupOut

com.adobe.xfa.text.markup.MarkupEngineOut

com.adobe.xfa.text.markup.MarkupRtfOut

public class MarkupRtfOut
extends MarkupEngineOut

This class is the RTF output markup engine. To use it, one creates an instance, passing the string to be translated in a constructor parameter. Then the engine is passed to a Markup() method on either a text stream or range. Finally, one calls the Translation() method on this class to obtain the resulting markup.

For more information, please see the extenral documentation.

Constructor Summary

Constructors

Constructor and Description
MarkupRtfOut()
MarkupRtfOut(MarkupAttr pMarkupAttr)
MarkupRtfOut(MarkupAttr pMarkupAttr, List<GFXColour> pColorTable)
MarkupRtfOut(MarkupAttr pMarkupAttr, List<GFXColour> pColorTable, List<String> pFontTable) Constructor.

Method Summary

Modifier and Type	Method and Description
String	translation() Obtain the resulting markup.

Methods inherited from class com.adobe.xfa.text.markup.MarkupEngineOut

attr, closeScopedBlock, openScopedBlock, para, reset, text

Methods inherited from class com.adobe.xfa.text.markup.MarkupOut

embed, field, suppressAttributes

Methods inherited from class com.adobe.xfa.text.TextMarkupBase

attributePtr, issueFirstPara, legacyPositioning, marker, markerEnd, markerStart

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MarkupRtfOut

public MarkupRtfOut(MarkupAttr pMarkupAttr,
                    List<GFXColour> pColorTable,
                    List<String> pFontTable)

Constructor.

Parameters:

pMarkupAttr - - (optional) Markup attribute table to use instead of the defalt. It is strongly recommended that you pass NULL (default).

pColorTable - - (optional) Colour table.

pFontTable - - (optional) Font table.

MarkupRtfOut

public MarkupRtfOut(MarkupAttr pMarkupAttr,
                    List<GFXColour> pColorTable)

MarkupRtfOut

public MarkupRtfOut(MarkupAttr pMarkupAttr)

MarkupRtfOut

public MarkupRtfOut()

Method Detail

translation

public String translation()

Obtain the resulting markup.

Overrides:

translation in class MarkupEngineOut

Returns:

Generated markup, as a string.