public class ViewerHtmlHandler extends ViewerHandler<PageHtml>
Handler for rendering document as HTML.
Constructor and Description |
---|
ViewerHtmlHandler()
Initializes a new instance of the
ViewerHtmlHandler class. |
ViewerHtmlHandler(ViewerConfig viewerConfig)
Initializes a new instance of the
ViewerHtmlHandler class. |
ViewerHtmlHandler(ViewerConfig viewerConfig,
com.groupdocs.foundation.utils.CultureInfo cultureInfo)
Initializes a new instance of the
ViewerHtmlHandler class. |
ViewerHtmlHandler(ViewerConfig viewerConfig,
IInputDataHandler inputDataHandler)
Initializes a new instance of the
ViewerHtmlHandler class. |
ViewerHtmlHandler(ViewerConfig viewerConfig,
IInputDataHandler inputDataHandler,
com.groupdocs.foundation.utils.CultureInfo cultureInfo)
Initializes a new instance of the
ViewerHtmlHandler class. |
ViewerHtmlHandler(ViewerConfig viewerConfig,
IInputDataHandler inputDataHandler,
ICacheDataHandler cacheDataHandler)
Initializes a new instance of the
ViewerHtmlHandler class. |
ViewerHtmlHandler(ViewerConfig viewerConfig,
IInputDataHandler inputDataHandler,
ICacheDataHandler cacheDataHandler,
com.groupdocs.foundation.utils.CultureInfo cultureInfo)
Initializes a new instance of the
ViewerHtmlHandler class. |
ViewerHtmlHandler(ViewerConfig viewerConfig,
IInputDataHandler inputDataHandler,
ICacheDataHandler cacheDataHandler,
IFileDataStore fileDataStore)
Initializes a new instance of the
ViewerHtmlHandler class. |
ViewerHtmlHandler(ViewerConfig viewerConfig,
IInputDataHandler inputDataHandler,
ICacheDataHandler cacheDataHandler,
IFileDataStore fileDataStore,
com.groupdocs.foundation.utils.CultureInfo cultureInfo)
Initializes a new instance of the
ViewerHtmlHandler class. |
Modifier and Type | Method and Description |
---|---|
void |
clearTempFiles()
Clears temporary files created during rendering.
|
List<PageHtml> |
getPages(AttachmentBase attachment)
Get list of pages HTML representations for attachment.
|
List<PageHtml> |
getPages(AttachmentBase attachment,
HtmlOptions htmlOptions)
Get list of pages HTML representations for attachment.
|
List<PageHtml> |
getPages(InputStream fileStream)
Get list of pages HTML representations.
|
List<PageHtml> |
getPages(InputStream fileStream,
HtmlOptions htmlOptions)
Get list of pages HTML representations.
|
List<PageHtml> |
getPages(InputStream fileStream,
String fileName)
Get list of pages HTML representations.
|
List<PageHtml> |
getPages(InputStream fileStream,
String fileName,
HtmlOptions htmlOptions)
Get list of pages HTML representations.
|
List<PageHtml> |
getPages(String guid)
Get list of pages HTML representations
|
List<PageHtml> |
getPages(String guid,
HtmlOptions htmlOptions)
Get list of pages HTML representations.
|
List<PageHtml> |
getPages(URI uri)
Get list of pages HTML representations.
|
List<PageHtml> |
getPages(URI uri,
HtmlOptions htmlOptions)
Get list of pages HTML representations.
|
List<PageHtml> |
getPages(URI uri,
WindowsAuthenticationCredential credential,
HtmlOptions htmlOptions)
Get list of pages HTML representations.
|
PrintableHtmlContainer |
getPrintableHtml(String guid)
Get document HTML for print.
|
PrintableHtmlContainer |
getPrintableHtml(String guid,
PrintableHtmlOptions printableHtmlOptions)
Get document HTML for print.
|
InputStream |
getResource(AttachmentBase attachment,
HtmlResource htmlResource)
Get html page resource stream.
|
InputStream |
getResource(String guid,
HtmlResource htmlResource)
Get HTML page resource.
|
com.groupdocs.viewer.helper.transformation.options.TransformationOptions |
getTransformationOptions(com.groupdocs.viewer.domain.options.ConvertOptions convertOptions) |
PageHtml |
getUnlicensedViewCountExceededPage(RenderOptions renderOptions) |
void |
performTransformations(List<PageHtml> pages,
com.groupdocs.viewer.helper.transformation.options.TransformationOptions transformationOptions) |
com.groupdocs.viewer.converter.Converter<PageHtml> |
resolveConverter(com.groupdocs.viewer.domain.options.ConvertOptions convertOptions) |
clearCache, clearCache, getCacheDataHandler, getDocumentInfo, getDocumentInfo, getDocumentInfo, getDocumentInfo, getDocumentInfo, getDocumentInfo, getDocumentInfo, getDocumentInfo, getDocumentInfo, getDocumentInfo, getFile, getFile, getFileList, getFileList, getInputDataHandler, getLocalizationHandler, getPages, getPages, getPages, getPages, getPages, getPages, getPdfFile, getPdfFile, getPdfFile, getPdfFile, getPdfFile, getPdfFile, getPdfFile, getPdfFile, getPdfFile, getSupportedDocumentFormats, getViewerConfig, reorderPage, rotatePage
public ViewerHtmlHandler()
Initializes a new instance of the ViewerHtmlHandler
class.
public ViewerHtmlHandler(ViewerConfig viewerConfig)
Initializes a new instance of the ViewerHtmlHandler
class.
viewerConfig
- The viewer configuration.public ViewerHtmlHandler(ViewerConfig viewerConfig, com.groupdocs.foundation.utils.CultureInfo cultureInfo)
Initializes a new instance of the ViewerHtmlHandler
class.
viewerConfig
- The viewer configuration.cultureInfo
- The viewer culture. Supported cultures are en-Us, pt-PT and ru-RU.public ViewerHtmlHandler(ViewerConfig viewerConfig, IInputDataHandler inputDataHandler)
Initializes a new instance of the ViewerHtmlHandler
class.
viewerConfig
- The viewer configuration.inputDataHandler
- The input data handler.public ViewerHtmlHandler(ViewerConfig viewerConfig, IInputDataHandler inputDataHandler, com.groupdocs.foundation.utils.CultureInfo cultureInfo)
Initializes a new instance of the ViewerHtmlHandler
class.
viewerConfig
- The viewer configuration.inputDataHandler
- The input data handler.cultureInfo
- The viewer culture. Supported cultures are en-Us, pt-PT and ru-RU.public ViewerHtmlHandler(ViewerConfig viewerConfig, IInputDataHandler inputDataHandler, ICacheDataHandler cacheDataHandler)
Initializes a new instance of the ViewerHtmlHandler
class.
viewerConfig
- The viewer configuration.inputDataHandler
- The input data handler.cacheDataHandler
- The cache data handler.public ViewerHtmlHandler(ViewerConfig viewerConfig, IInputDataHandler inputDataHandler, ICacheDataHandler cacheDataHandler, com.groupdocs.foundation.utils.CultureInfo cultureInfo)
Initializes a new instance of the ViewerHtmlHandler
class.
viewerConfig
- The viewer configuration.inputDataHandler
- The input data handler.cacheDataHandler
- The cache data handler.cultureInfo
- The viewer culture. Supported cultures are en-Us, pt-PT and ru-RU.public ViewerHtmlHandler(ViewerConfig viewerConfig, IInputDataHandler inputDataHandler, ICacheDataHandler cacheDataHandler, IFileDataStore fileDataStore)
Initializes a new instance of the ViewerHtmlHandler
class.
viewerConfig
- The viewer configuration.inputDataHandler
- The input data handler.cacheDataHandler
- The cache data handler.fileDataStore
- The file data store.public ViewerHtmlHandler(ViewerConfig viewerConfig, IInputDataHandler inputDataHandler, ICacheDataHandler cacheDataHandler, IFileDataStore fileDataStore, com.groupdocs.foundation.utils.CultureInfo cultureInfo)
Initializes a new instance of the ViewerHtmlHandler
class.
viewerConfig
- The viewer configuration.inputDataHandler
- The input data handler.cacheDataHandler
- The cache data handler.fileDataStore
- The file data store.cultureInfo
- The viewer culture. Supported cultures are en-Us, pt-PT and ru-RU.public List<PageHtml> getPages(String guid) throws Exception
Get list of pages HTML representations
The following example demonstrates how to get the list of pages.public List<PageHtml> getPages(String guid, HtmlOptions htmlOptions) throws Exception
Get list of pages HTML representations.
The following example demonstrates how to get HTML representations of the second page.guid
- a String
object.htmlOptions
- a HtmlOptions
object.Exception
- if any.public List<PageHtml> getPages(InputStream fileStream) throws Exception
Get list of pages HTML representations.
fileStream
- a InputStream
object.Exception
- if any.public List<PageHtml> getPages(InputStream fileStream, HtmlOptions htmlOptions) throws Exception
Get list of pages HTML representations.
fileStream
- a InputStream
object.htmlOptions
- a HtmlOptions
object.Exception
- if any.public List<PageHtml> getPages(InputStream fileStream, String fileName) throws Exception
Get list of pages HTML representations.
fileStream
- a InputStream
object.fileName
- a String
object.Exception
- if any.public List<PageHtml> getPages(InputStream fileStream, String fileName, HtmlOptions htmlOptions) throws Exception
Get list of pages HTML representations.
fileStream
- a InputStream
object.fileName
- a String
object.htmlOptions
- a HtmlOptions
object.Exception
- if any.public List<PageHtml> getPages(URI uri) throws Exception
Get list of pages HTML representations.
public List<PageHtml> getPages(URI uri, HtmlOptions htmlOptions) throws Exception
Get list of pages HTML representations.
uri
- a URI
object.htmlOptions
- a HtmlOptions
object.Exception
- if any.public List<PageHtml> getPages(URI uri, WindowsAuthenticationCredential credential, HtmlOptions htmlOptions) throws Exception
Get list of pages HTML representations.
uri
- a URI
object.credential
- a WindowsAuthenticationCredential
object.htmlOptions
- a HtmlOptions
object.Exception
- if any.public List<PageHtml> getPages(AttachmentBase attachment) throws Exception
Get list of pages HTML representations for attachment.
attachment
- a AttachmentBase
object.Exception
- if any.public List<PageHtml> getPages(AttachmentBase attachment, HtmlOptions htmlOptions) throws Exception
Get list of pages HTML representations for attachment.
attachment
- a AttachmentBase
object.htmlOptions
- a HtmlOptions
object.Exception
- if any.public InputStream getResource(String guid, HtmlResource htmlResource) throws Exception
Get HTML page resource.
guid
- a String
object.htmlResource
- a HtmlResource
object.InputStream
object.Exception
- if any.public InputStream getResource(AttachmentBase attachment, HtmlResource htmlResource) throws Exception
Get html page resource stream.
The following example demonstrates how to get resource stream of each HtmlResource in html representation pages of the document attachment.attachment
- The attachment descriptor.htmlResource
- The resource description.Exception
- if any.public PrintableHtmlContainer getPrintableHtml(String guid) throws Exception
Get document HTML for print.
Gets the printable HTML.
The following example demonstrates how to get printable HTML of the document.getPrintableHtml
in class ViewerHandler<PageHtml>
guid
- The file unique identifier, full path for local storage e.g. c:\\storage\\document.txt,
relative path e.g document.txt, url e.g. http://site.com/document.txtException
- if any.public PrintableHtmlContainer getPrintableHtml(String guid, PrintableHtmlOptions printableHtmlOptions) throws Exception
Get document HTML for print.
Gets the printable HTML.
getPrintableHtml
in class ViewerHandler<PageHtml>
guid
- The file unique identifier, full path for local storage e.g. c:\\storage\\document.txt,
relative path e.g document.txt, url e.g. http://site.com/document.txtprintableHtmlOptions
- The rotatePageOptions.Exception
- if any.public PageHtml getUnlicensedViewCountExceededPage(RenderOptions renderOptions)
getUnlicensedViewCountExceededPage
in class ViewerHandler<PageHtml>
public com.groupdocs.viewer.helper.transformation.options.TransformationOptions getTransformationOptions(com.groupdocs.viewer.domain.options.ConvertOptions convertOptions)
public void performTransformations(List<PageHtml> pages, com.groupdocs.viewer.helper.transformation.options.TransformationOptions transformationOptions)
public com.groupdocs.viewer.converter.Converter<PageHtml> resolveConverter(com.groupdocs.viewer.domain.options.ConvertOptions convertOptions)
public void clearTempFiles()
Clears temporary files created during rendering.
Copyright © 2018. All rights reserved.