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

PDFInkAnnotation Class Members
In This Topic

The following tables list the members exposed by PDFInkAnnotation.

Public Constructors

| Name | Description
--- | --- | ---
| PDFInkAnnotation Constructor | Overloaded.

Top
Protected Fields

| Name | Description
--- | --- | ---
| annotationType | (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| appearance | (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| cosAnnotation | (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| doubleBuffer | (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isInitialization | True if the annotation is in process of initialization. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isStandardAppearance | (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| page | (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| visualRectangle | (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)

Top
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. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| canRotate | Gets a value indicating whether the annotation should be rotated when the page is rotated. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| 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. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| createFromCosAnnotation | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| createFromXFDF | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| endInit | Signals the end of the initialization of annotation's properties. The annotation appearance is updated when the initialization ends. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| exportAsXFDF | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| flatten | Merges the annotation appearance with the page content stream. After the annotation is flattened, it is removed from the page's annotations collection. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getAuthor | Gets the annotation author. (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
| getContents | Gets the annotation contents. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getCosAnnotation | Gets the COS annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getCreationDate | Gets the annotation creation date. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getDisplayRectangle | Gets the display rectangle of this annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getID | Gets the annotation ID. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getInkColor | Gets the annotation ink color.
| getInkWidth | Gets the ink width.
| getInReplyTo | Gets the annotation that this annotation is "in reply to". (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
| getModifiedDate | Gets the annotation modified date. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getMouseDownAction | Gets the mouse down action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getMouseEnterAction | Gets the mouse enter action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getMouseLeaveAction | Gets the mouse leave action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getMouseUpAction | Gets the mouse up action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getNormalAppearance | Gets the annotation normal appearance. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getOpacity | Gets the annotation opacity. (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
| getPage | Gets the page that contains this annotation.. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getPageCloseAction | Gets the page close action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getPageInvisibleAction | Gets the page invisible action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getPageOpenAction | Gets the page open action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getPageVisibleAction | Gets the page visible action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getPDFRectangle | Gets the annotation rectangle in standard PDF coordinates. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getPoints | Gets the annotation points.
| getPopup | Gets the associated popup annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getRotation | Gets the annotation rotation angle. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getSubject | Gets the annotation subject. (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
| getToggleNoView | Gets a value indicating whether the interpretation of isViewable method should be reversed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getType | Gets the type of the annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| 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. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isInvisible | Gets a value indicating whether the annotation should be displayed if it does not belong to one of the standard annotation types. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isLocked | Gets a value indicating whether the annotation should be modified. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isLockedContents | Gets a value indicating whether the annotation contents should be modified. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isPrintable | Gets a value indicating whether the annotation should be printed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isReadOnly | Gets a value indicating whether the annotation is read only. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isViewable | Gets a value indicating whether the annotation should be displayed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isZoomable | Gets a value indicating whether the annotation should be scaled to current page zoom. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setAuthor | Sets the annotation author. (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
| setCanRotate | Sets a value indicating whether the annotation should be rotated when the page is rotated. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setContents | Sets the annotation contents. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setCreationDate | Sets the annotation creation date. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setDisplayRectangle | Sets the display rectangle of this annotation Object.
| setHidden | Sets a value indicating whether to display the annotation or not. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setID | Sets the annotation ID. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setInkColor | Sets the annotation ink color. The color must be Gray, RGB or CMYK.
| setInkWidth | Sets the ink width.
| setInReplyTo | Sets the annotation that this annotation is "in reply to". (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
| setInvisible | Sets a value indicating whether the annotation should be displayed if it does not belong to one of the standard annotation types. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setLocked | Sets a value indicating whether the annotation should be modified. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setLockedContents | Sets a value indicating whether the annotation contents should be modified. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setModifiedDate | Sets the annotation modified date. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setMouseDownAction | Sets the mouse down action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setMouseEnterAction | Sets the mouse enter action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setMouseLeaveAction | Sets the mouse leave action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setMouseUpAction | Sets the mouse up action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setNormalAppearance | Sets the annotation normal appearance. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setOpacity | Sets the annotation opacity. (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
| setPageCloseAction | Sets the page close action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setPageInvisibleAction | Sets the page invisible action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setPageOpenAction | Sets the page open action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setPageVisibleAction | Sets the page visible action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setPDFRectangle | Sets the annotation rectangle in standard PDF coordinates. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setPoints | Sets the annotation points. The points in this array are given in page display coordinates, relative to top left corner of the visible page.
| setPopup | Sets the associated popup annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setPrintable | Sets a value indicating whether the annotation should be printed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setReadOnly | Sets a value indicating whether the annotation is read only. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setRotation | Sets the annotation rotation angle. The accepted values for this property are 0, 90, 180 and 270 degrees. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setSubject | Sets the annotation subject. (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
| setToggleNoView | Sets a value indicating whether the interpretation of isViewable method should be reversed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setViewable | Sets a value indicating whether the annotation should be displayed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setZoomable | Sets a value indicating whether the annotation should be scaled to current page zoom. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| zInternalMethod1 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| zInternalMethod2 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| zInternalMethod3 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| zInternalMethod4 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| zInternalMethod5 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| zInternalMethod6 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| zInternalMethod7 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| zInternalMethod8 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)

Top
Protected Methods

| Name | Description
--- | --- | ---
| initActions | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| initAdditionalAction | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| initAppearance | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setAction | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| 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. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| writeXFDFStartElement | This method supports the internal library infrastructure and should not be used by external client code.

Top
See Also

#### Reference

PDFInkAnnotation Class
com.o2sol.pdf4java.annotations Package

© 2025 O2 Solutions All Rights Reserved.

Send comments on this topic.