Package com.levigo.jadice.server.msoffice

Class MSExcelNode

  • public class MSExcelNode
extends Node
    This Node uses Microsoft Office Excel to convert an excel worksheet with a virtual printer or by native file export (only MS Office 2007 and above).

    For further configuration details, have a look at the file server-config/ms-office/export-configuration.xml

    • Constructor Detail

      • MSExcelNode

        public MSExcelNode()

    • Method Detail

      • getWorkerClassName

        public String getWorkerClassName()
        Description copied from class: Node
        Return the node's associated com.levigo.jadice.server.core.NodeWorker full qualified class's name. By default, the worker class name is
        • The same as the node name with the trailing "Node" replaced by "Worker" if the node name ends in "Node"
        • The node class name with an appended "Worker" otherwise.
        The package name of the worker class is the name of the Node's package with an appended ".worker".

        This behavior can be overridden in concrete subclasses.

        Overrides:
        getWorkerClassName in class Node
        Returns:
        the full qualified class name of the worker of this node.

      • getPassword

        public String getPassword()
        Returns:
        current document password.

      • setPassword

        public void setPassword​(String password)
        Set document password
        Parameters:
        password - the document password

      • getTargetMimeType

        public String getTargetMimeType()

      • setTargetMimeType

        public void setTargetMimeType​(String targetMimeType)
        Set the target MIME type.
        Default value: application/pdf
        Parameters:
        targetMimeType - the targetMimeType to set

      • setFilename

        public void setFilename​(String filename)
        Set the fallback filename. This value will be used to generate a temporary file when no filename is provided in the StreamDescriptor.

        Default value: worksheet.xls

        Parameters:
        filename - fallback filename

      • getFilename

        public String getFilename()

      • setExportRange

        public void setExportRange​(PageRange exportRange)
        Set the range of pages to export/convert. It must be ensured on client side that this range of pages is valid, else an error might occur and the job might fail.
        Parameters:
        exportRange - range of pages (default: PageRange.ALL_PAGES)
        Since:
        jadice server 4.3.1.1

      • getExportRange

        public PageRange getExportRange()

      • getReplacementPageStyleSheetLocation

        public String getReplacementPageStyleSheetLocation()

      • setReplacementPageStyleSheetLocation

        public void setReplacementPageStyleSheetLocation​(String replacementPageStyleSheetLocation)
        Set the replacement style sheet location on the server side. E.g. "resource:/ms-office/emptyExcelReplacementStylesheet.xsl"
        Parameters:
        replacementPageStyleSheetLocation - the replacement style sheet location on the server side.
        Since:
        jadice server 5.7.2.0

      • setEmptyWorkbookHandlingMode

        public void setEmptyWorkbookHandlingMode​(MSExcelNode.EmptyWorkbookHandlingMode emptyWorkbookHandlingMode)
        Set the empty workbook handling mode for conversions.
        Parameters:
        emptyWorkbookHandlingMode - the empty workbook handling mode.