|
Oracle Outside In Java API Reference 8.5.4 F11002-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 | |
---|---|
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 |
---|
void addTextHighlight(HighlightTextAnnotation textAnno)
textAnno
- the location and attributes of the text highlightvoid addTextHighlight(HighlightTextAnnotation textAnno, java.lang.String comment)
textAnno
- the location and attributes of the text highlightcomment
- the comment to associate with the text highlightvoid addTextHighlight(HighlightTextAnnotation textAnno, java.util.Map<java.lang.String,java.lang.String> properties)
Map
of key/value pairs.textAnno
- the location and attributes of the text highlightproperties
- the properties to associate with the text highlightvoid addTextHighlight(HighlightTextAnnotation textAnno, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties)
textAnno
- the location and attributes of the text highlightcomment
- the comment to associate with the text highlightproperties
- the properties to associate with the text highlightvoid addAreaHighlight(HighlightAreaAnnotation areaAnno)
areaAnno
- the location and attributes of the area highlightvoid addAreaHighlight(HighlightAreaAnnotation areaAnno, java.lang.String comment)
areaAnno
- the location and attributes of the area highlightcomment
- the comment to associate with the area highlightvoid addAreaHighlight(HighlightAreaAnnotation areaAnno, java.util.Map<java.lang.String,java.lang.String> properties)
areaAnno
- the location and attributes of the area highlightproperties
- the properties to associate with the area highlightvoid addAreaHighlight(HighlightAreaAnnotation areaAnno, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties)
areaAnno
- the location and attributes of the area highlightcomment
- the comment to associate with the area highlightproperties
- the properties to associate with the area highlightvoid addStampAnnotation(StampAnnotation stampAnno)
stampAnno
- the location and attributes of the area highlightvoid addStampAnnotation(StampAnnotation stampAnno, java.lang.String comment)
stampAnno
- the location and attributes of the area highlightcomment
- the comment to associate with the area highlightvoid addStampAnnotation(StampAnnotation stampAnno, java.util.Map<java.lang.String,java.lang.String> properties)
stampAnno
- the location and attributes of the area highlightproperties
- the properties to associate with the area highlightvoid addStampAnnotation(StampAnnotation stampAnno, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties)
stampAnno
- the location and attributes of the area highlightcomment
- the comment to associate with the area highlightproperties
- the properties to associate with the area highlightvoid addStampImageFile(java.util.Map<java.lang.String,java.io.File> stamps) throws OutsideInException
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.stamps
- a mapping of image name references to image filesOutsideInException
StampAnnotation
void addStampImageURL(java.util.Map<java.lang.String,java.net.URI> stamps)
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.stamps
- a mapping of image name references to image filesStampAnnotation
void applyHighlights(java.lang.String highlightJsonData)
highlightJsonData
- the json description of highlights to applyvoid redactText(RedactAnnotation redaction)
redaction
- describes the content to redact
|
Oracle Outside In Java API Reference 8.5.4 F11002-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |