public class ContentHandlerResult extends HashMap implements Serializable
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
Modifier and Type | Field and Description |
---|---|
static String |
DOCUMENT_ID_TO_RELOAD
Key for an updated document key to use after saving.
|
static String |
KEY_ALL_ANNOTATIONS_HASH
Key for map of annotation layer keys to annotation layer objects.
|
static String |
KEY_ANNOTATION_CONTENT
Key for an annotation layer's file content.
|
static String |
KEY_ANNOTATION_CREATED_DATE
Key for date annotation layer was created.
|
static String |
KEY_ANNOTATION_DELETABLE
Key for whether an annotation is deletable.
|
static String |
KEY_ANNOTATION_DISPLAY_NAME
Key for annotation layer display name.
|
static String |
KEY_ANNOTATION_ID
Key for annotation layer key.
|
static String |
KEY_ANNOTATION_IMAGE_DOCUMENT_ID
Deprecated.
No longer used.
|
static String |
KEY_ANNOTATION_NAMES
Key for a list of annotation layer keys/names.
|
static String |
KEY_ANNOTATION_OWNER
Key for user who created the annotation layer.
|
static String |
KEY_ANNOTATION_PERMISSION
Deprecated.
No longer used.
|
static String |
KEY_ANNOTATION_PROPERTIES
Key for custom annotation properties.
|
static String |
KEY_ANNOTATION_SESSION_ID
Deprecated.
No longer used.
|
static String |
KEY_AVAILABLE_DISPLAY_NAMES
Key for list of document display names that are available to view.
|
static String |
KEY_AVAILABLE_DOCUMENT_IDS
Key for list of document keys that are available to view.
|
static String |
KEY_BOOKMARK_CONTENT
Key for a document's bookmark file content.
|
static String |
KEY_CLIENT_INSTANCE_ID
Deprecated.
Use equivalent in ContentHandlerInput.
|
static String |
KEY_CLIENT_PREFERENCES_XML
Deprecated.
No longer used.
|
static String |
KEY_CURRENT_USER_NAME
Deprecated.
No longer used.
|
static String |
KEY_DOCUMENT_CONTENT
Key for the document content returned from getDocumentContent.
|
static String |
KEY_DOCUMENT_CONTENT_ELEMENTS
Key for the list of document content elements.
|
static String |
KEY_DOCUMENT_DISPLAY_NAME
Key for the document name VirtualViewer displays to the user.
|
static String |
KEY_DOCUMENT_FILE
Key for a document file reference returned from getDocumentContent.
|
static String |
KEY_DOCUMENT_ID
Key for the document key.
|
static String |
KEY_DOCUMENT_INPUT_STREAM
Key for input stream to document content returned from getDocumentContent.
|
static String |
KEY_DOCUMENT_SPARSE_ELEMENTS
Key for the list of sparse content elements.
|
static String |
KEY_DOCUMENT_SPARSE_PAGE_INDEX
Key for the first page index of the pages returned in KEY_DOCUMENT_SPARSE_ELEMENTS.
|
static String |
KEY_DOCUMENT_SPARSE_RETURN_PAGE_COUNT
Key for the number of pages returned in KEY_DOCUMENT_SPARSE_ELEMENTS.
|
static String |
KEY_DOCUMENT_SPARSE_TOTAL_PAGE_COUNT
Key for the number of pages in the whole sparse document.
|
static String |
KEY_EVENT
Deprecated.
Use equivalent in ContentHandlerInput.
|
static String |
KEY_EVENT_EXPORT_FORMAT_NAME
Deprecated.
Use equivalent in ContentHandlerInput.
|
static String |
KEY_EVENT_PAGE_REQUESTED_NUMBER
Deprecated.
Use equivalent in ContentHandlerInput.
|
static String |
KEY_EVENT_PRINT_PAGE_NUMBERS
Deprecated.
Use equivalent in ContentHandlerInput.
|
static String |
KEY_EVENT_ROTATE_DEGREES
Deprecated.
Use equivalent in ContentHandlerInput.
|
static String |
KEY_EVENT_ROTATE_PAGE
Deprecated.
Use equivalent in ContentHandlerInput.
|
static String |
KEY_EVENT_SAVE_ANNOTATION_LAYER_NAME_BASE
Deprecated.
Use equivalent in ContentHandlerInput.
|
static String |
KEY_EXTERNAL_REFERENCE_CONTENT_ELEMENTS
Key for external reference files used by a CAD or DWG file.
|
static String |
KEY_METADATA_HASHTABLE
Key for custom document metadata that may be retrieved on the client.
|
static String |
KEY_NOTES_CONTENT
Key for a document's note file content.
|
static String |
KEY_NOTES_PERMISSIONS
Deprecated.
No longer used.
|
static String |
KEY_NOTES_TEMPLATES
Deprecated.
No longer used.
|
static String |
KEY_OCR_DATA_JSON
Key to pass existing OCR data to VirtualViewer, in JSON format.
|
static String |
KEY_OCR_DATA_JSON_STRING
Key to pass existing OCR data to VirtualViewer, in JSON format, as a string.
|
static String |
KEY_PUBLISH_STATUS
Deprecated.
No longer used.
|
static String |
KEY_RETRIEVED_EXTERNAL_REFERENCES
Key for whether external references are being returned with the document.
|
static String |
KEY_USE_OF_CACHE_ALLOWED
Key for whether the cache's use is to be allowed.
|
static String |
KEY_USERS_AND_GROUPS
Deprecated.
No Longer used.
|
static String |
KEY_WATERMARK_CONTENT
Key for a document's watermark file content.
|
static String |
VALUE_EVENT_CLOSE_DOCUMENT
Deprecated.
Not used. The afterTabClosed client-side callback should be used instead.
|
static String |
VALUE_EVENT_DOCUMENT_RETRIEVED_FROM_CACHE
Deprecated.
Use equivalent in ContentHandlerInput.
|
static String |
VALUE_EVENT_EXPORT
Deprecated.
Use equivalent in ContentHandlerInput.
|
static String |
VALUE_EVENT_PAGE_REQUESTED
Deprecated.
Use equivalent in ContentHandlerInput.
|
static String |
VALUE_EVENT_PRINT
Deprecated.
Use equivalent in ContentHandlerInput.
|
static String |
VALUE_EVENT_ROTATE_DEGREES
Deprecated.
Use KEY_EVENT_ROTATE_DEGREES in ContentHandlerInput.
|
static String |
VALUE_EVENT_ROTATE_PAGE
Deprecated.
Not used.
|
static String |
VALUE_EVENT_SAVE_ANNOTATION
Deprecated.
Use equivalent in ContentHandlerInput.
|
static String |
VALUE_EVENT_SAVE_DOCUMENT
Deprecated.
Not used. Content handlers should put any actions they wish to perform when saving a document in
VirtualViewerContentHandlerInterface.saveDocumentComponents(com.snowbound.contenthandler.ContentHandlerInput) . |
static Boolean |
VALUE_FALSE
Shorthand for Boolean.FALSE.
|
static String |
VALUE_PUBLISH_ERROR
Deprecated.
No longer used.
|
static String |
VALUE_PUBLISH_SUCCESS
Deprecated.
No longer used.
|
static Boolean |
VALUE_TRUE
Shorthand for Boolean.TRUE.
|
static ContentHandlerResult |
VOID
This constant value can be used for null or void returns.
|
Constructor and Description |
---|
ContentHandlerResult() |
Modifier and Type | Method and Description |
---|---|
byte[] |
getAnnotationContent()
Shortcut to get
KEY_ANNOTATION_CONTENT 's value. |
String[] |
getAnnotationNames()
Shortcut to get
KEY_ANNOTATION_NAMES 's value. |
Hashtable |
getAnnotationProperties()
Shortcut to get
KEY_ANNOTATION_PROPERTIES 's value. |
String[] |
getAvailableDisplayNames()
Shortcut to get
KEY_AVAILABLE_DISPLAY_NAMES 's value. |
String[] |
getAvailableDocumentIds()
Shortcut to get
KEY_AVAILABLE_DOCUMENT_IDS 's value. |
byte[] |
getBookmarkContent()
Shortcut to get
KEY_BOOKMARK_CONTENT 's value. |
String |
getClientPreferencesXML()
Deprecated.
No longer used.
|
byte[] |
getDocumentContent()
Shortcut to get
KEY_DOCUMENT_CONTENT 's value. |
List |
getDocumentContentElements()
Shortcut to get
KEY_DOCUMENT_CONTENT_ELEMENTS 's value. |
File |
getDocumentFile()
Shortcut to get
KEY_DOCUMENT_FILE 's value. |
List |
getDocumentSparseElements()
Shortcut to get
KEY_DOCUMENT_SPARSE_ELEMENTS 's value. |
InputStream |
getDocumentStream()
Shortcut to get
KEY_DOCUMENT_INPUT_STREAM 's value. |
byte[] |
getNotesContent()
Shortcut to get
KEY_NOTES_CONTENT 's value. |
String |
getNotesPermissionLevel()
Deprecated.
No longer used.
|
List<com.snowbound.snapserv.servlet.NotesTemplate> |
getNotesTemplates()
Deprecated.
No longer used.
|
byte[] |
getWatermarkContent()
Shortcut to get
KEY_WATERMARK_CONTENT 's value. |
boolean |
hasDocumentContent()
Returns true if one of KEY_DOCUMENT_CONTENT, KEY_DOCUMENT_INPUT_STREAM, KEY_DOCUMENT_FILE,
KEY_DOCUMENT_CONTENT_ELEMENTS, or KEY_DOCUMENT_SPARSE_ELEMENTS has a value.
|
clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
equals, hashCode, toString
public static final ContentHandlerResult VOID
@Deprecated public static final String KEY_USERS_AND_GROUPS
@Deprecated public static final String KEY_CURRENT_USER_NAME
public static final String KEY_USE_OF_CACHE_ALLOWED
public static final Boolean VALUE_FALSE
public static final Boolean VALUE_TRUE
public static final String KEY_ANNOTATION_DISPLAY_NAME
public static final String KEY_ANNOTATION_ID
public static final String KEY_ALL_ANNOTATIONS_HASH
public static final String KEY_OCR_DATA_JSON
public static final String KEY_OCR_DATA_JSON_STRING
@Deprecated public static final String KEY_ANNOTATION_IMAGE_DOCUMENT_ID
public static final String KEY_ANNOTATION_OWNER
public static final String KEY_ANNOTATION_CREATED_DATE
public static final String KEY_ANNOTATION_DELETABLE
@Deprecated public static final String KEY_PUBLISH_STATUS
@Deprecated public static final String KEY_ANNOTATION_PERMISSION
@Deprecated public static final String KEY_ANNOTATION_SESSION_ID
@Deprecated public static final String VALUE_PUBLISH_SUCCESS
@Deprecated public static final String VALUE_PUBLISH_ERROR
public static final String KEY_DOCUMENT_CONTENT
public static final String KEY_DOCUMENT_FILE
public static final String KEY_DOCUMENT_CONTENT_ELEMENTS
public static final String KEY_DOCUMENT_SPARSE_ELEMENTS
public static final String KEY_DOCUMENT_SPARSE_PAGE_INDEX
public static final String KEY_DOCUMENT_SPARSE_RETURN_PAGE_COUNT
public static final String KEY_DOCUMENT_SPARSE_TOTAL_PAGE_COUNT
public static final String KEY_RETRIEVED_EXTERNAL_REFERENCES
public static final String KEY_EXTERNAL_REFERENCE_CONTENT_ELEMENTS
ExternalReference
.public static final String KEY_DOCUMENT_INPUT_STREAM
public static final String KEY_DOCUMENT_DISPLAY_NAME
public static final String KEY_METADATA_HASHTABLE
public static final String KEY_DOCUMENT_ID
public static final String KEY_ANNOTATION_NAMES
public static final String KEY_ANNOTATION_CONTENT
public static final String KEY_BOOKMARK_CONTENT
public static final String KEY_WATERMARK_CONTENT
public static final String KEY_NOTES_CONTENT
@Deprecated public static final String KEY_NOTES_PERMISSIONS
@Deprecated public static final String KEY_NOTES_TEMPLATES
public static final String KEY_ANNOTATION_PROPERTIES
@Deprecated public static final String KEY_CLIENT_PREFERENCES_XML
public static final String KEY_AVAILABLE_DOCUMENT_IDS
public static final String KEY_AVAILABLE_DISPLAY_NAMES
public static final String DOCUMENT_ID_TO_RELOAD
@Deprecated public static final String KEY_EVENT
@Deprecated public static final String KEY_CLIENT_INSTANCE_ID
@Deprecated public static final String VALUE_EVENT_PAGE_REQUESTED
@Deprecated public static final String VALUE_EVENT_DOCUMENT_RETRIEVED_FROM_CACHE
@Deprecated public static final String KEY_EVENT_PAGE_REQUESTED_NUMBER
@Deprecated public static final String VALUE_EVENT_SAVE_ANNOTATION
@Deprecated public static final String VALUE_EVENT_SAVE_DOCUMENT
VirtualViewerContentHandlerInterface.saveDocumentComponents(com.snowbound.contenthandler.ContentHandlerInput)
.@Deprecated public static final String VALUE_EVENT_CLOSE_DOCUMENT
@Deprecated public static final String KEY_EVENT_SAVE_ANNOTATION_LAYER_NAME_BASE
@Deprecated public static final String VALUE_EVENT_ROTATE_PAGE
@Deprecated public static final String KEY_EVENT_ROTATE_PAGE
@Deprecated public static final String VALUE_EVENT_ROTATE_DEGREES
@Deprecated public static final String KEY_EVENT_ROTATE_DEGREES
@Deprecated public static final String VALUE_EVENT_PRINT
@Deprecated public static final String KEY_EVENT_PRINT_PAGE_NUMBERS
@Deprecated public static final String VALUE_EVENT_EXPORT
@Deprecated public static final String KEY_EVENT_EXPORT_FORMAT_NAME
public boolean hasDocumentContent()
public byte[] getDocumentContent()
KEY_DOCUMENT_CONTENT
's value.public List getDocumentContentElements()
KEY_DOCUMENT_CONTENT_ELEMENTS
's value.public List getDocumentSparseElements()
KEY_DOCUMENT_SPARSE_ELEMENTS
's value.public InputStream getDocumentStream()
KEY_DOCUMENT_INPUT_STREAM
's value.public String[] getAnnotationNames()
KEY_ANNOTATION_NAMES
's value.public byte[] getAnnotationContent()
KEY_ANNOTATION_CONTENT
's value.public byte[] getBookmarkContent()
KEY_BOOKMARK_CONTENT
's value.public byte[] getWatermarkContent()
KEY_WATERMARK_CONTENT
's value.public Hashtable getAnnotationProperties()
KEY_ANNOTATION_PROPERTIES
's value.@Deprecated public String getClientPreferencesXML()
public String[] getAvailableDocumentIds()
KEY_AVAILABLE_DOCUMENT_IDS
's value.public String[] getAvailableDisplayNames()
KEY_AVAILABLE_DISPLAY_NAMES
's value.public byte[] getNotesContent()
KEY_NOTES_CONTENT
's value.@Deprecated public String getNotesPermissionLevel()
public File getDocumentFile()
KEY_DOCUMENT_FILE
's value.@Deprecated public List<com.snowbound.snapserv.servlet.NotesTemplate> getNotesTemplates()
Copyright © 2020 Snowbound Software Corporation. All rights reserved.