Package com.snowbound.contenthandler
Class ContentHandlerResult
- java.lang.Object
-
- java.util.AbstractMap<K,V>
-
- java.util.HashMap
-
- com.snowbound.contenthandler.ContentHandlerResult
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.util.Map
public class ContentHandlerResult extends java.util.HashMap implements java.io.Serializable
All of VirtualViewer's content handler API's methods have a return type of ContentHandlerResult. This class is designed to be a flexible class that allows multiple types of data to be returned. 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.String
DOCUMENT_ID_TO_RELOAD
Key for an updated document key to use after saving.static java.lang.String
KEY_ALL_ANNOTATIONS_HASH
Key for map of annotation layer keys to annotation layer objects.static java.lang.String
KEY_ANNOTATION_CONTENT
Key for an annotation layer's file content.static java.lang.String
KEY_ANNOTATION_CREATED_DATE
Key for date annotation layer was created.static java.lang.String
KEY_ANNOTATION_DELETABLE
Key for whether an annotation is deletable.static java.lang.String
KEY_ANNOTATION_DISPLAY_NAME
Key for annotation layer display name.static java.lang.String
KEY_ANNOTATION_ID
Key for annotation layer key.static java.lang.String
KEY_ANNOTATION_IMAGE_DOCUMENT_ID
Deprecated.No longer used.static java.lang.String
KEY_ANNOTATION_NAMES
Key for a list of annotation layer keys/names.static java.lang.String
KEY_ANNOTATION_OWNER
Key for user who created the annotation layer.static java.lang.String
KEY_ANNOTATION_PERMISSION
Deprecated.No longer used.static java.lang.String
KEY_ANNOTATION_PROPERTIES
Key for custom annotation properties.static java.lang.String
KEY_ANNOTATION_SESSION_ID
Deprecated.No longer used.static java.lang.String
KEY_AVAILABLE_DISPLAY_NAMES
Key for list of document display names that are available to view.static java.lang.String
KEY_AVAILABLE_DOCUMENT_IDS
Key for list of document keys that are available to view.static java.lang.String
KEY_AVAILABLE_MEDIA_CAPTION_FILES
Key for list of WebVTT caption files for video or audio documents.static java.lang.String
KEY_BOOKMARK_CONTENT
Key for a document's bookmark file content.static java.lang.String
KEY_CLIENT_INSTANCE_ID
Deprecated.Use equivalent in ContentHandlerInput.static java.lang.String
KEY_CLIENT_PREFERENCES_XML
Deprecated.No longer used.static java.lang.String
KEY_CURRENT_USER_NAME
Deprecated.No longer used.static java.lang.String
KEY_DOCUMENT_CONTENT
Key for the document content returned from getDocumentContent.static java.lang.String
KEY_DOCUMENT_CONTENT_ELEMENTS
Key for the list of document content elements.static java.lang.String
KEY_DOCUMENT_DISPLAY_NAME
Key for the document name VirtualViewer displays to the user.static java.lang.String
KEY_DOCUMENT_FILE
Key for a document file reference returned from getDocumentContent.static java.lang.String
KEY_DOCUMENT_ID
Key for the document key.static java.lang.String
KEY_DOCUMENT_INPUT_STREAM
Key for input stream to document content returned from getDocumentContent.static java.lang.String
KEY_DOCUMENT_SPARSE_ELEMENTS
Key for the list of sparse content elements.static java.lang.String
KEY_DOCUMENT_SPARSE_PAGE_INDEX
Key for the first page index of the pages returned in KEY_DOCUMENT_SPARSE_ELEMENTS.static java.lang.String
KEY_DOCUMENT_SPARSE_RETURN_PAGE_COUNT
Key for the number of pages returned in KEY_DOCUMENT_SPARSE_ELEMENTS.static java.lang.String
KEY_DOCUMENT_SPARSE_TOTAL_PAGE_COUNT
Key for the number of pages in the whole sparse document.static java.lang.String
KEY_EVENT
Deprecated.Use equivalent in ContentHandlerInput.static java.lang.String
KEY_EVENT_EXPORT_FORMAT_NAME
Deprecated.Use equivalent in ContentHandlerInput.static java.lang.String
KEY_EVENT_PAGE_REQUESTED_NUMBER
Deprecated.Use equivalent in ContentHandlerInput.static java.lang.String
KEY_EVENT_PRINT_PAGE_NUMBERS
Deprecated.Use equivalent in ContentHandlerInput.static java.lang.String
KEY_EVENT_ROTATE_DEGREES
Deprecated.Use equivalent in ContentHandlerInput.static java.lang.String
KEY_EVENT_ROTATE_PAGE
Deprecated.Use equivalent in ContentHandlerInput.static java.lang.String
KEY_EVENT_SAVE_ANNOTATION_LAYER_NAME_BASE
Deprecated.Use equivalent in ContentHandlerInput.static java.lang.String
KEY_EXTERNAL_REFERENCE_CONTENT_ELEMENTS
Key for external reference files used by a CAD or DWG file.static java.lang.String
KEY_METADATA_HASHTABLE
Key for custom document metadata that may be retrieved on the client.static java.lang.String
KEY_NOTES_CONTENT
Key for a document's note file content.static java.lang.String
KEY_NOTES_PERMISSIONS
Deprecated.No longer used.static java.lang.String
KEY_NOTES_TEMPLATES
Deprecated.No longer used.static java.lang.String
KEY_OCR_DATA_JSON
Key to pass existing OCR data to VirtualViewer, in JSON format.static java.lang.String
KEY_OCR_DATA_JSON_STRING
Key to pass existing OCR data to VirtualViewer, in JSON format, as a string.static java.lang.String
KEY_PUBLISH_STATUS
Deprecated.No longer used.static java.lang.String
KEY_RETRIEVED_EXTERNAL_REFERENCES
Key for whether external references are being returned with the document.static java.lang.String
KEY_USE_OF_CACHE_ALLOWED
Key for whether the cache's use is to be allowed.static java.lang.String
KEY_USERS_AND_GROUPS
Deprecated.No Longer used.static java.lang.String
KEY_WATERMARK_CONTENT
Key for a document's watermark file content.static java.lang.String
VALUE_EVENT_CLOSE_DOCUMENT
Deprecated.Not used.static java.lang.String
VALUE_EVENT_DOCUMENT_RETRIEVED_FROM_CACHE
Deprecated.Use equivalent in ContentHandlerInput.static java.lang.String
VALUE_EVENT_EXPORT
Deprecated.Use equivalent in ContentHandlerInput.static java.lang.String
VALUE_EVENT_PAGE_REQUESTED
Deprecated.Use equivalent in ContentHandlerInput.static java.lang.String
VALUE_EVENT_PRINT
Deprecated.Use equivalent in ContentHandlerInput.static java.lang.String
VALUE_EVENT_ROTATE_DEGREES
Deprecated.Use KEY_EVENT_ROTATE_DEGREES in ContentHandlerInput.static java.lang.String
VALUE_EVENT_ROTATE_PAGE
Deprecated.Not used.static java.lang.String
VALUE_EVENT_SAVE_ANNOTATION
Deprecated.Use equivalent in ContentHandlerInput.static java.lang.String
VALUE_EVENT_SAVE_DOCUMENT
Deprecated.Not used.static java.lang.Boolean
VALUE_FALSE
Shorthand for Boolean.FALSE.static java.lang.String
VALUE_PUBLISH_ERROR
Deprecated.No longer used.static java.lang.String
VALUE_PUBLISH_SUCCESS
Deprecated.No longer used.static java.lang.Boolean
VALUE_TRUE
Shorthand for Boolean.TRUE.static ContentHandlerResult
VOID
This constant value can be used for null or void returns.
-
Constructor Summary
Constructors Constructor Description ContentHandlerResult()
-
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[]
getAnnotationNames()
Shortcut to getKEY_ANNOTATION_NAMES
's value.java.util.Hashtable
getAnnotationProperties()
Shortcut to getKEY_ANNOTATION_PROPERTIES
's value.java.util.List<MediaCaption>
getAvailableCaptions()
java.lang.String[]
getAvailableDisplayNames()
Shortcut to getKEY_AVAILABLE_DISPLAY_NAMES
's value.java.lang.String[]
getAvailableDocumentIds()
Shortcut to getKEY_AVAILABLE_DOCUMENT_IDS
's value.byte[]
getBookmarkContent()
Shortcut to getKEY_BOOKMARK_CONTENT
's value.java.lang.String
getClientPreferencesXML()
Deprecated.No longer used.byte[]
getDocumentContent()
Shortcut to getKEY_DOCUMENT_CONTENT
's value.java.util.List
getDocumentContentElements()
Shortcut to getKEY_DOCUMENT_CONTENT_ELEMENTS
's value.java.io.File
getDocumentFile()
Shortcut to getKEY_DOCUMENT_FILE
's value.java.util.List
getDocumentSparseElements()
Shortcut to getKEY_DOCUMENT_SPARSE_ELEMENTS
's value.java.io.InputStream
getDocumentStream()
Shortcut to getKEY_DOCUMENT_INPUT_STREAM
's value.byte[]
getNotesContent()
Shortcut to getKEY_NOTES_CONTENT
's value.java.lang.String
getNotesPermissionLevel()
Deprecated.No longer used.java.util.List<com.snowbound.snapserv.servlet.NotesTemplate>
getNotesTemplates()
Deprecated.No longer used.byte[]
getWatermarkContent()
Shortcut to getKEY_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.
-
-
-
Field Detail
-
VOID
public static final ContentHandlerResult VOID
This constant value can be used for null or void returns.
-
KEY_USERS_AND_GROUPS
@Deprecated public static final java.lang.String KEY_USERS_AND_GROUPS
Deprecated.No Longer used.Key for a list of user and group names.- See Also:
- Constant Field Values
-
KEY_CURRENT_USER_NAME
@Deprecated public static final java.lang.String KEY_CURRENT_USER_NAME
Deprecated.No longer used.Key for current user's name.- See Also:
- Constant Field Values
-
KEY_USE_OF_CACHE_ALLOWED
public static final java.lang.String KEY_USE_OF_CACHE_ALLOWED
Key for whether the cache's use is to be allowed. Expected value type is Boolean.
-
VALUE_FALSE
public static final java.lang.Boolean VALUE_FALSE
Shorthand for Boolean.FALSE.
-
VALUE_TRUE
public static final java.lang.Boolean VALUE_TRUE
Shorthand for Boolean.TRUE.
-
KEY_ANNOTATION_DISPLAY_NAME
public static final java.lang.String KEY_ANNOTATION_DISPLAY_NAME
Key for annotation layer display name. Expected value type is String.- See Also:
- Constant Field Values
-
KEY_ANNOTATION_ID
public static final java.lang.String KEY_ANNOTATION_ID
Key for annotation layer key. Expected value type is String.- See Also:
- Constant Field Values
-
KEY_ALL_ANNOTATIONS_HASH
public static final java.lang.String KEY_ALL_ANNOTATIONS_HASH
Key for map of annotation layer keys to annotation layer objects. Expected value type is java.util.Map<String, com.snowbound.common.transport.AnnotationLayer>.- See Also:
- Constant Field Values
-
KEY_OCR_DATA_JSON
public static final java.lang.String KEY_OCR_DATA_JSON
Key to pass existing OCR data to VirtualViewer, in JSON format. Expected value type is byte[].- See Also:
- Constant Field Values
-
KEY_OCR_DATA_JSON_STRING
public static final java.lang.String KEY_OCR_DATA_JSON_STRING
Key to pass existing OCR data to VirtualViewer, in JSON format, as a string. Expected value type is String.- See Also:
- Constant Field Values
-
KEY_ANNOTATION_IMAGE_DOCUMENT_ID
@Deprecated public static final java.lang.String KEY_ANNOTATION_IMAGE_DOCUMENT_ID
Deprecated.No longer used.- See Also:
- Constant Field Values
-
KEY_ANNOTATION_OWNER
public static final java.lang.String KEY_ANNOTATION_OWNER
Key for user who created the annotation layer. Used when retrieving annotation properties. Expected value type is String.
-
KEY_ANNOTATION_CREATED_DATE
public static final java.lang.String KEY_ANNOTATION_CREATED_DATE
Key for date annotation layer was created. Used when retrieving annotation properties. Expected value type is java.util.Date.
-
KEY_ANNOTATION_DELETABLE
public static final java.lang.String KEY_ANNOTATION_DELETABLE
Key for whether an annotation is deletable. Used when retrieving annotation properties. Expected value type is Boolean.
-
KEY_PUBLISH_STATUS
@Deprecated public static final java.lang.String KEY_PUBLISH_STATUS
Deprecated.No longer used.- See Also:
- Constant Field Values
-
KEY_ANNOTATION_PERMISSION
@Deprecated public static final java.lang.String KEY_ANNOTATION_PERMISSION
Deprecated.No longer used.- See Also:
- Constant Field Values
-
KEY_ANNOTATION_SESSION_ID
@Deprecated public static final java.lang.String KEY_ANNOTATION_SESSION_ID
Deprecated.No longer used.- See Also:
- Constant Field Values
-
VALUE_PUBLISH_SUCCESS
@Deprecated public static final java.lang.String VALUE_PUBLISH_SUCCESS
Deprecated.No longer used.- See Also:
- Constant Field Values
-
VALUE_PUBLISH_ERROR
@Deprecated public static final java.lang.String VALUE_PUBLISH_ERROR
Deprecated.No longer used.- See Also:
- Constant Field Values
-
KEY_DOCUMENT_CONTENT
public static final java.lang.String KEY_DOCUMENT_CONTENT
Key for the document content returned from getDocumentContent. Should not be combined with KEY_DOCUMENT_INPUT_STREAM, KEY_DOCUMENT_FILE, KEY_DOCUMENT_CONTENT_ELEMENTS or KEY_DOCUMENT_SPARSE_ELEMENTS. Expected value type is byte[].
-
KEY_DOCUMENT_FILE
public static final java.lang.String KEY_DOCUMENT_FILE
Key for a document file reference returned from getDocumentContent. Should not be combined with KEY_DOCUMENT_CONTENT, KEY_DOCUMENT_INPUT_STREAM, KEY_DOCUMENT_CONTENT_ELEMENTS or KEY_DOCUMENT_SPARSE_ELEMENTS. Expected value type is java.io.File.
-
KEY_DOCUMENT_CONTENT_ELEMENTS
public static final java.lang.String KEY_DOCUMENT_CONTENT_ELEMENTS
Key for the list of document content elements. This can be used if the document being returned from getDocumentContent is a compound document - made of more than one file. Should not be combined with KEY_DOCUMENT_CONTENT, KEY_DOCUMENT_INPUT_STREAM, KEY_DOCUMENT_FILE, or KEY_DOCUMENT_SPARSE_ELEMENTS. Expected value type is java.util.List, containing some mix of byte[], java.io.InputStream, and java.io.File.
-
KEY_DOCUMENT_SPARSE_ELEMENTS
public static final java.lang.String KEY_DOCUMENT_SPARSE_ELEMENTS
Key for the list of sparse content elements. This can be used to return pages of a sparse document. Should not be combined with KEY_DOCUMENT_CONTENT, KEY_DOCUMENT_INPUT_STREAM, KEY_DOCUMENT_FILE or KEY_DOCUMENT_CONTENT_ELEMENTS. Expected value type is java.util.List containing some mix of byte[] and java.io.InputStream (note: java.io.File content elements are not supported).
-
KEY_DOCUMENT_SPARSE_PAGE_INDEX
public static final java.lang.String KEY_DOCUMENT_SPARSE_PAGE_INDEX
Key for the first page index of the pages returned in KEY_DOCUMENT_SPARSE_ELEMENTS. For instance, if KEY_DOCUMENT_SPARSE_ELEMENTS is returning pages 4-6 in a 15 page document, this key should hold the value '3'--the 0-based index of the first page returned. Expected value type is int.- See Also:
- Constant Field Values
-
KEY_DOCUMENT_SPARSE_RETURN_PAGE_COUNT
public static final java.lang.String KEY_DOCUMENT_SPARSE_RETURN_PAGE_COUNT
Key for the number of pages returned in KEY_DOCUMENT_SPARSE_ELEMENTS. Expected value type is int.- See Also:
- Constant Field Values
-
KEY_DOCUMENT_SPARSE_TOTAL_PAGE_COUNT
public static final java.lang.String KEY_DOCUMENT_SPARSE_TOTAL_PAGE_COUNT
Key for the number of pages in the whole sparse document. Expected value type is int.- See Also:
- Constant Field Values
-
KEY_RETRIEVED_EXTERNAL_REFERENCES
public static final java.lang.String KEY_RETRIEVED_EXTERNAL_REFERENCES
Key for whether external references are being returned with the document. This value isn't needed - just setting KEY_EXTERNAL_REFERENCE_CONTENT_ELEMENTS is sufficient. Expected value type is Boolean.- See Also:
- Constant Field Values
-
KEY_EXTERNAL_REFERENCE_CONTENT_ELEMENTS
public static final java.lang.String KEY_EXTERNAL_REFERENCE_CONTENT_ELEMENTS
Key for external reference files used by a CAD or DWG file. Expected value type is java.util.List ofExternalReference
.
-
KEY_DOCUMENT_INPUT_STREAM
public static final java.lang.String KEY_DOCUMENT_INPUT_STREAM
Key for input stream to document content returned from getDocumentContent. Should not be combined with KEY_DOCUMENT_INPUT_STREAM, KEY_DOCUMENT_FILE, KEY_DOCUMENT_CONTENT_ELEMENTS or KEY_DOCUMENT_SPARSE_ELEMENTS. Expected value type is java.io.InputStream.
-
KEY_DOCUMENT_DISPLAY_NAME
public static final java.lang.String KEY_DOCUMENT_DISPLAY_NAME
Key for the document name VirtualViewer displays to the user. If not specified VirtualViewer will use the document key instead. Expected value type is String.- See Also:
- Constant Field Values
-
KEY_METADATA_HASHTABLE
public static final java.lang.String KEY_METADATA_HASHTABLE
Key for custom document metadata that may be retrieved on the client. Just as clientInstanceId is a way to pass data from client to content handler, this is a way to pass data to client. This is sent with the document model. Expected value type is java.util.Map of String to Object.- See Also:
- Constant Field Values
-
KEY_DOCUMENT_ID
public static final java.lang.String KEY_DOCUMENT_ID
Key for the document key. Expected value type is String.- See Also:
- Constant Field Values
-
KEY_ANNOTATION_NAMES
public static final java.lang.String KEY_ANNOTATION_NAMES
Key for a list of annotation layer keys/names. Expected value type is String[].- See Also:
- Constant Field Values
-
KEY_ANNOTATION_CONTENT
public static final java.lang.String KEY_ANNOTATION_CONTENT
Key for an annotation layer's file content. Expected value type is byte[].- See Also:
- Constant Field Values
-
KEY_BOOKMARK_CONTENT
public static final java.lang.String KEY_BOOKMARK_CONTENT
Key for a document's bookmark file content. Expected value type is byte[].- See Also:
- Constant Field Values
-
KEY_WATERMARK_CONTENT
public static final java.lang.String KEY_WATERMARK_CONTENT
Key for a document's watermark file content. Expected value type is byte[].- See Also:
- Constant Field Values
-
KEY_NOTES_CONTENT
public static final java.lang.String KEY_NOTES_CONTENT
Key for a document's note file content. Expected value type is byte[].- See Also:
- Constant Field Values
-
KEY_NOTES_PERMISSIONS
@Deprecated public static final java.lang.String KEY_NOTES_PERMISSIONS
Deprecated.No longer used.- See Also:
- Constant Field Values
-
KEY_NOTES_TEMPLATES
@Deprecated public static final java.lang.String KEY_NOTES_TEMPLATES
Deprecated.No longer used.- See Also:
- Constant Field Values
-
KEY_ANNOTATION_PROPERTIES
public static final java.lang.String KEY_ANNOTATION_PROPERTIES
Key for custom annotation properties. Expected value type is java.util.Map of String to Object.- See Also:
- Constant Field Values
-
KEY_CLIENT_PREFERENCES_XML
@Deprecated public static final java.lang.String KEY_CLIENT_PREFERENCES_XML
Deprecated.No longer used.- See Also:
- Constant Field Values
-
KEY_AVAILABLE_DOCUMENT_IDS
public static final java.lang.String KEY_AVAILABLE_DOCUMENT_IDS
Key for list of document keys that are available to view. Used to populate the VirtualViewer Documents tab. Expected value type is String[].
-
KEY_AVAILABLE_DISPLAY_NAMES
public static final java.lang.String KEY_AVAILABLE_DISPLAY_NAMES
Key for list of document display names that are available to view. Each element of this list should be paired with an element in KEY_AVAILABLE_DOCUMENT_IDS (i.e. the first display name in this list should go with the first key in KEY_AVAILABLE_DOCUMENT_IDS and so on). Expected value type is String[].- See Also:
- Constant Field Values
-
KEY_AVAILABLE_MEDIA_CAPTION_FILES
public static final java.lang.String KEY_AVAILABLE_MEDIA_CAPTION_FILES
Key for list of WebVTT caption files for video or audio documents. These captions will be automatically offered as caption/subtitle options to the user.- See Also:
- Constant Field Values
-
DOCUMENT_ID_TO_RELOAD
public static final java.lang.String DOCUMENT_ID_TO_RELOAD
Key for an updated document key to use after saving. Setting this alerts the VirtualViewer client to update the document key it uses to retrieve and save changes. This is often used when the content handler saves copies of a document instead of overwriting the existing document, or when saving a new document with a temporary key. Expected value type is String.- See Also:
- Constant Field Values
-
KEY_EVENT
@Deprecated public static final java.lang.String KEY_EVENT
Deprecated.Use equivalent in ContentHandlerInput.- See Also:
- Constant Field Values
-
KEY_CLIENT_INSTANCE_ID
@Deprecated public static final java.lang.String KEY_CLIENT_INSTANCE_ID
Deprecated.Use equivalent in ContentHandlerInput.Key for custom configurable value used to pass data from client to content handler. Expected value type is String.- See Also:
- Constant Field Values
-
VALUE_EVENT_PAGE_REQUESTED
@Deprecated public static final java.lang.String VALUE_EVENT_PAGE_REQUESTED
Deprecated.Use equivalent in ContentHandlerInput.- See Also:
- Constant Field Values
-
VALUE_EVENT_DOCUMENT_RETRIEVED_FROM_CACHE
@Deprecated public static final java.lang.String VALUE_EVENT_DOCUMENT_RETRIEVED_FROM_CACHE
Deprecated.Use equivalent in ContentHandlerInput.- See Also:
- Constant Field Values
-
KEY_EVENT_PAGE_REQUESTED_NUMBER
@Deprecated public static final java.lang.String KEY_EVENT_PAGE_REQUESTED_NUMBER
Deprecated.Use equivalent in ContentHandlerInput.- See Also:
- Constant Field Values
-
VALUE_EVENT_SAVE_ANNOTATION
@Deprecated public static final java.lang.String VALUE_EVENT_SAVE_ANNOTATION
Deprecated.Use equivalent in ContentHandlerInput.- See Also:
- Constant Field Values
-
VALUE_EVENT_SAVE_DOCUMENT
@Deprecated public static final java.lang.String VALUE_EVENT_SAVE_DOCUMENT
Deprecated.Not used. Content handlers should put any actions they wish to perform when saving a document inVirtualViewerContentHandlerInterface.saveDocumentComponents(com.snowbound.contenthandler.ContentHandlerInput)
.- See Also:
- Constant Field Values
-
VALUE_EVENT_CLOSE_DOCUMENT
@Deprecated public static final java.lang.String VALUE_EVENT_CLOSE_DOCUMENT
Deprecated.Not used. The afterTabClosed client-side callback should be used instead.- See Also:
- Constant Field Values
-
KEY_EVENT_SAVE_ANNOTATION_LAYER_NAME_BASE
@Deprecated public static final java.lang.String KEY_EVENT_SAVE_ANNOTATION_LAYER_NAME_BASE
Deprecated.Use equivalent in ContentHandlerInput.- See Also:
- Constant Field Values
-
VALUE_EVENT_ROTATE_PAGE
@Deprecated public static final java.lang.String VALUE_EVENT_ROTATE_PAGE
Deprecated.Not used.- See Also:
- Constant Field Values
-
KEY_EVENT_ROTATE_PAGE
@Deprecated public static final java.lang.String KEY_EVENT_ROTATE_PAGE
Deprecated.Use equivalent in ContentHandlerInput.- See Also:
- Constant Field Values
-
VALUE_EVENT_ROTATE_DEGREES
@Deprecated public static final java.lang.String VALUE_EVENT_ROTATE_DEGREES
Deprecated.Use KEY_EVENT_ROTATE_DEGREES in ContentHandlerInput.- See Also:
- Constant Field Values
-
KEY_EVENT_ROTATE_DEGREES
@Deprecated public static final java.lang.String KEY_EVENT_ROTATE_DEGREES
Deprecated.Use equivalent in ContentHandlerInput.- See Also:
- Constant Field Values
-
VALUE_EVENT_PRINT
@Deprecated public static final java.lang.String VALUE_EVENT_PRINT
Deprecated.Use equivalent in ContentHandlerInput.- See Also:
- Constant Field Values
-
KEY_EVENT_PRINT_PAGE_NUMBERS
@Deprecated public static final java.lang.String KEY_EVENT_PRINT_PAGE_NUMBERS
Deprecated.Use equivalent in ContentHandlerInput.- See Also:
- Constant Field Values
-
VALUE_EVENT_EXPORT
@Deprecated public static final java.lang.String VALUE_EVENT_EXPORT
Deprecated.Use equivalent in ContentHandlerInput.- See Also:
- Constant Field Values
-
KEY_EVENT_EXPORT_FORMAT_NAME
@Deprecated public static final java.lang.String KEY_EVENT_EXPORT_FORMAT_NAME
Deprecated.Use equivalent in ContentHandlerInput.- See Also:
- Constant Field Values
-
-
Method Detail
-
hasDocumentContent
public 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. Note that only one of those values should be set.- Returns:
- true if some form of document content is set
-
getDocumentContent
public byte[] getDocumentContent()
Shortcut to getKEY_DOCUMENT_CONTENT
's value.- Returns:
- document content byte array
-
getDocumentContentElements
public java.util.List getDocumentContentElements()
Shortcut to getKEY_DOCUMENT_CONTENT_ELEMENTS
's value.- Returns:
- list of set content elements
-
getDocumentSparseElements
public java.util.List getDocumentSparseElements()
Shortcut to getKEY_DOCUMENT_SPARSE_ELEMENTS
's value.- Returns:
- list of sparse content elements
-
getDocumentStream
public java.io.InputStream getDocumentStream()
Shortcut to getKEY_DOCUMENT_INPUT_STREAM
's value.- Returns:
- document content input stream
-
getAnnotationNames
public java.lang.String[] getAnnotationNames()
Shortcut to getKEY_ANNOTATION_NAMES
's value.- Returns:
- list of annotation layer keys/names
-
getAnnotationContent
public byte[] getAnnotationContent()
Shortcut to getKEY_ANNOTATION_CONTENT
's value.- Returns:
- annotation content byte array
-
getBookmarkContent
public byte[] getBookmarkContent()
Shortcut to getKEY_BOOKMARK_CONTENT
's value.- Returns:
- bookmark content byte array
-
getWatermarkContent
public byte[] getWatermarkContent()
Shortcut to getKEY_WATERMARK_CONTENT
's value.- Returns:
- watermark content byte array
-
getAnnotationProperties
public java.util.Hashtable getAnnotationProperties()
Shortcut to getKEY_ANNOTATION_PROPERTIES
's value.- Returns:
- map of annotation properties
-
getClientPreferencesXML
@Deprecated public java.lang.String getClientPreferencesXML()
Deprecated.No longer used.- Returns:
- client preferences XML
-
getAvailableDocumentIds
public java.lang.String[] getAvailableDocumentIds()
Shortcut to getKEY_AVAILABLE_DOCUMENT_IDS
's value.- Returns:
- list of available document keys
-
getAvailableDisplayNames
public java.lang.String[] getAvailableDisplayNames()
Shortcut to getKEY_AVAILABLE_DISPLAY_NAMES
's value.- Returns:
- list of available document display names
-
getNotesContent
public byte[] getNotesContent()
Shortcut to getKEY_NOTES_CONTENT
's value.- Returns:
- notes content byte array
-
getNotesPermissionLevel
@Deprecated public java.lang.String getNotesPermissionLevel()
Deprecated.No longer used.- Returns:
- notes permission level
-
getDocumentFile
public java.io.File getDocumentFile()
Shortcut to getKEY_DOCUMENT_FILE
's value.- Returns:
- reference to document content File
-
getNotesTemplates
@Deprecated public java.util.List<com.snowbound.snapserv.servlet.NotesTemplate> getNotesTemplates()
Deprecated.No longer used.- Returns:
- list of note templates
-
getAvailableCaptions
public java.util.List<MediaCaption> getAvailableCaptions()
- Returns:
- list of available caption files
-
-