com.hcl.domino.richtext.conversion

Class AppendFileHotspotConversion

java.lang.Object

com.hcl.domino.richtext.conversion.AppendFileHotspotConversion

All Implemented Interfaces:

IRichTextConversion

public class AppendFileHotspotConversion
extends Object
implements IRichTextConversion

Constructor Summary

Constructors

Constructor and Description
AppendFileHotspotConversion(Attachment att, String fileNameToDisplay) Creates a new instance
AppendFileHotspotConversion(String attachmentProgrammaticName, String fileNameToDisplay) Creates a new instance

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppendFileHotspotConversion

public AppendFileHotspotConversion(String attachmentProgrammaticName,
                                   String fileNameToDisplay)

Creates a new instance

Parameters:

attachmentProgrammaticName - name returned by Attachment.getFileName()

fileNameToDisplay - filename to display below the file icon, not necessarily the same as Attachment.getFileName()

AppendFileHotspotConversion

public AppendFileHotspotConversion(Attachment att,
                                   String fileNameToDisplay)

Creates a new instance

Parameters:

att - attachment to add an icon for

fileNameToDisplay - filename to display below the file icon, not necessarily the same as Attachment.getFileName()

Method Detail

richTextNavigationStart

public void richTextNavigationStart()

Description copied from interface: IRichTextConversion

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.

Specified by:

richTextNavigationStart in interface IRichTextConversion

richTextNavigationEnd

public void richTextNavigationEnd()

Description copied from interface: IRichTextConversion

Method is called when the rich text navigation is done

Specified by:

richTextNavigationEnd in interface IRichTextConversion

isMatch

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

Description copied from interface: IRichTextConversion

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

Specified by:

isMatch in interface IRichTextConversion

Parameters:

nav - rich text navigator

Returns:

true if conversion is required

convert

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

Description copied from interface: IRichTextConversion

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.

Specified by:

convert in interface IRichTextConversion

Parameters:

source - source rich text navigator

target - target to write conversion result