CaretAnnotation

Inheritance: java.lang.Object, com.aspose.pdf.BaseParagraph, com.aspose.pdf.Annotation, com.aspose.pdf.MarkupAnnotation

public final class CaretAnnotation extends MarkupAnnotation

Class representing Caret annotation.

Constructors

ConstructorDescription
CaretAnnotation(IDocument document)Constructor for usign in Generator.
CaretAnnotation(Page page, Rectangle rect)Creates new Caret annotation on the specified page.

Methods

MethodDescription
getAnnotationType()Gets type of annotation.
getFrame()Gets caret rectangle.
setFrame(Rectangle value)Sets caret rectangle.
getSymbol()Gets symbol associated with caret.
setSymbol(int value)Sets output page size for import.
accept(AnnotationSelector visitor)Accepts visitor object to process the annotation.

CaretAnnotation(IDocument document)

public CaretAnnotation(IDocument document)

Constructor for usign in Generator.

Parameters:

ParameterTypeDescription
documentIDocumentDocument where annotation will be created.

CaretAnnotation(Page page, Rectangle rect)

public CaretAnnotation(Page page, Rectangle rect)

Creates new Caret annotation on the specified page.

Parameters:

ParameterTypeDescription
pagePageDocument’s page where annotation should be created.
rectRectangleRequired rectangle that sets annotation’s border.

getAnnotationType()

public AnnotationType getAnnotationType()

Gets type of annotation.

Returns: AnnotationType - AnnotationType element

getFrame()

public Rectangle getFrame()

Gets caret rectangle.

Returns: Rectangle - caret rectangle.

setFrame(Rectangle value)

public void setFrame(Rectangle value)

Sets caret rectangle.

Parameters:

ParameterTypeDescription
valueRectanglecaret rectangle.

getSymbol()

public int getSymbol()

Gets symbol associated with caret.

CaretSymbol

Returns: int - CaretSymbol element

setSymbol(int value)

public void setSymbol(int value)

Sets output page size for import.

Parameters:

ParameterTypeDescription
valueintCaretSymbol element

accept(AnnotationSelector visitor)

public void accept(AnnotationSelector visitor)

Accepts visitor object to process the annotation.

Parameters:

ParameterTypeDescription
visitorAnnotationSelectorVisitor object.