|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.groupdocs.viewer.resources.GroupDocsViewer
com.groupdocs.annotation.handler.GroupDocsAnnotation
com.groupdocs.annotation.handler.AnnotationHandler
public class AnnotationHandler
Annotation handler
Field Summary | |
---|---|
static String |
ANONIMOUS_USERNAME
|
protected com.groupdocs.viewer.config.ServiceConfiguration |
config
|
protected com.groupdocs.viewer.handlers.ViewerHandler |
viewerHandler
|
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 | |
---|---|
AnnotationHandler(com.groupdocs.viewer.config.ServiceConfiguration config)
Constructor with basic configuration |
|
AnnotationHandler(com.groupdocs.viewer.config.ServiceConfiguration config,
com.groupdocs.viewer.handlers.input.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,
AccessRights accessRights,
int color)
Add collaborator if one doesn't exist and return guid |
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] |
String |
getAnnotationScript(String annotationId,
String filePath,
String userName,
String userGuid)
Get inline JavaScript's JavaScripts |
Object |
getAvatarHandler(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String userId)
Get user avatar image [GET request] |
com.groupdocs.viewer.config.ServiceConfiguration |
getConfiguration()
Get service configuration |
Object |
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] |
Object |
getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
Object |
getDocumentPageImageHandler(String guid,
Integer width,
Integer quality,
Boolean usePdf,
Integer pageIndex,
javax.servlet.http.HttpServletResponse response)
|
Object |
getFileHandler(String path,
boolean getPdf,
javax.servlet.http.HttpServletResponse response)
|
void |
getFileHandler(String path,
javax.servlet.http.HttpServletResponse response)
Deprecated. as of release 1.4.0, replaced by getFileHandler(String, boolean, HttpServletResponse) |
Object |
getFontHandler(String fontName,
javax.servlet.http.HttpServletResponse response)
|
String |
getHeader()
Get HTML header including all JavaScipts, style sheets and images |
String |
getHeader(javax.servlet.http.HttpServletRequest request)
Deprecated. since 1.5.0, use getHeader() instead Get HTML header including all JavaScipts, style sheets and images |
String |
getHeader(String appPath)
Deprecated. since 1.5.0, use getHeader() instead Get HTML header including all JavaScipts, style sheets and images |
Object |
getHtmlRecoucesHandler(String filePath,
javax.servlet.http.HttpServletResponse response)
|
Object |
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)
|
Object |
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 |
getPdfWithPrintDialog(String path,
javax.servlet.http.HttpServletResponse response)
|
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)
|
Object |
getPrintViewHandler(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Get view for print document [POST request] |
String |
getScripts(javax.servlet.http.HttpServletRequest request,
HashMap<String,Object> params)
Deprecated. since 1.5.0, use getAnnotationScript instead Get inline JavaScript's JavaScripts |
String |
getScripts(String appPath,
HashMap<String,Object> params)
Deprecated. since 1.5.0, use getAnnotationScript instead Get inline JavaScript's JavaScripts |
Object |
importAnnotationsHandler(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Import document with annotations [POST request] |
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] |
void |
onAtmosphereMessage(org.atmosphere.cpr.AtmosphereResource resource)
On message handler [POST request] |
void |
onAtmosphereReady(org.atmosphere.cpr.AtmosphereResource resource)
On ready handler [POST request] |
Object |
reorderPageHandler(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
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] |
boolean |
sendMessage(Object message)
Send message to all clients |
Object |
setTextFieldColorHandler(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Set color to text annotation [POST request] |
Object |
uploadFileHandler(String userId,
String fld,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Upload file for import [POST request] |
Object |
uploadFileHandler(String userGuid,
String uploadFileName,
InputStream uploadInputStream,
boolean callImport)
Upload file for import |
Object |
uploadFileHandler(String userGuid,
String fld,
String uploadFileName,
InputStream uploadInputStream,
int timeToLive,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Deprecated. |
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 |
---|
public static final String ANONIMOUS_USERNAME
protected com.groupdocs.viewer.handlers.ViewerHandler viewerHandler
protected com.groupdocs.viewer.config.ServiceConfiguration config
Constructor Detail |
---|
public AnnotationHandler(com.groupdocs.viewer.config.ServiceConfiguration config) throws Exception
config
- sets of basic configurations to initialize viewer
Exception
public AnnotationHandler(com.groupdocs.viewer.config.ServiceConfiguration config, com.groupdocs.viewer.handlers.input.InputDataHandler inputDataHandler) throws Exception
config
- sets of basic configurations to initialize viewerinputDataHandler
- custom input data handler
Exception
Method Detail |
---|
public String getHeader(javax.servlet.http.HttpServletRequest request) throws IOException
request
- http servlet request
IOException
public String getHeader(String appPath) throws IOException
appPath
- base application url (example http://annotation.local:8080/context-path/ )
IOException
public String getHeader() throws IOException
IOException
public String getScripts(javax.servlet.http.HttpServletRequest request, HashMap<String,Object> params) throws IOException
request
- http servlet requestparams
- parameters to configure annotation
IOException
public String getScripts(String appPath, HashMap<String,Object> params) throws IOException
appPath
- base application url (example http://annotation.local:8080/context-path/ )params
- parameters to configure annotation
IOException
public String getAnnotationScript(String annotationId, String filePath, String userName, String userGuid) throws IOException
annotationId
- div idfilePath
- path to fileuserName
- user nameuserGuid
- user guid
IOException
public Object getJsHandler(String script, javax.servlet.http.HttpServletResponse response)
getJsHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object getCssHandler(String script, javax.servlet.http.HttpServletResponse response)
getCssHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object getImageHandler(String name, javax.servlet.http.HttpServletResponse response)
getImageHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object getFontHandler(String fontName, javax.servlet.http.HttpServletResponse response)
getFontHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object getHtmlRecoucesHandler(String filePath, javax.servlet.http.HttpServletResponse response)
getHtmlRecoucesHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
@Deprecated public void getFileHandler(String path, javax.servlet.http.HttpServletResponse response) throws Exception
getFileHandler(String, boolean, HttpServletResponse)
path
- path to file to be downloadedresponse
- HTTP servlet response
Exception
- file not foundpublic Object getFileHandler(String path, boolean getPdf, javax.servlet.http.HttpServletResponse response)
getFileHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object getDocumentPageImageHandler(String guid, Integer width, Integer quality, Boolean usePdf, Integer pageIndex, javax.servlet.http.HttpServletResponse response)
getDocumentPageImageHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object viewDocumentHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
viewDocumentHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object viewDocumentHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
viewDocumentHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object loadFileBrowserTreeDataHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
loadFileBrowserTreeDataHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object loadFileBrowserTreeDataHandler(String callback, String data, javax.servlet.http.HttpServletResponse response)
loadFileBrowserTreeDataHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object getPdf2JavaScriptHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
getPdf2JavaScriptHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object getPdf2JavaScriptHandler(String callback, String data, javax.servlet.http.HttpServletResponse response)
getPdf2JavaScriptHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
getPrintableHtmlHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object getPrintableHtmlHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
getPrintableHtmlHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
getDocumentPageHtmlHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object getImageUrlsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
getImageUrlsHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object getImageUrlsHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
getImageUrlsHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object listAnnotationsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
GroupDocsAnnotation
listAnnotationsHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object exportAnnotationsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
GroupDocsAnnotation
exportAnnotationsHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object getPdfVersionOfDocumentHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
GroupDocsAnnotation
getPdfVersionOfDocumentHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object createAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
GroupDocsAnnotation
createAnnotationHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object getAvatarHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String userId)
GroupDocsAnnotation
getAvatarHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet responseuserId
- user id
public Object addAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
GroupDocsAnnotation
addAnnotationReplyHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object editAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
GroupDocsAnnotation
editAnnotationReplyHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object deleteAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
GroupDocsAnnotation
deleteAnnotationReplyHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object deleteAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
GroupDocsAnnotation
deleteAnnotationHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object saveTextFieldHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
GroupDocsAnnotation
saveTextFieldHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object setTextFieldColorHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
GroupDocsAnnotation
setTextFieldColorHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object moveAnnotationMarkerHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
GroupDocsAnnotation
moveAnnotationMarkerHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object resizeAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
GroupDocsAnnotation
resizeAnnotationHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object getDocumentCollaboratorsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
GroupDocsAnnotation
getDocumentCollaboratorsHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet response
public com.groupdocs.viewer.config.ServiceConfiguration getConfiguration()
public String addCollaborator(String userName, String fileGuid, AccessRights accessRights, int color)
userName
- collaborator user namefileGuid
- document guidaccessRights
- access rightscolor
- color to collaborator
public String addCollaborator(String userName, String fileGuid, Integer accessRights, int color)
userName
- collaborator user namefileGuid
- document guidaccessRights
- access rightscolor
- color to collaborator
public Object uploadFileHandler(String userId, String fld, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
GroupDocsAnnotation
uploadFileHandler
in class GroupDocsAnnotation
userId
- user idfld
- actionrequest
- HTTP servlet requestresponse
- HTTP servlet response
Exception
@Deprecated public Object uploadFileHandler(String userGuid, String fld, String uploadFileName, InputStream uploadInputStream, int timeToLive, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
public Object uploadFileHandler(String userGuid, String uploadFileName, InputStream uploadInputStream, boolean callImport)
userGuid
- user iduploadFileName
- name of uploaded fileuploadInputStream
- stream of uploaded filecallImport
- use import annotation flag
public Object importAnnotationsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
GroupDocsAnnotation
importAnnotationsHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object getPrintViewHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
GroupDocsAnnotation
getPrintViewHandler
in class GroupDocsAnnotation
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object getPdfWithPrintDialog(String path, javax.servlet.http.HttpServletResponse response)
getPdfWithPrintDialog
in class com.groupdocs.viewer.resources.GroupDocsViewer
public Object reorderPageHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
reorderPageHandler
in class com.groupdocs.viewer.resources.GroupDocsViewer
public void onAtmosphereReady(org.atmosphere.cpr.AtmosphereResource resource)
GroupDocsAnnotation
onAtmosphereReady
in class GroupDocsAnnotation
resource
- resource data received from socketpublic void onAtmosphereMessage(org.atmosphere.cpr.AtmosphereResource resource)
GroupDocsAnnotation
onAtmosphereMessage
in class GroupDocsAnnotation
resource
- resource data received from socketpublic boolean sendMessage(Object message)
message
- string or class (will be serialized to json)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |