com.groupdocs.annotation.handler
Class AnnotationHandler

java.lang.Object
  com.groupdocs.viewer.resources.GroupDocsViewer
      com.groupdocs.annotation.handler.GroupDocsAnnotation
          com.groupdocs.annotation.handler.AnnotationHandler

public class AnnotationHandler
extends GroupDocsAnnotation

Annotation handler

Author:

Alex Bobkov

Field Summary

protected ServiceConfiguration	config
protected com.groupdocs.viewer.handlers.ViewerHandler	viewerHandler

Fields inherited from class com.groupdocs.annotation.handler.GroupDocsAnnotation

ADD_ANNOTATION_REPLY_HANDLER, CREATE_ANNOTATION_HANDLER, DELETE_ANNOTATION_HANDLER, DELETE_ANNOTATION_REPLY_HANDLER, DOCUMENT_ANNOTATION, EDIT_ANNOTATION_REPLY_HANDLER, EXPORT_ANNOTATIONS_HANDLER, GET_AVATAR_HANDLER, GET_DOCUMENT_COLLABORATORS_HANDLER, GET_PDF_VERSION_OF_DOCUMENT_HANDLER, IMPORT_ANNOTATIONS_HANDLER, LIST_ANNOTATIONS_HANDLER, MOVE_ANNOTATION_MARKER_HANDLER, RESIZE_ANNOTATION_HANDLER, SAVE_TEXT_FIELD_HANDLER, SET_TEXT_FIELD_COLOR_HANDLER, UPLOAD_FILE

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_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, START_GENERATE_IMAGES, VIEW, VIEW_DOCUMENT_HANDLER

Constructor Summary

AnnotationHandler(ServiceConfiguration config)
Constructor with basic configuration

AnnotationHandler(ServiceConfiguration config, com.groupdocs.viewer.handlers.InputDataHandler inputDataHandler)
Constructor with basic configuration and custom input data handler

Method Summary

Object	addAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Add reply to annotation [POST request]
String	addCollaborator(String userName, String fileGuid, Integer accessRights, int color) Add collaborator if one doesn't exist and return guid
Object	createAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Create annotation [POST request]
Object	deleteAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Delete annotation [POST request]
Object	deleteAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Delete annotation reply [POST request]
Object	editAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Edit annotation reply [POST request]
Object	exportAnnotationsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Export annotations to PDF [POST request]
Object	getAvatarHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String userId) Get user avatar image [GET request]
ServiceConfiguration	getConfiguration() Get service configuration
void	getCssHandler(String script, javax.servlet.http.HttpServletResponse response)
Object	getDocumentCollaboratorsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Return list of collaborators [POST request]
void	getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	getDocumentPageImageHandler(String guid, Integer width, Integer quality, Boolean usePdf, Integer pageIndex, javax.servlet.http.HttpServletResponse response)
void	getFileHandler(String path, javax.servlet.http.HttpServletResponse response)
void	getFontHandler(String fontName, javax.servlet.http.HttpServletResponse response)
String	getHeader() Deprecated. [v1.3.0] function will be deleted at next annotation version
String	getHeader(javax.servlet.http.HttpServletRequest request) Get HTML header including all JavaScipts, style sheets and images
String	getHeader(String appPath) Get HTML header including all JavaScipts, style sheets and images
void	getHtmlRecoucesHandler(String filePath, javax.servlet.http.HttpServletResponse response)
void	getImageHandler(String name, javax.servlet.http.HttpServletResponse response)
Object	getImageUrlsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Object	getImageUrlsHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	getJsHandler(String script, javax.servlet.http.HttpServletResponse response)
Object	getPdf2JavaScriptHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Object	getPdf2JavaScriptHandler(String callback, String data, javax.servlet.http.HttpServletResponse response)
Object	getPdfVersionOfDocumentHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get document as PDF file [POST request]
Object	getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Object	getPrintableHtmlHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
String	getScripts(HashMap<String,String> params) Deprecated. [v1.3.0] function will be deleted at next annotation version
String	getScripts(javax.servlet.http.HttpServletRequest request, HashMap<String,String> params) Get inline JavaScript's JavaScripts
String	getScripts(String appPath, HashMap<String,String> params) Get inline JavaScript's JavaScripts
Object	listAnnotationsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get list of annotations [POST request]
Object	loadFileBrowserTreeDataHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Object	loadFileBrowserTreeDataHandler(String callback, String data, javax.servlet.http.HttpServletResponse response)
Object	moveAnnotationMarkerHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Move marker of annotation [POST request]
Object	resizeAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Change annotation size [POST request]
Object	saveTextFieldHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Save changes in text of annotation [POST request]
Object	setTextFieldColorHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Set color to text annotation [POST request]
Object	viewDocumentHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Object	viewDocumentHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

viewerHandler

protected com.groupdocs.viewer.handlers.ViewerHandler viewerHandler

config

protected ServiceConfiguration config

Constructor Detail

AnnotationHandler

public AnnotationHandler(ServiceConfiguration config)
                  throws Exception

Constructor with basic configuration

Parameters:

config - sets of basic configurations to initialize viewer

Throws:

Exception

AnnotationHandler

public AnnotationHandler(ServiceConfiguration config,
                         com.groupdocs.viewer.handlers.InputDataHandler inputDataHandler)
                  throws Exception

Constructor with basic configuration and custom input data handler

Parameters:

config - sets of basic configurations to initialize viewer

inputDataHandler - custom input data handler

Throws:

Exception

Method Detail

getHeader

@Deprecated
public String getHeader()
                 throws IOException

Deprecated. [v1.3.0] function will be deleted at next annotation version

Get HTML header including all JavaScipts, style sheets and images

Returns:

HTML formatted header

Throws:

IOException

getHeader

public String getHeader(javax.servlet.http.HttpServletRequest request)
                 throws IOException

Get HTML header including all JavaScipts, style sheets and images

Parameters:

request - http servlet request

Returns:

HTML formatted header

Throws:

IOException

getHeader

public String getHeader(String appPath)
                 throws IOException

Get HTML header including all JavaScipts, style sheets and images

Parameters:

appPath - base application url (example http://annotation.local:8080/context-path/ )

Returns:

HTML formatted header

Throws:

IOException

getScripts

@Deprecated
public String getScripts(HashMap<String,String> params)
                  throws IOException

Deprecated. [v1.3.0] function will be deleted at next annotation version

Get inline JavaScript's JavaScripts

Parameters:

params - parameters to configure annotation

Returns:

html with inline JavaScript

Throws:

IOException

getScripts

public String getScripts(javax.servlet.http.HttpServletRequest request,
                         HashMap<String,String> params)
                  throws IOException

Get inline JavaScript's JavaScripts

Parameters:

request - http servlet request

params - parameters to configure annotation

Returns:

html with inline JavaScript

Throws:

IOException

getScripts

public String getScripts(String appPath,
                         HashMap<String,String> params)
                  throws IOException

Get inline JavaScript's JavaScripts

Parameters:

appPath - base application url (example http://annotation.local:8080/context-path/ )

params - parameters to configure annotation

Returns:

html with inline JavaScript

Throws:

IOException

getJsHandler

public void getJsHandler(String script,
                         javax.servlet.http.HttpServletResponse response)
                  throws IOException

Specified by:

getJsHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

Throws:

IOException

See Also:

GroupDocsViewer

getCssHandler

public void getCssHandler(String script,
                          javax.servlet.http.HttpServletResponse response)
                   throws IOException

Specified by:

getCssHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

Throws:

IOException

See Also:

GroupDocsViewer

getImageHandler

public void getImageHandler(String name,
                            javax.servlet.http.HttpServletResponse response)
                     throws IOException

Specified by:

getImageHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

Throws:

IOException

See Also:

GroupDocsViewer

getFontHandler

public void getFontHandler(String fontName,
                           javax.servlet.http.HttpServletResponse response)
                    throws IOException

Specified by:

getFontHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

Throws:

IOException

See Also:

GroupDocsViewer

getHtmlRecoucesHandler

public void getHtmlRecoucesHandler(String filePath,
                                   javax.servlet.http.HttpServletResponse response)
                            throws FileNotFoundException,
                                   IOException

Specified by:

getHtmlRecoucesHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

Throws:

FileNotFoundException

IOException

See Also:

GroupDocsViewer

getFileHandler

public void getFileHandler(String path,
                           javax.servlet.http.HttpServletResponse response)
                    throws Exception

Specified by:

getFileHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

Throws:

Exception

See Also:

GroupDocsViewer

getDocumentPageImageHandler

public void getDocumentPageImageHandler(String guid,
                                        Integer width,
                                        Integer quality,
                                        Boolean usePdf,
                                        Integer pageIndex,
                                        javax.servlet.http.HttpServletResponse response)
                                 throws Exception

Specified by:

getDocumentPageImageHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

Throws:

Exception

See Also:

GroupDocsViewer

viewDocumentHandler

public Object viewDocumentHandler(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)

Specified by:

viewDocumentHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

See Also:

GroupDocsViewer

viewDocumentHandler

public Object viewDocumentHandler(String callback,
                                  String data,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)

Specified by:

viewDocumentHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

See Also:

GroupDocsViewer

loadFileBrowserTreeDataHandler

public Object loadFileBrowserTreeDataHandler(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)

Specified by:

loadFileBrowserTreeDataHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

See Also:

GroupDocsViewer

loadFileBrowserTreeDataHandler

public Object loadFileBrowserTreeDataHandler(String callback,
                                             String data,
                                             javax.servlet.http.HttpServletResponse response)

Specified by:

loadFileBrowserTreeDataHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

See Also:

GroupDocsViewer

getPdf2JavaScriptHandler

public Object getPdf2JavaScriptHandler(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)

Specified by:

getPdf2JavaScriptHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

See Also:

GroupDocsViewer

getPdf2JavaScriptHandler

public Object getPdf2JavaScriptHandler(String callback,
                                       String data,
                                       javax.servlet.http.HttpServletResponse response)

Specified by:

getPdf2JavaScriptHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

See Also:

GroupDocsViewer

getPrintableHtmlHandler

public Object getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)

Specified by:

getPrintableHtmlHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

See Also:

GroupDocsViewer

getPrintableHtmlHandler

public Object getPrintableHtmlHandler(String callback,
                                      String data,
                                      javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)

Specified by:

getPrintableHtmlHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

See Also:

GroupDocsViewer

getDocumentPageHtmlHandler

public void getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)

Specified by:

getDocumentPageHtmlHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

See Also:

GroupDocsViewer

getImageUrlsHandler

public Object getImageUrlsHandler(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)

Specified by:

getImageUrlsHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

See Also:

GroupDocsViewer

getImageUrlsHandler

public Object getImageUrlsHandler(String callback,
                                  String data,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)

Specified by:

getImageUrlsHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

See Also:

GroupDocsViewer

listAnnotationsHandler

public Object listAnnotationsHandler(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)

Description copied from class: GroupDocsAnnotation

Get list of annotations [POST request]

Specified by:

listAnnotationsHandler in class GroupDocsAnnotation

Parameters:

request - HTTP servlet request

Returns:

object with respective parameters

See Also:

GroupDocsAnnotation

exportAnnotationsHandler

public Object exportAnnotationsHandler(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)

Description copied from class: GroupDocsAnnotation

Export annotations to PDF [POST request]

Specified by:

exportAnnotationsHandler in class GroupDocsAnnotation

Parameters:

request - HTTP servlet request

Returns:

object with respective parameters

See Also:

GroupDocsAnnotation

getPdfVersionOfDocumentHandler

public Object getPdfVersionOfDocumentHandler(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)

Description copied from class: GroupDocsAnnotation

Get document as PDF file [POST request]

Specified by:

getPdfVersionOfDocumentHandler in class GroupDocsAnnotation

Parameters:

request - HTTP servlet request

Returns:

object with respective parameters

See Also:

GroupDocsAnnotation

createAnnotationHandler

public Object createAnnotationHandler(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)

Description copied from class: GroupDocsAnnotation

Create annotation [POST request]

Specified by:

createAnnotationHandler in class GroupDocsAnnotation

Parameters:

request - HTTP servlet request

Returns:

object with respective parameters

See Also:

GroupDocsAnnotation

getAvatarHandler

public Object getAvatarHandler(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response,
                               String userId)

Description copied from class: GroupDocsAnnotation

Get user avatar image [GET request]

Specified by:

getAvatarHandler in class GroupDocsAnnotation

Parameters:

request - HTTP servlet request

userId - user id

Returns:

object with respective parameters

See Also:

GroupDocsAnnotation

addAnnotationReplyHandler

public Object addAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)

Description copied from class: GroupDocsAnnotation

Add reply to annotation [POST request]

Specified by:

addAnnotationReplyHandler in class GroupDocsAnnotation

Parameters:

request - HTTP servlet request

Returns:

object with respective parameters

See Also:

GroupDocsAnnotation

editAnnotationReplyHandler

public Object editAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)

Description copied from class: GroupDocsAnnotation

Edit annotation reply [POST request]

Specified by:

editAnnotationReplyHandler in class GroupDocsAnnotation

Parameters:

request - HTTP servlet request

Returns:

object with respective parameters

See Also:

GroupDocsAnnotation

deleteAnnotationReplyHandler

public Object deleteAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)

Description copied from class: GroupDocsAnnotation

Delete annotation reply [POST request]

Specified by:

deleteAnnotationReplyHandler in class GroupDocsAnnotation

Parameters:

request - HTTP servlet request

Returns:

object with respective parameters

See Also:

GroupDocsAnnotation

deleteAnnotationHandler

public Object deleteAnnotationHandler(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)

Description copied from class: GroupDocsAnnotation

Delete annotation [POST request]

Specified by:

deleteAnnotationHandler in class GroupDocsAnnotation

Parameters:

request - HTTP servlet request

Returns:

object with respective parameters

See Also:

GroupDocsAnnotation

saveTextFieldHandler

public Object saveTextFieldHandler(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response)

Description copied from class: GroupDocsAnnotation

Save changes in text of annotation [POST request]

Specified by:

saveTextFieldHandler in class GroupDocsAnnotation

Parameters:

request - HTTP servlet request

Returns:

object with respective parameters

See Also:

GroupDocsAnnotation

setTextFieldColorHandler

public Object setTextFieldColorHandler(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)

Description copied from class: GroupDocsAnnotation

Set color to text annotation [POST request]

Specified by:

setTextFieldColorHandler in class GroupDocsAnnotation

Parameters:

request - HTTP servlet request

Returns:

object with respective parameters

See Also:

GroupDocsAnnotation

moveAnnotationMarkerHandler

public Object moveAnnotationMarkerHandler(javax.servlet.http.HttpServletRequest request,
                                          javax.servlet.http.HttpServletResponse response)

Description copied from class: GroupDocsAnnotation

Move marker of annotation [POST request]

Specified by:

moveAnnotationMarkerHandler in class GroupDocsAnnotation

Parameters:

request - HTTP servlet request

Returns:

object with respective parameters

See Also:

GroupDocsAnnotation

resizeAnnotationHandler

public Object resizeAnnotationHandler(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)

Description copied from class: GroupDocsAnnotation

Change annotation size [POST request]

Specified by:

resizeAnnotationHandler in class GroupDocsAnnotation

Parameters:

request - HTTP servlet request

Returns:

object with response parameters

See Also:

GroupDocsAnnotation

getDocumentCollaboratorsHandler

public Object getDocumentCollaboratorsHandler(javax.servlet.http.HttpServletRequest request,
                                              javax.servlet.http.HttpServletResponse response)

Description copied from class: GroupDocsAnnotation

Return list of collaborators [POST request]

Specified by:

getDocumentCollaboratorsHandler in class GroupDocsAnnotation

Parameters:

request - HTTP servlet request

Returns:

object with response parameters

See Also:

GroupDocsAnnotation

getConfiguration

public ServiceConfiguration getConfiguration()

Get service configuration

Returns:

service configuration

addCollaborator

public String addCollaborator(String userName,
                              String fileGuid,
                              Integer accessRights,
                              int color)

Add collaborator if one doesn't exist and return guid

Parameters:

userName - collaborator user name

fileGuid - document guid

color - color to collaborator

Returns:

collaborator guid