com.qoppa.pdf.annotations

Interface AnnotationComponent

All Known Subinterfaces:

WidgetSignatureComponent

public interface AnnotationComponent

This interface is implemented by components that display annotations.

Author:

Qoppa Software

Method Summary

Modifier and Type	Method and Description
void	annotUpdated() If an annotation's properties are modified, call this method to alert the AnnotationComponent that it needs to update itself based on the annotation's properties.
Annotation	getAnnotation() Returns the annotation for this AnnotationComponent.
IPDFPage	getPage() Returns the page in which this annotation component is located.
int	getPageIndex() Returns the index of the page in which this annotation component is located.
void	showPopup(int x, int y) Shows the popup window for the annotation that contains the text contents.

Method Detail

getAnnotation

Annotation getAnnotation()

Returns the annotation for this AnnotationComponent.

Returns:

The annotation for this AnnotationComponent

getPage

IPDFPage getPage()

Returns the page in which this annotation component is located.

Returns:

The parent page, null if none

getPageIndex

int getPageIndex()

Returns the index of the page in which this annotation component is located.

Returns:

The index to the parent page, -1 if none.

showPopup

void showPopup(int x,
               int y)

Shows the popup window for the annotation that contains the text contents. There are some annotations that do not have a popup, such as the FreeText (Typewriter) annotations.

Parameters:

x - The x location, relative to the annotation component, at which to display the popup.

y - The y location, relative to the annotation component, at which to display the popup.

annotUpdated

void annotUpdated()

If an annotation's properties are modified, call this method to alert the AnnotationComponent that it needs to update itself based on the annotation's properties.