com.groupdocs.viewer.domain.cache

Class CachedPageDescription


  • public class CachedPageDescription
extends CacheFileDescription

    Class that describes cached document page.

    • Constructor Detail

      • CachedPageDescription

        public CachedPageDescription(String guid)

        Initializes a new instance of the CachedPageDescription class.

        Parameters:
        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.txt

      • CachedPageDescription

        public CachedPageDescription(String guid,
                     String name)

        Initializes a new instance of the CachedPageDescription class.

        Parameters:
        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.txt
        name - File name with extension

    • Method Detail

      • getArchiveOptions

        public ArchiveOptions getArchiveOptions()

        Gets or sets the Archive file rendering options.

        Parameters:
        value - The Archive file options.

      • getCadOptions

        public CadOptions getCadOptions()

        The CAD documents rendering options.

        Returns:
        The CAD documents rendering options.

      • getCellsOptions

        public CellsOptions getCellsOptions()

        The Spreadsheet documents rendering options.

        Returns:
        The Spreadsheet documents rendering options.

      • getEmailOptions

        public EmailOptions getEmailOptions()

        The Email documents rendering options.

        Returns:
        The Email documents rendering options.

      • getExtractText

        public boolean getExtractText()

        Indicates whether the document text has been extracted.

        Returns:
        true if text extracted; otherwise, false.

      • getHeight

        public int getHeight()

        The page height.

        Returns:
        The page height.

      • getJpegQuality

        public int getJpegQuality()

        The JPEG quality.

        Returns:
        The JPEG quality.

      • getOutlookOptions

        public OutlookOptions getOutlookOptions()

        Gets or sets the Outlook Data File document rendering options.

        Returns:
        The Outlook Data File options.

      • getOutputExtension

        public String getOutputExtension()

        The extension of the cached file.

        Returns:
        The output extension.

      • getPageNumber

        public int getPageNumber()

        The page number.

        Returns:
        The page number.

      • getPdfOptions

        public PdfOptions getPdfOptions()

        The PDF documents rendering options.

        Returns:
        The PDF documents rendering options.

      • getProjectOptions

        public ProjectOptions getProjectOptions()

        Gets or sets the Project document rendering options.

        Returns:
        The Project options.

      • getSlidesOptions

        public SlidesOptions getSlidesOptions()

        The Presentation documents rendering options.

        Returns:
        The Presentation documents rendering options.

      • getWidth

        public int getWidth()

        The page width.

        Returns:
        The page width.

      • getWordsOptions

        public WordsOptions getWordsOptions()

        The Text documents rendering options.

        Returns:
        The Text documents rendering options.

      • setArchiveOptions

        public void setArchiveOptions(ArchiveOptions value)

        Gets or sets the Archive file rendering options.

        Parameters:
        value - The Archive file options.

      • setCadOptions

        public void setCadOptions(CadOptions value)

        The CAD documents rendering options.

        Parameters:
        value - The CAD documents rendering options.

      • setCellsOptions

        public void setCellsOptions(CellsOptions value)

        The Spreadsheet documents rendering options.

        Parameters:
        value - The Spreadsheet documents rendering options.

      • setEmailOptions

        public void setEmailOptions(EmailOptions value)

        The Email documents rendering options.

        Parameters:
        value - The Email documents rendering options.

      • setExtractText

        public void setExtractText(boolean value)

        Indicates whether the document text has been extracted.

        Parameters:
        value - true if text extracted; otherwise, false.

      • setHeight

        public void setHeight(int value)

        The page height.

        Parameters:
        value - The page height.

      • setJpegQuality

        public void setJpegQuality(int value)

        The JPEG quality.

        Parameters:
        value - The JPEG quality.

      • setOutlookOptions

        public void setOutlookOptions(OutlookOptions value)

        Gets or sets the Outlook Data File document rendering options.

        Parameters:
        value - The Outlook Data File options.

      • setOutputExtension

        public void setOutputExtension(String value)

        The extension of the cached file.

        Parameters:
        value - The output extension.

      • setPageNumber

        public void setPageNumber(int value)

        The page number.

        Parameters:
        value - The page number.

      • setPdfOptions

        public void setPdfOptions(PdfOptions value)

        The PDF documents rendering options.

        Parameters:
        value - The PDF documents rendering options.

      • setProjectOptions

        public void setProjectOptions(ProjectOptions value)

        Gets or sets the Project document rendering options.

        Parameters:
        value - The Project options.

      • setSlidesOptions

        public void setSlidesOptions(SlidesOptions value)

        The Presentation documents rendering options.

        Parameters:
        value - The Presentation documents rendering options.

      • setWidth

        public void setWidth(int value)

        The page width.

        Parameters:
        value - The page width.

      • setWordsOptions

        public void setWordsOptions(WordsOptions value)

        The Text documents rendering options.

        Parameters:
        value - The Text documents rendering options.