com.groupdocs.annotation.handler
Class GroupDocsAnnotation

java.lang.Object
  extended by com.groupdocs.viewer.resources.GroupDocsViewer
      extended by com.groupdocs.annotation.handler.GroupDocsAnnotation
All Implemented Interfaces:
com.groupdocs.viewer.resources.IGroupDocsViewer, com.groupdocs.viewer.resources.IGroupDocsViewerBasic

public abstract class GroupDocsAnnotation
extends com.groupdocs.viewer.resources.GroupDocsViewer

Annotation

Author:
Alex Bobkov

Field Summary
protected static String ADD_ANNOTATION_REPLY_HANDLER
           
static String ATMOSPHERE_ANNOTATION
           
protected static String CREATE_ANNOTATION_HANDLER
           
protected static String DELETE_ANNOTATION_HANDLER
           
protected static String DELETE_ANNOTATION_REPLY_HANDLER
           
protected static String DOCUMENT_ANNOTATION
           
protected static String EDIT_ANNOTATION_REPLY_HANDLER
           
protected static String EXPORT_ANNOTATIONS_HANDLER
           
protected static String GET_AVATAR_HANDLER
           
protected static String GET_DOCUMENT_COLLABORATORS_HANDLER
           
protected static String GET_PDF_VERSION_OF_DOCUMENT_HANDLER
           
protected static String GET_PRINT_DOCUMENT_PAGE_IMAGE_HANDLER
           
protected static String GET_PRINT_VIEW_HANDLER
           
protected static String IMPORT_ANNOTATIONS_HANDLER
           
protected static String LIST_ANNOTATIONS_HANDLER
           
protected static String MOVE_ANNOTATION_MARKER_HANDLER
           
protected static String RESIZE_ANNOTATION_HANDLER
           
protected static String RESTORE_ANNOTATION_REPLIES_HANDLER
           
protected static String SAVE_TEXT_FIELD_HANDLER
           
protected static String SET_TEXT_FIELD_COLOR_HANDLER
           
protected static String UPLOAD_FILE_HANDLER
           
 
Fields inherited from class com.groupdocs.viewer.resources.GroupDocsViewer
DOCUMENT_VIEWER, GET_CSS_HANDLER, GET_DOCUMENT_PAGE_HTML_HANDLER, GET_DOCUMENT_PAGE_IMAGE_HANDLER, GET_FILE_HANDLER, GET_FILENET, GET_FONT_HANDLER, GET_GENERATE_PROGRESS, GET_HTML_RESOURCES_HANDLER, GET_IMAGE_HANDLER, GET_IMAGE_URL_HANDLER, GET_JS_HANDLER, GET_PDF_2_JAVA_SCRIPT_HANDLER, GET_PDF_WITH_PRINT_DIALOG, GET_PRINTABLE_HTML_HANDLER, LOAD_FILE_BROWSER_TREE_DATA_HANLER, REORDER_PAGE_HANDLER, START_GENERATE_IMAGES, UPLOAD_FILE, VIEW, VIEW_DOCUMENT_HANDLER
 
Constructor Summary
GroupDocsAnnotation()
           
 
Method Summary
abstract  Object addAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Add reply to annotation [POST request]
abstract  Object createAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Create annotation [POST request]
abstract  Object deleteAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Delete annotation [POST request]
abstract  Object deleteAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Delete annotation reply [POST request]
abstract  Object editAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Edit annotation reply [POST request]
abstract  Object exportAnnotationsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Export annotations to PDF [POST request]
abstract  Object getAvatarHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String userId)
          Get user avatar image [GET request]
abstract  Object getDocumentCollaboratorsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Return list of collaborators [POST request]
abstract  Object getPdfVersionOfDocumentHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get document as PDF file [POST request]
abstract  Object getPrintDocumentPageImageHandler(String guid, Integer pageIndex, javax.servlet.http.HttpServletResponse response)
          Get image file for print dialog [GET request]
abstract  Object getPrintViewHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get view for print document [POST request]
abstract  Object importAnnotationsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Import document with annotations [POST request]
abstract  Object listAnnotationsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get list of annotations [POST request]
abstract  Object moveAnnotationMarkerHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Move marker of annotation [POST request]
abstract  void onAtmosphereMessage(org.atmosphere.cpr.AtmosphereResource resource)
          On message handler [POST request]
abstract  void onAtmosphereReady(org.atmosphere.cpr.AtmosphereResource resource)
          On ready handler [POST request]
abstract  Object resizeAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Change annotation size [POST request]
abstract  Object restoreAnnotationRepliesHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Restore annotation replies [POST request]
abstract  Object saveTextFieldHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Save changes in text of annotation [POST request]
abstract  Object setTextFieldColorHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Set color to text annotation [POST request]
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.groupdocs.viewer.resources.IGroupDocsViewer
getImageUrlsHandler, getPrintableHtmlHandler, loadFileBrowserTreeDataHandler, viewDocumentHandler
 
Methods inherited from interface com.groupdocs.viewer.resources.IGroupDocsViewerBasic
getCssHandler, getDocumentPageHtmlHandler, getDocumentPageImageHandler, getFileHandler, getFontHandler, getHtmlRecoucesHandler, getImageHandler, getImageUrlsHandler, getJsHandler, getPdfWithPrintDialog, getPrintableHtmlHandler, loadFileBrowserTreeDataHandler, reorderPageHandler, viewDocumentHandler
 

Field Detail

ATMOSPHERE_ANNOTATION

public static final String ATMOSPHERE_ANNOTATION
See Also:
Constant Field Values

DOCUMENT_ANNOTATION

protected static final String DOCUMENT_ANNOTATION
See Also:
Constant Field Values

LIST_ANNOTATIONS_HANDLER

protected static final String LIST_ANNOTATIONS_HANDLER
See Also:
Constant Field Values

EXPORT_ANNOTATIONS_HANDLER

protected static final String EXPORT_ANNOTATIONS_HANDLER
See Also:
Constant Field Values

GET_PDF_VERSION_OF_DOCUMENT_HANDLER

protected static final String GET_PDF_VERSION_OF_DOCUMENT_HANDLER
See Also:
Constant Field Values

CREATE_ANNOTATION_HANDLER

protected static final String CREATE_ANNOTATION_HANDLER
See Also:
Constant Field Values

GET_AVATAR_HANDLER

protected static final String GET_AVATAR_HANDLER
See Also:
Constant Field Values

ADD_ANNOTATION_REPLY_HANDLER

protected static final String ADD_ANNOTATION_REPLY_HANDLER
See Also:
Constant Field Values

EDIT_ANNOTATION_REPLY_HANDLER

protected static final String EDIT_ANNOTATION_REPLY_HANDLER
See Also:
Constant Field Values

DELETE_ANNOTATION_REPLY_HANDLER

protected static final String DELETE_ANNOTATION_REPLY_HANDLER
See Also:
Constant Field Values

DELETE_ANNOTATION_HANDLER

protected static final String DELETE_ANNOTATION_HANDLER
See Also:
Constant Field Values

SAVE_TEXT_FIELD_HANDLER

protected static final String SAVE_TEXT_FIELD_HANDLER
See Also:
Constant Field Values

SET_TEXT_FIELD_COLOR_HANDLER

protected static final String SET_TEXT_FIELD_COLOR_HANDLER
See Also:
Constant Field Values

MOVE_ANNOTATION_MARKER_HANDLER

protected static final String MOVE_ANNOTATION_MARKER_HANDLER
See Also:
Constant Field Values

RESIZE_ANNOTATION_HANDLER

protected static final String RESIZE_ANNOTATION_HANDLER
See Also:
Constant Field Values

GET_DOCUMENT_COLLABORATORS_HANDLER

protected static final String GET_DOCUMENT_COLLABORATORS_HANDLER
See Also:
Constant Field Values

IMPORT_ANNOTATIONS_HANDLER

protected static final String IMPORT_ANNOTATIONS_HANDLER
See Also:
Constant Field Values

GET_PRINT_VIEW_HANDLER

protected static final String GET_PRINT_VIEW_HANDLER
See Also:
Constant Field Values

UPLOAD_FILE_HANDLER

protected static final String UPLOAD_FILE_HANDLER
See Also:
Constant Field Values

GET_PRINT_DOCUMENT_PAGE_IMAGE_HANDLER

protected static final String GET_PRINT_DOCUMENT_PAGE_IMAGE_HANDLER
See Also:
Constant Field Values

RESTORE_ANNOTATION_REPLIES_HANDLER

protected static final String RESTORE_ANNOTATION_REPLIES_HANDLER
See Also:
Constant Field Values
Constructor Detail

GroupDocsAnnotation

public GroupDocsAnnotation()
Method Detail

listAnnotationsHandler

public abstract Object listAnnotationsHandler(javax.servlet.http.HttpServletRequest request,
                                              javax.servlet.http.HttpServletResponse response)
Get list of annotations [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with respective parameters

exportAnnotationsHandler

public abstract Object exportAnnotationsHandler(javax.servlet.http.HttpServletRequest request,
                                                javax.servlet.http.HttpServletResponse response)
Export annotations to PDF [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with respective parameters

getPdfVersionOfDocumentHandler

public abstract Object getPdfVersionOfDocumentHandler(javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
Get document as PDF file [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with respective parameters

createAnnotationHandler

public abstract Object createAnnotationHandler(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response)
Create annotation [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with respective parameters

getAvatarHandler

public abstract Object getAvatarHandler(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response,
                                        String userId)
Get user avatar image [GET request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
userId - user id
Returns:
object with respective parameters

addAnnotationReplyHandler

public abstract Object addAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request,
                                                 javax.servlet.http.HttpServletResponse response)
                                          throws AnnotationException
Add reply to annotation [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with respective parameters
Throws:
AnnotationException - annotation exception

editAnnotationReplyHandler

public abstract Object editAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request,
                                                  javax.servlet.http.HttpServletResponse response)
Edit annotation reply [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with respective parameters

deleteAnnotationReplyHandler

public abstract Object deleteAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request,
                                                    javax.servlet.http.HttpServletResponse response)
Delete annotation reply [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with respective parameters

deleteAnnotationHandler

public abstract Object deleteAnnotationHandler(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response)
Delete annotation [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with respective parameters

saveTextFieldHandler

public abstract Object saveTextFieldHandler(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)
Save changes in text of annotation [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with respective parameters

setTextFieldColorHandler

public abstract Object setTextFieldColorHandler(javax.servlet.http.HttpServletRequest request,
                                                javax.servlet.http.HttpServletResponse response)
Set color to text annotation [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with respective parameters

moveAnnotationMarkerHandler

public abstract Object moveAnnotationMarkerHandler(javax.servlet.http.HttpServletRequest request,
                                                   javax.servlet.http.HttpServletResponse response)
Move marker of annotation [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with respective parameters

resizeAnnotationHandler

public abstract Object resizeAnnotationHandler(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response)
Change annotation size [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with response parameters

getDocumentCollaboratorsHandler

public abstract Object getDocumentCollaboratorsHandler(javax.servlet.http.HttpServletRequest request,
                                                       javax.servlet.http.HttpServletResponse response)
Return list of collaborators [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with response parameters

importAnnotationsHandler

public abstract Object importAnnotationsHandler(javax.servlet.http.HttpServletRequest request,
                                                javax.servlet.http.HttpServletResponse response)
Import document with annotations [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with response parameters

getPrintViewHandler

public abstract Object getPrintViewHandler(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)
Get view for print document [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

onAtmosphereReady

public abstract void onAtmosphereReady(org.atmosphere.cpr.AtmosphereResource resource)
On ready handler [POST request]

Parameters:
resource - resource data received from socket

onAtmosphereMessage

public abstract void onAtmosphereMessage(org.atmosphere.cpr.AtmosphereResource resource)
On message handler [POST request]

Parameters:
resource - resource data received from socket

getPrintDocumentPageImageHandler

public abstract Object getPrintDocumentPageImageHandler(String guid,
                                                        Integer pageIndex,
                                                        javax.servlet.http.HttpServletResponse response)
Get image file for print dialog [GET request]

Parameters:
guid - Relative path to file from base path directory (ex: folder/example.doc or example.doc)
pageIndex - Page number
response - HTTP servlet response
Returns:
response object

restoreAnnotationRepliesHandler

public abstract Object restoreAnnotationRepliesHandler(javax.servlet.http.HttpServletRequest request,
                                                       javax.servlet.http.HttpServletResponse response)
Restore annotation replies [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object


Copyright © 2014. All rights reserved.