Class ContentHandlerInput
- java.lang.Object
-
- java.util.AbstractMap<K,V>
-
- java.util.HashMap
-
- com.snowbound.contenthandler.ContentHandlerInput
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.util.Map
public class ContentHandlerInput extends java.util.HashMap
All of VirtualViewer's content handler API's methods have an input parameter of ContentHandlerInput.
This class is designed to be a flexible class that allows multiple types of data to be provided to the content handler. Its public methods are identical to a java.util.HashMap. This allows future features to be added, and current code fixed, without changes to the existing content handler API.
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.Object
KEY_ANNOTATION_CONTENT
Key for the contents of an annotation file, used when saving a single annotation layer.static java.lang.Object
KEY_ANNOTATION_ID
Key for an annotation layer key, used to identify a specific annotation layer on a document.static java.lang.Object
KEY_ANNOTATION_LAYERS
Key for an array of annotation layer objects.static java.lang.Object
KEY_ANNOTATION_PROPERTIES
Key for the map of annotation properties, which maps String keys to custom properties.static java.lang.Object
KEY_BOOKMARK_CONTENT
Key for the contents of a bookmarks XML file, used when saving.static java.lang.Object
KEY_CACHE_ACTION
Key for action to be confirmed by validateCache.static java.lang.Object
KEY_CLIENT_INSTANCE_ID
Key for a custom, configurable, value used to pass data from client to content handler.static java.lang.Object
KEY_CLIENT_PREFERENCES_XML
Deprecated.No longer used.static java.lang.Object
KEY_DELETED_ANNOTATION_LAYERS
Key for an array of Strings, representing the layer names of any annotation layers deleted by the user in the current session being saved.static java.lang.Object
KEY_DOCUMENT_CONTENT
Key for the document file content.static java.lang.Object
KEY_DOCUMENT_DISPLAY_NAME
Key for the user-friendly display name for a document.static java.lang.Object
KEY_DOCUMENT_FILE
Deprecated.no longer used.static java.lang.Object
KEY_DOCUMENT_FORMAT
Key for a format code used to identify a file format like PDF or TIF by VirtualViewer and Rastermaster.static java.lang.Object
KEY_DOCUMENT_ID
Key for a document key, used to identify a specific document.static java.lang.String
KEY_DOCUMENT_OCR_LANGUAGE
static java.lang.String
KEY_EVENT
Key for the type of event in an event notification.static java.lang.String
KEY_EVENT_EMAIL_BCC_ADDRESSES
Key for a comma-separated list of the "BCC:" addresses a document email was sent to in anexport event
.static java.lang.String
KEY_EVENT_EMAIL_BODY
Key for the body of a sent document email in anexport event
.static java.lang.String
KEY_EVENT_EMAIL_CC_ADDRESSES
Key for a comma-separated list of the "CC:" addresses a document email was sent to in anexport event
.static java.lang.String
KEY_EVENT_EMAIL_FORMAT_NAME
Key for which format a document was emailed as in anexport event
.static java.lang.String
KEY_EVENT_EMAIL_FROM_ADDRESS
Key for the address a document email was marked as from in anexport event
.static java.lang.String
KEY_EVENT_EMAIL_SUBJECT
Key for the subject line of a sent document email in anexport event
.static java.lang.String
KEY_EVENT_EMAIL_TO_ADDRESSES
Key for a comma-separated list of the "To:" addresses a document email was sent to in anexport event
.static java.lang.String
KEY_EVENT_EXPORT_FORMAT_NAME
Key for which format a document was exported as in anexport event
.static java.lang.String
KEY_EVENT_PAGE_REQUESTED_NUMBER
Key for the zero-based page index of a specific page.static java.lang.String
KEY_EVENT_PRINT_PAGE_NUMBERS
Key for which pages were printed in aprint event
.static java.lang.String
KEY_EVENT_ROTATE_DEGREES
Key for the degrees pages were rotated by in a rotate action.static java.lang.String
KEY_EVENT_ROTATE_PAGE
Key for a list of zero-based page indexes affected by a rotate action.static java.lang.String
KEY_EVENT_SAVE_ANNOTATION_LAYER_NAME_BASE
Used for theannotations saved
event.static java.lang.Object
KEY_HTTP_SERVLET_REQUEST
Key for the request object, used to retrieve information about the request that spawned the current content handler method.static java.lang.Object
KEY_IS_EMAIL_ATTACHMENT
Key sent to theCreateDocumentInterface
function, marking if a new document is an email attachment.static java.lang.Object
KEY_MERGE_ANNOTATIONS
Key for whether annotations were merged into the document being sent.static java.lang.Object
KEY_NOTES_CONTENT
Key for the contents of a document notes XML file, used when saving.static java.lang.Object
KEY_PAGE_COUNT
Key for the number of pages in the document.static java.lang.Object
KEY_PARENT_DOCUMENT_ID
Key sent to theCreateDocumentInterface
function.static java.lang.Object
KEY_SPARSE_PAGE_COUNT
Key for the suggested number of pages to return for a sparse document.static java.lang.Object
KEY_SPARSE_PAGE_INDEX
Key for the requested page index, used if the content handler's getDocumentContent supports sparse documents for the requested document.static java.lang.Object
KEY_STAMP_STATUS
Deprecated.No longer used.static java.lang.Object
KEY_WATERMARK_CONTENT
Key for the contents of a watermarks json file, used when saving.static java.lang.Object
VALUE_CACHE_ACTION_GET
Value indicating retrieving from the cache.static java.lang.Object
VALUE_CACHE_ACTION_PUT
Value indicating storing to the cache.static java.lang.String
VALUE_EVENT_CLOSE_DOCUMENT
Deprecated.Not used.static java.lang.String
VALUE_EVENT_DOCUMENT_RETRIEVED_FROM_CACHE
Event fired when a document has been retrieved from the VirtualViewer cache.static java.lang.String
VALUE_EVENT_EMAIL
Event fired when a document is emailed.static java.lang.String
VALUE_EVENT_EXPORT
Event fired when a document is exported.static java.lang.String
VALUE_EVENT_PAGE_REQUESTED
Event fired when a user is viewing a specific page.static java.lang.String
VALUE_EVENT_PRINT
Event fired when a document is printed.static java.lang.String
VALUE_EVENT_ROTATE_PAGE
Event fired when a page is rotated on the client.static java.lang.String
VALUE_EVENT_SAVE_ANNOTATION
Event fired when annotation data is saved.static java.lang.String
VALUE_EVENT_SAVE_DOCUMENT
Deprecated.Not used.
-
Constructor Summary
Constructors Constructor Description ContentHandlerInput()
Default constructor.ContentHandlerInput(java.lang.String documentId, java.lang.String clientInstanceId)
ContentHandlerInput(java.lang.String documentId, java.lang.String clientInstanceId, java.lang.Object request)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description byte[]
getAnnotationContent()
Shortcut to getKEY_ANNOTATION_CONTENT
's value.java.lang.String
getAnnotationId()
Shortcut to getKEY_ANNOTATION_ID
's value.AnnotationLayer[]
getAnnotationLayers()
Shortcut to getKEY_ANNOTATION_LAYERS
's value.java.util.Hashtable
getAnnotationProperties()
Shortcut to getKEY_ANNOTATION_PROPERTIES
's value.byte[]
getBookmarkContent()
Shortcut to getKEY_BOOKMARK_CONTENT
's value.java.lang.String
getClientInstanceId()
Shortcut to getKEY_CLIENT_INSTANCE_ID
's value.java.lang.String
getClientPreferencesXML()
Deprecated.No longer used.java.lang.String[]
getDeletedAnnotationLayers()
Shortcut to getKEY_DELETED_ANNOTATION_LAYERS
's value.byte[]
getDocumentContent()
Shortcut to getKEY_DOCUMENT_CONTENT
's value.java.lang.String
getDocumentDisplayName()
Shortcut to getKEY_DOCUMENT_DISPLAY_NAME
's value.java.io.File
getDocumentFile()
Deprecated.No longer used.int
getDocumentFormat()
Shortcut to getKEY_DOCUMENT_FORMAT
's value.java.lang.String
getDocumentId()
Shortcut to getKEY_DOCUMENT_ID
's value.int
getDocumentPageCount()
Shortcut to getKEY_PAGE_COUNT
's value.javax.servlet.http.HttpServletRequest
getHttpServletRequest()
Shortcut to getKEY_HTTP_SERVLET_REQUEST
's value.boolean
getIsEmailAttachment()
Shortcut to getKEY_IS_EMAIL_ATTACHMENT
's value.byte[]
getNotesContent()
Shortcut to getKEY_NOTES_CONTENT
's value.java.lang.String
getParentDocumentId()
Shortcut to getKEY_PARENT_DOCUMENT_ID
's value.int
getSparseRequestedPageCount()
Shortcut to getKEY_SPARSE_PAGE_COUNT
's value.java.lang.Integer
getSparseRequestedPageIndex()
Shortcut to getKEY_SPARSE_PAGE_INDEX
's value.int
getSparseRequestedPageNumber()
Deprecated.getSparseRequestedPageIndex()
should be used instead.java.lang.String
getStampStatus()
Deprecated.No longer used.byte[]
getWatermarkContent()
Shortcut to getKEY_WATERMARK_CONTENT
's value.boolean
mergeAnnotations()
Shortcut to getKEY_MERGE_ANNOTATIONS
's value.void
setAnnotationContent(byte[] annContent)
Shortcut to setKEY_ANNOTATION_CONTENT
's value.void
setAnnotationId(java.lang.String annotationId)
Shortcut to setKEY_ANNOTATION_ID
's value.void
setAnnotationLayers(AnnotationLayer[] layers)
Shortcut to setKEY_ANNOTATION_LAYERS
's value.void
setAnnotationProperties(java.util.Hashtable props)
Shortcut to setKEY_ANNOTATION_PROPERTIES
's value.void
setBookmarkContent(byte[] bookmarkContent)
Shortcut to setKEY_BOOKMARK_CONTENT
's value.void
setClientInstanceId(java.lang.String clientInstanceId)
Shortcut to setKEY_CLIENT_INSTANCE_ID
's value.void
setClientPreferencesXML(java.lang.String xml)
Deprecated.No longer used.void
setDeletedAnnotationLayers(java.lang.String[] layers)
Shortcut to setKEY_DELETED_ANNOTATION_LAYERS
's value.void
setDocumentContent(byte[] content)
Shortcut to setKEY_DOCUMENT_CONTENT
's value.void
setDocumentDisplayName(java.lang.String displayName)
Shortcut to setKEY_DOCUMENT_DISPLAY_NAME
's value.void
setDocumentFile(java.io.File contentFile)
Deprecated.No longer used.void
setDocumentFormat(int format)
Shortcut to setKEY_DOCUMENT_FORMAT
's value.void
setDocumentId(java.lang.String documentId)
Shortcut to setKEY_DOCUMENT_ID
's value.void
setDocumentPageCount(int pageCount)
Shortcut to setKEY_PAGE_COUNT
's value.void
setHttpServletRequest(java.lang.Object httpServletRequest)
Shortcut to setKEY_HTTP_SERVLET_REQUEST
's value.void
setMergeAnnotations(boolean mergeAnnotations)
Shortcut to setKEY_MERGE_ANNOTATIONS
's value.void
setNotesContent(byte[] notesContent)
Shortcut to setKEY_NOTES_CONTENT
's value.void
setSparseRequestedPageCount(int pageCount)
Shortcut to setKEY_SPARSE_PAGE_COUNT
's value.void
setSparseRequestedPageIndex(java.lang.Integer index)
Shortcut to setKEY_SPARSE_PAGE_INDEX
's value.void
setSparseRequestedPageNumber(int pageNumber)
Deprecated.setSparseRequestedPageIndex(java.lang.Integer)
should be used instead.void
setStampStatus(java.lang.String stampStatus)
Deprecated.No longer used.void
setWatermarkContent(byte[] watermarkContent)
Shortcut to setKEY_WATERMARK_CONTENT
's value.
-
-
-
Field Detail
-
KEY_CACHE_ACTION
public static final java.lang.Object KEY_CACHE_ACTION
Key for action to be confirmed by validateCache. Value should be eitherVALUE_CACHE_ACTION_GET
orVALUE_CACHE_ACTION_PUT
.
-
VALUE_CACHE_ACTION_GET
public static final java.lang.Object VALUE_CACHE_ACTION_GET
Value indicating retrieving from the cache.
-
VALUE_CACHE_ACTION_PUT
public static final java.lang.Object VALUE_CACHE_ACTION_PUT
Value indicating storing to the cache.
-
KEY_CLIENT_INSTANCE_ID
public static final java.lang.Object KEY_CLIENT_INSTANCE_ID
Key for a custom, configurable, value used to pass data from client to content handler. If not set then will be the session ID. Value type is a String. Can usegetClientInstanceId()
instead of this key.
-
KEY_CLIENT_PREFERENCES_XML
@Deprecated public static final java.lang.Object KEY_CLIENT_PREFERENCES_XML
Deprecated.No longer used.Key for client-side preferences. No longer used; see config.js settings and User Preferences instead.
-
KEY_DOCUMENT_ID
public static final java.lang.Object KEY_DOCUMENT_ID
Key for a document key, used to identify a specific document. Value type is a String. Can usegetDocumentId()
instead of this key.
-
KEY_DOCUMENT_DISPLAY_NAME
public static final java.lang.Object KEY_DOCUMENT_DISPLAY_NAME
Key for the user-friendly display name for a document. Value type is a String. Can usegetDocumentDisplayName()
instead of this key.
-
KEY_ANNOTATION_ID
public static final java.lang.Object KEY_ANNOTATION_ID
Key for an annotation layer key, used to identify a specific annotation layer on a document. Value type is a String. Can usegetAnnotationId()
instead of this key.
-
KEY_HTTP_SERVLET_REQUEST
public static final java.lang.Object KEY_HTTP_SERVLET_REQUEST
Key for the request object, used to retrieve information about the request that spawned the current content handler method. Value type is a javax.servlet.http.HttpServletRequest. Can usegetHttpServletRequest()
instead of this key.
-
KEY_MERGE_ANNOTATIONS
public static final java.lang.Object KEY_MERGE_ANNOTATIONS
Key for whether annotations were merged into the document being sent. Value type is a Boolean. Can usemergeAnnotations()
instead of this key.- See Also:
SendDocumentInterface
-
KEY_DOCUMENT_CONTENT
public static final java.lang.Object KEY_DOCUMENT_CONTENT
Key for the document file content. Value type is a byte[]. Can usegetDocumentContent()
instead of this key.
-
KEY_PAGE_COUNT
public static final java.lang.Object KEY_PAGE_COUNT
Key for the number of pages in the document. Value type is an Integer. Can usegetDocumentPageCount()
instead of this key.
-
KEY_IS_EMAIL_ATTACHMENT
public static final java.lang.Object KEY_IS_EMAIL_ATTACHMENT
Key sent to theCreateDocumentInterface
function, marking if a new document is an email attachment.
-
KEY_PARENT_DOCUMENT_ID
public static final java.lang.Object KEY_PARENT_DOCUMENT_ID
Key sent to theCreateDocumentInterface
function. If the new document is an email attachment, this will store the ID of its parent email document.
-
KEY_DOCUMENT_FORMAT
public static final java.lang.Object KEY_DOCUMENT_FORMAT
Key for a format code used to identify a file format like PDF or TIF by VirtualViewer and Rastermaster. Can use VirtualViewerFormatHash to retrieve detailed information about the format, such as name and extension. Value type is an int. Can usegetDocumentFormat()
instead of this key.- See Also:
VirtualViewerFormatHash.getFormat(int)
-
KEY_DOCUMENT_FILE
@Deprecated public static final java.lang.Object KEY_DOCUMENT_FILE
Deprecated.no longer used.Key for the document file object. Value type is a java.io.File.
-
KEY_BOOKMARK_CONTENT
public static final java.lang.Object KEY_BOOKMARK_CONTENT
Key for the contents of a bookmarks XML file, used when saving. Value type is a byte[].
-
KEY_NOTES_CONTENT
public static final java.lang.Object KEY_NOTES_CONTENT
Key for the contents of a document notes XML file, used when saving. Value type is a byte[].
-
KEY_WATERMARK_CONTENT
public static final java.lang.Object KEY_WATERMARK_CONTENT
Key for the contents of a watermarks json file, used when saving. Value type is a byte[].
-
KEY_ANNOTATION_CONTENT
public static final java.lang.Object KEY_ANNOTATION_CONTENT
Key for the contents of an annotation file, used when saving a single annotation layer. Each annotation file represents a single layer. Value type is a byte[]. Can usegetAnnotationContent()
instead of this key.
-
KEY_ANNOTATION_LAYERS
public static final java.lang.Object KEY_ANNOTATION_LAYERS
Key for an array of annotation layer objects. Used when saving changes to all annotation layers. Value type is a com.snowbound.common.transport.AnnotationLayer[]. Can usegetAnnotationLayers()
instead of this key.
-
KEY_DELETED_ANNOTATION_LAYERS
public static final java.lang.Object KEY_DELETED_ANNOTATION_LAYERS
Key for an array of Strings, representing the layer names of any annotation layers deleted by the user in the current session being saved. Value type is a String[]. Can usegetDeletedAnnotationLayers()
instead of this key.
-
KEY_STAMP_STATUS
@Deprecated public static final java.lang.Object KEY_STAMP_STATUS
Deprecated.No longer used.
-
KEY_ANNOTATION_PROPERTIES
public static final java.lang.Object KEY_ANNOTATION_PROPERTIES
Key for the map of annotation properties, which maps String keys to custom properties. Value type is a java.util.Hashtable. Can usegetAnnotationProperties()
instead of this key
-
KEY_SPARSE_PAGE_INDEX
public static final java.lang.Object KEY_SPARSE_PAGE_INDEX
Key for the requested page index, used if the content handler's getDocumentContent supports sparse documents for the requested document. Value type is an Integer. Can usegetSparseRequestedPageNumber()
instead of this key.
-
KEY_SPARSE_PAGE_COUNT
public static final java.lang.Object KEY_SPARSE_PAGE_COUNT
Key for the suggested number of pages to return for a sparse document. Value type is an Integer. Can usegetSparseRequestedPageCount()
instead of this key.
-
KEY_EVENT
public static final java.lang.String KEY_EVENT
Key for the type of event in an event notification. There may be additional parameters that depend on the type of event, but every event input will contain at least the
client instance key
and therequest object
.Value type is one of the VALUE_EVENT String properties of ContentHandlerInput.
- See Also:
EventSubscriberInterface
, Constant Field Values
-
VALUE_EVENT_PAGE_REQUESTED
public static final java.lang.String VALUE_EVENT_PAGE_REQUESTED
Event fired when a user is viewing a specific page. UseKEY_EVENT_PAGE_REQUESTED_NUMBER
to retrieve the zero-based page index of that page.- See Also:
EventSubscriberInterface
, Constant Field Values
-
VALUE_EVENT_DOCUMENT_RETRIEVED_FROM_CACHE
public static final java.lang.String VALUE_EVENT_DOCUMENT_RETRIEVED_FROM_CACHE
Event fired when a document has been retrieved from the VirtualViewer cache. UseKEY_DOCUMENT_ID
to get the document's key.- See Also:
EventSubscriberInterface
, Constant Field Values
-
KEY_EVENT_PAGE_REQUESTED_NUMBER
public static final java.lang.String KEY_EVENT_PAGE_REQUESTED_NUMBER
Key for the zero-based page index of a specific page. Used for thepage requested
andannotation saved
events. Value type is int.- See Also:
- Constant Field Values
-
VALUE_EVENT_SAVE_ANNOTATION
public static final java.lang.String VALUE_EVENT_SAVE_ANNOTATION
Event fired when annotation data is saved. UseKEY_EVENT_PAGE_REQUESTED_NUMBER
to retrieve the current page index the user was viewing (although not necessarily the page annotations were saved on!) and seeKEY_EVENT_SAVE_ANNOTATION_LAYER_NAME_BASE
for the prefix to obtain the annotation layer names.- See Also:
EventSubscriberInterface
, Constant Field Values
-
VALUE_EVENT_SAVE_DOCUMENT
public static final java.lang.String VALUE_EVENT_SAVE_DOCUMENT
Deprecated.Not used.- See Also:
- Constant Field Values
-
VALUE_EVENT_CLOSE_DOCUMENT
public static final java.lang.String VALUE_EVENT_CLOSE_DOCUMENT
Deprecated.Not used.- See Also:
- Constant Field Values
-
KEY_EVENT_SAVE_ANNOTATION_LAYER_NAME_BASE
public static final java.lang.String KEY_EVENT_SAVE_ANNOTATION_LAYER_NAME_BASE
Used for the
annotations saved
event. All annotation layer names will be provided as separate parameters of ContentHandlerInput with the keys "KEY_EVENT_ANNOTATION_LAYER_NAME" + i, where i is the index of the annotation layer name. If i is known, the specific key can be generated with this code:String specificAnnotationLayerKey = ContentHandlerInput.KEY_EVENT_SAVE_ANNOTATION_LAYER_NAME_BASE.replace("_BASE", "" + i);
- See Also:
- Constant Field Values
-
VALUE_EVENT_ROTATE_PAGE
public static final java.lang.String VALUE_EVENT_ROTATE_PAGE
Event fired when a page is rotated on the client. Note that this does not mean the rotation has been saved yet. Additional parameters areKEY_EVENT_ROTATE_PAGE
for a list of rotated page indexes andKEY_EVENT_ROTATE_DEGREES
for how many degrees they were rotated by.- See Also:
EventSubscriberInterface
, Constant Field Values
-
KEY_EVENT_ROTATE_PAGE
public static final java.lang.String KEY_EVENT_ROTATE_PAGE
Key for a list of zero-based page indexes affected by a rotate action. Used for theVALUE_EVENT_ROTATE_PAGE
event. Value type is int[].- See Also:
- Constant Field Values
-
KEY_EVENT_ROTATE_DEGREES
public static final java.lang.String KEY_EVENT_ROTATE_DEGREES
Key for the degrees pages were rotated by in a rotate action. Used for therotate page(s)
event.- See Also:
- Constant Field Values
-
VALUE_EVENT_PRINT
public static final java.lang.String VALUE_EVENT_PRINT
Event fired when a document is printed. UsegetDocumentId()
to get the document key andKEY_EVENT_PRINT_PAGE_NUMBERS
to get the list of printed pages.- See Also:
EventSubscriberInterface
, Constant Field Values
-
KEY_EVENT_PRINT_PAGE_NUMBERS
public static final java.lang.String KEY_EVENT_PRINT_PAGE_NUMBERS
Key for which pages were printed in aprint event
. Value will be an int[] of zero-based page indexes.- See Also:
- Constant Field Values
-
VALUE_EVENT_EXPORT
public static final java.lang.String VALUE_EVENT_EXPORT
Event fired when a document is exported. UsegetDocumentId()
to get the document key andKEY_EVENT_EXPORT_FORMAT_NAME
to get the format it was exported as.- See Also:
EventSubscriberInterface
, Constant Field Values
-
KEY_EVENT_EXPORT_FORMAT_NAME
public static final java.lang.String KEY_EVENT_EXPORT_FORMAT_NAME
Key for which format a document was exported as in anexport event
. Value type is String and will be either "PDF", "TIFF" or "Original".- See Also:
- Constant Field Values
-
VALUE_EVENT_EMAIL
public static final java.lang.String VALUE_EVENT_EMAIL
Event fired when a document is emailed. UsegetDocumentId()
to get the document key andKEY_EVENT_EXPORT_FORMAT_NAME
to get the format it was exported as.- See Also:
EventSubscriberInterface
, Constant Field Values
-
KEY_EVENT_EMAIL_FORMAT_NAME
public static final java.lang.String KEY_EVENT_EMAIL_FORMAT_NAME
Key for which format a document was emailed as in anexport event
. Value type is String and will be either "PDF", "TIFF" or "Original".- See Also:
- Constant Field Values
-
KEY_EVENT_EMAIL_FROM_ADDRESS
public static final java.lang.String KEY_EVENT_EMAIL_FROM_ADDRESS
Key for the address a document email was marked as from in anexport event
. Value type is String.- See Also:
- Constant Field Values
-
KEY_EVENT_EMAIL_TO_ADDRESSES
public static final java.lang.String KEY_EVENT_EMAIL_TO_ADDRESSES
Key for a comma-separated list of the "To:" addresses a document email was sent to in anexport event
. Value type is String.- See Also:
- Constant Field Values
-
KEY_EVENT_EMAIL_CC_ADDRESSES
public static final java.lang.String KEY_EVENT_EMAIL_CC_ADDRESSES
Key for a comma-separated list of the "CC:" addresses a document email was sent to in anexport event
. Value type is String.- See Also:
- Constant Field Values
-
KEY_EVENT_EMAIL_BCC_ADDRESSES
public static final java.lang.String KEY_EVENT_EMAIL_BCC_ADDRESSES
Key for a comma-separated list of the "BCC:" addresses a document email was sent to in anexport event
. Value type is String.- See Also:
- Constant Field Values
-
KEY_EVENT_EMAIL_SUBJECT
public static final java.lang.String KEY_EVENT_EMAIL_SUBJECT
Key for the subject line of a sent document email in anexport event
. Value type is String.- See Also:
- Constant Field Values
-
KEY_EVENT_EMAIL_BODY
public static final java.lang.String KEY_EVENT_EMAIL_BODY
Key for the body of a sent document email in anexport event
. Value type is String.- See Also:
- Constant Field Values
-
KEY_DOCUMENT_OCR_LANGUAGE
public static final java.lang.String KEY_DOCUMENT_OCR_LANGUAGE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ContentHandlerInput
public ContentHandlerInput()
Default constructor.
-
ContentHandlerInput
public ContentHandlerInput(java.lang.String documentId, java.lang.String clientInstanceId)
- Parameters:
documentId
- key for documentclientInstanceId
- a custom, configurable, value used to pass data from the client to the content handler
-
ContentHandlerInput
public ContentHandlerInput(java.lang.String documentId, java.lang.String clientInstanceId, java.lang.Object request)
- Parameters:
documentId
- key for documentclientInstanceId
- a custom, configurable, value used to pass data from the client to the content handlerrequest
- object containing HTTP request details
-
-
Method Detail
-
getClientInstanceId
public java.lang.String getClientInstanceId()
Shortcut to getKEY_CLIENT_INSTANCE_ID
's value.- Returns:
- the clientInstanceId, a custom, configurable, value used to pass data from the client to the content handler
-
getDocumentId
public java.lang.String getDocumentId()
Shortcut to getKEY_DOCUMENT_ID
's value.- Returns:
- document key
-
getAnnotationId
public java.lang.String getAnnotationId()
Shortcut to getKEY_ANNOTATION_ID
's value.- Returns:
- annotation layer key
-
getDocumentFormat
public int getDocumentFormat()
Shortcut to getKEY_DOCUMENT_FORMAT
's value.- Returns:
- a code specifying a file format
- See Also:
VirtualViewerFormatHash.getFormat(int)
-
setDocumentDisplayName
public void setDocumentDisplayName(java.lang.String displayName)
Shortcut to setKEY_DOCUMENT_DISPLAY_NAME
's value.- Parameters:
displayName
- A name displayed on the client in place of the document's ID
-
getDocumentDisplayName
public java.lang.String getDocumentDisplayName()
Shortcut to getKEY_DOCUMENT_DISPLAY_NAME
's value.- Returns:
- the name displayed on the client in place of the document's ID
-
mergeAnnotations
public boolean mergeAnnotations()
Shortcut to getKEY_MERGE_ANNOTATIONS
's value.- Returns:
- whether annotations have been merged
-
getDocumentContent
public byte[] getDocumentContent()
Shortcut to getKEY_DOCUMENT_CONTENT
's value.- Returns:
- a byte array containing document content
-
getDocumentFile
public java.io.File getDocumentFile()
Deprecated.No longer used.Shortcut to getKEY_DOCUMENT_FILE
's value.- Returns:
- a File reference to a document file
-
getIsEmailAttachment
public boolean getIsEmailAttachment()
Shortcut to getKEY_IS_EMAIL_ATTACHMENT
's value.- Returns:
- a boolean sent when creating a document, indicating if the new document is an email attachment.
-
getParentDocumentId
public java.lang.String getParentDocumentId()
Shortcut to getKEY_PARENT_DOCUMENT_ID
's value.- Returns:
- a string naming the ID of a new document's parent, if the new document is an email attachment.
-
getAnnotationContent
public byte[] getAnnotationContent()
Shortcut to getKEY_ANNOTATION_CONTENT
's value.- Returns:
- a byte array containing annotation content
-
getBookmarkContent
public byte[] getBookmarkContent()
Shortcut to getKEY_BOOKMARK_CONTENT
's value.- Returns:
- a byte array containing bookmark content
-
getWatermarkContent
public byte[] getWatermarkContent()
Shortcut to getKEY_WATERMARK_CONTENT
's value.- Returns:
- a byte array containing watermark content
-
getNotesContent
public byte[] getNotesContent()
Shortcut to getKEY_NOTES_CONTENT
's value.- Returns:
- a byte array containing notes content
-
setClientInstanceId
public void setClientInstanceId(java.lang.String clientInstanceId)
Shortcut to setKEY_CLIENT_INSTANCE_ID
's value.- Parameters:
clientInstanceId
- custom, configurable, value used to pass data from client to content handler
-
setClientPreferencesXML
@Deprecated public void setClientPreferencesXML(java.lang.String xml)
Deprecated.No longer used. See client-side config.js and User Preferences settings instead.Shortcut to setKEY_CLIENT_PREFERENCES_XML
's value.- Parameters:
xml
- client preference XML
-
getClientPreferencesXML
@Deprecated public java.lang.String getClientPreferencesXML()
Deprecated.No longer used. See client-side config.js and User Preferences settings instead.Shortcut to getKEY_CLIENT_PREFERENCES_XML
's value.- Returns:
- client preference XML
-
setDocumentId
public void setDocumentId(java.lang.String documentId)
Shortcut to setKEY_DOCUMENT_ID
's value.- Parameters:
documentId
- key for document
-
setAnnotationId
public void setAnnotationId(java.lang.String annotationId)
Shortcut to setKEY_ANNOTATION_ID
's value.- Parameters:
annotationId
- an annotation layer key
-
setHttpServletRequest
public void setHttpServletRequest(java.lang.Object httpServletRequest)
Shortcut to setKEY_HTTP_SERVLET_REQUEST
's value.- Parameters:
httpServletRequest
- object containing HTTP request details
-
setMergeAnnotations
public void setMergeAnnotations(boolean mergeAnnotations)
Shortcut to setKEY_MERGE_ANNOTATIONS
's value.- Parameters:
mergeAnnotations
- whether annotations have been merged
-
setDocumentContent
public void setDocumentContent(byte[] content)
Shortcut to setKEY_DOCUMENT_CONTENT
's value.- Parameters:
content
- a byte array containing document content
-
setDocumentPageCount
public void setDocumentPageCount(int pageCount)
Shortcut to setKEY_PAGE_COUNT
's value.- Parameters:
pageCount
- number of pages in document
-
getDocumentPageCount
public int getDocumentPageCount()
Shortcut to getKEY_PAGE_COUNT
's value.- Returns:
- number of pages in the document
-
setDocumentFormat
public void setDocumentFormat(int format)
Shortcut to setKEY_DOCUMENT_FORMAT
's value.- Parameters:
format
- file format code
-
setDocumentFile
public void setDocumentFile(java.io.File contentFile)
Deprecated.No longer used.Shortcut to setKEY_DOCUMENT_FILE
's value.- Parameters:
contentFile
- reference to document file
-
setAnnotationContent
public void setAnnotationContent(byte[] annContent)
Shortcut to setKEY_ANNOTATION_CONTENT
's value.- Parameters:
annContent
- byte array containing annotation content
-
setBookmarkContent
public void setBookmarkContent(byte[] bookmarkContent)
Shortcut to setKEY_BOOKMARK_CONTENT
's value.- Parameters:
bookmarkContent
- byte array containing bookmark content
-
setWatermarkContent
public void setWatermarkContent(byte[] watermarkContent)
Shortcut to setKEY_WATERMARK_CONTENT
's value.- Parameters:
watermarkContent
- byte array containing watermark content
-
setNotesContent
public void setNotesContent(byte[] notesContent)
Shortcut to setKEY_NOTES_CONTENT
's value.- Parameters:
notesContent
- byte array containing notes content
-
setAnnotationLayers
public void setAnnotationLayers(AnnotationLayer[] layers)
Shortcut to setKEY_ANNOTATION_LAYERS
's value.- Parameters:
layers
- array of annotation layers
-
getAnnotationLayers
public AnnotationLayer[] getAnnotationLayers()
Shortcut to getKEY_ANNOTATION_LAYERS
's value.- Returns:
- an array of annotation layer objects
-
setAnnotationProperties
public void setAnnotationProperties(java.util.Hashtable props)
Shortcut to setKEY_ANNOTATION_PROPERTIES
's value.- Parameters:
props
- map of String keys to custom annotation property values
-
getAnnotationProperties
public java.util.Hashtable getAnnotationProperties()
Shortcut to getKEY_ANNOTATION_PROPERTIES
's value.- Returns:
- a map of String keys to custom annotation property values
-
setDeletedAnnotationLayers
public void setDeletedAnnotationLayers(java.lang.String[] layers)
Shortcut to setKEY_DELETED_ANNOTATION_LAYERS
's value.- Parameters:
layers
- array of String annotation layer names that were deleted by the user
-
getDeletedAnnotationLayers
public java.lang.String[] getDeletedAnnotationLayers()
Shortcut to getKEY_DELETED_ANNOTATION_LAYERS
's value.- Returns:
- an array of String annotation layer names that were deleted by the user
-
setSparseRequestedPageIndex
public void setSparseRequestedPageIndex(java.lang.Integer index)
Shortcut to setKEY_SPARSE_PAGE_INDEX
's value.- Parameters:
index
- zero-based page index
-
getSparseRequestedPageIndex
public java.lang.Integer getSparseRequestedPageIndex()
Shortcut to getKEY_SPARSE_PAGE_INDEX
's value.- Returns:
- zero-based index of requested page; null if all pages are required
-
setSparseRequestedPageNumber
@Deprecated public void setSparseRequestedPageNumber(int pageNumber)
Deprecated.setSparseRequestedPageIndex(java.lang.Integer)
should be used instead.- Parameters:
pageNumber
- value to set forKEY_SPARSE_PAGE_INDEX
-
getSparseRequestedPageNumber
@Deprecated public int getSparseRequestedPageNumber()
Deprecated.getSparseRequestedPageIndex()
should be used instead. This method returns a non-nullable int value, but that is misleading as the null value is important and means all pages should be returned.Shortcut to getKEY_SPARSE_PAGE_INDEX
's value.- Returns:
- requested sparse page index
-
setSparseRequestedPageCount
public void setSparseRequestedPageCount(int pageCount)
Shortcut to setKEY_SPARSE_PAGE_COUNT
's value.- Parameters:
pageCount
- suggested number of pages to return
-
getSparseRequestedPageCount
public int getSparseRequestedPageCount()
Shortcut to getKEY_SPARSE_PAGE_COUNT
's value.- Returns:
- suggested number of pages to return
-
setStampStatus
@Deprecated public void setStampStatus(java.lang.String stampStatus)
Deprecated.No longer used.Shortcut to setKEY_STAMP_STATUS
's value.- Parameters:
stampStatus
- stamp status description
-
getStampStatus
@Deprecated public java.lang.String getStampStatus()
Deprecated.No longer used.Shortcut to getKEY_STAMP_STATUS
's value.- Returns:
- stamp status
-
getHttpServletRequest
public javax.servlet.http.HttpServletRequest getHttpServletRequest()
Shortcut to getKEY_HTTP_SERVLET_REQUEST
's value.- Returns:
- An object that can be used to retrieve request information, such as URL parameters and cookies.
-
-