|
||||||||||
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.viewer.handlers.etc.ViewerHandlerBase
com.groupdocs.viewer.handlers.ViewerHandler
public class ViewerHandler
Provides all data actions with Viewer object
GroupDocsViewer
Field Summary |
---|
Fields inherited from class com.groupdocs.viewer.handlers.etc.ViewerHandlerBase |
---|
config, DEFAULT_CHARSET, DOCUMENT_PAGE_IMAGE_HANDLER_HTML_URL, DOCUMENT_PAGE_IMAGE_HANDLER_IMG_URL, ERROR_MESSAGE_TEMPLATE, FILE_HANDLER_URL, generateProgress, pattern, PDF_WITH_PRINT_DIALOG_URL, PRINTABLE_HTML_TEMPLATE, PRINTABLE_PAGE_TEMPLATE, STRING_EMPTY, STRING_FILE, STRING_FOLDER, viewAccessManager |
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 | |
---|---|
ViewerHandler(ServiceConfiguration config)
Viewer constructor |
|
ViewerHandler(ServiceConfiguration config,
InputDataHandler inputDataHandler)
Viewer constructor |
Method Summary | |
---|---|
void |
generateCache(String guid,
String width,
Integer quality,
Boolean usePdf,
javax.servlet.http.HttpServletResponse response)
Generate cache in the background |
String |
getCacheGenerationProgress(String guid,
javax.servlet.http.HttpServletRequest request)
Get cache generation progress |
ServiceConfiguration |
getConfiguration()
Get service configuration |
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 |
Object |
getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Get HTML page [POST request] |
Object |
getDocumentPageImageHandler(String path,
Integer width,
Integer quality,
Boolean usePdf,
Integer pageIndex,
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.HttpServletResponse response)
Get fonts This method is used to get font that are required to generate documents |
String |
getHeader()
Get HTML header |
Object |
getHtmlRecoucesHandler(String filePath,
javax.servlet.http.HttpServletResponse response)
Get HTML resources [GET request] |
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 |
Object |
getImageUrls(Image image)
Get thumbs and other images files |
Object |
getImageUrlsHandler(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Get thumbs and other images files [POST request] |
Object |
getImageUrlsHandler(String callback,
String data,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Get thumbs and other images files [GET request] |
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 |
String |
getLocale()
Get locale |
String |
getPdf2JavaScriptHandler(String guid,
int pageCount)
Get text from file as json |
Object |
getPdfWithPrintDialog(String path,
javax.servlet.http.HttpServletResponse response)
Get PDF print dialog [GET request] |
String |
getPrintableHtml(PrintDocument doc)
Get HTML print document |
String |
getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Print document [POST request] |
String |
getPrintableHtmlHandler(PrintDocument doc,
String mediaType,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Get printable html from specific file type |
String |
getPrintableHtmlHandler(String callback,
String data,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Print document [GET request] |
String |
getViewerScript(String viewerId,
String filePath,
String locale)
Get Viewer Script |
Object |
loadFileBrowserTreeData(FileBrowserTreeData treeData)
Load tree of files from base directory |
Object |
loadFileBrowserTreeDataHandler(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Load tree of files from base directory [POST request] |
Object |
loadFileBrowserTreeDataHandler(String callback,
String data,
javax.servlet.http.HttpServletResponse response)
Load tree of files from base directory [GET request] |
Object |
renewTokenId(String tokenId)
Renew expired token |
Object |
reorderPageHandler(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Reorder Page [POST request] |
Object |
uploadFile(File file,
Integer timeToLive)
Upload file |
Object |
uploadFile(InputStream inputStream,
String fileName,
Integer timeToLive)
Upload file |
Object |
uploadFile(String filePath,
Integer timeToLive)
Upload file |
Object |
viewDocument(ViewDocument viewDocument)
Generate list of images/pages |
Object |
viewDocumentHandler(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Generate list of images/pages [POST request] |
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 com.groupdocs.viewer.handlers.etc.ViewerHandlerBase |
---|
closeStream, formatWidth, generateImage, generateImages, getBody, getDownloadStream, getErrorMessage, getImageUrl, getLicenseStream, getObjectData, initDirectoryCheck, objectToJson, preLoadFiles, setBrowserCache, setLicense, setResponseContentType, useCache |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ViewerHandler(ServiceConfiguration config) throws Exception
config
- Configuration files with required data to create viewer instance
Exception
- Invalid licensepublic ViewerHandler(ServiceConfiguration config, InputDataHandler inputDataHandler) throws Exception
config
- Configuration files with required data to create viewer instanceinputDataHandler
- Data handler to read from different location or data source (default local disk)
Exception
- Invalid licenseMethod Detail |
---|
public ServiceConfiguration getConfiguration()
public String getHeader() throws IOException
IOException
public String getViewerScript(String viewerId, String filePath, String locale) throws IOException
viewerId
- viewer id used in htmlfilePath
- path to default filelocale
- locale
IOException
public String getLocale()
public Object uploadFile(String filePath, Integer timeToLive)
filePath
- path to filetimeToLive
- expiration date for file upload in minutes public Object uploadFile(File file, Integer timeToLive)
file
- filetimeToLive
- expiration date for file upload in minutes public Object uploadFile(InputStream inputStream, String fileName, Integer timeToLive)
inputStream
- input streamfileName
- file nametimeToLive
- expiration date for file upload in minutes public Object renewTokenId(String tokenId)
tokenId
- expired token id
public String getPdf2JavaScriptHandler(String guid, int pageCount) throws Exception
guid
- file guidpageCount
-
Exception
public void generateCache(String guid, String width, Integer quality, Boolean usePdf, javax.servlet.http.HttpServletResponse response) throws Exception
guid
- file guidwidth
- output file widthquality
- output file qualityusePdf
- use pdf flagresponse
- HTTP servlet respose
Exception
public String getCacheGenerationProgress(String guid, javax.servlet.http.HttpServletRequest request) throws Exception
guid
- file guidrequest
- HTTP servlet request
Exception
public Object getJsHandler(String scriptName, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewerBasic
scriptName
- Script name or/and path (ex: libs/jquery.js)response
- HTTP servlet response
public Object getCssHandler(String cssName, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewerBasic
cssName
- Script name or/and path (ex: libs/custom.css)response
- HTTP servlet response
public Object getImageHandler(String imageName, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewerBasic
imageName
- Image nameresponse
- HTTP servlet response
public Object getFontHandler(String fontName, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewerBasic
fontName
- font nameresponse
- HTTP servlet response
public Object getHtmlRecoucesHandler(String filePath, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewerBasic
filePath
- path to resource fileresponse
- HTTP servlet response
public Object getFileHandler(String path, boolean getPdf, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewerBasic
path
- Path to file to be downloadedgetPdf
- flag to set if file will be downloaded as PDF or originalresponse
- HTTP servlet response
public Object getDocumentPageImageHandler(String path, Integer width, Integer quality, Boolean usePdf, Integer pageIndex, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewerBasic
path
- Relative path to file from base path directory (ex: folder/example.doc or example.doc)width
- Generated images withquality
- Generated images qualityusePdf
- Use PDF flagpageIndex
- Page numberresponse
- HTTP servlet response
public Object viewDocumentHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewerBasic
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object viewDocumentHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewer
callback
- Callback valuedata
- Data as json objectrequest
- HTTP servlet requestresponse
- HTTP servlet response
public Object viewDocument(ViewDocument viewDocument) throws Exception
com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
viewDocument
- request object
Exception
public Object loadFileBrowserTreeDataHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewerBasic
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object loadFileBrowserTreeDataHandler(String callback, String data, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewer
callback
- Callback valuedata
- Data as json objectresponse
- HTTP servlet response
public Object loadFileBrowserTreeData(FileBrowserTreeData treeData) throws Exception
com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Exception
public Object getImageUrlsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewerBasic
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object getImageUrlsHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewer
callback
- Callback valuedata
- Data as json objectrequest
- HTTP servlet requestresponse
- HTTP servlet response
public Object getImageUrls(Image image) throws IOException
com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
IOException
public String getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewerBasic
request
- HTTP servlet requestresponse
- HTTP servlet response
public String getPrintableHtmlHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewer
callback
- Callback valuedata
- Data as json objectrequest
- HTTP servlet requestresponse
- HTTP servlet response
public String getPrintableHtmlHandler(PrintDocument doc, String mediaType, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
doc
- document objectmediaType
- media typerequest
- HTTP servlet requestresponse
- HTTP servlet response
public String getPrintableHtml(PrintDocument doc) throws Exception
com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Exception
public Object getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewerBasic
request
- HTTP servlet requestresponse
- HTTP servlet response
public Object getPdfWithPrintDialog(String path, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewerBasic
path
- path to fileresponse
- HTTP servlet response
public Object reorderPageHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
com.groupdocs.viewer.resources.IGroupDocsViewerBasic
request
- HTTP servlet requestresponse
- HTTP servlet response
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |