public class AnnotationLayer extends Object
Modifier and Type | Field and Description |
---|---|
static Object |
PROPERTIES_KEY_PERMISSION_LEVEL
Key for annotation permission level in annotation properties map.
|
static Object |
PROPERTIES_KEY_REDACTION_FLAG
Key for redaction flag in the annotation properties map.
|
Constructor and Description |
---|
AnnotationLayer() |
Modifier and Type | Method and Description |
---|---|
byte[] |
getData()
Get the contents of this annotation layer.
|
String |
getDocumentId()
Returns the key of the document to which this annotation layer belongs.
|
String |
getLayerName()
Returns the name/key of this annotation layer.
|
String |
getLayerObjectId() |
int |
getPageSpecificIndex()
-1 indicates that the annotations are not page-specific.
|
Map |
getProperties()
The properties map contains additional properties for this Annotation Layer.
|
boolean |
isModified()
Whether this annotation has been modified since it was last saved.
|
boolean |
isNew()
Whether this annotation has been saved before.
|
void |
setData(byte[] data)
Sets the contents of this annotation layer.
|
void |
setDocumentId(String documentId)
Sets the document key of this annotation layer.
|
void |
setLayerName(String layerId)
Sets the name/key of this annotation layer.
|
void |
setLayerObjectId(String layerObjectId) |
void |
setModified(boolean isModified)
Set whether this annotation has been modified.
|
void |
setNew(boolean pNew)
Set whether this annotation is new.
|
void |
setPageSpecificIndex(int psIndex)
Set the specific page index for this annotation.
|
void |
setProperties(Map properties)
Set the properties map for this annotation layer.
|
public static final Object PROPERTIES_KEY_REDACTION_FLAG
public static final Object PROPERTIES_KEY_PERMISSION_LEVEL
PermissionLevel
.public int getPageSpecificIndex()
public void setPageSpecificIndex(int psIndex)
psIndex
- specific page indexpublic byte[] getData()
public void setData(byte[] data)
data
- The data to set.public String getDocumentId()
public void setDocumentId(String documentId)
documentId
- The document key to set.public String getLayerName()
public void setLayerName(String layerId)
layerId
- The annotation layer key to set.public boolean isNew()
public void setNew(boolean pNew)
pNew
- whether annotation is newpublic String getLayerObjectId()
public void setLayerObjectId(String layerObjectId)
layerObjectId
- The layerObjectId to set.public Map getProperties()
PROPERTIES_KEY_REDACTION_FLAG
Value: Boolean true or false depending on if this is a redaction layer.
Key: PROPERTIES_KEY_PERMISSION_LEVEL
Value: One of the values from the PermissionLevel
class.public void setProperties(Map properties)
properties
- map of String to custom property valuepublic boolean isModified()
public void setModified(boolean isModified)
isModified
- whether annotation has been modifiedCopyright © 2019 Snowbound Software Corporation. All rights reserved.