public abstract class MarkupAnnotation extends Annotation implements com.aspose.pdf.engine.ITitledAnnotation
Abstract class representing markup annotation.
Constructor and Description |
---|
MarkupAnnotation()
Constructor
|
MarkupAnnotation(IDocument document)
Constructor for markup annotation.
|
Modifier and Type | Method and Description |
---|---|
void |
clearState()
Clears state and state model for the annotation.
|
Date |
getCreationDate()
Gets date and time when annotation was created.
|
Annotation |
getInReplyTo()
A reference to the annotation that this annotation is "in reply to".
|
double |
getOpacity()
Gets the constant opacity value to be used in painting the annotation.
|
PopupAnnotation |
getPopup()
Pop-up annotation for entering or editing the text associated with this annotation.
|
int |
getReplyType()
A string specifying the relationship (the "reply type") between this annotation and one
specified by InReplyTo.
|
String |
getRichText()
Gets a rich text string to be displayed in the pop-up window when the annotation is opened.
|
int |
getState()
Gets the state of the annotation.
|
AnnotationStateModel |
getStateModel()
Gets the state model of the annotation.
|
String |
getSubject()
Gets text representing desciption of the object.
|
String |
getTitle()
Gets a text that shall be displayed in title bar of annotation.
|
void |
setInReplyTo(Annotation value)
A reference to the annotation that this annotation is "in reply to".
|
void |
setMarkedState(boolean marked)
Sets Marked and Unmarked state for the annotation.
|
void |
setOpacity(double value)
Sets the constant opacity value to be used in painting the annotation.
|
void |
setPopup(PopupAnnotation value)
Pop-up annotation for entering or editing the text associated with this annotation.
|
void |
setReplyType(int value)
A string specifying the relationship (the "reply type") between this annotation and one
specified by InReplyTo.
|
void |
setReviewState(int state)
Sets the review state for an annotation.
|
void |
setReviewState(int state,
String userName)
Sets the review state for an annotation.
|
void |
setRichText(String value)
Sets a rich text string to be displayed in the pop-up window when the annotation is opened.
|
void |
setSubject(String value)
Sets text representing desciption of the object.
|
void |
setTitle(String value)
Sets a text that shall be displayed in title bar of annotation.
|
accept, changeAfterResize, createAnnotation, flatten, getActiveState, getAlignment, getAnnotationType, 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
deepClone, getHorizontalAlignment, getHyperlink, getMargin, getVerticalAlignment, getZIndex, isFirstParagraphInColumn, isInLineParagraph, isInNewPage, isKeptWithNext, setFirstParagraphInColumn, setHorizontalAlignment, setHyperlink, setInLineParagraph, setInNewPage, setKeptWithNext, setMargin, setVerticalAlignment, setZIndex
public MarkupAnnotation(IDocument document)
Constructor for markup annotation.
document
- Document where annotation will be created.public MarkupAnnotation()
public String getTitle()
Gets a text that shall be displayed in title bar of annotation.
getTitle
in interface com.aspose.pdf.engine.ITitledAnnotation
public void setTitle(String value)
Sets a text that shall be displayed in title bar of annotation.
setTitle
in interface com.aspose.pdf.engine.ITitledAnnotation
value
- String valuepublic String getRichText()
Gets a rich text string to be displayed in the pop-up window when the annotation is opened.
public void setRichText(String value)
Sets a rich text string to be displayed in the pop-up window when the annotation is opened.
value
- String valuepublic Date getCreationDate()
Gets date and time when annotation was created.
public String getSubject()
Gets text representing desciption of the object.
public void setSubject(String value)
Sets text representing desciption of the object.
value
- String valuepublic PopupAnnotation getPopup()
Pop-up annotation for entering or editing the text associated with this annotation.
public void setPopup(PopupAnnotation value)
Pop-up annotation for entering or editing the text associated with this annotation.
value
- PopupAnnotation valuepublic double getOpacity()
Gets the constant opacity value to be used in painting the annotation.
public void setOpacity(double value)
Sets the constant opacity value to be used in painting the annotation.
value
- double valuepublic 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.
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.
value
- Annotation valuepublic int getReplyType()
A string specifying the relationship (the "reply type") between this annotation and one specified by InReplyTo.
ReplyType
public void setReplyType(int value)
A string specifying the relationship (the "reply type") between this annotation and one specified by InReplyTo.
value
- ReplyType valueReplyType
public final void clearState()
Clears state and state model for the annotation. For example, clears the review status for an annotation. Note, the state stored in other text annotation which has state and statemodel keys.
public final void setReviewState(int state, String userName)
Sets the review state for an annotation. Marked and Unmarked states are ignored as they do not belong to the Review StateModel. Note, the state stored in other text annotation which has state and statemodel keys.
state
- Status for assignment.userName
- The username that appears in the comments header.
The name can be the same as the name in the Title of the target annotation or different if the status is set by another user.public final void setReviewState(int state)
Sets the review state for an annotation. Marked and Unmarked states are ignored as they do not belong to the Review StateModel. The state is set by the user who created the target annotation. The value is taken from the Title property of the target annotation. Note, the state stored in other text annotation which has state and statemodel keys.
state
- Status for assignment.public final void setMarkedState(boolean marked)
Sets Marked and Unmarked state for the annotation. Note, the state stored in other text annotation which has state and statemodel keys.
marked
- True if sets Marked state, and false if sets Unmarked state.public final int getState()
Gets the state of the annotation. Note, the state stored in other text annotation which has state and statemodel keys.
public final AnnotationStateModel getStateModel()
Gets the state model of the annotation. Note, the state stored in other text annotation which has state and statemodel keys.
Copyright © 2024 Aspose. All Rights Reserved.