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

Annotation	getAnnotation() Returns the annotation that this component displays.
IPDFPage	getPage() Returns the page object in which this annotation is located.
int	getPageIndex() Returns the index of the page that this annotation is located under.
boolean	isSelected() Returns a flag indicating whether this annotation component is selected.
void	setSelected(boolean selected) Sets this annotation component's selection status.
void	showPopup(int x, int y) Shows the popup window for the annotation that contains the text contents.

Method Detail

getAnnotation

public Annotation getAnnotation()

Returns the annotation that this component displays.

Returns:

Reference to the annotation displayed by this component.

getPage

public IPDFPage getPage()

Returns the page object in which this annotation is located.

Returns:

The parent page, null if none

getPageIndex

public int getPageIndex()

Returns the index of the page that this annotation is located under.

Returns:

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

isSelected

public boolean isSelected()

Returns a flag indicating whether this annotation component is selected.

Returns:

Flag indicating whether this annotation is selected

setSelected

public void setSelected(boolean selected)

Sets this annotation component's selection status.

Parameters:

selected -

showPopup

public 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 teh popup.