com.pdf_tools.fourheights.pdftoolbox.pdf.annotations

Class MarkupInfo

java.lang.Object

com.pdf_tools.fourheights.pdftoolbox.internal.NativeBase

com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.MarkupInfo

public class MarkupInfo
extends NativeObject

Information for a markup annotation

Holds information contained in a markup annotation or in a reply to a markup annotation.

Method Summary

Modifier and Type	Method and Description
static MarkupInfo	createDynamicObject(long handle)
java.lang.String	getAuthor() The author (Getter)
java.lang.String	getContent() The information content (Getter)
java.time.OffsetDateTime	getCreationDate() The date of creation (Getter)
boolean	getLocked() Whether the content can be modified (Getter)
java.time.OffsetDateTime	getModificationDate() The date of last modification (Getter)
java.lang.String	getSubject() The subject (Getter)
void	setAuthor(java.lang.String value) The author (Setter)
void	setContent(java.lang.String value) The information content (Setter)
void	setLocked(boolean value) Whether the content can be modified (Setter)
void	setSubject(java.lang.String value) The subject (Setter)

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

createDynamicObject

public static MarkupInfo createDynamicObject(long handle)

getCreationDate

public java.time.OffsetDateTime getCreationDate()

The date of creation (Getter)

Throws:

java.lang.IllegalStateException - if the object has already been closed

getModificationDate

public java.time.OffsetDateTime getModificationDate()

The date of last modification (Getter)

Throws:

java.lang.IllegalStateException - if the object has already been closed

getLocked

public boolean getLocked()

Whether the content can be modified (Getter)

This does not restrict the modification of other aspects of the annotation or its deletion.

Throws:

java.lang.IllegalStateException - if the object has already been closed

setLocked

public void setLocked(boolean value)

Whether the content can be modified (Setter)

This does not restrict the modification of other aspects of the annotation or its deletion.

Throws:

java.lang.IllegalStateException - if the object has already been closed

java.lang.UnsupportedOperationException - if the document is read-only

java.lang.IllegalStateException - if the annotation has already been appended to a page's list of annotations

getAuthor

public java.lang.String getAuthor()

The author (Getter)

Throws:

java.lang.IllegalStateException - if the object has already been closed

setAuthor

public void setAuthor(java.lang.String value)

The author (Setter)

Throws:

java.lang.IllegalStateException - if the object has already been closed

java.lang.UnsupportedOperationException - if the document is read-only

java.lang.IllegalStateException - if the annotation has already been appended to a page's list of annotations

getSubject

public java.lang.String getSubject()

The subject (Getter)

Throws:

java.lang.IllegalStateException - if the object has already been closed

setSubject

public void setSubject(java.lang.String value)

The subject (Setter)

Throws:

java.lang.IllegalStateException - if the object has already been closed

java.lang.UnsupportedOperationException - if the document is read-only

java.lang.IllegalStateException - if the annotation has already been appended to a page's list of annotations

getContent

public java.lang.String getContent()

The information content (Getter)

Throws:

java.lang.IllegalStateException - if the object has already been closed

setContent

public void setContent(java.lang.String value)

The information content (Setter)

Throws:

java.lang.IllegalStateException - if the object has already been closed

java.lang.UnsupportedOperationException - if the document is read-only

java.lang.IllegalStateException - if the annotation has already been appended to a page's list of annotations