Packages

com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

InvalidFormTypeOperationException

Skip navigation links

java.lang.Object
- com.aspose.pdf.BaseParagraph
- - com.aspose.pdf.Annotation

All Implemented Interfaces:

com.aspose.ms.System.ICloneable

Direct Known Subclasses:

LinkAnnotation, MarkupAnnotation, MovieAnnotation, PDF3DAnnotation, PopupAnnotation, RedactionAnnotation, RichMediaAnnotation, ScreenAnnotation, WatermarkAnnotation, WidgetAnnotation
```
public abstract class Annotation
extends BaseParagraph
```
Class representing annotation object.

Field Summary

Fields
Modifier and Type Field and Description

boolean _disableUpdateAppearance
For Internal usage only

Fields
Modifier and Type	Field and Description
`boolean`	`_disableUpdateAppearance` For Internal usage only

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract void`	`accept(AnnotationSelector visitor)` Accepts visitor for annotation processing.
`static Annotation`	`createAnnotation(com.aspose.pdf.engine.data.IPdfObject annotEngineObj, Page page)` For internal usage only Initializes annotation from PDF object which describes the annotation.
`void`	`flatten()` Places annotation contents directly on the page, annotation object will be removed.
`String`	`getActiveState()` Gets current annotation appearance state.
`int`	`getAlignment()` Deprecated. Use TextHorizontalAlignment property
`abstract int`	`getAnnotationType()` Gets type of annotation.
`AppearanceDictionary`	`getAppearance()` Gets appearance dictionary of the annotation.
`Border`	`getBorder()` Gets annotation border characteristics.
`Characteristics`	`getCharacteristics()` Gets annotation characteristics.
`Color`	`getColor()` Gets annotation color.
`String`	`getContents()` Gets annotation text.
`com.aspose.pdf.engine.data.IPdfDictionary`	`getEngineDict()` Internal only
`com.aspose.pdf.engine.data.IPdfObject`	`getEngineObj()` For Internal usage only
`int`	`getFlags()` Get flags of the annotation.
`String`	`getFullName()` Gets full qualified name of the annotation.
`double`	`getHeight()` Gets height of the annotation.
`int`	`getHorizontalAlignment_Annotation_New()` Deprecated. Use TextHorizontalAlignment property
`Date`	`getModified()` Gets date and time when annotation was recently modified.
`com.aspose.ms.System.DateTime`	`getModifiedInternal()` Gets date and time when annotation was recently modified.
`String`	`getName()` Gets annotation name on the page.
`XForm`	`getNormalAppearance()` Gets normal appearance.
`Page`	`getPage()` Gets the page object with which this annotation is associated.
`int`	`getPageIndex()` Gets index of page which contains annotation.
`int`	`getPageIndex(Annotation annotation)` Gets index of page which contains annotation.
`PdfActionCollection`	`getPdfActions()` Gets list of annotation actions.
`Rectangle`	`getRect()` Gets annotation rectangle.
`Rectangle`	`getRectangle(boolean considerRotation)` Returns rectangle of annotation taking into consideration page rotation.
`AppearanceDictionary`	`getStates()` Gets appearance dictionary of annotation.
`int`	`getTextHorizontalAlignment()` Gets text alignment for annotation.
`double`	`getWidth()` Gets width of the annotation.
`void`	`initialize(IDocument doc)` Instance initialization
`static boolean`	`isUpdateAppearanceOnConvert()` If true, annotation appearance will be updated before converting PF document into image.
`static boolean`	`isUseFontSubset()` If this property set to true, fonts will be added to document as subsets.
`void`	`setActiveState(String value)` Sets current annotation appearance state.
`void`	`setAlignment(int value)` Deprecated. Use TextHorizontalAlignment property
`void`	`setBorder(Border value)` Sets annotation border characteristics.
`void`	`setColor(Color value)` Sets annotation color.
`void`	`setContents(String value)` Sets annotation text.
`void`	`setFlags(int value)` Set flags of the annotation.
`void`	`setHeight(double value)` Sets height of the annotation.
`void`	`setHorizontalAlignment_Annotation_New(int value)` Deprecated. Use TextHorizontalAlignment property
`void`	`setModified(Date value)` Sets date and time when annotation was recently modified.
`void`	`setModifiedInternal(com.aspose.ms.System.DateTime value)` Sets date and time when annotation was recently modified.
`void`	`setName(String value)` Sets annotation name on the page.
`void`	`setRect(Rectangle value)` Sets annotation rectangle.
`void`	`setStructParent(int value)`
`void`	`setTextHorizontalAlignment(int value)` Sets text alignmennt for annotation.
`static void`	`setUpdateAppearanceOnConvert(boolean value)` If true, annotation appearance will be updated before converting PF document into image.
`static void`	`setUseFontSubset(boolean value)` If this property set to true, fonts will be added to document as subsets.
`void`	`setWidth(double value)` Sets width of the annotation.

Methods inherited from class com.aspose.pdf.BaseParagraph
deepClone, getHorizontalAlignment, getHyperlink, getMargin, getVerticalAlignment, getZIndex, isFirstParagraphInColumn, isInLineParagraph, isInNewPage, isKeptWithNext, setFirstParagraphInColumn, setHorizontalAlignment, setHyperlink, setInLineParagraph, setInNewPage, setKeptWithNext, setMargin, setVerticalAlignment, setZIndex

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _disableUpdateAppearance
```
public boolean _disableUpdateAppearance
```
    For Internal usage only
- Method Detail
  - initialize
```
public void initialize(IDocument doc)
```
    Instance initialization
    
    Parameters:
    
    doc - IDocument object
  - getEngineObj
```
public com.aspose.pdf.engine.data.IPdfObject getEngineObj()
```
    For Internal usage only
    
    Returns:
    
    Internal onject
  - getEngineDict
```
public com.aspose.pdf.engine.data.IPdfDictionary getEngineDict()
```
    Internal only
    
    Returns:
    
    IPdfDictionary object
  - setStructParent
```
public final void setStructParent(int value)
```
  - isUpdateAppearanceOnConvert
```
public static boolean isUpdateAppearanceOnConvert()
```
    If true, annotation appearance will be updated before converting PF document into image. This allows convert fields correctly but probably demand more time.
    
    Returns:
    
    boolean value
  - setUpdateAppearanceOnConvert
```
public static void setUpdateAppearanceOnConvert(boolean value)
```
    If true, annotation appearance will be updated before converting PF document into image. This allows convert fields correctly but probably demand more time.
    
    Parameters:
    
    value - boolean value
  - isUseFontSubset
```
public static boolean isUseFontSubset()
```
    If this property set to true, fonts will be added to document as subsets. Default value is true.
    
    Returns:
    
    boolean value
  - setUseFontSubset
```
public static void setUseFontSubset(boolean value)
```
    If this property set to true, fonts will be added to document as subsets. Default value is true.
    
    Parameters:
    
    value - boolean value
  - getNormalAppearance
```
public XForm getNormalAppearance()
```
    Gets normal appearance.
    
    Returns:
    
    XForm object
  - getFlags
```
public int getFlags()
```
    Get flags of the annotation.
    
    Returns:
    
    Flags of the annotation
    
    See Also:
    
    AnnotationFlags
  - setFlags
```
public void setFlags(int value)
```
    Set flags of the annotation.
    
    Parameters:
    
    value - flags of the annotation
    
    See Also:
    
    AnnotationFlags
  - getPage
```
public Page getPage()
```
    Gets the page object with which this annotation is associated.
    
    Returns:
    
    Page object
  - getAnnotationType
```
public abstract int getAnnotationType()
```
    Gets type of annotation.
    
    Returns:
    
    int value
    
    See Also:
    
    AnnotationType
  - getWidth
```
public double getWidth()
```
    Gets width of the annotation.
    
    Returns:
    
    double value, width of the annotation.
  - setWidth
```
public void setWidth(double value)
```
    Sets width of the annotation.
    
    Parameters:
    
    value - width of the annotation.
  - getPdfActions
```
public PdfActionCollection getPdfActions()
```
    Gets list of annotation actions.
    
    Returns:
    
    PdfActionCollection instance
  - getHeight
```
public double getHeight()
```
    Gets height of the annotation.
    
    Returns:
    
    height of the annotation
  - setHeight
```
public void setHeight(double value)
```
    Sets height of the annotation.
    
    Parameters:
    
    value - height of the annotation
  - getRect
```
public Rectangle getRect()
```
    Gets annotation rectangle.
    
    Returns:
    
    Rectangle object
  - setRect
```
public void setRect(Rectangle value)
```
    Sets annotation rectangle.
    
    Parameters:
    
    value - Rectangle value
  - getRectangle
```
public Rectangle getRectangle(boolean considerRotation)
```
    Returns rectangle of annotation taking into consideration page rotation.
    
    Parameters:
    
    considerRotation - If true, page rotation is taken into consideration.
    
    Returns:
    
    Rectangle object
  - getContents
```
public String getContents()
```
    Gets annotation text.
    
    Returns:
    
    String value
  - setContents
```
public void setContents(String value)
```
    Sets annotation text.
    
    Parameters:
    
    value - String value
  - getName
```
public String getName()
```
    Gets annotation name on the page.
    
    Returns:
    
    String value
  - setName
```
public void setName(String value)
```
    Sets annotation name on the page.
    
    Parameters:
    
    value - String value
  - getModifiedInternal
```
public com.aspose.ms.System.DateTime getModifiedInternal()
```
    Gets date and time when annotation was recently modified.
    
    Returns:
    
    DateTime object
  - getModified
```
public Date getModified()
```
    Gets date and time when annotation was recently modified.
    
    Returns:
    
    date and time when annotation was recently modified.
  - setModifiedInternal
```
public void setModifiedInternal(com.aspose.ms.System.DateTime value)
```
    Sets date and time when annotation was recently modified.
    
    Parameters:
    
    value - DateTime object
  - setModified
```
public void setModified(Date value)
```
    Sets date and time when annotation was recently modified.
    
    Parameters:
    
    value - Date object
  - getColor
```
public Color getColor()
```
    Gets annotation color.
    
    Returns:
    
    Color object
  - setColor
```
public void setColor(Color value)
```
    Sets annotation color.
    
    Parameters:
    
    value - Color value
  - getBorder
```
public Border getBorder()
```
    Gets annotation border characteristics. Border
    
    Returns:
    
    Border object
  - setBorder
```
public void setBorder(Border value)
```
    Sets annotation border characteristics. Border
    
    Parameters:
    
    value - Border value
  - getActiveState
```
public String getActiveState()
```
    Gets current annotation appearance state.
    
    Returns:
    
    String value
  - setActiveState
```
public void setActiveState(String value)
```
    Sets current annotation appearance state.
    
    Parameters:
    
    value - String value
  - getCharacteristics
```
public Characteristics getCharacteristics()
```
    Gets annotation characteristics.
    
    Returns:
    
    Characteristics object
  - getStates
```
public AppearanceDictionary getStates()
```
    Gets appearance dictionary of annotation.
    
    Returns:
    
    AppearanceDictionary object
  - getAlignment
```
@Deprecated
public int getAlignment()
```
    Deprecated. Use TextHorizontalAlignment property
    
    Annotation alignment. This property is obsolete. Use getHorizontalAlignment_Annotation_New instead.
    
    Returns:
    
    TextAlignment element
    
    See Also:
    
    TextAlignment
  - setAlignment
```
@Deprecated
public void setAlignment(int value)
```
    Deprecated. Use TextHorizontalAlignment property
    
    Annotation alignment. This property is obsolete. Use getHorizontalAlignment_Annotation_New instead.
    
    Parameters:
    
    value - TextAlignment element
    
    See Also:
    
    TextAlignment
  - getHorizontalAlignment_Annotation_New
```
@Deprecated
public final int getHorizontalAlignment_Annotation_New()
```
    Deprecated. Use TextHorizontalAlignment property
    
    Gets or sets text alignment for annotation.
    
    Returns:
    
    text alignment for annotation.
    
    See Also:
    
    HorizontalAlignment
  - setHorizontalAlignment_Annotation_New
```
@Deprecated
public final void setHorizontalAlignment_Annotation_New(int value)
```
    Deprecated. Use TextHorizontalAlignment property
    
    Gets or sets text alignment for annotation.
    
    Parameters:
    
    value - text alignmennt for annotation.
    
    See Also:
    
    HorizontalAlignment
  - getTextHorizontalAlignment
```
public int getTextHorizontalAlignment()
```
    Gets text alignment for annotation.
    
    Returns:
    
    text alignment for annotation.
    
    See Also:
    
    HorizontalAlignment
  - setTextHorizontalAlignment
```
public void setTextHorizontalAlignment(int value)
```
    Sets text alignmennt for annotation.
    
    Parameters:
    
    value - text alignmennt for annotation.
    
    See Also:
    
    HorizontalAlignment
  - createAnnotation
```
public static Annotation createAnnotation(com.aspose.pdf.engine.data.IPdfObject annotEngineObj,
                                          Page page)
```
    For internal usage only
    Initializes annotation from PDF object which describes the annotation.
    
    Parameters:
    
    annotEngineObj - PDF object describing annotation
    
    page - Page object
    
    Returns:
    
    Created annotation object of appropriate type
  - accept
```
public abstract void accept(AnnotationSelector visitor)
```
    Accepts visitor for annotation processing.
    
    Parameters:
    
    visitor - AnnotationSelector object.
  - flatten
```
public void flatten()
```
    Places annotation contents directly on the page, annotation object will be removed.
  - getFullName
```
public String getFullName()
```
    Gets full qualified name of the annotation.
    
    Returns:
    
    String value
  - getAppearance
```
public AppearanceDictionary getAppearance()
```
    Gets appearance dictionary of the annotation.
    
    Returns:
    
    AppearanceDictionary object
  - getPageIndex
```
public int getPageIndex()
```
    Gets index of page which contains annotation.
    
    Returns:
    
    int value
  - getPageIndex
```
public int getPageIndex(Annotation annotation)
```
    Gets index of page which contains annotation.
    
    Parameters:
    
    annotation - Annotation object
    
    Returns:
    
    int value

Packages

com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

Class Annotation

Field Summary

Method Summary

Methods inherited from class com.aspose.pdf.BaseParagraph

Methods inherited from class java.lang.Object

Field Detail

_disableUpdateAppearance

Method Detail

initialize

getEngineObj

getEngineDict

setStructParent

isUpdateAppearanceOnConvert

setUpdateAppearanceOnConvert

isUseFontSubset

setUseFontSubset

getNormalAppearance

getFlags

setFlags

getPage

getAnnotationType

getWidth

setWidth

getPdfActions

getHeight

setHeight

getRect

setRect

getRectangle

getContents

setContents

getName

setName

getModifiedInternal

getModified

setModifiedInternal

setModified

getColor

setColor

getBorder

setBorder

getActiveState

setActiveState

getCharacteristics

getStates

getAlignment

setAlignment

getHorizontalAlignment_Annotation_New

setHorizontalAlignment_Annotation_New

getTextHorizontalAlignment

setTextHorizontalAlignment

createAnnotation

accept

flatten

getFullName

getAppearance

getPageIndex

getPageIndex