Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup Detail: |
public float getConstantOpacity() {
return getDictionary().getFloat( "CA", 1 );
}
This will retrieve the constant opacity value used when rendering the
annotation (excluing any popup). |
public Calendar getCreationDate() throws IOException {
return getDictionary().getDate( "CreationDate" );
}
This will retrieve the date and time the annotation was created. |
public PDExternalDataDictionary getExternalData() {
COSBase exData = this.getDictionary().getDictionaryObject("ExData");
if (exData instanceof COSDictionary)
{
return new PDExternalDataDictionary((COSDictionary) exData);
}
return null;
}
This will return the external data dictionary. |
public PDAnnotation getInReplyTo() throws IOException {
COSBase irt = getDictionary().getDictionaryObject( "IRT" );
return PDAnnotation.createAnnotation( irt );
}
This will retrieve the annotation to which this one is "In Reply To" the
actual relationship is specified by the RT entry. |
public String getIntent() {
return getDictionary().getNameAsString( "IT" );
}
This will retrieve the intent of the annotation The values and meanings
are specific to the actual annotation See the IT_* constants for the
annotation classes. |
public PDAnnotationPopup getPopup() {
COSDictionary popup = (COSDictionary) getDictionary().getDictionaryObject( "Popup" );
if (popup != null)
{
return new PDAnnotationPopup( popup );
}
else
{
return null;
}
}
This will retrieve the popup annotation used for entering/editing the
text for this annotation. |
public String getReplyType() {
return getDictionary().getNameAsString( "RT", RT_REPLY );
}
This will retrieve the Reply Type (relationship) with the annotation in
the IRT entry See the RT_* constants for the available values. |
public PDTextStream getRichContents() {
COSBase rc = getDictionary().getDictionaryObject( "RC" );
if (rc != null)
{
return PDTextStream.createTextStream( rc );
}
else
{
return null;
}
}
This will retrieve the rich text stream which is displayed in the popup
window. |
public String getSubject() {
return getDictionary().getString( "Subj" );
}
This will retrieve the short description of the subject of the annotation. |
public String getTitlePopup() {
return getDictionary().getString( "T" );
}
Retrieve the string used as the title of the popup window shown when open
and active (by convention this identifies who added the annotation). |
public void setConstantOpacity(float ca) {
getDictionary().setFloat( "CA", ca );
}
This will set the constant opacity value used when rendering the
annotation (excluing any popup). |
public void setCreationDate(Calendar creationDate) {
getDictionary().setDate( "CreationDate", creationDate );
}
This will set the the date and time the annotation was created. |
public void setExternalData(PDExternalDataDictionary externalData) {
this.getDictionary().setItem("ExData", externalData);
}
This will set the external data dictionary. |
public void setInReplyTo(PDAnnotation irt) {
getDictionary().setItem( "IRT", irt );
}
This will set the annotation to which this one is "In Reply To" the
actual relationship is specified by the RT entry. |
public void setIntent(String it) {
getDictionary().setName( "IT", it );
}
This will set the intent of the annotation The values and meanings are
specific to the actual annotation See the IT_* constants for the
annotation classes. |
public void setPopup(PDAnnotationPopup popup) {
getDictionary().setItem( "Popup", popup );
}
This will set the popup annotation used for entering/editing the text for
this annotation. |
public void setReplyType(String rt) {
getDictionary().setName( "RT", rt );
}
This will set the Reply Type (relationship) with the annotation in the
IRT entry See the RT_* constants for the available values. |
public void setRichContents(PDTextStream rc) {
getDictionary().setItem( "RC", rc);
}
This will set the rich text stream which is displayed in the popup window. |
public void setSubject(String subj) {
getDictionary().setString( "Subj", subj );
}
This will set the short description of the subject of the annotation. |
public void setTitlePopup(String t) {
getDictionary().setString( "T", t );
}
Set the string used as the title of the popup window shown when open and
active (by convention this identifies who added the annotation). |