MarkupAnnotation
Inheritance: java.lang.Object, com.aspose.pdf.BaseParagraph, com.aspose.pdf.Annotation
All Implemented Interfaces: com.aspose.pdf.engine.ITitledAnnotation
public abstract class MarkupAnnotation extends Annotation implements ITitledAnnotation
Abstract class representing markup annotation.
Constructors
Constructor | Description |
---|---|
MarkupAnnotation(IDocument document) | Constructor for markup annotation. |
MarkupAnnotation() | Constructor |
Methods
Method | Description |
---|---|
getTitle() | Gets a text that shall be displayed in title bar of annotation. |
setTitle(String value) | Sets a text that shall be displayed in title bar of annotation. |
getRichText() | Gets a rich text string to be displayed in the pop-up window when the annotation is opened. |
setRichText(String value) | Sets a rich text string to be displayed in the pop-up window when the annotation is opened. |
getCreationDate() | Gets date and time when annotation was created. |
getSubject() | Gets text representing desciption of the object. |
setSubject(String value) | Sets text representing desciption of the object. |
getPopup() | Pop-up annotation for entering or editing the text associated with this annotation. |
setPopup(PopupAnnotation value) | Pop-up annotation for entering or editing the text associated with this annotation. |
getOpacity() | Gets the constant opacity value to be used in painting the annotation. |
setOpacity(double value) | Sets the constant opacity value to be used in painting the annotation. |
getInReplyTo() | A reference to the annotation that this annotation is “in reply to”. |
setInReplyTo(Annotation value) | A reference to the annotation that this annotation is “in reply to”. |
getReplyType() | A string specifying the relationship (the “reply type”) between this annotation and one specified by InReplyTo. |
setReplyType(int value) | A string specifying the relationship (the “reply type”) between this annotation and one specified by InReplyTo. |
MarkupAnnotation(IDocument document)
public MarkupAnnotation(IDocument document)
Constructor for markup annotation.
Parameters:
Parameter | Type | Description |
---|---|---|
document | IDocument | Document where annotation will be created. |
MarkupAnnotation()
public MarkupAnnotation()
Constructor
getTitle()
public String getTitle()
Gets a text that shall be displayed in title bar of annotation.
Returns: java.lang.String - String value
setTitle(String value)
public void setTitle(String value)
Sets a text that shall be displayed in title bar of annotation.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String | String value |
getRichText()
public String getRichText()
Gets a rich text string to be displayed in the pop-up window when the annotation is opened.
Returns: java.lang.String - String value
setRichText(String value)
public void setRichText(String value)
Sets a rich text string to be displayed in the pop-up window when the annotation is opened.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String | String value |
getCreationDate()
public Date getCreationDate()
Gets date and time when annotation was created.
Returns: Date - Date object
getSubject()
public String getSubject()
Gets text representing desciption of the object.
Returns: java.lang.String - String value
setSubject(String value)
public void setSubject(String value)
Sets text representing desciption of the object.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String | String value |
getPopup()
public PopupAnnotation getPopup()
Pop-up annotation for entering or editing the text associated with this annotation.
Returns: PopupAnnotation - PopupAnnotation value
setPopup(PopupAnnotation value)
public void setPopup(PopupAnnotation value)
Pop-up annotation for entering or editing the text associated with this annotation.
Parameters:
Parameter | Type | Description |
---|---|---|
value | PopupAnnotation | PopupAnnotation value |
getOpacity()
public double getOpacity()
Gets the constant opacity value to be used in painting the annotation.
Returns: double - double value
setOpacity(double value)
public void setOpacity(double value)
Sets the constant opacity value to be used in painting the annotation.
Parameters:
Parameter | Type | Description |
---|---|---|
value | double | double value |
getInReplyTo()
public Annotation getInReplyTo()
A reference to the annotation that this annotation is “in reply to”. Both annotations must be on the same page of the document.
Returns: Annotation - Annotation value
setInReplyTo(Annotation value)
public void setInReplyTo(Annotation value)
A reference to the annotation that this annotation is “in reply to”. Both annotations must be on the same page of the document.
Parameters:
Parameter | Type | Description |
---|---|---|
value | Annotation | Annotation value |
getReplyType()
public int getReplyType()
A string specifying the relationship (the “reply type”) between this annotation and one specified by InReplyTo.
Returns: int - ReplyType value
setReplyType(int value)
public void setReplyType(int value)
A string specifying the relationship (the “reply type”) between this annotation and one specified by InReplyTo.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int | ReplyType value |