com.groupdocs.viewer.resources
Interface IGroupDocsViewer

All Known Implementing Classes:
ViewerHandler

public interface IGroupDocsViewer

Basic interface to support Viewer Handler
This interface doesn't support IE
For IE support please

Author:
Alex Bobkov
See Also:
IGroupDocsViewerIE

Method Summary
 Object getCssHandler(String cssName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get CSS scripts
This method is used to get CSS scripts that are required to construct Viewer's UI
 Object getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get HTML page [POST request]
 Object getDocumentPageImageHandler(String guid, Integer width, Integer quality, Boolean usePdf, Integer pageIndex, Boolean isPrint, javax.servlet.http.HttpServletResponse response)
          Get image file [GET request]
 Object getFileHandler(String path, boolean getPdf, javax.servlet.http.HttpServletResponse response)
          Download file [GET request]
 Object getFontHandler(String fontName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get fonts
This method is used to get font that are required to generate documents
 Object getHtmlResourcesHandler(String filePath, String guid, Integer page, String resourceName, javax.servlet.http.HttpServletResponse response)
          Get HTML resources [GET request]
 Object getImageHandler(String imageName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get images
This method is used to get images that are required to construct Viewer's UI
 Object getImageUrlsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get thumbs and other images files [POST request]
 Object getJsHandler(String scriptName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get JavaScript scripts
This method is used to get JavaScripts that are required to construct Viewer's UI
 void getPdfWithPrintDialog(String path, javax.servlet.http.HttpServletResponse response)
          Get PDF print dialog [GET request]
 Object getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Print document [POST request]
 Object loadFileBrowserTreeDataHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Load tree of files from base directory [POST request]
 Object reorderPageHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Reorder Page [POST request]
 Object rotatePageHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Rotate Page [POST request]
 Object viewDocumentHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Generate list of images/pages [POST request]
 

Method Detail

getJsHandler

Object getJsHandler(String scriptName,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
                    throws Exception
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)
request - HTTP servlet request
response - HTTP servlet response
Returns:
inputStream as object
Throws:
Exception

getCssHandler

Object getCssHandler(String cssName,
                     javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
                     throws Exception
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)
request - HTTP servlet request
response - HTTP servlet response
Returns:
inputStream as object
Throws:
Exception

getImageHandler

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

Parameters:
imageName - Image name
request - HTTP servlet request
response - HTTP servlet response
Returns:
inputStream as object
Throws:
Exception

getFontHandler

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

Parameters:
fontName - font name
request - HTTP servlet request
response - HTTP servlet response
Returns:
inputStream as object
Throws:
Exception

getHtmlResourcesHandler

Object getHtmlResourcesHandler(String filePath,
                               String guid,
                               Integer page,
                               String resourceName,
                               javax.servlet.http.HttpServletResponse response)
                               throws Exception
Get HTML resources [GET request]

Parameters:
filePath - path to resource file
guid - document guid/id
page - page number
resourceName - resource name
response - HTTP servlet response
Returns:
HTML resources input stream as object
resources: images, fonts, etc
Throws:
Exception

getFileHandler

Object getFileHandler(String path,
                      boolean getPdf,
                      javax.servlet.http.HttpServletResponse response)
                      throws Exception
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:
inputStream as object
Throws:
Exception

getDocumentPageImageHandler

Object getDocumentPageImageHandler(String guid,
                                   Integer width,
                                   Integer quality,
                                   Boolean usePdf,
                                   Integer pageIndex,
                                   Boolean isPrint,
                                   javax.servlet.http.HttpServletResponse response)
                                   throws Exception
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
isPrint -
response - HTTP servlet response
Returns:
input stream as object
Throws:
Exception

viewDocumentHandler

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

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

loadFileBrowserTreeDataHandler

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

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

getImageUrlsHandler

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

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

getPrintableHtmlHandler

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

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

getDocumentPageHtmlHandler

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
input stream html page as object
Throws:
Exception

getPdfWithPrintDialog

void getPdfWithPrintDialog(String path,
                           javax.servlet.http.HttpServletResponse response)
                           throws Exception
Get PDF print dialog [GET request]

Parameters:
path - path to file
response - HTTP servlet response
Throws:
Exception

reorderPageHandler

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

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

rotatePageHandler

Object rotatePageHandler(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                         throws Exception
Rotate Page [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
json object with success flag and rotation angle
Throws:
Exception


Copyright © 2015. All rights reserved.