PDF4Java Reference Documentation
com.o2sol.pdf4java.annotations Package / PDFAnnotation Class
Collapse All Expand All Members Options: Show All Members Options: Filtered
Include Inherited Members
Include Protected Members
In This Topic

PDFAnnotation Class Methods
In This Topic

For a list of all members of this type, see PDFAnnotation members.

Public Methods

| Name | Description
--- | --- | ---
| beginInit | Signals the start of the initialization of annotation's properties. The annotation appearance is not updated while properties are initialized. When initialization is completed, call to signal the end of initialization and update the annotation appearance.
| canRotate | Gets a value indicating whether the annotation should be rotated when the page is rotated.
| createAnnotationAppearance | Creates the visual appearance for the annotation. This method supports the internal library infrastructure and should not be used by external client code.
| createAppearance | Creates the visual appearance for the annotation. This method supports the internal library infrastructure and should not be used by external client code.
| createFromCosAnnotation | This method supports the internal library infrastructure and should not be used by external client code.
| createFromXFDF | This method supports the internal library infrastructure and should not be used by external client code.
| endInit | Signals the end of the initialization of annotation's properties. The annotation appearance is updated when the initialization ends.
| exportAsXFDF | This method supports the internal library infrastructure and should not be used by external client code.
| flatten | Overloaded. Merges the annotation appearance with the page content stream. After the annotation is flattened, it is removed from the page's annotations collection.
| getContents | Gets the annotation contents.
| getCosAnnotation | Gets the COS annotation.
| getCreationDate | Gets the annotation creation date.
| getDisplayRectangle | Gets the display rectangle of this annotation.
| getID | Gets the annotation ID.
| getModifiedDate | Gets the annotation modified date.
| getMouseDownAction | Gets the mouse down action.
| getMouseEnterAction | Gets the mouse enter action.
| getMouseLeaveAction | Gets the mouse leave action.
| getMouseUpAction | Gets the mouse up action.
| getNormalAppearance | Gets the annotation normal appearance.
| getPage | Gets the page that contains this annotation..
| getPageCloseAction | Gets the page close action.
| getPageInvisibleAction | Gets the page invisible action.
| getPageOpenAction | Gets the page open action.
| getPageVisibleAction | Gets the page visible action.
| getPDFRectangle | Gets the annotation rectangle in standard PDF coordinates.
| getPopup | Gets the associated popup annotation.
| getRotation | Gets the annotation rotation angle.
| getToggleNoView | Gets a value indicating whether the interpretation of isViewable method should be reversed.
| getType | Gets the type of the annotation.
| importFromXFDF | This method supports the internal library infrastructure and should not be used by external client code.
| isHidden | Gets a value indicating whether to display the annotation or not.
| isInvisible | Gets a value indicating whether the annotation should be displayed if it does not belong to one of the standard annotation types.
| isLocked | Gets a value indicating whether the annotation should be modified.
| isLockedContents | Gets a value indicating whether the annotation contents should be modified.
| isPrintable | Gets a value indicating whether the annotation should be printed.
| isReadOnly | Gets a value indicating whether the annotation is read only.
| isViewable | Gets a value indicating whether the annotation should be displayed.
| isZoomable | Gets a value indicating whether the annotation should be scaled to current page zoom.
| setCanRotate | Sets a value indicating whether the annotation should be rotated when the page is rotated.
| setContents | Sets the annotation contents.
| setCreationDate | Sets the annotation creation date.
| setDisplayRectangle | Overloaded. Sets the display rectangle of this annotation.
| setHidden | Sets a value indicating whether to display the annotation or not.
| setID | Sets the annotation ID.
| setInvisible | Sets a value indicating whether the annotation should be displayed if it does not belong to one of the standard annotation types.
| setLocked | Sets a value indicating whether the annotation should be modified.
| setLockedContents | Sets a value indicating whether the annotation contents should be modified.
| setModifiedDate | Sets the annotation modified date.
| setMouseDownAction | Sets the mouse down action.
| setMouseEnterAction | Sets the mouse enter action.
| setMouseLeaveAction | Sets the mouse leave action.
| setMouseUpAction | Sets the mouse up action.
| setNormalAppearance | Sets the annotation normal appearance.
| setPageCloseAction | Sets the page close action.
| setPageInvisibleAction | Sets the page invisible action.
| setPageOpenAction | Sets the page open action.
| setPageVisibleAction | Sets the page visible action.
| setPDFRectangle | Sets the annotation rectangle in standard PDF coordinates.
| setPopup | Sets the associated popup annotation.
| setPrintable | Sets a value indicating whether the annotation should be printed.
| setReadOnly | Sets a value indicating whether the annotation is read only.
| setRotation | Sets the annotation rotation angle. The accepted values for this property are 0, 90, 180 and 270 degrees.
| setToggleNoView | Sets a value indicating whether the interpretation of isViewable method should be reversed.
| setViewable | Sets a value indicating whether the annotation should be displayed.
| setZoomable | Sets a value indicating whether the annotation should be scaled to current page zoom.
| zInternalMethod1 | This method supports the internal library infrastructure and should not be used by external client code.
| zInternalMethod2 | This method supports the internal library infrastructure and should not be used by external client code.
| zInternalMethod3 | This method supports the internal library infrastructure and should not be used by external client code.
| zInternalMethod4 | This method supports the internal library infrastructure and should not be used by external client code.
| zInternalMethod5 | This method supports the internal library infrastructure and should not be used by external client code.
| zInternalMethod6 | This method supports the internal library infrastructure and should not be used by external client code.
| zInternalMethod7 | This method supports the internal library infrastructure and should not be used by external client code.
| zInternalMethod8 | This method supports the internal library infrastructure and should not be used by external client code.

Top
Protected Methods

| Name | Description
--- | --- | ---
| initActions | This method supports the internal library infrastructure and should not be used by external client code.
| initAdditionalAction | This method supports the internal library infrastructure and should not be used by external client code.
| initAppearance | This method supports the internal library infrastructure and should not be used by external client code.
| setAction | This method supports the internal library infrastructure and should not be used by external client code.
| writeXFDFAttributes | This method supports the internal library infrastructure and should not be used by external client code.
| writeXFDFChildNodes | This method supports the internal library infrastructure and should not be used by external client code.
| writeXFDFEndElement | This method supports the internal library infrastructure and should not be used by external client code.
| writeXFDFStartElement | This method supports the internal library infrastructure and should not be used by external client code.

Top
See Also

#### Reference

PDFAnnotation Class
com.o2sol.pdf4java.annotations Package

© 2025 O2 Solutions All Rights Reserved.

Send comments on this topic.