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

Interface IRtfTextContainer

Known Subinterfaces:
IRtfHyperLinkContainer
Known Implementing Classes:
RtfHyperLink, RtfParagraph

public interface IRtfTextContainer

Interface for RtfElements that can contain RtfText elements
Author:
Bertrand Delacretaz bdelacretaz@codeconsult.ch

Method Summary

RtfAttributes
getTextContainerAttributes()
Text containers usually provide default attributes for all texts that they contain.
void
newLineBreak()
Add a line break
RtfText
newText(String str)
Close current text run, if any, and start a new one with default attributes
RtfText
newText(String str, RtfAttributes attr)
Close current text element, if any, and start a new one

Method Details

getTextContainerAttributes

public RtfAttributes getTextContainerAttributes()
Text containers usually provide default attributes for all texts that they contain.
Returns:
a copy of the container's attributes.

newLineBreak

public void newLineBreak()
            throws IOException
Add a line break

newText

public RtfText newText(String str)
            throws IOException
Close current text run, if any, and start a new one with default attributes
Parameters:
str - if not null, added to the RtfText created
Returns:
a new text object

newText

public RtfText newText(String str,
                       RtfAttributes attr)
            throws IOException
Close current text element, if any, and start a new one
Parameters:
str - if not null, added to the RtfText created
attr - attributes for text
Returns:
new text object

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