com.qoppa.pdfNotes

Interface IAnnotationManagerNotes

All Superinterfaces:

IAnnotationManager

public interface IAnnotationManagerNotes
extends IAnnotationManager

This interface extends IAnnotationManager to manage the review/marked status of Annotations.

An implementation of this class can be obtained from a PDFNotesBean with PDFNotesBean#getAnnotationManagerNotes.

Author:

Qoppa Software

Method Summary

Modifier and Type	Method and Description
boolean	isRichTextEditable() Get the flag that allows setting text styles using the annotation context menu and shortcut keys.
void	setMarked(Annotation annot, boolean marked, PDFPage parentPage) Set the marked status of an Annotation.
void	setReviewStatus(Annotation annot, String status, PDFPage parentPage) Set the review status of an Annotation.
void	setRichTextEditable(boolean enabled) Set the flag to allow setting text styles using the annotation context menu and shortcut keys.

Methods inherited from interface com.qoppa.pdf.annotations.IAnnotationManager

addComponentToSelection, addSelectionListener, clearSelection, deselectAnnotationComponent, getSelectedComponents, isSelected, removeSelectionListener, selectAnnotationComponent, selectAnnotationComponents

Method Detail

setMarked

void setMarked(Annotation annot,
               boolean marked,
               PDFPage parentPage)

Set the marked status of an Annotation.

Parameters:

annot - The Annotation to update.

marked - True to set the annotation as marked, false to set as unmarked.

parentPage - The annot's parent page.

setReviewStatus

void setReviewStatus(Annotation annot,
                     String status,
                     PDFPage parentPage)

Set the review status of an Annotation. The status parameter should be one of the status strings defined in AnnotationReviewStatus.

Parameters:

annot - The Annotation to update.

status - The new review status.

parentPage - The annot's parent page.

setRichTextEditable

void setRichTextEditable(boolean enabled)

Set the flag to allow setting text styles using the annotation context menu and shortcut keys. This is enabled by default.

Parameters:

enabled - set to true to allow setting text styles using the annotation context menu and shortcut keys.

isRichTextEditable

boolean isRichTextEditable()

Get the flag that allows setting text styles using the annotation context menu and shortcut keys. This is enabled by default.

Parameters:

enabled - returns true if setting text styles using the annotation context menu and shortcut keys is allowed.