com.aspose.pdf

Class TextAnnotation

java.lang.Object

com.aspose.pdf.BaseParagraph

com.aspose.pdf.Annotation

com.aspose.pdf.MarkupAnnotation

com.aspose.pdf.TextAnnotation

All Implemented Interfaces:

com.aspose.ms.System.ICloneable, com.aspose.pdf.engine.ITitledAnnotation

public final class TextAnnotation
extends MarkupAnnotation

Represents a text annotation that is a "sticky note" attached to a point in the PDF document.

Constructor Summary

Constructors

Constructor and Description
TextAnnotation() Create TextAnnotation instance
TextAnnotation(IDocument document) Constructor for annotation when used in Generator.
TextAnnotation(Page page, Rectangle rect) Creates new Text annotation on the specified page.

Method Summary

Modifier and Type	Method and Description
void	accept(AnnotationSelector visitor) Accepts visitor object to process the annotation.
int	getAnnotationType() Gets type of annotation.
int	getIcon() Gets an icon to be used in displaying the annotation.
boolean	getOpen() Gets a flag specifying whether the annotation should initially be displayed open.
int	getState() Gets the state to which the original annotation should be set.
int	getStateModel() Gets state model
void	setIcon(int value) Sets an icon to be used in displaying the annotation.
void	setOpen(boolean value) Sets a flag specifying whether the annotation should initially be displayed open.
void	setState(int value) Sets the state to which the original annotation should be set.

Methods inherited from class com.aspose.pdf.MarkupAnnotation

getCreationDate, getInReplyTo, getOpacity, getPopup, getReplyType, getRichText, getSubject, getTitle, setInReplyTo, setOpacity, setPopup, setReplyType, setRichText, setSubject, setTitle

Methods inherited from class com.aspose.pdf.Annotation

changeAfterResize, createAnnotation, flatten, getActiveState, getAlignment, getAppearance, getBorder, getCharacteristics, getColor, getContents, getEngineDict, getEngineObj, getFlags, getFullName, getHeight, getHorizontalAlignment_Annotation_New, getModified, getModifiedInternal, getName, getNormalAppearance, getPage, getPageIndex, getPageIndex, getPdfActions, getRect, getRectangle, getStates, getTextHorizontalAlignment, getWidth, initialize, isUpdateAppearanceOnConvert, isUseFontSubset, setActiveState, setAlignment, setBorder, setColor, setContents, setFlags, setHeight, setHorizontalAlignment_Annotation_New, setModified, setModifiedInternal, setName, setRect, setTextHorizontalAlignment, setUpdateAppearanceOnConvert, setUseFontSubset, setWidth

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

Constructor Detail

TextAnnotation

public TextAnnotation(IDocument document)

Constructor for annotation when used in Generator.

Parameters:

document - Document where text annotation will be created.

TextAnnotation

public TextAnnotation(Page page,
                      Rectangle rect)

Creates new Text annotation on the specified page.

Parameters:

page - The document's page where annotation should be created.

rect - The annotation rectangle, defining the location of the annotation on the page.

TextAnnotation

public TextAnnotation()

Create TextAnnotation instance

Method Detail

getOpen

public boolean getOpen()

Gets a flag specifying whether the annotation should initially be displayed open.

Returns:

boolean value

setOpen

public void setOpen(boolean value)

Sets a flag specifying whether the annotation should initially be displayed open.

Parameters:

value - boolean value

getIcon

public int getIcon()

Gets an icon to be used in displaying the annotation.

Returns:

TextIcon value

See Also:

TextIcon

setIcon

public void setIcon(int value)

Sets an icon to be used in displaying the annotation.

Parameters:

value - TextIcon value

See Also:

TextIcon

getState

public int getState()

Gets the state to which the original annotation should be set.

Returns:

AnnotationState value

See Also:

AnnotationState

setState

public void setState(int value)

Sets the state to which the original annotation should be set.

Parameters:

value - AnnotationState value

See Also:

AnnotationState

getAnnotationType

public int getAnnotationType()

Gets type of annotation.

Specified by:

getAnnotationType in class Annotation

Returns:

AnnotationType value

See Also:

AnnotationState

accept

public void accept(AnnotationSelector visitor)

Accepts visitor object to process the annotation.

Specified by:

accept in class Annotation

Parameters:

visitor - Visitor object.

getStateModel

public int getStateModel()

Gets state model

Returns:

AnnotationStateModel value

See Also:

AnnotationStateModel