com.groupdocs.viewer.resources
Class GroupDocsViewer

java.lang.Object
  extended by com.groupdocs.viewer.resources.GroupDocsViewer
Direct Known Subclasses:
ViewerHandler

public abstract class GroupDocsViewer
extends Object

Provides required methods for Viewer integration

Author:
Alex Bobkov

Constructor Summary
GroupDocsViewer()
           
 
Method Summary
abstract  Object getCssHandler(String cssName, javax.servlet.http.HttpServletResponse response)
          Get CSS scripts
This method is used to get CSS scripts that are required to construct Viewer's UI
abstract  Object getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get HTML page [POST request]
abstract  Object getDocumentPageImageHandler(String guid, Integer width, Integer quality, Boolean usePdf, Integer pageIndex, javax.servlet.http.HttpServletResponse response)
          Get image file [GET request]
abstract  Object getFileHandler(String path, boolean getPdf, javax.servlet.http.HttpServletResponse response)
          Download file [GET request]
abstract  Object getFontHandler(String fontName, javax.servlet.http.HttpServletResponse response)
          Get fonts
This method is used to get font that are required to generate documents
abstract  Object getHtmlRecoucesHandler(String filePath, javax.servlet.http.HttpServletResponse response)
          Get HTML resources [GET request]
abstract  Object getImageHandler(String imageName, javax.servlet.http.HttpServletResponse response)
          Get images
This method is used to get images that are required to construct Viewer's UI
abstract  Object getImageUrlsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get thumbs and other images files [POST request]
abstract  Object getImageUrlsHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get thumbs and other images files [GET request]
abstract  Object getJsHandler(String scriptName, javax.servlet.http.HttpServletResponse response)
          Get JavaScript scripts
This method is used to get JavaScripts that are required to construct Viewer's UI
abstract  Object getPdf2JavaScriptHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. since version 2.3.0 Converts document to PDF and then to JavaScript for text search and selection [POST request]
abstract  Object getPdf2JavaScriptHandler(String callback, String data, javax.servlet.http.HttpServletResponse response)
          Deprecated. since version 2.3.0 Converts document to PDF and then to JavaScript for text search and selection [GET request]
abstract  Object getPdfWithPrintDialog(String path, javax.servlet.http.HttpServletResponse response)
          Get PDF print dialog [GET request]
abstract  Object getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Print document [POST request]
abstract  Object getPrintableHtmlHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Print document [GET request]
abstract  Object loadFileBrowserTreeDataHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Load tree of files from base directory [POST request]
abstract  Object loadFileBrowserTreeDataHandler(String callback, String data, javax.servlet.http.HttpServletResponse response)
          Load tree of files from base directory [GET request]
abstract  Object reorderPageHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Reorder Page [POST request]
abstract  Object viewDocumentHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Generate list of images/pages [POST request]
abstract  Object viewDocumentHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Generate list of images/pages [GET request]
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroupDocsViewer

public GroupDocsViewer()
Method Detail

getJsHandler

public abstract Object getJsHandler(String scriptName,
                                    javax.servlet.http.HttpServletResponse response)
Get JavaScript scripts
This method is used to get JavaScripts that are required to construct Viewer's UI

Parameters:
scriptName - Script name or/and path (ex: libs/jquery.js)
response - HTTP servlet response
Returns:

getCssHandler

public abstract Object getCssHandler(String cssName,
                                     javax.servlet.http.HttpServletResponse response)
Get CSS scripts
This method is used to get CSS scripts that are required to construct Viewer's UI

Parameters:
cssName - Script name or/and path (ex: libs/custom.css)
response - HTTP servlet response
Returns:

getImageHandler

public abstract Object getImageHandler(String imageName,
                                       javax.servlet.http.HttpServletResponse response)
Get images
This method is used to get images that are required to construct Viewer's UI

Parameters:
imageName - Image name
response - HTTP servlet response
Returns:

getFontHandler

public abstract Object getFontHandler(String fontName,
                                      javax.servlet.http.HttpServletResponse response)
Get fonts
This method is used to get font that are required to generate documents

Parameters:
fontName - font name
response - HTTP servlet response
Returns:

getHtmlRecoucesHandler

public abstract Object getHtmlRecoucesHandler(String filePath,
                                              javax.servlet.http.HttpServletResponse response)
Get HTML resources [GET request]

Parameters:
filePath - path to resource file
response - HTTP servlet response
Returns:

getFileHandler

public abstract Object getFileHandler(String path,
                                      boolean getPdf,
                                      javax.servlet.http.HttpServletResponse response)
Download file [GET request]

Parameters:
path - Path to file to be downloaded
getPdf - flag to set if file will be downloaded as PDF or original
response - HTTP servlet response
Returns:

getDocumentPageImageHandler

public abstract Object getDocumentPageImageHandler(String guid,
                                                   Integer width,
                                                   Integer quality,
                                                   Boolean usePdf,
                                                   Integer pageIndex,
                                                   javax.servlet.http.HttpServletResponse response)
Get image file [GET request]

Parameters:
guid - Relative path to file from base path directory (ex: folder/example.doc or example.doc)
width - Generated images with
quality - Generated images quality
usePdf - Use PDF flag
pageIndex - Page number
response - HTTP servlet response
Returns:

viewDocumentHandler

public abstract Object viewDocumentHandler(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)
Generate list of images/pages [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
Document as json object

viewDocumentHandler

public abstract Object viewDocumentHandler(String callback,
                                           String data,
                                           javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)
Generate list of images/pages [GET request]

Parameters:
callback - Callback value
data - Data as json object
request - HTTP servlet request
response - HTTP servlet response
Returns:
Document as json object

loadFileBrowserTreeDataHandler

public abstract Object loadFileBrowserTreeDataHandler(javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
Load tree of files from base directory [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
File list as json object

loadFileBrowserTreeDataHandler

public abstract Object loadFileBrowserTreeDataHandler(String callback,
                                                      String data,
                                                      javax.servlet.http.HttpServletResponse response)
Load tree of files from base directory [GET request]

Parameters:
callback - Callback value
data - Data as json object
response - HTTP servlet response
Returns:
File list as json object

getImageUrlsHandler

public abstract Object getImageUrlsHandler(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)
Get thumbs and other images files [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
Image thumbnail data as json object

getImageUrlsHandler

public abstract Object getImageUrlsHandler(String callback,
                                           String data,
                                           javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)
Get thumbs and other images files [GET request]

Parameters:
callback - Callback value
data - Data as json object
request - HTTP servlet request
response - HTTP servlet response
Returns:
Image thumbnail data as json object

getPdf2JavaScriptHandler

@Deprecated
public abstract Object getPdf2JavaScriptHandler(javax.servlet.http.HttpServletRequest request,
                                                           javax.servlet.http.HttpServletResponse response)
Deprecated. since version 2.3.0 Converts document to PDF and then to JavaScript for text search and selection [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
JavaScript data as json object

getPdf2JavaScriptHandler

@Deprecated
public abstract Object getPdf2JavaScriptHandler(String callback,
                                                           String data,
                                                           javax.servlet.http.HttpServletResponse response)
Deprecated. since version 2.3.0 Converts document to PDF and then to JavaScript for text search and selection [GET request]

Parameters:
callback - Callback value
data - Data as json object
response - HTTP servlet response
Returns:
JavaScript data as json object

getPrintableHtmlHandler

public abstract Object getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response)
Print document [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
HTML page for printing

getPrintableHtmlHandler

public abstract Object getPrintableHtmlHandler(String callback,
                                               String data,
                                               javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response)
Print document [GET request]

Parameters:
callback - Callback value
data - Data as json object
request - HTTP servlet request
response - HTTP servlet response
Returns:
HTML page for printing

getDocumentPageHtmlHandler

public abstract Object getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request,
                                                  javax.servlet.http.HttpServletResponse response)
Get HTML page [POST request]

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

getPdfWithPrintDialog

public abstract Object getPdfWithPrintDialog(String path,
                                             javax.servlet.http.HttpServletResponse response)
Get PDF print dialog [GET request]

Parameters:
path - path to file
response - HTTP servlet response
Returns:

reorderPageHandler

public abstract Object reorderPageHandler(javax.servlet.http.HttpServletRequest request,
                                          javax.servlet.http.HttpServletResponse response)
Reorder Page [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
json object with success flag as true or false


Copyright © 2014. All rights reserved.