com.hcl.domino.richtext.conversion

Interface IRichTextConversion

All Known Implementing Classes:

AppendFileHotspotConversion, RemoveAttachmentIconConversion

public interface IRichTextConversion

Interface for a conversion class that transforms rich text structures

Author:

Karsten Lehmann

Method Summary

Modifier and Type	Method and Description
void	convert(List<RichTextRecord<?>> source, RichTextWriter target) Method to do the actual conversion, e.g.
boolean	isMatch(List<RichTextRecord<?>> nav) Method to check whether the rich text item actually requires a conversion
void	richTextNavigationEnd() Method is called when the rich text navigation is done
void	richTextNavigationStart() Method is called before starting the CD record traversal.

Method Detail

richTextNavigationStart

void richTextNavigationStart()

Method is called before starting the CD record traversal. Can be used to reset variables, e.g. to track if we are within a BEGIN/END block.

isMatch

boolean isMatch(List<RichTextRecord<?>> nav)

Method to check whether the rich text item actually requires a conversion

Parameters:

nav - rich text navigator

Returns:

true if conversion is required

convert

void convert(List<RichTextRecord<?>> source,
             RichTextWriter target)

Method to do the actual conversion, e.g. traversing the CD records of the specified RichTextRecord list and writing the resulting output to the target.

Parameters:

source - source rich text navigator

target - target to write conversion result

richTextNavigationEnd

void richTextNavigationEnd()

Method is called when the rich text navigation is done