MarkupAnnotation Class

Servers as a base class for markup annotations.

Declaration

public abstract class MarkupAnnotation extends BaseAnnotation

Remarks

The MarkupAnnotation class contains common markup annotation settings.

Refer to the following help topic for additional information: Text Markup Annotations.

Inherited Members

clone(DocumentCloneContext context)

deepClone()

getAppearance()

getAppearanceName()

getBorder()

getBounds()

getColor()

getContent()

getHidden()

getInvisible()

getLocked()

getLockedContents()

getModified()

getName()

getNoRotate()

getNoView()

getNoZoom()

getPrint()

getReadOnly()

getToggleNoView()

objectClone()

setAppearance(AnnotationAppearances value)

setAppearanceName(String value)

setBorder(AnnotationBorder value)

setBounds(RectangleF value)

setColor(PdfColor value)

setContent(String value)

setHidden(boolean value)

setInvisible(boolean value)

setLocked(boolean value)

setLockedContents(boolean value)

setModified(OffsetDateTime value)

setName(String value)

setNoRotate(boolean value)

setNoView(boolean value)

setNoZoom(boolean value)

setPrint(boolean value)

setReadOnly(boolean value)

setToggleNoView(boolean value)

com.devexpress.system.JavaObject.clone()

com.devexpress.system.JavaObject.equals(java.lang.Object)

com.devexpress.system.JavaObject.hashCode()

com.devexpress.system.JavaObject.memberwiseClone()

com.devexpress.system.JavaObject.toString()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

JavaObject

BaseAnnotation

MarkupAnnotation

Methods

addReply(Page page, String author, String contents) Method

Adds a text reply to the markup annotation.

Declaration

public TextAnnotation addReply(Page page, String author, String contents)

Parameters

Name	Type	Description
page	Page	The page that contains the markup annotation.
author	String	The reply author.
contents	String	The reply contents.

Returns

Type	Description
TextAnnotation	The created text reply annotation.

addReview(Page page, String author, ReviewStatus reviewStatus) Method

Adds a review entry to the markup annotation.

Declaration

public TextAnnotation addReview(Page page, String author, ReviewStatus reviewStatus)

Parameters

Name	Type	Description
page	Page	The page that contains the markup annotation.
author	String	The review author.
reviewStatus	ReviewStatus	The review status.

Returns

Type	Description
TextAnnotation	The created review annotation.

clearReviews(Page page) Method

Clears review history for the markup annotation.

Declaration

public void clearReviews(Page page)

Parameters

Name	Type	Description
page	Page	The page that contains the markup annotation.

getCreationDate() Method

Returns the markup annotation creation date.

Declaration

public OffsetDateTime getCreationDate()

Returns

Type	Description
OffsetDateTime	The markup annotation creation date.

getInReplyTo() Method

Returns the annotation this markup annotation replies to.

Declaration

public BaseAnnotation getInReplyTo()

Returns

Type	Description
BaseAnnotation	The annotation this markup annotation replies to.

getIntent() Method

Returns the markup annotation intent.

Declaration

public String getIntent()

Returns

Type	Description
String	The markup annotation intent.

getOpacity() Method

Returns the markup annotation opacity.

Declaration

public double getOpacity()

Returns

Type	Description
double	The markup annotation opacity.

getPopup() Method

Returns the popup annotation associated with this markup annotation.

Declaration

public PopupAnnotation getPopup()

Returns

Type	Description
PopupAnnotation	The popup annotation associated with this markup annotation.

getReplyType() Method

Returns the markup annotation reply type.

Declaration

public MarkupAnnotationReplyType getReplyType()

Returns

Type	Description
MarkupAnnotationReplyType	The markup annotation reply type.

getReviewHistory(Page page) Method

Returns review history for the markup annotation.

Declaration

public Collection<ReviewHistoryItem> getReviewHistory(Page page)

Parameters

Name	Type	Description
page	Page	The page that contains the markup annotation.

Returns

Type	Description
java.util.Collection<ReviewHistoryItem>	The markup annotation review history.

getRichTextData() Method

Returns the markup annotation rich text data.

Declaration

public String getRichTextData()

Returns

Type	Description
String	The markup annotation rich text data.

getSubject() Method

Returns the markup annotation subject.

Declaration

public String getSubject()

Returns

Type	Description
String	The markup annotation subject.

getTitle() Method

Returns the markup annotation title.

Declaration

public String getTitle()

Returns

Type	Description
String	The markup annotation title.

removeReply(Page page, MarkupAnnotation reply) Method

Removes a reply from the markup annotation.

Declaration

public boolean removeReply(Page page, MarkupAnnotation reply)

Parameters

Name	Type	Description
page	Page	The page that contains the markup annotation.
reply	MarkupAnnotation	The reply to remove.

Returns

Type	Description
boolean	true if the reply was removed; otherwise, false.

setCreationDate(OffsetDateTime value) Method

Sets the markup annotation creation date.

Declaration

public void setCreationDate(OffsetDateTime value)

Parameters

Name	Type	Description
value	OffsetDateTime	The markup annotation creation date.

setInReplyTo(BaseAnnotation value) Method

Sets the annotation this markup annotation replies to.

Declaration

public void setInReplyTo(BaseAnnotation value)

Parameters

Name	Type	Description
value	BaseAnnotation	The annotation this markup annotation replies to.

setIntent(String value) Method

Sets the markup annotation intent.

Declaration

public void setIntent(String value)

Parameters

Name	Type	Description
value	String	The markup annotation intent.

setOpacity(double value) Method

Sets the markup annotation opacity.

Declaration

public void setOpacity(double value)

Parameters

Name	Type	Description
value	double	The markup annotation opacity.

setPopup(PopupAnnotation value) Method

Sets the popup annotation associated with this markup annotation.

Declaration

public void setPopup(PopupAnnotation value)

Parameters

Name	Type	Description
value	PopupAnnotation	The popup annotation associated with this markup annotation.

setReplyType(MarkupAnnotationReplyType value) Method

Sets the markup annotation reply type.

Declaration

public void setReplyType(MarkupAnnotationReplyType value)

Parameters

Name	Type	Description
value	MarkupAnnotationReplyType	The markup annotation reply type.

setRichTextData(String value) Method

Sets the markup annotation rich text data.

Declaration

public void setRichTextData(String value)

Parameters

Name	Type	Description
value	String	The markup annotation rich text data.

setSubject(String value) Method

Sets the markup annotation subject.

Declaration

public void setSubject(String value)

Parameters

Name	Type	Description
value	String	The markup annotation subject.

setTitle(String value) Method

Sets the markup annotation title.

Declaration

public void setTitle(String value)

Parameters

Name	Type	Description
value	String	The markup annotation title.