com.oracle.outsidein.annotations

Interface Annotatable

All Known Subinterfaces:

Document, Exporter

public interface Annotatable

Interface for adding annotations to an exported document. API users will interact with an Exporter's implementation of this interface. Annotations include text and area highlighting, and stamp annotations.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAreaHighlight(HighlightAreaAnnotation areaAnno) Applies highlighting to a rectangular area in the destination document.
void	addAreaHighlight(HighlightAreaAnnotation areaAnno, java.util.Map<java.lang.String,java.lang.String> properties) Applies highlighting to a rectangular area in the destination document and associates properties with the annotation.
void	addAreaHighlight(HighlightAreaAnnotation areaAnno, java.lang.String comment) Applies highlighting to a rectangular area in the destination document and associates a comment with the annotation.
void	addAreaHighlight(HighlightAreaAnnotation areaAnno, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties) Applies highlighting to a rectangular area in the destination document and associates a comment and properties with the annotation.
void	addStampAnnotation(StampAnnotation stampAnno) Overlays a stamp image on the destination document.
void	addStampAnnotation(StampAnnotation stampAnno, java.util.Map<java.lang.String,java.lang.String> properties) Overlays a stamp image on the destination document document and associates properties with the annotation.
void	addStampAnnotation(StampAnnotation stampAnno, java.lang.String comment) Overlays a stamp image on the destination document document and associates a comment with the annotation.
void	addStampAnnotation(StampAnnotation stampAnno, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties) Overlays a stamp image on the destination document document and associates a comment and properties with the annotation.
void	addStampImageFile(java.util.Map<java.lang.String,java.io.File> stamps) Specifies stamp image files to be used in stamp annotations.
void	addStampImageURL(java.util.Map<java.lang.String,java.net.URI> stamps) Specifies stamp image files to be used in stamp annotations.
void	addTextHighlight(HighlightTextAnnotation textAnno) Applies highlighting to text in the destination document.
void	addTextHighlight(HighlightTextAnnotation textAnno, java.util.Map<java.lang.String,java.lang.String> properties) Applies highlighting to text in the destination document and associates a set of properties with the annotation.
void	addTextHighlight(HighlightTextAnnotation textAnno, java.lang.String comment) Applies highlighting to text in the destination document and associates a comment with the annotation.
void	addTextHighlight(HighlightTextAnnotation textAnno, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties) Applies highlighting to text in the destination document and associates a comment and properties with the annotation.
void	applyHighlights(java.lang.String highlightJsonData) Applies a set of json highlights when exporting to the HTML5 destination document.
void	redactText(RedactAnnotation redaction) Applies a redaction annotation to the rendered output document.

Method Detail

addTextHighlight

void addTextHighlight(HighlightTextAnnotation textAnno)

Applies highlighting to text in the destination document.

Parameters:

textAnno - the location and attributes of the text highlight

addTextHighlight

void addTextHighlight(HighlightTextAnnotation textAnno,
                    java.lang.String comment)

Applies highlighting to text in the destination document and associates a comment with the annotation.

Parameters:

textAnno - the location and attributes of the text highlight

comment - the comment to associate with the text highlight

addTextHighlight

void addTextHighlight(HighlightTextAnnotation textAnno,
                    java.util.Map<java.lang.String,java.lang.String> properties)

Applies highlighting to text in the destination document and associates a set of properties with the annotation. The set of properties are in the form of a Map of key/value pairs.

Parameters:

textAnno - the location and attributes of the text highlight

properties - the properties to associate with the text highlight

addTextHighlight

void addTextHighlight(HighlightTextAnnotation textAnno,
                    java.lang.String comment,
                    java.util.Map<java.lang.String,java.lang.String> properties)

Applies highlighting to text in the destination document and associates a comment and properties with the annotation.

Parameters:

textAnno - the location and attributes of the text highlight

comment - the comment to associate with the text highlight

properties - the properties to associate with the text highlight

addAreaHighlight

void addAreaHighlight(HighlightAreaAnnotation areaAnno)

Applies highlighting to a rectangular area in the destination document. Only available when exporting to the HTML5 destination file format.

Parameters:

areaAnno - the location and attributes of the area highlight

addAreaHighlight

void addAreaHighlight(HighlightAreaAnnotation areaAnno,
                    java.lang.String comment)

Applies highlighting to a rectangular area in the destination document and associates a comment with the annotation. Only available when exporting to the HTML5 destination file format.

Parameters:

areaAnno - the location and attributes of the area highlight

comment - the comment to associate with the area highlight

addAreaHighlight

void addAreaHighlight(HighlightAreaAnnotation areaAnno,
                    java.util.Map<java.lang.String,java.lang.String> properties)

Applies highlighting to a rectangular area in the destination document and associates properties with the annotation. Only available when exporting to the HTML5 destination file format.

Parameters:

areaAnno - the location and attributes of the area highlight

properties - the properties to associate with the area highlight

addAreaHighlight

void addAreaHighlight(HighlightAreaAnnotation areaAnno,
                    java.lang.String comment,
                    java.util.Map<java.lang.String,java.lang.String> properties)

Applies highlighting to a rectangular area in the destination document and associates a comment and properties with the annotation. Only available when exporting to the HTML5 destination file format.

Parameters:

areaAnno - the location and attributes of the area highlight

comment - the comment to associate with the area highlight

properties - the properties to associate with the area highlight

addStampAnnotation

void addStampAnnotation(StampAnnotation stampAnno)

Overlays a stamp image on the destination document. Only available when exporting to the HTML5 destination file format.

Parameters:

stampAnno - the location and attributes of the area highlight

addStampAnnotation

void addStampAnnotation(StampAnnotation stampAnno,
                      java.lang.String comment)

Overlays a stamp image on the destination document document and associates a comment with the annotation. Only available when exporting to the HTML5 destination file format.

Parameters:

stampAnno - the location and attributes of the area highlight

comment - the comment to associate with the area highlight

addStampAnnotation

void addStampAnnotation(StampAnnotation stampAnno,
                      java.util.Map<java.lang.String,java.lang.String> properties)

Overlays a stamp image on the destination document document and associates properties with the annotation. Only available when exporting to the HTML5 destination file format.

Parameters:

stampAnno - the location and attributes of the area highlight

properties - the properties to associate with the area highlight

addStampAnnotation

void addStampAnnotation(StampAnnotation stampAnno,
                      java.lang.String comment,
                      java.util.Map<java.lang.String,java.lang.String> properties)

Overlays a stamp image on the destination document document and associates a comment and properties with the annotation. Only available when exporting to the HTML5 destination file format.

Parameters:

stampAnno - the location and attributes of the area highlight

comment - the comment to associate with the area highlight

properties - the properties to associate with the area highlight

addStampImageFile

void addStampImageFile(java.util.Map<java.lang.String,java.io.File> stamps)
                       throws OutsideInException

Specifies stamp image files to be used in stamp annotations. The Map of key/value pairs associates each stamp name with the file containing the stamp image. The stamp name can then be referenced in the StampAnnotation constructor.

Parameters:

stamps - a mapping of image name references to image files

Throws:

OutsideInException

See Also:

StampAnnotation

addStampImageURL

void addStampImageURL(java.util.Map<java.lang.String,java.net.URI> stamps)

Specifies stamp image files to be used in stamp annotations. The Map of key/value pairs associates a stamp name with the url reference to the stamp image. The stamp name can then be referenced in the StampAnnotation constructor.

Parameters:

stamps - a mapping of image name references to image files

See Also:

StampAnnotation

applyHighlights

void applyHighlights(java.lang.String highlightJsonData)

Applies a set of json highlights when exporting to the HTML5 destination document. This is only useful when exporting to the HTML5 destination file format. See Outside In WebView documentation for acceptable json input.

Parameters:

highlightJsonData - the json description of highlights to apply

redactText

void redactText(RedactAnnotation redaction)

Applies a redaction annotation to the rendered output document. This is only supported when exporting to the PDF destination file format or an image destination file format.

Parameters:

redaction - describes the content to redact