CaretAnnotation
Contents
[
Hide
]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
Constructor | Description |
---|---|
CaretAnnotation(IDocument document) | Constructor for usign in Generator. |
CaretAnnotation(Page page, Rectangle rect) | Creates new Caret annotation on the specified page. |
Methods
Method | Description |
---|---|
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:
Parameter | Type | Description |
---|---|---|
document | IDocument | Document 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:
Parameter | Type | Description |
---|---|---|
page | Page | Document’s page where annotation should be created. |
rect | Rectangle | Required 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:
Parameter | Type | Description |
---|---|---|
value | Rectangle | caret 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:
Parameter | Type | Description |
---|---|---|
value | int | CaretSymbol element |
accept(AnnotationSelector visitor)
public void accept(AnnotationSelector visitor)
Accepts visitor object to process the annotation.
Parameters:
Parameter | Type | Description |
---|---|---|
visitor | AnnotationSelector | Visitor object. |