OptionsCacheImpl (Outside In Java API Reference)

Used internally by the Outside In API and not to be used externally. OptionsCache is the interface that developers should use, and that class describes how to obtain a concrete object that implements the interface.

See Also:: OptionsCache

Nested Class Summary
`protected class`	`OptionsCacheImpl.SourceFileInfo` Used internally by the Outside In API, and not to be used externally.

Field Summary
`protected boolean`	`bNextFile`
`protected boolean`	`m_bDoOpenInput`
`protected OptionsCacheImpl.SourceFileInfo`	`m_cumulativeInfo`
`protected java.io.File`	`m_dstFile`
`protected FileFormat`	`m_dstFileId`
`protected SeekableByteChannel6ToBasicIO`	`m_dstRedirect`
`protected OptionsCacheImpl.SourceFileInfo`	`m_srcInfo`
`protected java.util.List<OptionsCacheImpl.SourceFileInfo>`	`m_srcInfoList`
`protected java.io.File`	`m_templatefile`

Constructor Summary
`protected`	`OptionsCacheImpl()`
`protected`	`OptionsCacheImpl(OptionsCacheImpl copy)`

Method Summary
`OptionsCache`	`addSourceFile(java.io.File file)` Sets the next source document when exporting multiple input documents to the same destination document.
`OptionsCache`	`addSourceFile(SeekableByteChannel6 redirect)` Sets an object that implements `SeekableByteChannel6` to be used as the next source document when exporting multiple input documents to the same destination document.
`OptionsCache`	`addSourceFile(SeekableByteChannel6 redirect, java.lang.String filename)` Sets an object that implements `SeekableByteChannel6` to be used as the next source document when exporting multiple input documents to the same destination document and provides information about the filename.
`boolean`	`getAcceptAlternateGraphics()` Gets the AcceptAlternateGraphics option.
`boolean`	`getAppendEmailAttachments()` Gets the AppendEmailAttachments option.
`boolean`	`getApplyZLIBCompression()` Gets the ApplyZLIBCompression option.
`Options.BiDiReorderMethodValue`	`getBiDiReorderMethod()` Gets the BiDiReorderMethod option.
`Options.BorderModeValue`	`getBorderMode()` Gets the BorderMode option.
`boolean`	`getCollapseWhiteSpace()` Gets the CollapseWhiteSpace option.
`boolean`	`getCropToContent()` Gets the CropToContent option.
`Options.DefaultInputCharacterSetValue`	`getDefaultInputCharacterSet()` Gets the DefaultInputCharacterSet option.
`Margins`	`getDefaultPageMargins()` Gets the DefaultPageMargins option.
`PageInfo`	`getDefaultPageSize()` Gets the DefaultPageSize option.
`FontInfo`	`getDefaultRenderFont()` Gets the DefaultRenderFont option.
`FileFormat`	`getDestinationFormat()` Gets the DestinationFormat option.
`boolean`	`getDetectGrayScaleAsColor()` Gets the DetectGrayScaleAsColor option.
`Options.DocumentMemoryModeValue`	`getDocumentMemoryMode()` Gets the DocumentMemoryMode option.
`boolean`	`getDropPDFHyphens()` Gets the DropPDFHyphens option.
`Options.EmailAttachmentHandlingValue`	`getEmailAttachmentHandling()` Gets the EmailAttachmentHandling option.
`MailHeaders`	`getEmailHeaders()` Gets the EmailHeaders option.
`Options.EmbedFontsValue`	`getEmbedFonts()` Gets the EmbedFonts option.
`boolean`	`getEnableAllSubObjects()` Gets the EnableAllSubObjects option.
`boolean`	`getEnableAlphaBlending()` Gets the EnableAlphaBlending option.
`Options.ExportPerformanceModeValue`	`getExportPerformanceMode()` Gets the ExportPerformanceMode option.
`java.util.List<java.lang.String>`	`getExternalStylesheets()` Gets the .
`Options.ExtractEmbeddedFilesValue`	`getExtractEmbeddedFiles()` Gets the ExtractEmbeddedFiles option.
`boolean`	`getExtractXMPMetadata()` Gets the ExtractXMPMetadata option.
`Options.FallbackFormatValue`	`getFallbackFormat()` Gets the FallbackFormat option.
`long`	`getFitHeightToPages()` Gets the FitHeightToPages option.
`long`	`getFitWidthToPages()` Gets the FitWidthToPages option.
`FontAliases`	`getFontAliasList()` Gets the FontAliasList option.
`java.lang.String`	`getFontBaseURL()` Gets the FontBaseURL option.
`java.util.List<java.io.File>`	`getFontDirectories()` Gets the .
`FontList`	`getFontFilter()` Gets the FontFilter option.
`Options.FontReferenceMethodValue`	`getFontReferenceMethod()` Gets the FontReferenceMethod option.
`boolean`	`getGenerateBulletsAndNumbering()` Gets the GenerateBulletsAndNumbering option.
`boolean`	`getGenerateExcelRevisions()` Gets the GenerateExcelRevisions option.
`boolean`	`getGenerateJavascriptTabs()` Gets the GenerateJavascriptTabs option.
`long`	`getGraphicHeight()` Gets the GraphicHeight option.
`long`	`getGraphicHeightLimit()` Gets the GraphicHeightLimit option.
`long`	`getGraphicOutputDPI()` Gets the GraphicOutputDPI option.
`boolean`	`getGraphicRenderAsPage()` Gets the GraphicRenderAsPage option.
`long`	`getGraphicSizeLimit()` Gets the GraphicSizeLimit option.
`Options.GraphicSizeMethodValue`	`getGraphicSizeMethod()` Gets the GraphicSizeMethod option.
`long`	`getGraphicWidth()` Gets the GraphicWidth option.
`long`	`getGraphicWidthLimit()` Gets the GraphicWidthLimit option.
`long`	`getGridMaxPageHeight()` Gets the GridMaxPageHeight option.
`long`	`getGridMaxPageWidth()` Gets the GridMaxPageWidth option.
`GridWrapInfo`	`getGridWrap()` Gets the GridWrap option.
`Options.HTMLFlavorValue`	`getHTMLFlavor()` Gets the HTMLFlavor option.
`boolean`	`getHTMLOutputFormatting()` Gets the HTMLOutputFormatting option.
`java.util.EnumSet<Options.IECondCommentFlagValues>`	`getIECondCommentMode()` Gets the IECondCommentMode option.
`boolean`	`getIgnorePassword()` Gets the IgnorePassword option.
`boolean`	`getImagePassthrough()` Gets the ImagePassthrough option.
`java.util.EnumSet<Options.IncludeCharacterAttributeValues>`	`getIncludeCharacterAttributes()` Gets the IncludeCharacterAttributes option.
`boolean`	`getIncludeSearchMLOffset()` Gets the IncludeSearchMLOffset option.
`boolean`	`getInterlacedGIFs()` Gets the InterlacedGIFs option.
`boolean`	`getInternalRendering()` Gets the InternalRendering option.
`boolean`	`getISODateTimes()` Gets the ISODateTimes option.
`long`	`getJPEGQuality()` Gets the JPEGQuality option.
`boolean`	`getLinearizePDFOutput()` Gets the LinearizePDFOutput option.
`java.lang.String`	`getLotusNotesDirectory()` Gets the LotusNotesDirectory option.
`MarginText`	`getMarginText()` Gets the MarginText option.
`FontInfo`	`getMarginTextFont()` Gets the MarginTextFont option.
`int`	`getNullReplacementCharacter()` Gets the NullReplacementCharacter option.
`boolean`	`getOutputChangeTracking()` Gets the OutputChangeTracking option.
`Options.OutputCharacterSetValue`	`getOutputCharacterSet()` Gets the OutputCharacterSet option.
`Options.OutputGraphicTypeValue`	`getOutputGraphicType()` Gets the OutputGraphicType option.
`boolean`	`getOutputRawtext()` Gets the OutputRawtext option.
`long`	`getPageBreakLimit()` Gets the PageBreakLimit option.
`Options.PageDirectionValue`	`getPageDirection()` Gets the PageDirection option.
`Options.PageFitModeValue`	`getPageFitMode()` Gets the PageFitMode option.
`java.util.EnumSet<Options.PageMLFlagValues>`	`getPageMLFlags()` Gets the PageMLFlags option.
`PageRange`	`getPageRange()` Gets the PageRange option.
`long`	`getPageScalePercent()` Gets the PageScalePercent option.
`boolean`	`getParseXMPMetadata()` Gets the ParseXMPMetadata option.
`long`	`getPDFInputMaxEmbeddedObjects()` Gets the PDFInputMaxEmbeddedObjects option.
`long`	`getPDFInputMaxVectorPaths()` Gets the PDFInputMaxVectorPaths option.
`Options.PDFReorderBiDiValue`	`getPDFReorderBiDi()` Gets the PDFReorderBiDi option.
`float`	`getPDFWordSpacingFactor()` Gets the PDFWordSpacingFactor option.
`boolean`	`getPerformExtendedFI()` Gets the PerformExtendedFI option.
`java.util.List<java.lang.String>`	`getPostLibraryScripts()` Gets the .
`java.util.List<java.lang.String>`	`getPreLibraryScripts()` Gets the .
`boolean`	`getPreventGraphicOverlap()` Gets the PreventGraphicOverlap option.
`java.lang.String`	`getPrinterName()` Gets the PrinterName option.
`Options.ProcessOLEEmbeddingModeValue`	`getProcessOLEEmbeddingMode()` Gets the ProcessOLEEmbeddingMode option.
`boolean`	`getQuickThumbnail()` Gets the QuickThumbnail option.
`long`	`getRawTextBufferSize()` Gets the RawTextBufferSize option.
`ColorInfo`	`getRedactionColor()` Gets the RedactionColor option.
`FontInfo`	`getRedactionLabelFont()` Gets the RedactionLabelFont option.
`boolean`	`getRedactionLabelsVisible()` Gets the RedactionLabelsVisible option.
`boolean`	`getRedactionsEnabled()` Gets the RedactionsEnabled option.
`boolean`	`getRenderEmbeddedFonts()` Gets the RenderEmbeddedFonts option.
`boolean`	`getRenderGridlines()` Gets the RenderGridlines option.
`boolean`	`getRenderHeadings()` Gets the RenderHeadings option.
`java.util.EnumSet<Options.SearchMLFlagValues>`	`getSearchMLFlags()` Gets the SearchMLFlags option.
`java.util.EnumSet<Options.SearchMLParaAttributeValues>`	`getSearchMLParaAttributes()` Gets the SearchMLParaAttributes option.
`boolean`	`getShowArchiveFullPath()` Gets the ShowArchiveFullPath option.
`boolean`	`getShowColumnHeadings()` Gets the ShowColumnHeadings option.
`boolean`	`getShowHiddenCells()` Gets the ShowHiddenCells option.
`boolean`	`getShowHiddenSpreadSheetData()` Gets the ShowHiddenSpreadSheetData option.
`boolean`	`getShowHiddenText()` Gets the ShowHiddenText option.
`boolean`	`getSimpleStyleNames()` Gets the SimpleStyleNames option.
`boolean`	`getStrictFile()` Gets the StrictFile option.
`boolean`	`getStrokeOutText()` Gets the StrokeOutText option.
`boolean`	`getSuppressEmptyCells()` Gets the SuppressEmptyCells option.
`java.util.EnumSet<Options.SuppressFontAttributeValues>`	`getSuppressFontAttributes()` Gets the SuppressFontAttributes option.
`java.lang.String`	`getTempDirectory()` Gets the TempDirectory option.
`Options.TIFFByteOrderValue`	`getTIFFByteOrder()` Gets the TIFFByteOrder option.
`Options.TIFFColorSpaceValue`	`getTIFFColorSpace()` Gets the TIFFColorSpace option.
`Options.TIFFCompressionValue`	`getTIFFCompression()` Gets the TIFFCompression option.
`Options.TIFFFillOrderValue`	`getTIFFFillOrder()` Gets the TIFFFillOrder option.
`boolean`	`getTIFFMultiPage()` Gets the TIFFMultiPage option.
`long`	`getTimeZoneOffset()` Gets the TimeZoneOffset option.
`ColorInfo`	`getTransparencyColor()` Gets the TransparencyColor option.
`Options.UnicodeByteOrderValue`	`getUnicodeByteOrder()` Gets the UnicodeByteOrder option.
`int`	`getUnmappableCharacter()` Gets the UnmappableCharacter option.
`Options.UnmappedTextValue`	`getUnmappedText()` Gets the UnmappedText option.
`java.lang.String`	`getURLPathOutput()` Gets the URLPathOutput option.
`java.lang.String`	`getURLPathResources()` Gets the URLPathResources option.
`boolean`	`getUseDocumentPageSettings()` Gets the UseDocumentPageSettings option.
`long`	`getVectorObjectLimit()` Gets the VectorObjectLimit option.
`Watermark`	`getWatermark()` Gets the Watermark option.
`java.util.EnumSet<Options.WebFontPermissionValues>`	`getWebFontPermissions()` Gets the WebFontPermissions option.
`java.lang.String`	`getWebViewLibraryName()` Gets the WebViewLibraryName option.
`Options.WebViewStructureValue`	`getWebViewStructure()` Gets the WebViewStructure option.
`java.lang.String`	`getWebViewStylesheetName()` Gets the WebViewStylesheetName option.
`XMLReference`	`getXMLDefinitionReference()` Gets the XMLDefinitionReference option.
`java.util.EnumSet<Options.XXFormatOptionValues>`	`getXXFormatOptions()` Gets the XXFormatOptions option.
`OptionsCache`	`setAcceptAlternateGraphics(boolean AcceptAlternateGraphics)` Sets the AcceptAlternateGraphics option.
`OptionsCache`	`setAppendEmailAttachments(boolean AppendEmailAttachments)` Sets the AppendEmailAttachments option.
`OptionsCache`	`setApplyZLIBCompression(boolean ApplyZLIBCompression)` Sets the ApplyZLIBCompression option.
`OptionsCache`	`setBiDiReorderMethod(Options.BiDiReorderMethodValue BiDiReorderMethod)` Sets the BiDiReorderMethod option.
`OptionsCache`	`setBorderMode(Options.BorderModeValue BorderMode)` Sets the BorderMode option.
`OptionsCache`	`setCallbackHandler(Callback callback)` Sets the callback handler object.
`OptionsCache`	`setCollapseWhiteSpace(boolean CollapseWhiteSpace)` Sets the CollapseWhiteSpace option.
`OptionsCache`	`setCropToContent(boolean CropToContent)` Sets the CropToContent option.
`OptionsCache`	`setDefaultInputCharacterSet(Options.DefaultInputCharacterSetValue DefaultInputCharacterSet)` Sets the DefaultInputCharacterSet option.
`OptionsCache`	`setDefaultPageMargins(Margins DefaultPageMargins)` Sets the DefaultPageMargins option.
`OptionsCache`	`setDefaultPageSize(PageInfo DefaultPageSize)` Sets the DefaultPageSize option.
`OptionsCache`	`setDefaultRenderFont(FontInfo DefaultRenderFont)` Sets the DefaultRenderFont option.
`OptionsCache`	`setDestinationFile(java.io.File file)` Sets the destination document.
`OptionsCache`	`setDestinationFile(SeekableByteChannel6 redirect)` Sets an object that implements `SeekableByteChannel6` to be used as the destination document.
`OptionsCache`	`setDestinationFormat(FileFormat fileId)` Sets the destination file format.
`OptionsCache`	`setDetectGrayScaleAsColor(boolean DetectGrayScaleAsColor)` Sets the DetectGrayScaleAsColor option.
`OptionsCache`	`setDocumentMemoryMode(Options.DocumentMemoryModeValue DocumentMemoryMode)` Sets the DocumentMemoryMode option.
`OptionsCache`	`setDropPDFHyphens(boolean DropPDFHyphens)` Sets the DropPDFHyphens option.
`OptionsCache`	`setEmailAttachmentHandling(Options.EmailAttachmentHandlingValue EmailAttachmentHandling)` Sets the EmailAttachmentHandling option.
`OptionsCache`	`setEmailHeaders(MailHeaders EmailHeaders)` Sets the EmailHeaders option.
`OptionsCache`	`setEmbedFonts(Options.EmbedFontsValue EmbedFonts)` Sets the EmbedFonts option.
`OptionsCache`	`setEnableAllSubObjects(boolean EnableAllSubObjects)` Sets the EnableAllSubObjects option.
`OptionsCache`	`setEnableAlphaBlending(boolean EnableAlphaBlending)` Sets the EnableAlphaBlending option.
`OptionsCache`	`setExportPerformanceMode(Options.ExportPerformanceModeValue ExportPerformanceMode)` Sets the ExportPerformanceMode option.
`OptionsCache`	`setExportTemplate(java.io.File template)` Sets the template file to be used for exporting html files.
`OptionsCache`	`setExternalStylesheets(java.util.List<java.lang.String> ExternalStylesheets)` Sets the .
`OptionsCache`	`setExtractEmbeddedFiles(Options.ExtractEmbeddedFilesValue ExtractEmbeddedFiles)` Sets the ExtractEmbeddedFiles option.
`OptionsCache`	`setExtractXMPMetadata(boolean ExtractXMPMetadata)` Sets the ExtractXMPMetadata option.
`OptionsCache`	`setFallbackFormat(Options.FallbackFormatValue FallbackFormat)` Sets the FallbackFormat option.
`OptionsCache`	`setFitHeightToPages(long FitHeightToPages)` Sets the FitHeightToPages option.
`OptionsCache`	`setFitWidthToPages(long FitWidthToPages)` Sets the FitWidthToPages option.
`OptionsCache`	`setFontAliasList(FontAliases FontAliasList)` Sets the FontAliasList option.
`OptionsCache`	`setFontBaseURL(java.lang.String FontBaseURL)` Sets the FontBaseURL option.
`OptionsCache`	`setFontDirectories(java.util.List<java.io.File> FontDirectories)` Sets the .
`OptionsCache`	`setFontFilter(FontList FontFilter)` Sets the FontFilter option.
`OptionsCache`	`setFontReferenceMethod(Options.FontReferenceMethodValue FontReferenceMethod)` Sets the FontReferenceMethod option.
`OptionsCache`	`setGenerateBulletsAndNumbering(boolean GenerateBulletsAndNumbering)` Sets the GenerateBulletsAndNumbering option.
`OptionsCache`	`setGenerateExcelRevisions(boolean GenerateExcelRevisions)` Sets the GenerateExcelRevisions option.
`OptionsCache`	`setGenerateJavascriptTabs(boolean GenerateJavascriptTabs)` Sets the GenerateJavascriptTabs option.
`OptionsCache`	`setGraphicHeight(long GraphicHeight)` Sets the GraphicHeight option.
`OptionsCache`	`setGraphicHeightLimit(long GraphicHeightLimit)` Sets the GraphicHeightLimit option.
`OptionsCache`	`setGraphicOutputDPI(long GraphicOutputDPI)` Sets the GraphicOutputDPI option.
`OptionsCache`	`setGraphicRenderAsPage(boolean GraphicRenderAsPage)` Sets the GraphicRenderAsPage option.
`OptionsCache`	`setGraphicSizeLimit(long GraphicSizeLimit)` Sets the GraphicSizeLimit option.
`OptionsCache`	`setGraphicSizeMethod(Options.GraphicSizeMethodValue GraphicSizeMethod)` Sets the GraphicSizeMethod option.
`OptionsCache`	`setGraphicWidth(long GraphicWidth)` Sets the GraphicWidth option.
`OptionsCache`	`setGraphicWidthLimit(long GraphicWidthLimit)` Sets the GraphicWidthLimit option.
`OptionsCache`	`setGridMaxPageHeight(long GridMaxPageHeight)` Sets the GridMaxPageHeight option.
`OptionsCache`	`setGridMaxPageWidth(long GridMaxPageWidth)` Sets the GridMaxPageWidth option.
`OptionsCache`	`setGridWrap(GridWrapInfo GridWrap)` Sets the GridWrap option.
`OptionsCache`	`setHTMLFlavor(Options.HTMLFlavorValue HTMLFlavor)` Sets the HTMLFlavor option.
`OptionsCache`	`setHTMLOutputFormatting(boolean HTMLOutputFormatting)` Sets the HTMLOutputFormatting option.
`OptionsCache`	`setIECondCommentMode(java.util.EnumSet<Options.IECondCommentFlagValues> IECondCommentMode)` Sets the IECondCommentMode option.
`OptionsCache`	`setIgnorePassword(boolean IgnorePassword)` Sets the IgnorePassword option.
`OptionsCache`	`setImagePassthrough(boolean ImagePassthrough)` Sets the ImagePassthrough option.
`OptionsCache`	`setIncludeCharacterAttributes(java.util.EnumSet<Options.IncludeCharacterAttributeValues> IncludeCharacterAttributes)` Sets the IncludeCharacterAttributes option.
`OptionsCache`	`setIncludeSearchMLOffset(boolean IncludeSearchMLOffset)` Sets the IncludeSearchMLOffset option.
`OptionsCache`	`setInterlacedGIFs(boolean InterlacedGIFs)` Sets the InterlacedGIFs option.
`OptionsCache`	`setInternalRendering(boolean InternalRendering)` Sets the InternalRendering option.
`OptionsCache`	`setISODateTimes(boolean ISODateTimes)` Sets the ISODateTimes option.
`OptionsCache`	`setJPEGQuality(long JPEGQuality)` Sets the JPEGQuality option.
`OptionsCache`	`setLinearizePDFOutput(boolean LinearizePDFOutput)` Sets the LinearizePDFOutput option.
`OptionsCache`	`setLotusNotesDirectory(java.lang.String LotusNotesDirectory)` Sets the LotusNotesDirectory option.
`OptionsCache`	`setLotusNotesId(java.lang.String notesIdFile)` Sets the path and filename of the Lotus Notes id file used when attempting to open Lotus Notes source files.
`OptionsCache`	`setMarginText(MarginText MarginText)` Sets the MarginText option.
`OptionsCache`	`setMarginTextFont(FontInfo MarginTextFont)` Sets the MarginTextFont option.
`OptionsCache`	`setNullReplacementCharacter(int NullReplacementCharacter)` Sets the NullReplacementCharacter option.
`OptionsCache`	`setOpenForNonSequentialAccess(boolean bOpenForNonSequentialAccess)` Sets the open mode for archive input files.
`protected void`	`setOptions(net.bitform.oilink.OILink oil, net.bitform.oilink.OIHandle hDoc, OptionImpl.OptionScopeValue scope)`
`OptionsCache`	`setOutputChangeTracking(boolean OutputChangeTracking)` Sets the OutputChangeTracking option.
`OptionsCache`	`setOutputCharacterSet(Options.OutputCharacterSetValue OutputCharacterSet)` Sets the OutputCharacterSet option.
`OptionsCache`	`setOutputGraphicType(Options.OutputGraphicTypeValue OutputGraphicType)` Sets the OutputGraphicType option.
`OptionsCache`	`setOutputRawtext(boolean OutputRawtext)` Sets the OutputRawtext option.
`OptionsCache`	`setPageBreakLimit(long PageBreakLimit)` Sets the PageBreakLimit option.
`OptionsCache`	`setPageDirection(Options.PageDirectionValue PageDirection)` Sets the PageDirection option.
`OptionsCache`	`setPageFitMode(Options.PageFitModeValue PageFitMode)` Sets the PageFitMode option.
`OptionsCache`	`setPageMLFlags(java.util.EnumSet<Options.PageMLFlagValues> PageMLFlags)` Sets the PageMLFlags option.
`OptionsCache`	`setPageRange(PageRange PageRange)` Sets the PageRange option.
`OptionsCache`	`setPageScalePercent(long PageScalePercent)` Sets the PageScalePercent option.
`OptionsCache`	`setParseXMPMetadata(boolean ParseXMPMetadata)` Sets the ParseXMPMetadata option.
`protected void`	`setPasswordAndNotesId(net.bitform.oilink.OILink oil, net.bitform.oilink.OIHandle hDoc)`
`OptionsCache`	`setPasswordsList(java.util.List<java.lang.String> passwords)` Sets the list of passwords to use when attempting to open a password protected source file.
`OptionsCache`	`setPDFInputMaxEmbeddedObjects(long PDFInputMaxEmbeddedObjects)` Sets the PDFInputMaxEmbeddedObjects option.
`OptionsCache`	`setPDFInputMaxVectorPaths(long PDFInputMaxVectorPaths)` Sets the PDFInputMaxVectorPaths option.
`OptionsCache`	`setPDFReorderBiDi(Options.PDFReorderBiDiValue PDFReorderBiDi)` Sets the PDFReorderBiDi option.
`OptionsCache`	`setPDFWordSpacingFactor(float PDFWordSpacingFactor)` Sets the PDFWordSpacingFactor option.
`OptionsCache`	`setPerformExtendedFI(boolean PerformExtendedFI)` Sets the PerformExtendedFI option.
`OptionsCache`	`setPostLibraryScripts(java.util.List<java.lang.String> PostLibraryScripts)` Sets the .
`OptionsCache`	`setPreLibraryScripts(java.util.List<java.lang.String> PreLibraryScripts)` Sets the .
`OptionsCache`	`setPreventGraphicOverlap(boolean PreventGraphicOverlap)` Sets the PreventGraphicOverlap option.
`OptionsCache`	`setPrinterName(java.lang.String PrinterName)` Sets the PrinterName option.
`OptionsCache`	`setProcessOLEEmbeddingMode(Options.ProcessOLEEmbeddingModeValue ProcessOLEEmbeddingMode)` Sets the ProcessOLEEmbeddingMode option.
`OptionsCache`	`setQuickThumbnail(boolean QuickThumbnail)` Sets the QuickThumbnail option.
`OptionsCache`	`setRawTextBufferSize(long RawTextBufferSize)` Sets the RawTextBufferSize option.
`OptionsCache`	`setRedactionColor(ColorInfo RedactionColor)` Sets the RedactionColor option.
`OptionsCache`	`setRedactionLabelFont(FontInfo RedactionLabelFont)` Sets the RedactionLabelFont option.
`OptionsCache`	`setRedactionLabelsVisible(boolean RedactionLabelsVisible)` Sets the RedactionLabelsVisible option.
`OptionsCache`	`setRedactionsEnabled(boolean RedactionsEnabled)` Sets the RedactionsEnabled option.
`OptionsCache`	`setRenderEmbeddedFonts(boolean RenderEmbeddedFonts)` Sets the RenderEmbeddedFonts option.
`OptionsCache`	`setRenderGridlines(boolean RenderGridlines)` Sets the RenderGridlines option.
`OptionsCache`	`setRenderHeadings(boolean RenderHeadings)` Sets the RenderHeadings option.
`OptionsCache`	`setSearchMLFlags(java.util.EnumSet<Options.SearchMLFlagValues> SearchMLFlags)` Sets the SearchMLFlags option.
`OptionsCache`	`setSearchMLParaAttributes(java.util.EnumSet<Options.SearchMLParaAttributeValues> SearchMLParaAttributes)` Sets the SearchMLParaAttributes option.
`OptionsCache`	`setShowArchiveFullPath(boolean ShowArchiveFullPath)` Sets the ShowArchiveFullPath option.
`OptionsCache`	`setShowColumnHeadings(boolean ShowColumnHeadings)` Sets the ShowColumnHeadings option.
`OptionsCache`	`setShowHiddenCells(boolean ShowHiddenCells)` Sets the ShowHiddenCells option.
`OptionsCache`	`setShowHiddenSpreadSheetData(boolean ShowHiddenSpreadSheetData)` Sets the ShowHiddenSpreadSheetData option.
`OptionsCache`	`setShowHiddenText(boolean ShowHiddenText)` Sets the ShowHiddenText option.
`OptionsCache`	`setSimpleStyleNames(boolean SimpleStyleNames)` Sets the SimpleStyleNames option.
`OptionsCache`	`setSourceFile(java.io.File file)` Sets the source document.
`OptionsCache`	`setSourceFile(SeekableByteChannel6 redirect)` Sets an object that implements `SeekableByteChannel6` to be used as the source document.
`OptionsCache`	`setSourceFile(SeekableByteChannel6 redirect, java.lang.String filename)` Sets an object that implements `SeekableByteChannel6` to be used as the source document and provides information about the filename.
`OptionsCache`	`setSourceFormat(FileFormat fileId)` Sets the preferred file input format of the source document.
`protected void`	`setSpecialOptionFlag(Options.SpecialOptionFlag flag)`
`OptionsCache`	`setStrictFile(boolean StrictFile)` Sets the StrictFile option.
`OptionsCache`	`setStrokeOutText(boolean StrokeOutText)` Sets the StrokeOutText option.
`OptionsCache`	`setSuppressEmptyCells(boolean SuppressEmptyCells)` Sets the SuppressEmptyCells option.
`OptionsCache`	`setSuppressFontAttributes(java.util.EnumSet<Options.SuppressFontAttributeValues> SuppressFontAttributes)` Sets the SuppressFontAttributes option.
`OptionsCache`	`setTempDirectory(java.lang.String TempDirectory)` Sets the TempDirectory option.
`OptionsCache`	`setTIFFByteOrder(Options.TIFFByteOrderValue TIFFByteOrder)` Sets the TIFFByteOrder option.
`OptionsCache`	`setTIFFColorSpace(Options.TIFFColorSpaceValue TIFFColorSpace)` Sets the TIFFColorSpace option.
`OptionsCache`	`setTIFFCompression(Options.TIFFCompressionValue TIFFCompression)` Sets the TIFFCompression option.
`OptionsCache`	`setTIFFFillOrder(Options.TIFFFillOrderValue TIFFFillOrder)` Sets the TIFFFillOrder option.
`OptionsCache`	`setTIFFMultiPage(boolean TIFFMultiPage)` Sets the TIFFMultiPage option.
`OptionsCache`	`setTimeZoneOffset(long TimeZoneOffset)` Sets the TimeZoneOffset option.
`OptionsCache`	`setTransparencyColor(ColorInfo TransparencyColor)` Sets the TransparencyColor option.
`OptionsCache`	`setUnicodeByteOrder(Options.UnicodeByteOrderValue UnicodeByteOrder)` Sets the UnicodeByteOrder option.
`OptionsCache`	`setUnmappableCharacter(int UnmappableCharacter)` Sets the UnmappableCharacter option.
`OptionsCache`	`setUnmappedText(Options.UnmappedTextValue UnmappedText)` Sets the UnmappedText option.
`OptionsCache`	`setURLPathOutput(java.lang.String URLPathOutput)` Sets the URLPathOutput option.
`OptionsCache`	`setURLPathResources(java.lang.String URLPathResources)` Sets the URLPathResources option.
`OptionsCache`	`setUseDocumentPageSettings(boolean UseDocumentPageSettings)` Sets the UseDocumentPageSettings option.
`OptionsCache`	`setVectorObjectLimit(long VectorObjectLimit)` Sets the VectorObjectLimit option.
`OptionsCache`	`setWatermark(Watermark Watermark)` Sets the Watermark option.
`OptionsCache`	`setWebFontPermissions(java.util.EnumSet<Options.WebFontPermissionValues> WebFontPermissions)` Sets the WebFontPermissions option.
`OptionsCache`	`setWebViewLibraryName(java.lang.String WebViewLibraryName)` Sets the WebViewLibraryName option.
`OptionsCache`	`setWebViewStructure(Options.WebViewStructureValue WebViewStructure)` Sets the WebViewStructure option.
`OptionsCache`	`setWebViewStylesheetName(java.lang.String WebViewStylesheetName)` Sets the WebViewStylesheetName option.
`OptionsCache`	`setXMLDefinitionReference(XMLReference XMLDefinitionReference)` Sets the XMLDefinitionReference option.
`OptionsCache`	`setXXFormatOptions(java.util.EnumSet<Options.XXFormatOptionValues> XXFormatOptions)` Sets the XXFormatOptions option.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

m_srcInfoList

protected java.util.List<OptionsCacheImpl.SourceFileInfo> m_srcInfoList

m_srcInfo

protected OptionsCacheImpl.SourceFileInfo m_srcInfo

m_cumulativeInfo

protected OptionsCacheImpl.SourceFileInfo m_cumulativeInfo

m_dstFile

protected java.io.File m_dstFile

m_dstRedirect

protected SeekableByteChannel6ToBasicIO m_dstRedirect

m_dstFileId

protected FileFormat m_dstFileId

m_bDoOpenInput

protected boolean m_bDoOpenInput

m_templatefile

protected java.io.File m_templatefile

bNextFile

protected boolean bNextFile

Constructor Detail

OptionsCacheImpl

protected OptionsCacheImpl()

OptionsCacheImpl

protected OptionsCacheImpl(OptionsCacheImpl copy)

Method Detail

setOptions

protected void setOptions(net.bitform.oilink.OILink oil,
                          net.bitform.oilink.OIHandle hDoc,
                          OptionImpl.OptionScopeValue scope)
                   throws OutsideInException

Throws:: OutsideInException

setPasswordAndNotesId

protected void setPasswordAndNotesId(net.bitform.oilink.OILink oil,
                                     net.bitform.oilink.OIHandle hDoc)
                              throws OutsideInException

Throws:: OutsideInException

setSpecialOptionFlag

protected void setSpecialOptionFlag(Options.SpecialOptionFlag flag)

setSourceFile

public OptionsCache setSourceFile(java.io.File file)
                           throws OutsideInException

Description copied from interface: OptionsCache

Sets the source document. This file is used as the input for subsequent method calls.

Specified by:: setSourceFile in interface OptionsCache

Parameters:: file - A File object describing the source document location
Returns:: This OptionsCache object (to allow for chaining set option methods)
Throws:: OutsideInException - If the input file does not exist

setSourceFile

public OptionsCache setSourceFile(SeekableByteChannel6 redirect)
                           throws OutsideInException

Description copied from interface: OptionsCache

Sets an object that implements SeekableByteChannel6 to be used as the source document. Exporting a file using this method may have issues with files that require the original name of the file (examples: if the extension of the file is needed for identification purposes or if the name of a secondary file depends on the name/path of the original source file).

Specified by:: setSourceFile in interface OptionsCache

Parameters:: redirect - Object implementing SeekableByteChannel6 to be used to read the source data containing the input file
Returns:: This OptionsCache object (to allow for chaining set option methods)
Throws:: OutsideInException - If the provided SeekableByteChannel6 object is not valid

setSourceFile

public OptionsCache setSourceFile(SeekableByteChannel6 redirect,
                                  java.lang.String filename)
                           throws OutsideInException

Description copied from interface: OptionsCache

Sets an object that implements SeekableByteChannel6 to be used as the source document and provides information about the filename.

Specified by:: setSourceFile in interface OptionsCache

Parameters:: redirect - Object implementing SeekableByteChannel6 to be used to read the source data containing the input file; filename - A fully qualified path or file name that may be used to derive the extension of the file or name of a secondary file that is dependent on the name/path of the source file
Returns:: This OptionsCache object (to allow for chaining set option methods)
Throws:: OutsideInException - If the provided SeekableByteChannel6 object is not valid

addSourceFile

public OptionsCache addSourceFile(java.io.File file)
                           throws OutsideInException

Description copied from interface: OptionsCache

Sets the next source document when exporting multiple input documents to the same destination document. The initial export must use OptionsCache.setSourceFile(File), OptionsCache.setSourceFile(SeekableByteChannel6), or OptionsCache.setSourceFile(SeekableByteChannel6, String) for the first source file.

Specified by:: addSourceFile in interface OptionsCache

Parameters:: file - A File object describing the source document location
Returns:: This OptionsCache object (to allow for chaining set option methods)
Throws:: OutsideInException - If the input file does not exist

addSourceFile

public OptionsCache addSourceFile(SeekableByteChannel6 redirect)
                           throws OutsideInException

Description copied from interface: OptionsCache

Sets an object that implements SeekableByteChannel6 to be used as the next source document when exporting multiple input documents to the same destination document. The initial export must use setSourceFile(), OptionsCache.setSourceFile(SeekableByteChannel6), or OptionsCache.setSourceFile(SeekableByteChannel6, String) for the first source file. This method has the same limitations as OptionsCache.setSourceFile(SeekableByteChannel6).

Specified by:: addSourceFile in interface OptionsCache

Parameters:: redirect - Object implementing SeekableByteChannel6 to be used to read the source data containing the input file
Returns:: This OptionsCache object (to allow for chaining set option methods)
Throws:: OutsideInException - If the provided SeekableByteChannel6 object is not valid

addSourceFile

public OptionsCache addSourceFile(SeekableByteChannel6 redirect,
                                  java.lang.String filename)
                           throws OutsideInException

Description copied from interface: OptionsCache

Sets an object that implements SeekableByteChannel6 to be used as the next source document when exporting multiple input documents to the same destination document and provides information about the filename. The initial export must use setSourceFile(), OptionsCache.setSourceFile(SeekableByteChannel6), or OptionsCache.setSourceFile(SeekableByteChannel6, String) for the first source file.

Specified by:: addSourceFile in interface OptionsCache

Parameters:: redirect - Object implementing SeekableByteChannel6 to be used to read the source data containing the input file; filename - A fully qualified path or file name that may be used to derive the extension of the file or name of a secondary file that is dependent on the name/path of the source file
Returns:: This OptionsCache object (to allow for chaining set option methods)
Throws:: OutsideInException - If the provided SeekableByteChannel6 object is not valid

setSourceFormat

public OptionsCache setSourceFormat(FileFormat fileId)

Description copied from interface: OptionsCache

Sets the preferred file input format of the source document. When a source document can be interpreted as more than one format (for example, docx files may be interpreted as Microsoft Word or a zip archive), this option influences how Outside In interprets the input file.

Specified by:: setSourceFormat in interface OptionsCache

Parameters:: fileId - The file format when used to interpret the source file, if applicable to the source document
Returns:: This OptionsCache object (to allow for chaining set option methods)

setDestinationFile

public OptionsCache setDestinationFile(java.io.File file)
                                throws OutsideInException

Description copied from interface: OptionsCache

Sets the destination document. This file is used to generate the output filenames when Exporter.export() is called.

Specified by:: setDestinationFile in interface OptionsCache

Parameters:: file - A File object describing the destination document location and filename
Returns:: This OptionsCache object (to allow for chaining set option methods)
Throws:: OutsideInException - If the output directory does not exist

setDestinationFile

public OptionsCache setDestinationFile(SeekableByteChannel6 redirect)
                                throws OutsideInException

Description copied from interface: OptionsCache

Sets an object that implements SeekableByteChannel6 to be used as the destination document. An Exporter.export() operation will write the output data to the provided SeekableByteChannel6 object.

Specified by:: setDestinationFile in interface OptionsCache

Parameters:: redirect - Object implementing SeekableByteChannel6 to be used as the destination document written during an Exporter.export() operation
Returns:: This OptionsCache object (to allow for chaining set option methods)
Throws:: OutsideInException - If the provided SeekableByteChannel6 object is not valid

setDestinationFormat

public OptionsCache setDestinationFormat(FileFormat fileId)

Description copied from interface: OptionsCache

Sets the destination file format. Output files will be stored in the specified file format for subsequent calls to Exporter.export().

Specified by:: setDestinationFormat in interface OptionsCache

Parameters:: fileId - The file format type written during subsequent exports
Returns:: This OptionsCache object (to allow for chaining set option methods)

getDestinationFormat

public FileFormat getDestinationFormat()

Description copied from interface: OptionsCache

Gets the DestinationFormat option. Option indicating the file format of the main output file(s) produced by the export conversion.

Specified by:: getDestinationFormat in interface OptionsCache

setCallbackHandler

public OptionsCache setCallbackHandler(Callback callback)

Description copied from interface: OptionsCache

Sets the callback handler object. Callbacks enable client code to be notified of the creation of new destination files and allow client code to alter the destination file names and paths. Only one callback handler may be set per Exporter object. Subsequent calls to this method will overwrite any previously set callback handler. To disable this option after setting a previous callback handler, use null as the parameter.

Specified by:: setCallbackHandler in interface OptionsCache

Parameters:: callback - The callback handler to receive notifications
Returns:: This OptionsCache object (to allow for chaining set option methods)
See Also:: Callback

setPasswordsList

public OptionsCache setPasswordsList(java.util.List<java.lang.String> passwords)

Description copied from interface: OptionsCache

Sets the list of passwords to use when attempting to open a password protected source file. Only one password list may be set per Exporter object. Subsequent calls to this method will overwrite any previously set passwords list. To disable this option after setting a previous passwords list, use null as the parameter.

Specified by:: setPasswordsList in interface OptionsCache

Parameters:: passwords - The list of passwords to attempt
Returns:: This OptionsCache object (to allow for chaining set option methods)

setLotusNotesId

public OptionsCache setLotusNotesId(java.lang.String notesIdFile)

Description copied from interface: OptionsCache

Sets the path and filename of the Lotus Notes id file used when attempting to open Lotus Notes source files. Only one Lotus Notes id may be set per Exporter object. Subsequent calls to this method will overwrite any previously set Lotus Notes id. To disable this option after setting a previous Lotus Notes id, use null as the parameter.

Specified by:: setLotusNotesId in interface OptionsCache

Parameters:: notesIdFile - The Lotus Notes Id file
Returns:: This OptionsCache object (to allow for chaining set option methods)

setOpenForNonSequentialAccess

public OptionsCache setOpenForNonSequentialAccess(boolean bOpenForNonSequentialAccess)

Description copied from interface: OptionsCache

Sets the open mode for archive input files. This option enables archive files to open specific nodes without reading all prior nodes in the archive sequentially.

Specified by:: setOpenForNonSequentialAccess in interface OptionsCache

Parameters:: bOpenForNonSequentialAccess - Whether to enable or disable non-sequential access to archive nodes.
Returns:: This OptionsCache object (to allow for chaining set option methods)
See Also:: Document.saveArchiveNode(int, int, int, File), Exporter.newArchiveNodeExporter(int, int, int)

setExportTemplate

public OptionsCache setExportTemplate(java.io.File template)
                               throws OutsideInException

Description copied from interface: OptionsCache

Sets the template file to be used for exporting html files.

Specified by:: setExportTemplate in interface OptionsCache

Parameters:: template - A file object describing the html template location
Returns:: This OptionsCache object (to allow for chaining set option methods)
Throws:: OutsideInException - If the attempt to set the template fails

setDefaultInputCharacterSet

public OptionsCache setDefaultInputCharacterSet(Options.DefaultInputCharacterSetValue DefaultInputCharacterSet)

Description copied from interface: OptionsCache

Sets the DefaultInputCharacterSet option. This option is used in cases where Outside In cannot determine the character set used to encode the text of an input file. When all other means of determining the file's character set are exhausted, Outside In will assume that an input document is encoded in the character set specified by this option. This is most often used when reading plain-text files, but may also be used when reading HTML or PDF files. When PerformExtendedFI is true, this option will still apply to plain-text input files that are not identified as EBCDIC or Unicode.

Specified by:: setDefaultInputCharacterSet in interface OptionsCache

Parameters:: DefaultInputCharacterSet - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getDefaultInputCharacterSet

public Options.DefaultInputCharacterSetValue getDefaultInputCharacterSet()

Description copied from interface: OptionsCache

Gets the DefaultInputCharacterSet option. This option is used in cases where Outside In cannot determine the character set used to encode the text of an input file. When all other means of determining the file's character set are exhausted, Outside In will assume that an input document is encoded in the character set specified by this option. This is most often used when reading plain-text files, but may also be used when reading HTML or PDF files. When PerformExtendedFI is true, this option will still apply to plain-text input files that are not identified as EBCDIC or Unicode.

Specified by:: getDefaultInputCharacterSet in interface OptionsCache

Returns:: The current value for the DefaultInputCharacterSet option

setUnmappableCharacter

public OptionsCache setUnmappableCharacter(int UnmappableCharacter)

Description copied from interface: OptionsCache

Sets the UnmappableCharacter option. This option selects the character used when a character cannot be found in the output character set. This option takes the Unicode value for the replacement character. It is left to the user to make sure that the selected replacement character is available in the output character set.

Specified by:: setUnmappableCharacter in interface OptionsCache

Parameters:: UnmappableCharacter - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getUnmappableCharacter

public int getUnmappableCharacter()

Description copied from interface: OptionsCache

Gets the UnmappableCharacter option. This option selects the character used when a character cannot be found in the output character set. This option takes the Unicode value for the replacement character. It is left to the user to make sure that the selected replacement character is available in the output character set.

Specified by:: getUnmappableCharacter in interface OptionsCache

Returns:: The current value for the UnmappableCharacter option

setUnicodeByteOrder

public OptionsCache setUnicodeByteOrder(Options.UnicodeByteOrderValue UnicodeByteOrder)

Description copied from interface: OptionsCache

Sets the UnicodeByteOrder option. byte order of Unicode characters in the output files when Unicode is chosen as the output character set.

Specified by:: setUnicodeByteOrder in interface OptionsCache

Parameters:: UnicodeByteOrder - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getUnicodeByteOrder

public Options.UnicodeByteOrderValue getUnicodeByteOrder()

Description copied from interface: OptionsCache

Gets the UnicodeByteOrder option. byte order of Unicode characters in the output files when Unicode is chosen as the output character set.

Specified by:: getUnicodeByteOrder in interface OptionsCache

Returns:: The current value for the UnicodeByteOrder option

setOutputCharacterSet

public OptionsCache setOutputCharacterSet(Options.OutputCharacterSetValue OutputCharacterSet)

Description copied from interface: OptionsCache

Sets the OutputCharacterSet option. Output Character Set

Specified by:: setOutputCharacterSet in interface OptionsCache

Parameters:: OutputCharacterSet - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getOutputCharacterSet

public Options.OutputCharacterSetValue getOutputCharacterSet()

Description copied from interface: OptionsCache

Gets the OutputCharacterSet option. Output Character Set

Specified by:: getOutputCharacterSet in interface OptionsCache

Returns:: The current value for the OutputCharacterSet option

setInternalRendering

public OptionsCache setInternalRendering(boolean InternalRendering)

Description copied from interface: OptionsCache

Sets the InternalRendering option.

Specified by:: setInternalRendering in interface OptionsCache

Parameters:: InternalRendering - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getInternalRendering

public boolean getInternalRendering()

Description copied from interface: OptionsCache

Gets the InternalRendering option.

Specified by:: getInternalRendering in interface OptionsCache

Returns:: The current value for the InternalRendering option

setEnableAlphaBlending

public OptionsCache setEnableAlphaBlending(boolean EnableAlphaBlending)

Description copied from interface: OptionsCache

Sets the EnableAlphaBlending option.

Specified by:: setEnableAlphaBlending in interface OptionsCache

Parameters:: EnableAlphaBlending - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getEnableAlphaBlending

public boolean getEnableAlphaBlending()

Description copied from interface: OptionsCache

Gets the EnableAlphaBlending option.

Specified by:: getEnableAlphaBlending in interface OptionsCache

Returns:: The current value for the EnableAlphaBlending option

setOutputChangeTracking

public OptionsCache setOutputChangeTracking(boolean OutputChangeTracking)

Description copied from interface: OptionsCache

Sets the OutputChangeTracking option. option to output change tracking information.

Specified by:: setOutputChangeTracking in interface OptionsCache

Parameters:: OutputChangeTracking - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getOutputChangeTracking

public boolean getOutputChangeTracking()

Description copied from interface: OptionsCache

Gets the OutputChangeTracking option. option to output change tracking information.

Specified by:: getOutputChangeTracking in interface OptionsCache

Returns:: The current value for the OutputChangeTracking option

setCollapseWhiteSpace

public OptionsCache setCollapseWhiteSpace(boolean CollapseWhiteSpace)

Description copied from interface: OptionsCache

Sets the CollapseWhiteSpace option. option to delete whitespace from the output document

Specified by:: setCollapseWhiteSpace in interface OptionsCache

Parameters:: CollapseWhiteSpace - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getCollapseWhiteSpace

public boolean getCollapseWhiteSpace()

Description copied from interface: OptionsCache

Gets the CollapseWhiteSpace option. option to delete whitespace from the output document

Specified by:: getCollapseWhiteSpace in interface OptionsCache

Returns:: The current value for the CollapseWhiteSpace option

setExtractEmbeddedFiles

public OptionsCache setExtractEmbeddedFiles(Options.ExtractEmbeddedFilesValue ExtractEmbeddedFiles)

Description copied from interface: OptionsCache

Sets the ExtractEmbeddedFiles option. Option to control extraction of attached documents

Specified by:: setExtractEmbeddedFiles in interface OptionsCache

Parameters:: ExtractEmbeddedFiles - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getExtractEmbeddedFiles

public Options.ExtractEmbeddedFilesValue getExtractEmbeddedFiles()

Description copied from interface: OptionsCache

Gets the ExtractEmbeddedFiles option. Option to control extraction of attached documents

Specified by:: getExtractEmbeddedFiles in interface OptionsCache

Returns:: The current value for the ExtractEmbeddedFiles option

setHTMLFlavor

public OptionsCache setHTMLFlavor(Options.HTMLFlavorValue HTMLFlavor)

Description copied from interface: OptionsCache

Sets the HTMLFlavor option. html output flavor

Specified by:: setHTMLFlavor in interface OptionsCache

Parameters:: HTMLFlavor - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getHTMLFlavor

public Options.HTMLFlavorValue getHTMLFlavor()

Description copied from interface: OptionsCache

Gets the HTMLFlavor option. html output flavor

Specified by:: getHTMLFlavor in interface OptionsCache

Returns:: The current value for the HTMLFlavor option

setHTMLOutputFormatting

public OptionsCache setHTMLOutputFormatting(boolean HTMLOutputFormatting)

Description copied from interface: OptionsCache

Sets the HTMLOutputFormatting option. readable HTML output option

Specified by:: setHTMLOutputFormatting in interface OptionsCache

Parameters:: HTMLOutputFormatting - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getHTMLOutputFormatting

public boolean getHTMLOutputFormatting()

Description copied from interface: OptionsCache

Gets the HTMLOutputFormatting option. readable HTML output option

Specified by:: getHTMLOutputFormatting in interface OptionsCache

Returns:: The current value for the HTMLOutputFormatting option

setShowHiddenText

public OptionsCache setShowHiddenText(boolean ShowHiddenText)

Description copied from interface: OptionsCache

Sets the ShowHiddenText option. This option will force HTML Export to place all hidden text in line with surrounding text. Please note that enabling this option will not display hidden cells, hidden rows or hidden sheets in spreadsheet documents. Also note that when graphic documents (such as faxes) are processed by OCR software and converted to PDF, the optically recognized text may be rendered as a layer of hidden text behind the original image. In order to properly export such PDF documents, this option must be enabled.

Specified by:: setShowHiddenText in interface OptionsCache

Parameters:: ShowHiddenText - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getShowHiddenText

public boolean getShowHiddenText()

Description copied from interface: OptionsCache

Gets the ShowHiddenText option. This option will force HTML Export to place all hidden text in line with surrounding text. Please note that enabling this option will not display hidden cells, hidden rows or hidden sheets in spreadsheet documents. Also note that when graphic documents (such as faxes) are processed by OCR software and converted to PDF, the optically recognized text may be rendered as a layer of hidden text behind the original image. In order to properly export such PDF documents, this option must be enabled.

Specified by:: getShowHiddenText in interface OptionsCache

Returns:: The current value for the ShowHiddenText option

setSimpleStyleNames

public OptionsCache setSimpleStyleNames(boolean SimpleStyleNames)

Description copied from interface: OptionsCache

Sets the SimpleStyleNames option. This option is for use by people who intend to read or change the CSS style names generated by HTML Export. By default, HTML Export creates unique style names based on the style names used in the original document. Unfortunately, there is an inherent limitation in the style names the CSS standard permits. That standard only permits the characters [a-z][A-Z][0-9] and "-". Source document style names do not necessarily have this restriction. In fact they may even contain Unicode characters at times. For this reason, the original style names may need to be modified to conform to this standard. To avoid illegal style names, HTML Export performs the following substitutions on all source style names: 1. If the character is a "-", then it is replaced with "--". 2. If the character is not one of the remaining characters ([a-z][A-Z][0-9]), then it is replaced by "-xxxx" where "xxxx" is the Unicode value of the character in hexadecimal. 3. Otherwise the character appears in the style name normally. An example of one of the most common examples of this substitution is that spaces in style names are replaced with "-0020". For a more complete example of this character substitution in style names, consider the source style name My Special H1-Style!. This would be transformed to: My-0020Special-0020H1--Style-0021 While admittedly this system lacks a certain aesthetic, it avoids the problem of how the document looks when the browser receives duplicate or invalid style names. Developers should also appreciate the simplicity of the code needed to parse or create these style names. In addition, HTML Export will sometimes create special character attribute-only versions of styles. These have the same name as the style they are based on with "--Char" appended to the end. These styles differ from their original counterparts in that they contain no block level CSS. This more general solution replaces the solution implemented in versions 7.1 and earlier which created "--List" styles to solve a subset of this problem. This was done to work around limitations in some browsers. Because of these CSS limitations, the SCCOPT_EX_SIMPLESTYLENAMES option was created. Setting this option to TRUE causes HTML Export to generate style names that are easy to read but are not guaranteed to be unique. It does this by discarding all characters in the original style name that are not legal in CSS style names. As one would expect, this may lead to naming collisions. An example of a naming collision caused by setting this option can be seen if you look at source document styles named MyStyle and My $ Style. When exported with this option, both would become MyStyle. This in turn may generate confusion when viewing the document in the browser. This is because the browser will look upon the second style as being a redefinition of the first. With the option set to FALSE this is not a problem. The two styles would be converted to MyStyle and My-0020-0024-0020Style respectively. Because the style names are unique, the browser will not see the second style as a redefinition of the first. As this contrived example indicates, naming collisions should be rare for most U.S. documents. If a style name consists of nothing but illegal characters, HTML Export will create a style name for it. This style name is of the form UnnamedStyleX where X is a count of styles encountered so far that did not have style names for one reason or another. This behavior is expected to be very common when converting international documents in languages that are not based on 7-bit ASCII.

Specified by:: setSimpleStyleNames in interface OptionsCache

Parameters:: SimpleStyleNames - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getSimpleStyleNames

public boolean getSimpleStyleNames()

Description copied from interface: OptionsCache

Gets the SimpleStyleNames option. This option is for use by people who intend to read or change the CSS style names generated by HTML Export. By default, HTML Export creates unique style names based on the style names used in the original document. Unfortunately, there is an inherent limitation in the style names the CSS standard permits. That standard only permits the characters [a-z][A-Z][0-9] and "-". Source document style names do not necessarily have this restriction. In fact they may even contain Unicode characters at times. For this reason, the original style names may need to be modified to conform to this standard. To avoid illegal style names, HTML Export performs the following substitutions on all source style names: 1. If the character is a "-", then it is replaced with "--". 2. If the character is not one of the remaining characters ([a-z][A-Z][0-9]), then it is replaced by "-xxxx" where "xxxx" is the Unicode value of the character in hexadecimal. 3. Otherwise the character appears in the style name normally. An example of one of the most common examples of this substitution is that spaces in style names are replaced with "-0020". For a more complete example of this character substitution in style names, consider the source style name My Special H1-Style!. This would be transformed to: My-0020Special-0020H1--Style-0021 While admittedly this system lacks a certain aesthetic, it avoids the problem of how the document looks when the browser receives duplicate or invalid style names. Developers should also appreciate the simplicity of the code needed to parse or create these style names. In addition, HTML Export will sometimes create special character attribute-only versions of styles. These have the same name as the style they are based on with "--Char" appended to the end. These styles differ from their original counterparts in that they contain no block level CSS. This more general solution replaces the solution implemented in versions 7.1 and earlier which created "--List" styles to solve a subset of this problem. This was done to work around limitations in some browsers. Because of these CSS limitations, the SCCOPT_EX_SIMPLESTYLENAMES option was created. Setting this option to TRUE causes HTML Export to generate style names that are easy to read but are not guaranteed to be unique. It does this by discarding all characters in the original style name that are not legal in CSS style names. As one would expect, this may lead to naming collisions. An example of a naming collision caused by setting this option can be seen if you look at source document styles named MyStyle and My $ Style. When exported with this option, both would become MyStyle. This in turn may generate confusion when viewing the document in the browser. This is because the browser will look upon the second style as being a redefinition of the first. With the option set to FALSE this is not a problem. The two styles would be converted to MyStyle and My-0020-0024-0020Style respectively. Because the style names are unique, the browser will not see the second style as a redefinition of the first. As this contrived example indicates, naming collisions should be rare for most U.S. documents. If a style name consists of nothing but illegal characters, HTML Export will create a style name for it. This style name is of the form UnnamedStyleX where X is a count of styles encountered so far that did not have style names for one reason or another. This behavior is expected to be very common when converting international documents in languages that are not based on 7-bit ASCII.

Specified by:: getSimpleStyleNames in interface OptionsCache

Returns:: The current value for the SimpleStyleNames option

setShowHiddenSpreadSheetData

public OptionsCache setShowHiddenSpreadSheetData(boolean ShowHiddenSpreadSheetData)

Description copied from interface: OptionsCache

Sets the ShowHiddenSpreadSheetData option. The setting for this option determines whether or not hidden sheets in a spreadsheet will be included in the output. When set to FALSE (the default), the hidden elements are not written. When set to TRUE, they are placed in the output in the same manner as regular spreadsheet data.

Specified by:: setShowHiddenSpreadSheetData in interface OptionsCache

Parameters:: ShowHiddenSpreadSheetData - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getShowHiddenSpreadSheetData

public boolean getShowHiddenSpreadSheetData()

Description copied from interface: OptionsCache

Gets the ShowHiddenSpreadSheetData option. The setting for this option determines whether or not hidden sheets in a spreadsheet will be included in the output. When set to FALSE (the default), the hidden elements are not written. When set to TRUE, they are placed in the output in the same manner as regular spreadsheet data.

Specified by:: getShowHiddenSpreadSheetData in interface OptionsCache

Returns:: The current value for the ShowHiddenSpreadSheetData option

setFallbackFormat

public OptionsCache setFallbackFormat(Options.FallbackFormatValue FallbackFormat)

Description copied from interface: OptionsCache

Sets the FallbackFormat option. This option controls how files are handled when their specific application type cannot be determined. This normally affects all plain-text files, because plain-text files are generally identified by process of elimination, for example, when a file isn't identified as having been created by a known application, it is treated as a plain-text file. It is recommended that None be set to prevent the conversion from exporting unidentified binary files as though they were text, which could generate many pages of "garbage" output.

Specified by:: setFallbackFormat in interface OptionsCache

Parameters:: FallbackFormat - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getFallbackFormat

public Options.FallbackFormatValue getFallbackFormat()

Description copied from interface: OptionsCache

Gets the FallbackFormat option. This option controls how files are handled when their specific application type cannot be determined. This normally affects all plain-text files, because plain-text files are generally identified by process of elimination, for example, when a file isn't identified as having been created by a known application, it is treated as a plain-text file. It is recommended that None be set to prevent the conversion from exporting unidentified binary files as though they were text, which could generate many pages of "garbage" output.

Specified by:: getFallbackFormat in interface OptionsCache

Returns:: The current value for the FallbackFormat option

setExtractXMPMetadata

public OptionsCache setExtractXMPMetadata(boolean ExtractXMPMetadata)

Description copied from interface: OptionsCache

Sets the ExtractXMPMetadata option. Adobe's Extensible Metadata Platform (XMP) is a labeling technology that allows you to embed data about a file, known as metadata, into the file itself. This option enables the XMP feature, which does not interpret the XMP metadata, but passes it straight through without any interpretation. This option will be ignored if the ParseXMPMetadata option is enabled.

Specified by:: setExtractXMPMetadata in interface OptionsCache

Parameters:: ExtractXMPMetadata - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getExtractXMPMetadata

public boolean getExtractXMPMetadata()

Description copied from interface: OptionsCache

Gets the ExtractXMPMetadata option. Adobe's Extensible Metadata Platform (XMP) is a labeling technology that allows you to embed data about a file, known as metadata, into the file itself. This option enables the XMP feature, which does not interpret the XMP metadata, but passes it straight through without any interpretation. This option will be ignored if the ParseXMPMetadata option is enabled.

Specified by:: getExtractXMPMetadata in interface OptionsCache

Returns:: The current value for the ExtractXMPMetadata option

setParseXMPMetadata

public OptionsCache setParseXMPMetadata(boolean ParseXMPMetadata)

Description copied from interface: OptionsCache

Sets the ParseXMPMetadata option. Adobe's Extensible Metadata Platform (XMP) is a labeling technology that allows you to embed data about a file, known as metadata, into the file itself. This option enables parsing of the XMP data into normal OIT document properties. Enabling this option may cause the loss of some regular data in premium graphics filters (such as Postscript), but won't affect most formats (such as PDF).

Specified by:: setParseXMPMetadata in interface OptionsCache

Parameters:: ParseXMPMetadata - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getParseXMPMetadata

public boolean getParseXMPMetadata()

Description copied from interface: OptionsCache

Gets the ParseXMPMetadata option. Adobe's Extensible Metadata Platform (XMP) is a labeling technology that allows you to embed data about a file, known as metadata, into the file itself. This option enables parsing of the XMP data into normal OIT document properties. Enabling this option may cause the loss of some regular data in premium graphics filters (such as Postscript), but won't affect most formats (such as PDF).

Specified by:: getParseXMPMetadata in interface OptionsCache

Returns:: The current value for the ParseXMPMetadata option

setPerformExtendedFI

public OptionsCache setPerformExtendedFI(boolean PerformExtendedFI)

Description copied from interface: OptionsCache

Sets the PerformExtendedFI option. This option affects how an input file's internal format (application type) is identified when the file is first opened by the Oracle Outside In technology. When the extended test flag is in effect, and an input file is identified as being either 7-bit ASCII, EBCDIC, or Unicode, the file's contents will be interpreted as such by the export process. The extended test is optional because it requires extra processing and cannot guarantee complete accuracy (which would require the inspection of every single byte in a file to eliminate false positives.)

Specified by:: setPerformExtendedFI in interface OptionsCache

Parameters:: PerformExtendedFI - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getPerformExtendedFI

public boolean getPerformExtendedFI()

Description copied from interface: OptionsCache

Gets the PerformExtendedFI option. This option affects how an input file's internal format (application type) is identified when the file is first opened by the Oracle Outside In technology. When the extended test flag is in effect, and an input file is identified as being either 7-bit ASCII, EBCDIC, or Unicode, the file's contents will be interpreted as such by the export process. The extended test is optional because it requires extra processing and cannot guarantee complete accuracy (which would require the inspection of every single byte in a file to eliminate false positives.)

Specified by:: getPerformExtendedFI in interface OptionsCache

Returns:: The current value for the PerformExtendedFI option

setLotusNotesDirectory

public OptionsCache setLotusNotesDirectory(java.lang.String LotusNotesDirectory)

Description copied from interface: OptionsCache

Sets the LotusNotesDirectory option. This option allows the developer to specify the location of a Lotus Notes or Domino installation for use by the NSF filter. A valid Lotus installation directory must contain the file nnotes.dll. Either Lotus Notes version 8 or Lotus Domino version 8 must be installed on the same machine as OIT. A 32-bit version of the Lotus software must be used if you are using a 32-bit version of OIT. A 64-bit version of the Lotus software must be used if you are using a 64-bit version of OIT.

Specified by:: setLotusNotesDirectory in interface OptionsCache

Parameters:: LotusNotesDirectory - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getLotusNotesDirectory

public java.lang.String getLotusNotesDirectory()

Description copied from interface: OptionsCache

Gets the LotusNotesDirectory option. This option allows the developer to specify the location of a Lotus Notes or Domino installation for use by the NSF filter. A valid Lotus installation directory must contain the file nnotes.dll. Either Lotus Notes version 8 or Lotus Domino version 8 must be installed on the same machine as OIT. A 32-bit version of the Lotus software must be used if you are using a 32-bit version of OIT. A 64-bit version of the Lotus software must be used if you are using a 64-bit version of OIT.

Specified by:: getLotusNotesDirectory in interface OptionsCache

Returns:: The current value for the LotusNotesDirectory option

setPDFReorderBiDi

public OptionsCache setPDFReorderBiDi(Options.PDFReorderBiDiValue PDFReorderBiDi)

Description copied from interface: OptionsCache

Sets the PDFReorderBiDi option. This option controls whether or not the PDF filter will attempt to reorder bidirectional text runs so that the output is in standard logical order as used by the Unicode 2.0 and later specification. This additional processing will result in slower filter performance according to the amount of bidirectional data in the file.

Specified by:: setPDFReorderBiDi in interface OptionsCache

Parameters:: PDFReorderBiDi - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getPDFReorderBiDi

public Options.PDFReorderBiDiValue getPDFReorderBiDi()

Description copied from interface: OptionsCache

Gets the PDFReorderBiDi option. This option controls whether or not the PDF filter will attempt to reorder bidirectional text runs so that the output is in standard logical order as used by the Unicode 2.0 and later specification. This additional processing will result in slower filter performance according to the amount of bidirectional data in the file.

Specified by:: getPDFReorderBiDi in interface OptionsCache

Returns:: The current value for the PDFReorderBiDi option

setPDFWordSpacingFactor

public OptionsCache setPDFWordSpacingFactor(float PDFWordSpacingFactor)

Description copied from interface: OptionsCache

Sets the PDFWordSpacingFactor option. Option to specify the spacing threshold to detect word breaks in PDF documents

Specified by:: setPDFWordSpacingFactor in interface OptionsCache

Parameters:: PDFWordSpacingFactor - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getPDFWordSpacingFactor

public float getPDFWordSpacingFactor()

Description copied from interface: OptionsCache

Gets the PDFWordSpacingFactor option. Option to specify the spacing threshold to detect word breaks in PDF documents

Specified by:: getPDFWordSpacingFactor in interface OptionsCache

Returns:: The current value for the PDFWordSpacingFactor option

setPDFInputMaxEmbeddedObjects

public OptionsCache setPDFInputMaxEmbeddedObjects(long PDFInputMaxEmbeddedObjects)

Description copied from interface: OptionsCache

Sets the PDFInputMaxEmbeddedObjects option. This option specifies the maximum number of embedded objects that will be output by the PDF filter. Once the limit is reached the filter will ignore any further embedded objects that it encounters. Setting this to 0 specifies an unlimited number.

Specified by:: setPDFInputMaxEmbeddedObjects in interface OptionsCache

Parameters:: PDFInputMaxEmbeddedObjects - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getPDFInputMaxEmbeddedObjects

public long getPDFInputMaxEmbeddedObjects()

Description copied from interface: OptionsCache

Gets the PDFInputMaxEmbeddedObjects option. This option specifies the maximum number of embedded objects that will be output by the PDF filter. Once the limit is reached the filter will ignore any further embedded objects that it encounters. Setting this to 0 specifies an unlimited number.

Specified by:: getPDFInputMaxEmbeddedObjects in interface OptionsCache

Returns:: The current value for the PDFInputMaxEmbeddedObjects option

setPDFInputMaxVectorPaths

public OptionsCache setPDFInputMaxVectorPaths(long PDFInputMaxVectorPaths)

Description copied from interface: OptionsCache

Sets the PDFInputMaxVectorPaths option. This option specifies the maximum number of vector path drawings that will be output by the PDF filter. Once the limit is reached the filter will ignore any further vector drawings that it encounters. Setting this to 0 specifies an unlimited number.

Specified by:: setPDFInputMaxVectorPaths in interface OptionsCache

Parameters:: PDFInputMaxVectorPaths - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getPDFInputMaxVectorPaths

public long getPDFInputMaxVectorPaths()

Description copied from interface: OptionsCache

Gets the PDFInputMaxVectorPaths option. This option specifies the maximum number of vector path drawings that will be output by the PDF filter. Once the limit is reached the filter will ignore any further vector drawings that it encounters. Setting this to 0 specifies an unlimited number.

Specified by:: getPDFInputMaxVectorPaths in interface OptionsCache

Returns:: The current value for the PDFInputMaxVectorPaths option

setTimeZoneOffset

public OptionsCache setTimeZoneOffset(long TimeZoneOffset)

Description copied from interface: OptionsCache

Sets the TimeZoneOffset option. This option allows the user to define an offset to GMT that will be applied during date formatting, allowing date values to be displayed in a selectable time zone. This option affects the formatting of numbers that have been defined as date values. This option will not affect dates that are stored as text. Note: This option does not apply for spreadsheet files. Note: Daylight savings is not supported. The sent time in msg files when viewed in Outlook can be an hour different from the time sent when an image of the msg file is created. To query the operating system for the time zone set on the machine, specify TimeZoneOffset_UseNative.

Specified by:: setTimeZoneOffset in interface OptionsCache

Parameters:: TimeZoneOffset - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getTimeZoneOffset

public long getTimeZoneOffset()

Description copied from interface: OptionsCache

Gets the TimeZoneOffset option. This option allows the user to define an offset to GMT that will be applied during date formatting, allowing date values to be displayed in a selectable time zone. This option affects the formatting of numbers that have been defined as date values. This option will not affect dates that are stored as text. Note: This option does not apply for spreadsheet files. Note: Daylight savings is not supported. The sent time in msg files when viewed in Outlook can be an hour different from the time sent when an image of the msg file is created. To query the operating system for the time zone set on the machine, specify TimeZoneOffset_UseNative.

Specified by:: getTimeZoneOffset in interface OptionsCache

Returns:: The current value for the TimeZoneOffset option

setISODateTimes

public OptionsCache setISODateTimes(boolean ISODateTimes)

Description copied from interface: OptionsCache

Sets the ISODateTimes option. When this flag is set, all Date and Time values are converted to the ISO 8601 standard. This conversion can only be performed using dates that are stored as numeric data within the original file.

Specified by:: setISODateTimes in interface OptionsCache

Parameters:: ISODateTimes - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getISODateTimes

public boolean getISODateTimes()

Description copied from interface: OptionsCache

Gets the ISODateTimes option. When this flag is set, all Date and Time values are converted to the ISO 8601 standard. This conversion can only be performed using dates that are stored as numeric data within the original file.

Specified by:: getISODateTimes in interface OptionsCache

Returns:: The current value for the ISODateTimes option

setStrictFile

public OptionsCache setStrictFile(boolean StrictFile)

Description copied from interface: OptionsCache

Sets the StrictFile option. When an embedded file or URL can't be opened with the full path, OIT will sometimes try and open the referenced file from other locations, including the current directory. When this option is set, it will prevent OutsideIn from trying to open the file from any location other than the fully qualified path or URL.

Specified by:: setStrictFile in interface OptionsCache

Parameters:: StrictFile - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getStrictFile

public boolean getStrictFile()

Description copied from interface: OptionsCache

Gets the StrictFile option. When an embedded file or URL can't be opened with the full path, OIT will sometimes try and open the referenced file from other locations, including the current directory. When this option is set, it will prevent OutsideIn from trying to open the file from any location other than the fully qualified path or URL.

Specified by:: getStrictFile in interface OptionsCache

Returns:: The current value for the StrictFile option

setIgnorePassword

public OptionsCache setIgnorePassword(boolean IgnorePassword)

Description copied from interface: OptionsCache

Sets the IgnorePassword option. This option can disable the password verification of files where the contents can be processed without validation of the password. If this option is not set, the filter will return an error. Currently only the PST and MDB Filters support this option.

Specified by:: setIgnorePassword in interface OptionsCache

Parameters:: IgnorePassword - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getIgnorePassword

public boolean getIgnorePassword()

Description copied from interface: OptionsCache

Gets the IgnorePassword option. This option can disable the password verification of files where the contents can be processed without validation of the password. If this option is not set, the filter will return an error. Currently only the PST and MDB Filters support this option.

Specified by:: getIgnorePassword in interface OptionsCache

Returns:: The current value for the IgnorePassword option

setBiDiReorderMethod

public OptionsCache setBiDiReorderMethod(Options.BiDiReorderMethodValue BiDiReorderMethod)

Description copied from interface: OptionsCache

Sets the BiDiReorderMethod option. This option controls how the technology reorders bidirectional text.

Specified by:: setBiDiReorderMethod in interface OptionsCache

Parameters:: BiDiReorderMethod - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getBiDiReorderMethod

public Options.BiDiReorderMethodValue getBiDiReorderMethod()

Description copied from interface: OptionsCache

Gets the BiDiReorderMethod option. This option controls how the technology reorders bidirectional text.

Specified by:: getBiDiReorderMethod in interface OptionsCache

Returns:: The current value for the BiDiReorderMethod option

setIECondCommentMode

public OptionsCache setIECondCommentMode(java.util.EnumSet<Options.IECondCommentFlagValues> IECondCommentMode)

Description copied from interface: OptionsCache

Sets the IECondCommentMode option. Some HTML includes a special type of comment that will be read by particular versions of browsers or other products. This option allows you to control which of those comments are included in the output.

Specified by:: setIECondCommentMode in interface OptionsCache

Parameters:: IECondCommentMode - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getIECondCommentMode

public java.util.EnumSet<Options.IECondCommentFlagValues> getIECondCommentMode()

Description copied from interface: OptionsCache

Gets the IECondCommentMode option. Some HTML includes a special type of comment that will be read by particular versions of browsers or other products. This option allows you to control which of those comments are included in the output.

Specified by:: getIECondCommentMode in interface OptionsCache

Returns:: The current value for the IECondCommentMode option

setShowArchiveFullPath

public OptionsCache setShowArchiveFullPath(boolean ShowArchiveFullPath)

Description copied from interface: OptionsCache

Sets the ShowArchiveFullPath option. This option causes the full path of a node to be returned in "GetRecordInfo" and "GetObjectInfo".

Specified by:: setShowArchiveFullPath in interface OptionsCache

Parameters:: ShowArchiveFullPath - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getShowArchiveFullPath

public boolean getShowArchiveFullPath()

Description copied from interface: OptionsCache

Gets the ShowArchiveFullPath option. This option causes the full path of a node to be returned in "GetRecordInfo" and "GetObjectInfo".

Specified by:: getShowArchiveFullPath in interface OptionsCache

Returns:: The current value for the ShowArchiveFullPath option

setGenerateExcelRevisions

public OptionsCache setGenerateExcelRevisions(boolean GenerateExcelRevisions)

Description copied from interface: OptionsCache

Sets the GenerateExcelRevisions option. This option enables you to extract tracked changes from Excel. Extracted content shall include location (worksheet, row, column), author, date, and time. Please note that Excel has an option to display the changes inline or on a different sheet. Either case should be extracted along with where the comments are displayed in the Excel file (inline or separate sheet). Revisions are always displayed in a table following the final sheet in the document.

Specified by:: setGenerateExcelRevisions in interface OptionsCache

Parameters:: GenerateExcelRevisions - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getGenerateExcelRevisions

public boolean getGenerateExcelRevisions()

Description copied from interface: OptionsCache

Gets the GenerateExcelRevisions option. This option enables you to extract tracked changes from Excel. Extracted content shall include location (worksheet, row, column), author, date, and time. Please note that Excel has an option to display the changes inline or on a different sheet. Either case should be extracted along with where the comments are displayed in the Excel file (inline or separate sheet). Revisions are always displayed in a table following the final sheet in the document.

Specified by:: getGenerateExcelRevisions in interface OptionsCache

Returns:: The current value for the GenerateExcelRevisions option

setProcessOLEEmbeddingMode

public OptionsCache setProcessOLEEmbeddingMode(Options.ProcessOLEEmbeddingModeValue ProcessOLEEmbeddingMode)

Description copied from interface: OptionsCache

Sets the ProcessOLEEmbeddingMode option. Microsoft Powerpoint versions from 1997 through 2003 had the capability to embed OLE documents in the Powerpoint files. This option controls which embeddings are to be processed as native (OLE) documents and which are processed using the alternate graphic. Note: The Microsoft Powerpoint application sometimes does embed known Microsoft OLE embeddings (such as Visio, Project) as an "Unknown" type. To process these embeddings, the ProcessOLEEmbedAll option is required. Post Office-2003 products such as Office 2007 embeddings also fall into this category.

Specified by:: setProcessOLEEmbeddingMode in interface OptionsCache

Parameters:: ProcessOLEEmbeddingMode - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getProcessOLEEmbeddingMode

public Options.ProcessOLEEmbeddingModeValue getProcessOLEEmbeddingMode()

Description copied from interface: OptionsCache

Gets the ProcessOLEEmbeddingMode option. Microsoft Powerpoint versions from 1997 through 2003 had the capability to embed OLE documents in the Powerpoint files. This option controls which embeddings are to be processed as native (OLE) documents and which are processed using the alternate graphic. Note: The Microsoft Powerpoint application sometimes does embed known Microsoft OLE embeddings (such as Visio, Project) as an "Unknown" type. To process these embeddings, the ProcessOLEEmbedAll option is required. Post Office-2003 products such as Office 2007 embeddings also fall into this category.

Specified by:: getProcessOLEEmbeddingMode in interface OptionsCache

Returns:: The current value for the ProcessOLEEmbeddingMode option

setDropPDFHyphens

public OptionsCache setDropPDFHyphens(boolean DropPDFHyphens)

Description copied from interface: OptionsCache

Sets the DropPDFHyphens option. This option controls whether or not the PDF filter will drop hyphens at the end of a line. Since most PDF-generating tools create them as generic dashes, it's impossible for Outside In to know if the hyphen is a syllable hyphen or part of a hyphenated word. When this option is set to TRUE, all hyphens at the end of lines will be dropped from the extracted text. Note: When this option is TRUE, the character counts for the extracted text may not match the counts used for rendering where the hyphens are required for rendering. This will affect annotations in rendering APIs.

Specified by:: setDropPDFHyphens in interface OptionsCache

Parameters:: DropPDFHyphens - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getDropPDFHyphens

public boolean getDropPDFHyphens()

Description copied from interface: OptionsCache

Gets the DropPDFHyphens option. This option controls whether or not the PDF filter will drop hyphens at the end of a line. Since most PDF-generating tools create them as generic dashes, it's impossible for Outside In to know if the hyphen is a syllable hyphen or part of a hyphenated word. When this option is set to TRUE, all hyphens at the end of lines will be dropped from the extracted text. Note: When this option is TRUE, the character counts for the extracted text may not match the counts used for rendering where the hyphens are required for rendering. This will affect annotations in rendering APIs.

Specified by:: getDropPDFHyphens in interface OptionsCache

Returns:: The current value for the DropPDFHyphens option

setApplyZLIBCompression

public OptionsCache setApplyZLIBCompression(boolean ApplyZLIBCompression)

Description copied from interface: OptionsCache

Sets the ApplyZLIBCompression option. This option determines if ZLIB compression will be applied to all object streams when generating the PDF output file.

Specified by:: setApplyZLIBCompression in interface OptionsCache

Parameters:: ApplyZLIBCompression - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getApplyZLIBCompression

public boolean getApplyZLIBCompression()

Description copied from interface: OptionsCache

Gets the ApplyZLIBCompression option. This option determines if ZLIB compression will be applied to all object streams when generating the PDF output file.

Specified by:: getApplyZLIBCompression in interface OptionsCache

Returns:: The current value for the ApplyZLIBCompression option

setInterlacedGIFs

public OptionsCache setInterlacedGIFs(boolean InterlacedGIFs)

Description copied from interface: OptionsCache

Sets the InterlacedGIFs option. This option allows the developer to specify interlaced or non-interlaced GIF output. Interlaced GIFs are useful when graphics are to be downloaded over slow Internet connections. They allow the browser to begin to render a low-resolution view of the graphic quickly and then increase the quality of the image as it is received. There is no real penalty for using interlaced graphics.

Specified by:: setInterlacedGIFs in interface OptionsCache

Parameters:: InterlacedGIFs - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getInterlacedGIFs

public boolean getInterlacedGIFs()

Description copied from interface: OptionsCache

Gets the InterlacedGIFs option. This option allows the developer to specify interlaced or non-interlaced GIF output. Interlaced GIFs are useful when graphics are to be downloaded over slow Internet connections. They allow the browser to begin to render a low-resolution view of the graphic quickly and then increase the quality of the image as it is received. There is no real penalty for using interlaced graphics.

Specified by:: getInterlacedGIFs in interface OptionsCache

Returns:: The current value for the InterlacedGIFs option

setCropToContent

public OptionsCache setCropToContent(boolean CropToContent)

Description copied from interface: OptionsCache

Sets the CropToContent option. When this option is true, Image Export crops whitespace from the edge of each output image. This includes margins and any unused space at the end of a page. This results in smaller output files without any loss of original input document content. If there is no content, then no cropping is performed.

Specified by:: setCropToContent in interface OptionsCache

Parameters:: CropToContent - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getCropToContent

public boolean getCropToContent()

Description copied from interface: OptionsCache

Gets the CropToContent option. When this option is true, Image Export crops whitespace from the edge of each output image. This includes margins and any unused space at the end of a page. This results in smaller output files without any loss of original input document content. If there is no content, then no cropping is performed.

Specified by:: getCropToContent in interface OptionsCache

Returns:: The current value for the CropToContent option

setGraphicHeight

public OptionsCache setGraphicHeight(long GraphicHeight)

Description copied from interface: OptionsCache

Sets the GraphicHeight option. This option defines the absolute height in pixels to which exported graphics will be resized. If this option is set and the GraphicWidth option is not, the width of the image will be calculated based on the aspect ratio of the source image. The developer should be aware that very large values for this option or GraphicWidth could produce images whose size exceeds available system memory, resulting in conversion failure. If you are exporting a non-graphic file (word processing, spreadsheet or archive) and the settings for GraphicHeight and GraphicWidth do not match the aspect ratio of the original document, the exported image will have whitespace added so that the original file's aspect ratio is maintained. The settings for the GraphicWidthLimit and GraphicWidthLimit options can override the setting for GraphicHeight.

Specified by:: setGraphicHeight in interface OptionsCache

Parameters:: GraphicHeight - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getGraphicHeight

public long getGraphicHeight()

Description copied from interface: OptionsCache

Gets the GraphicHeight option. This option defines the absolute height in pixels to which exported graphics will be resized. If this option is set and the GraphicWidth option is not, the width of the image will be calculated based on the aspect ratio of the source image. The developer should be aware that very large values for this option or GraphicWidth could produce images whose size exceeds available system memory, resulting in conversion failure. If you are exporting a non-graphic file (word processing, spreadsheet or archive) and the settings for GraphicHeight and GraphicWidth do not match the aspect ratio of the original document, the exported image will have whitespace added so that the original file's aspect ratio is maintained. The settings for the GraphicWidthLimit and GraphicWidthLimit options can override the setting for GraphicHeight.

Specified by:: getGraphicHeight in interface OptionsCache

Returns:: The current value for the GraphicHeight option

setGraphicHeightLimit

public OptionsCache setGraphicHeightLimit(long GraphicHeightLimit)

Description copied from interface: OptionsCache

Sets the GraphicHeightLimit option. This option allows a hard limit to be set for how tall in pixels an exported graphic may be. Any images taller than this limit will be resized to match the limit. It should be noted that regardless whether the GraphicWidthLimit option is set or not, any resized images will preserve their original aspect ratio. Note that this option differs from the behavior of setting the height of graphics in that it sets an upper limit on the image height. Images larger than this limit will be reduced to the limit value. However, images smaller than this height will not be enlarged when using this option. Setting the height using GraphicHeight causes all output images to be reduced or enlarged to be of the specified height. A value of zero is equivalent to no limit, which causes this option to be ignored.

Specified by:: setGraphicHeightLimit in interface OptionsCache

Parameters:: GraphicHeightLimit - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getGraphicHeightLimit

public long getGraphicHeightLimit()

Description copied from interface: OptionsCache

Gets the GraphicHeightLimit option. This option allows a hard limit to be set for how tall in pixels an exported graphic may be. Any images taller than this limit will be resized to match the limit. It should be noted that regardless whether the GraphicWidthLimit option is set or not, any resized images will preserve their original aspect ratio. Note that this option differs from the behavior of setting the height of graphics in that it sets an upper limit on the image height. Images larger than this limit will be reduced to the limit value. However, images smaller than this height will not be enlarged when using this option. Setting the height using GraphicHeight causes all output images to be reduced or enlarged to be of the specified height. A value of zero is equivalent to no limit, which causes this option to be ignored.

Specified by:: getGraphicHeightLimit in interface OptionsCache

Returns:: The current value for the GraphicHeightLimit option

setGraphicOutputDPI

public OptionsCache setGraphicOutputDPI(long GraphicOutputDPI)

Description copied from interface: OptionsCache

Sets the GraphicOutputDPI option. This option allows the user to specify the output graphics device's resolution in DPI and only applies to images whose size is specified in physical units (in/cm). For example, consider a 1" square, 100 DPI graphic that is to be rendered on a 50 DPI device (GraphicOutputDPI is set to 50). In this case, the size of the resulting TIFF, BMP, JPEG, GIF, or PNG will be 50 x 50 pixels. In addition, setting this option to 0(Maintain Source Image DPI), can be used to suppress any dimensional changes to an image. In other words, a 1" square, 100 DPI graphic will be converted to an image that is 100 x 100 pixels in size. This value indicates that the DPI of the output device is not important. It extracts the maximum resolution from the input image with the smallest exported image size. Setting this option to 0 may result in the creation of extremely large images. Be aware that there may be limitations in the system running this technology that could result in undesirably large bandwidth consumption or an error message. Additionally, an out of memory error message will be generated if system memory is insufficient to handle a particularly large image. Also note that setting this option to 0 will force the technology to use the DPI settings already present in raster images, but will use the current screen resolution as the DPI setting for any other type of input file. For some output graphic types, there may be a discrepancy between the value set by this option and the DPI value reported by some graphics applications. The discrepancy occurs when the output format uses metric units (DPM, or dots per meter) instead of English units (DPI, or dots per inch). Depending on how the graphics application performs rounding on meters to inches conversions, the DPI value reported may be 1 unit more than expected. An example of a format which may exhibit this problem is PNG. The maximum value that can be set is 2400 DPI.

Specified by:: setGraphicOutputDPI in interface OptionsCache

Parameters:: GraphicOutputDPI - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getGraphicOutputDPI

public long getGraphicOutputDPI()

Description copied from interface: OptionsCache

Gets the GraphicOutputDPI option. This option allows the user to specify the output graphics device's resolution in DPI and only applies to images whose size is specified in physical units (in/cm). For example, consider a 1" square, 100 DPI graphic that is to be rendered on a 50 DPI device (GraphicOutputDPI is set to 50). In this case, the size of the resulting TIFF, BMP, JPEG, GIF, or PNG will be 50 x 50 pixels. In addition, setting this option to 0(Maintain Source Image DPI), can be used to suppress any dimensional changes to an image. In other words, a 1" square, 100 DPI graphic will be converted to an image that is 100 x 100 pixels in size. This value indicates that the DPI of the output device is not important. It extracts the maximum resolution from the input image with the smallest exported image size. Setting this option to 0 may result in the creation of extremely large images. Be aware that there may be limitations in the system running this technology that could result in undesirably large bandwidth consumption or an error message. Additionally, an out of memory error message will be generated if system memory is insufficient to handle a particularly large image. Also note that setting this option to 0 will force the technology to use the DPI settings already present in raster images, but will use the current screen resolution as the DPI setting for any other type of input file. For some output graphic types, there may be a discrepancy between the value set by this option and the DPI value reported by some graphics applications. The discrepancy occurs when the output format uses metric units (DPM, or dots per meter) instead of English units (DPI, or dots per inch). Depending on how the graphics application performs rounding on meters to inches conversions, the DPI value reported may be 1 unit more than expected. An example of a format which may exhibit this problem is PNG. The maximum value that can be set is 2400 DPI.

Specified by:: getGraphicOutputDPI in interface OptionsCache

Returns:: The current value for the GraphicOutputDPI option

setGraphicSizeLimit

public OptionsCache setGraphicSizeLimit(long GraphicSizeLimit)

Description copied from interface: OptionsCache

Sets the GraphicSizeLimit option. This option is used to set the maximum size of the exported graphic in pixels. It may be used to prevent inordinately large graphics from being converted to equally cumbersome output files, thus preventing bandwidth waste. This option takes precedence over all other options and settings that affect the size of a converted graphic. When creating a multi-page TIFF file, this limit is applied on a per page basis. It is not a pixel limit on the entire output file.

Specified by:: setGraphicSizeLimit in interface OptionsCache

Parameters:: GraphicSizeLimit - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getGraphicSizeLimit

public long getGraphicSizeLimit()

Description copied from interface: OptionsCache

Gets the GraphicSizeLimit option. This option is used to set the maximum size of the exported graphic in pixels. It may be used to prevent inordinately large graphics from being converted to equally cumbersome output files, thus preventing bandwidth waste. This option takes precedence over all other options and settings that affect the size of a converted graphic. When creating a multi-page TIFF file, this limit is applied on a per page basis. It is not a pixel limit on the entire output file.

Specified by:: getGraphicSizeLimit in interface OptionsCache

Returns:: The current value for the GraphicSizeLimit option

setTransparencyColor

public OptionsCache setTransparencyColor(ColorInfo TransparencyColor)

Description copied from interface: OptionsCache

Sets the TransparencyColor option. This option allows the user to set the color used as the "transparency color" in the output graphic file. Naturally, this option is only used when the selected output graphic file format supports transparency (GIF and PNG only). If the option is not set, the default behavior is to use the same color value that the input file used as the transparency color.

Specified by:: setTransparencyColor in interface OptionsCache

Parameters:: TransparencyColor - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getTransparencyColor

public ColorInfo getTransparencyColor()

Description copied from interface: OptionsCache

Gets the TransparencyColor option. This option allows the user to set the color used as the "transparency color" in the output graphic file. Naturally, this option is only used when the selected output graphic file format supports transparency (GIF and PNG only). If the option is not set, the default behavior is to use the same color value that the input file used as the transparency color.

Specified by:: getTransparencyColor in interface OptionsCache

Returns:: The current value for the TransparencyColor option

setGraphicWidth

public OptionsCache setGraphicWidth(long GraphicWidth)

Description copied from interface: OptionsCache

Sets the GraphicWidth option. This option defines the absolute width in pixels to which exported graphics will be resized. If this option is set and the GraphicHeight option is not, the height of the image will be calculated based on the aspect ratio of the source image. The developer should be aware that very large values for this option or GraphicWidth could produce images whose size exceeds available system memory, resulting in conversion failure. If you are exporting a non-graphic file (word processing, spreadsheet or archive) and the settings for GraphicHeight and GraphicWidth do not match the aspect ratio of the original document, the exported image will have whitespace added so that the original file's aspect ratio is maintained. The settings for the GraphicWidthLimit and GraphicWidthLimit options can override the setting for GraphicHeight.

Specified by:: setGraphicWidth in interface OptionsCache

Parameters:: GraphicWidth - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getGraphicWidth

public long getGraphicWidth()

Description copied from interface: OptionsCache

Gets the GraphicWidth option. This option defines the absolute width in pixels to which exported graphics will be resized. If this option is set and the GraphicHeight option is not, the height of the image will be calculated based on the aspect ratio of the source image. The developer should be aware that very large values for this option or GraphicWidth could produce images whose size exceeds available system memory, resulting in conversion failure. If you are exporting a non-graphic file (word processing, spreadsheet or archive) and the settings for GraphicHeight and GraphicWidth do not match the aspect ratio of the original document, the exported image will have whitespace added so that the original file's aspect ratio is maintained. The settings for the GraphicWidthLimit and GraphicWidthLimit options can override the setting for GraphicHeight.

Specified by:: getGraphicWidth in interface OptionsCache

Returns:: The current value for the GraphicWidth option

setGraphicWidthLimit

public OptionsCache setGraphicWidthLimit(long GraphicWidthLimit)

Description copied from interface: OptionsCache

Sets the GraphicWidthLimit option. This option allows a hard limit to be set for how wide in pixels an exported graphic may be. Any images wider than this limit will be resized to match the limit. It should be noted that regardless whether the GraphicHeightLimit option is set or not, any resized images will preserve their original aspect ratio. Note that this option differs from the behavior of setting the width of graphics by using GraphicWidth in that it sets an upper limit on the image width. Images larger than this limit will be reduced to the limit value. However, images smaller than this width will not be enlarged when using this option. Setting the width using GraphicWidth causes all output images to be reduced or enlarged to be of the specified width.

Specified by:: setGraphicWidthLimit in interface OptionsCache

Parameters:: GraphicWidthLimit - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getGraphicWidthLimit

public long getGraphicWidthLimit()

Description copied from interface: OptionsCache

Gets the GraphicWidthLimit option. This option allows a hard limit to be set for how wide in pixels an exported graphic may be. Any images wider than this limit will be resized to match the limit. It should be noted that regardless whether the GraphicHeightLimit option is set or not, any resized images will preserve their original aspect ratio. Note that this option differs from the behavior of setting the width of graphics by using GraphicWidth in that it sets an upper limit on the image width. Images larger than this limit will be reduced to the limit value. However, images smaller than this width will not be enlarged when using this option. Setting the width using GraphicWidth causes all output images to be reduced or enlarged to be of the specified width.

Specified by:: getGraphicWidthLimit in interface OptionsCache

Returns:: The current value for the GraphicWidthLimit option

setGraphicRenderAsPage

public OptionsCache setGraphicRenderAsPage(boolean GraphicRenderAsPage)

Description copied from interface: OptionsCache

Sets the GraphicRenderAsPage option. This option affects the way raster (bitmapped) images such as TIFF, JPG, and PNG are handled. The default behavior for Image Export is to export such images as copies of the input document, scaled according to the width and height options set by the caller. If this option is set to true, the output produced by Image Export will look like a printed page, with the image placed on a white rectangle representing a "virtual page." As usual, the dimensions of the entire image, including the virtual page, will be controlled by the normal Image Export output width and height settings. The margins into which the image will be placed will be controlled by existing Outside In print margin options. The image itself will be attempted to be scaled to its true (physical) size, or scaled down to fit within the margins if necessary.

Specified by:: setGraphicRenderAsPage in interface OptionsCache

Parameters:: GraphicRenderAsPage - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getGraphicRenderAsPage

public boolean getGraphicRenderAsPage()

Description copied from interface: OptionsCache

Gets the GraphicRenderAsPage option. This option affects the way raster (bitmapped) images such as TIFF, JPG, and PNG are handled. The default behavior for Image Export is to export such images as copies of the input document, scaled according to the width and height options set by the caller. If this option is set to true, the output produced by Image Export will look like a printed page, with the image placed on a white rectangle representing a "virtual page." As usual, the dimensions of the entire image, including the virtual page, will be controlled by the normal Image Export output width and height settings. The margins into which the image will be placed will be controlled by existing Outside In print margin options. The image itself will be attempted to be scaled to its true (physical) size, or scaled down to fit within the margins if necessary.

Specified by:: getGraphicRenderAsPage in interface OptionsCache

Returns:: The current value for the GraphicRenderAsPage option

setGraphicSizeMethod

public OptionsCache setGraphicSizeMethod(Options.GraphicSizeMethodValue GraphicSizeMethod)

Description copied from interface: OptionsCache

Sets the GraphicSizeMethod option. Option to determine the method used to size graphics

Specified by:: setGraphicSizeMethod in interface OptionsCache

Parameters:: GraphicSizeMethod - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getGraphicSizeMethod

public Options.GraphicSizeMethodValue getGraphicSizeMethod()

Description copied from interface: OptionsCache

Gets the GraphicSizeMethod option. Option to determine the method used to size graphics

Specified by:: getGraphicSizeMethod in interface OptionsCache

Returns:: The current value for the GraphicSizeMethod option

setTIFFColorSpace

public OptionsCache setTIFFColorSpace(Options.TIFFColorSpaceValue TIFFColorSpace)

Description copied from interface: OptionsCache

Sets the TIFFColorSpace option. This option will specify the color depth and color options in the TIFF File that is generated.

Specified by:: setTIFFColorSpace in interface OptionsCache

Parameters:: TIFFColorSpace - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getTIFFColorSpace

public Options.TIFFColorSpaceValue getTIFFColorSpace()

Description copied from interface: OptionsCache

Gets the TIFFColorSpace option. This option will specify the color depth and color options in the TIFF File that is generated.

Specified by:: getTIFFColorSpace in interface OptionsCache

Returns:: The current value for the TIFFColorSpace option

setTIFFCompression

public OptionsCache setTIFFCompression(Options.TIFFCompressionValue TIFFCompression)

Description copied from interface: OptionsCache

Sets the TIFFCompression option. This option will specify the type of compression used in the TIFF file that is generated.

Specified by:: setTIFFCompression in interface OptionsCache

Parameters:: TIFFCompression - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getTIFFCompression

public Options.TIFFCompressionValue getTIFFCompression()

Description copied from interface: OptionsCache

Gets the TIFFCompression option. This option will specify the type of compression used in the TIFF file that is generated.

Specified by:: getTIFFCompression in interface OptionsCache

Returns:: The current value for the TIFFCompression option

setTIFFMultiPage

public OptionsCache setTIFFMultiPage(boolean TIFFMultiPage)

Description copied from interface: OptionsCache

Sets the TIFFMultiPage option. When this option is set to true, the output of multiple pages from one input document will generate a single file with a separate image for each page converted.

Specified by:: setTIFFMultiPage in interface OptionsCache

Parameters:: TIFFMultiPage - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getTIFFMultiPage

public boolean getTIFFMultiPage()

Description copied from interface: OptionsCache

Gets the TIFFMultiPage option. When this option is set to true, the output of multiple pages from one input document will generate a single file with a separate image for each page converted.

Specified by:: getTIFFMultiPage in interface OptionsCache

Returns:: The current value for the TIFFMultiPage option

setTIFFByteOrder

public OptionsCache setTIFFByteOrder(Options.TIFFByteOrderValue TIFFByteOrder)

Description copied from interface: OptionsCache

Sets the TIFFByteOrder option. This option determines the byte order used within the TIFF file that is generated.

Specified by:: setTIFFByteOrder in interface OptionsCache

Parameters:: TIFFByteOrder - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getTIFFByteOrder

public Options.TIFFByteOrderValue getTIFFByteOrder()

Description copied from interface: OptionsCache

Gets the TIFFByteOrder option. This option determines the byte order used within the TIFF file that is generated.

Specified by:: getTIFFByteOrder in interface OptionsCache

Returns:: The current value for the TIFFByteOrder option

setTIFFFillOrder

public OptionsCache setTIFFFillOrder(Options.TIFFFillOrderValue TIFFFillOrder)

Description copied from interface: OptionsCache

Sets the TIFFFillOrder option. This option determines the fill order used within the TIFF file that is generated.

Specified by:: setTIFFFillOrder in interface OptionsCache

Parameters:: TIFFFillOrder - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getTIFFFillOrder

public Options.TIFFFillOrderValue getTIFFFillOrder()

Description copied from interface: OptionsCache

Gets the TIFFFillOrder option. This option determines the fill order used within the TIFF file that is generated.

Specified by:: getTIFFFillOrder in interface OptionsCache

Returns:: The current value for the TIFFFillOrder option

setJPEGQuality

public OptionsCache setJPEGQuality(long JPEGQuality)
                            throws OutsideInException

Description copied from interface: OptionsCache

Sets the JPEGQuality option. This option allows the developer to specify the lossyness of JPEG compression when creating JPEG Files.

Specified by:: setJPEGQuality in interface OptionsCache

Parameters:: JPEGQuality - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)
Throws:: OutsideInException

getJPEGQuality

public long getJPEGQuality()

Description copied from interface: OptionsCache

Gets the JPEGQuality option. This option allows the developer to specify the lossyness of JPEG compression when creating JPEG Files.

Specified by:: getJPEGQuality in interface OptionsCache

Returns:: The current value for the JPEGQuality option

setQuickThumbnail

public OptionsCache setQuickThumbnail(boolean QuickThumbnail)

Description copied from interface: OptionsCache

Sets the QuickThumbnail option. When this option is set to true the technology will render scaled images with a focus on speed and reduced overall memory usage. This focus on speed and memory usage, in some cases, will cause the resulting images to be less readable than when this option is set to false.

Specified by:: setQuickThumbnail in interface OptionsCache

Parameters:: QuickThumbnail - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getQuickThumbnail

public boolean getQuickThumbnail()

Description copied from interface: OptionsCache

Gets the QuickThumbnail option. When this option is set to true the technology will render scaled images with a focus on speed and reduced overall memory usage. This focus on speed and memory usage, in some cases, will cause the resulting images to be less readable than when this option is set to false.

Specified by:: getQuickThumbnail in interface OptionsCache

Returns:: The current value for the QuickThumbnail option

setImagePassthrough

public OptionsCache setImagePassthrough(boolean ImagePassthrough)

Description copied from interface: OptionsCache

Sets the ImagePassthrough option. This feature is used to allow certain input files to circumvent the normal filtering process and to be 'wrapped' in a PDF output file directly. This allows for much faster exporting of the supported file formats, which for release 8.4 are JPEG, JPEG2000, and TIFF.

Specified by:: setImagePassthrough in interface OptionsCache

Parameters:: ImagePassthrough - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getImagePassthrough

public boolean getImagePassthrough()

Description copied from interface: OptionsCache

Gets the ImagePassthrough option. This feature is used to allow certain input files to circumvent the normal filtering process and to be 'wrapped' in a PDF output file directly. This allows for much faster exporting of the supported file formats, which for release 8.4 are JPEG, JPEG2000, and TIFF.

Specified by:: getImagePassthrough in interface OptionsCache

Returns:: The current value for the ImagePassthrough option

setAcceptAlternateGraphics

public OptionsCache setAcceptAlternateGraphics(boolean AcceptAlternateGraphics)

Description copied from interface: OptionsCache

Sets the AcceptAlternateGraphics option. This option enables an optimization in XML Export's graphics output when exporting embedded graphics from an input document. When this option is set to TRUE and the input document contains embedded graphics that are already in one of our supported output formats, they will be copied to output files rather than converted to the selected output format specified by the SCCOPT_GRAPHIC_TYPE option. For example, if this option is set to TRUE and the selected output graphics type is GIF, an input document's embedded JPEG graphic will be copied to a JPEG output file rather than being converted to the GIF format. The same behavior applies to all of XML Export's supported graphics output formats (currently GIF, JPEG, and PNG.) If this option is set to FALSE, all graphics output will be in the format specified by the SCCOPT_GRAPHIC_TYPE option. Note: When using this option, JPEG files will be transferred directly to their output file location, without being filtered. This presents the possibility that any JPEG viruses in the file can be transferred to that location, as well.

Specified by:: setAcceptAlternateGraphics in interface OptionsCache

Parameters:: AcceptAlternateGraphics - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getAcceptAlternateGraphics

public boolean getAcceptAlternateGraphics()

Description copied from interface: OptionsCache

Gets the AcceptAlternateGraphics option. This option enables an optimization in XML Export's graphics output when exporting embedded graphics from an input document. When this option is set to TRUE and the input document contains embedded graphics that are already in one of our supported output formats, they will be copied to output files rather than converted to the selected output format specified by the SCCOPT_GRAPHIC_TYPE option. For example, if this option is set to TRUE and the selected output graphics type is GIF, an input document's embedded JPEG graphic will be copied to a JPEG output file rather than being converted to the GIF format. The same behavior applies to all of XML Export's supported graphics output formats (currently GIF, JPEG, and PNG.) If this option is set to FALSE, all graphics output will be in the format specified by the SCCOPT_GRAPHIC_TYPE option. Note: When using this option, JPEG files will be transferred directly to their output file location, without being filtered. This presents the possibility that any JPEG viruses in the file can be transferred to that location, as well.

Specified by:: getAcceptAlternateGraphics in interface OptionsCache

Returns:: The current value for the AcceptAlternateGraphics option

setOutputGraphicType

public OptionsCache setOutputGraphicType(Options.OutputGraphicTypeValue OutputGraphicType)

Description copied from interface: OptionsCache

Sets the OutputGraphicType option. This option allows the developer to specify the format of the graphics produced by the technology. When setting this option, remember that the JPEG file format does not support transparency. Though the GIF file format supports transparency, it is limited to using only one of its 256 available colors to represent a transparent pixel ("index transparency"). PNG supports many types of transparency. The PNG files written by HTML Export are created so that various levels of transparency are possible for each pixel. This is achieved through the implementation of an 8-bit "alpha channel". There is a special optimization that HTML Export can make when this option is set to FI_NONE. Some of the Outside In Viewer Technology's import filters can be optimized to ignore certain types of graphics. To take advantage of this optimization, the option must be set before EXOpenExport is called. Note: SCCOPT_GRAPHIC_TYPE = FI_NONE must be set (via DASetOption) before the call to EXOpenExport. Otherwise, the SCCUT_FILTEROPTIMIZEDFORTEXT speed enhancement for the PDF filter is not set. This will result in slower exports of HTML Files when graphic output is not required. It should be noted that unpredictable and potentially undesirable output will occur if this option is set to FI_NONE when EXOpenExport is called and the template then attempts to use the {## option} macro to turn graphics back on. Users who wish to turn graphics on and off from the template should set this option after the call to EXOpenExport.

Specified by:: setOutputGraphicType in interface OptionsCache

Parameters:: OutputGraphicType - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getOutputGraphicType

public Options.OutputGraphicTypeValue getOutputGraphicType()

Description copied from interface: OptionsCache

Gets the OutputGraphicType option. This option allows the developer to specify the format of the graphics produced by the technology. When setting this option, remember that the JPEG file format does not support transparency. Though the GIF file format supports transparency, it is limited to using only one of its 256 available colors to represent a transparent pixel ("index transparency"). PNG supports many types of transparency. The PNG files written by HTML Export are created so that various levels of transparency are possible for each pixel. This is achieved through the implementation of an 8-bit "alpha channel". There is a special optimization that HTML Export can make when this option is set to FI_NONE. Some of the Outside In Viewer Technology's import filters can be optimized to ignore certain types of graphics. To take advantage of this optimization, the option must be set before EXOpenExport is called. Note: SCCOPT_GRAPHIC_TYPE = FI_NONE must be set (via DASetOption) before the call to EXOpenExport. Otherwise, the SCCUT_FILTEROPTIMIZEDFORTEXT speed enhancement for the PDF filter is not set. This will result in slower exports of HTML Files when graphic output is not required. It should be noted that unpredictable and potentially undesirable output will occur if this option is set to FI_NONE when EXOpenExport is called and the template then attempts to use the {## option} macro to turn graphics back on. Users who wish to turn graphics on and off from the template should set this option after the call to EXOpenExport.

Specified by:: getOutputGraphicType in interface OptionsCache

Returns:: The current value for the OutputGraphicType option

setDetectGrayScaleAsColor

public OptionsCache setDetectGrayScaleAsColor(boolean DetectGrayScaleAsColor)

Description copied from interface: OptionsCache

Sets the DetectGrayScaleAsColor option. Option to export grayscale content to color JPEGs or not.

Specified by:: setDetectGrayScaleAsColor in interface OptionsCache

Parameters:: DetectGrayScaleAsColor - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getDetectGrayScaleAsColor

public boolean getDetectGrayScaleAsColor()

Description copied from interface: OptionsCache

Gets the DetectGrayScaleAsColor option. Option to export grayscale content to color JPEGs or not.

Specified by:: getDetectGrayScaleAsColor in interface OptionsCache

Returns:: The current value for the DetectGrayScaleAsColor option

setPageFitMode

public OptionsCache setPageFitMode(Options.PageFitModeValue PageFitMode)

Description copied from interface: OptionsCache

Sets the PageFitMode option. This option scales a spreadsheet/database file to a certain percent or to a page width or height. However, in an effort to preserve readability after scaling, PDF Export will not shrink a database document to under approximately one-third of its original size. It should be noted that when this option is set to "NoMap", the pages of the database file are printed down first and then across. Please note that any margins applied as a result of settings for the "DefaultPrintMargins" option will be included in any scaling that is applied to the output image as a result of settings for this option.

Specified by:: setPageFitMode in interface OptionsCache

Parameters:: PageFitMode - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getPageFitMode

public Options.PageFitModeValue getPageFitMode()

Description copied from interface: OptionsCache

Gets the PageFitMode option. This option scales a spreadsheet/database file to a certain percent or to a page width or height. However, in an effort to preserve readability after scaling, PDF Export will not shrink a database document to under approximately one-third of its original size. It should be noted that when this option is set to "NoMap", the pages of the database file are printed down first and then across. Please note that any margins applied as a result of settings for the "DefaultPrintMargins" option will be included in any scaling that is applied to the output image as a result of settings for this option.

Specified by:: getPageFitMode in interface OptionsCache

Returns:: The current value for the PageFitMode option

setRenderGridlines

public OptionsCache setRenderGridlines(boolean RenderGridlines)

Description copied from interface: OptionsCache

Sets the RenderGridlines option. Option to generate lines between cells in the rendered images

Specified by:: setRenderGridlines in interface OptionsCache

Parameters:: RenderGridlines - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getRenderGridlines

public boolean getRenderGridlines()

Description copied from interface: OptionsCache

Gets the RenderGridlines option. Option to generate lines between cells in the rendered images

Specified by:: getRenderGridlines in interface OptionsCache

Returns:: The current value for the RenderGridlines option

setRenderHeadings

public OptionsCache setRenderHeadings(boolean RenderHeadings)

Description copied from interface: OptionsCache

Sets the RenderHeadings option. Option to print headings in the rendered images

Specified by:: setRenderHeadings in interface OptionsCache

Parameters:: RenderHeadings - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getRenderHeadings

public boolean getRenderHeadings()

Description copied from interface: OptionsCache

Gets the RenderHeadings option. Option to print headings in the rendered images

Specified by:: getRenderHeadings in interface OptionsCache

Returns:: The current value for the RenderHeadings option

setGridMaxPageHeight

public OptionsCache setGridMaxPageHeight(long GridMaxPageHeight)

Description copied from interface: OptionsCache

Sets the GridMaxPageHeight option. Normally, the size of pages generated from spreadsheet worksheets and database tables is limited to the size of the page defined by the input document's page size information and how the UseDocPageSettings option is set. If, after scaling is factored in, the resulting image is too large to fit on a single page, it is split up into multiple pages. The options GridMaxPageWidth and GridMaxPageHeight are used to change the size of a page to match the scaled size of the page being rendered - within limits. The key reason for those limits is that rendering very large pages can easily overwhelm the memory available on the system. When using this feature, a calculation should be made to be sure that the values passed in work within said memory limits. The values for these two options will override the current page dimensions if necessary. The memory needed may be calculated based on the following: memory = [max. worksheet/table height (in inches)] x [max. worksheet/table width (in inches)] x [dpi setting]2 x 3 bytes/pixel + a bit extra for the needs of the rest of the conversion. By default, these options are set to the current page dimensions. Users may choose to set only one of the two options if desired. If, for example, only the SCCOPT_ set only one of the two options if desired. If, for example, only the GridMaxPageWidth is set, then the height of the page will be based on the normal page height. When a worksheet or table is larger than the maximum values specified by these options, then the file is rendered on multiple pages, with the requested (larger) page dimensions. These new options grow the page size (if needed) to match the size of the worksheet or table.

Specified by:: setGridMaxPageHeight in interface OptionsCache

Parameters:: GridMaxPageHeight - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getGridMaxPageHeight

public long getGridMaxPageHeight()

Description copied from interface: OptionsCache

Gets the GridMaxPageHeight option. Normally, the size of pages generated from spreadsheet worksheets and database tables is limited to the size of the page defined by the input document's page size information and how the UseDocPageSettings option is set. If, after scaling is factored in, the resulting image is too large to fit on a single page, it is split up into multiple pages. The options GridMaxPageWidth and GridMaxPageHeight are used to change the size of a page to match the scaled size of the page being rendered - within limits. The key reason for those limits is that rendering very large pages can easily overwhelm the memory available on the system. When using this feature, a calculation should be made to be sure that the values passed in work within said memory limits. The values for these two options will override the current page dimensions if necessary. The memory needed may be calculated based on the following: memory = [max. worksheet/table height (in inches)] x [max. worksheet/table width (in inches)] x [dpi setting]2 x 3 bytes/pixel + a bit extra for the needs of the rest of the conversion. By default, these options are set to the current page dimensions. Users may choose to set only one of the two options if desired. If, for example, only the SCCOPT_ set only one of the two options if desired. If, for example, only the GridMaxPageWidth is set, then the height of the page will be based on the normal page height. When a worksheet or table is larger than the maximum values specified by these options, then the file is rendered on multiple pages, with the requested (larger) page dimensions. These new options grow the page size (if needed) to match the size of the worksheet or table.

Specified by:: getGridMaxPageHeight in interface OptionsCache

Returns:: The current value for the GridMaxPageHeight option

setGridMaxPageWidth

public OptionsCache setGridMaxPageWidth(long GridMaxPageWidth)

Description copied from interface: OptionsCache

Sets the GridMaxPageWidth option. Normally, the size of pages generated from spreadsheet worksheets and database tables is limited to the size of the page defined by the input document's page size information and how the UseDocPageSettings option is set. If, after scaling is factored in, the resulting image is too large to fit on a single page, it is split up into multiple pages. The options GridMaxPageWidth and GridMaxPageHeight are used to change the size of a page to match the scaled size of the page being rendered - within limits. The key reason for those limits is that rendering very large pages can easily overwhelm the memory available on the system. When using this feature, a calculation should be made to be sure that the values passed in work within said memory limits. The values for these two options will override the current page dimensions if necessary. The memory needed may be calculated based on the following: memory = [max. worksheet/table height (in inches)] x [max. worksheet/table width (in inches)] x [dpi setting]2 x 3 bytes/pixel + a bit extra for the needs of the rest of the conversion. By default, these options are set to the current page dimensions. Users may choose to set only one of the two options if desired. If, for example, only the SCCOPT_ set only one of the two options if desired. If, for example, only the GridMaxPageWidth is set, then the height of the page will be based on the normal page height. When a worksheet or table is larger than the maximum values specified by these options, then the file is rendered on multiple pages, with the requested (larger) page dimensions. These new options grow the page size (if needed) to match the size of the worksheet or table.

Specified by:: setGridMaxPageWidth in interface OptionsCache

Parameters:: GridMaxPageWidth - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getGridMaxPageWidth

public long getGridMaxPageWidth()

Description copied from interface: OptionsCache

Gets the GridMaxPageWidth option. Normally, the size of pages generated from spreadsheet worksheets and database tables is limited to the size of the page defined by the input document's page size information and how the UseDocPageSettings option is set. If, after scaling is factored in, the resulting image is too large to fit on a single page, it is split up into multiple pages. The options GridMaxPageWidth and GridMaxPageHeight are used to change the size of a page to match the scaled size of the page being rendered - within limits. The key reason for those limits is that rendering very large pages can easily overwhelm the memory available on the system. When using this feature, a calculation should be made to be sure that the values passed in work within said memory limits. The values for these two options will override the current page dimensions if necessary. The memory needed may be calculated based on the following: memory = [max. worksheet/table height (in inches)] x [max. worksheet/table width (in inches)] x [dpi setting]2 x 3 bytes/pixel + a bit extra for the needs of the rest of the conversion. By default, these options are set to the current page dimensions. Users may choose to set only one of the two options if desired. If, for example, only the SCCOPT_ set only one of the two options if desired. If, for example, only the GridMaxPageWidth is set, then the height of the page will be based on the normal page height. When a worksheet or table is larger than the maximum values specified by these options, then the file is rendered on multiple pages, with the requested (larger) page dimensions. These new options grow the page size (if needed) to match the size of the worksheet or table.

Specified by:: getGridMaxPageWidth in interface OptionsCache

Returns:: The current value for the GridMaxPageWidth option

setPageDirection

public OptionsCache setPageDirection(Options.PageDirectionValue PageDirection)

Description copied from interface: OptionsCache

Sets the PageDirection option. This option controls the pattern in which the pages are rendered, either across first and then down, or down first and then across. This option is overridden when the UseDocPageSettings option is set to true and print direction is specified in the input document.

Specified by:: setPageDirection in interface OptionsCache

Parameters:: PageDirection - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getPageDirection

public Options.PageDirectionValue getPageDirection()

Description copied from interface: OptionsCache

Gets the PageDirection option. This option controls the pattern in which the pages are rendered, either across first and then down, or down first and then across. This option is overridden when the UseDocPageSettings option is set to true and print direction is specified in the input document.

Specified by:: getPageDirection in interface OptionsCache

Returns:: The current value for the PageDirection option

setPageScalePercent

public OptionsCache setPageScalePercent(long PageScalePercent)
                                 throws OutsideInException

Description copied from interface: OptionsCache

Sets the PageScalePercent option. This option will scale spreadsheet pages by the percentage specified. The option has no effect unless the PageFitMode option is set to ScaleToPercent. This option must take a value between 1 and 100. If any value outside of this range is used, the option will be ignored.

Specified by:: setPageScalePercent in interface OptionsCache

Parameters:: PageScalePercent - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)
Throws:: OutsideInException

getPageScalePercent

public long getPageScalePercent()

Description copied from interface: OptionsCache

Gets the PageScalePercent option. This option will scale spreadsheet pages by the percentage specified. The option has no effect unless the PageFitMode option is set to ScaleToPercent. This option must take a value between 1 and 100. If any value outside of this range is used, the option will be ignored.

Specified by:: getPageScalePercent in interface OptionsCache

Returns:: The current value for the PageScalePercent option

setFitHeightToPages

public OptionsCache setFitHeightToPages(long FitHeightToPages)

Description copied from interface: OptionsCache

Sets the FitHeightToPages option. This option will fit the spreadsheet image to the number of vertical pages specified. The setting for this option will have no effect unless the PageFitMode option is set to ScaleToPagesSpecified.

Specified by:: setFitHeightToPages in interface OptionsCache

Parameters:: FitHeightToPages - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getFitHeightToPages

public long getFitHeightToPages()

Description copied from interface: OptionsCache

Gets the FitHeightToPages option. This option will fit the spreadsheet image to the number of vertical pages specified. The setting for this option will have no effect unless the PageFitMode option is set to ScaleToPagesSpecified.

Specified by:: getFitHeightToPages in interface OptionsCache

Returns:: The current value for the FitHeightToPages option

setFitWidthToPages

public OptionsCache setFitWidthToPages(long FitWidthToPages)

Description copied from interface: OptionsCache

Sets the FitWidthToPages option. This option will fit the spreadsheet image to the number of horizontal pages specified. The setting for this option will have no effect unless the PageFitMode option is set to ScaleToPagesSpecified.

Specified by:: setFitWidthToPages in interface OptionsCache

Parameters:: FitWidthToPages - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getFitWidthToPages

public long getFitWidthToPages()

Description copied from interface: OptionsCache

Gets the FitWidthToPages option. This option will fit the spreadsheet image to the number of horizontal pages specified. The setting for this option will have no effect unless the PageFitMode option is set to ScaleToPagesSpecified.

Specified by:: getFitWidthToPages in interface OptionsCache

Returns:: The current value for the FitWidthToPages option

setShowHiddenCells

public OptionsCache setShowHiddenCells(boolean ShowHiddenCells)

Description copied from interface: OptionsCache

Sets the ShowHiddenCells option. This option lets you determine whether or not to show hidden rows or columns when rendering spreadsheets. It is used to expand the widths of cells that are hidden by virtue of having their row height or column width reduced to 0. Setting this option to false will leave the data hidden. Setting this option to true will show all hidden rows and columns, displayed using the default row width or default column height.

Specified by:: setShowHiddenCells in interface OptionsCache

Parameters:: ShowHiddenCells - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getShowHiddenCells

public boolean getShowHiddenCells()

Description copied from interface: OptionsCache

Gets the ShowHiddenCells option. This option lets you determine whether or not to show hidden rows or columns when rendering spreadsheets. It is used to expand the widths of cells that are hidden by virtue of having their row height or column width reduced to 0. Setting this option to false will leave the data hidden. Setting this option to true will show all hidden rows and columns, displayed using the default row width or default column height.

Specified by:: getShowHiddenCells in interface OptionsCache

Returns:: The current value for the ShowHiddenCells option

setShowColumnHeadings

public OptionsCache setShowColumnHeadings(boolean ShowColumnHeadings)

Description copied from interface: OptionsCache

Sets the ShowColumnHeadings option. When this option is set to true, row and column headings ("1", "2", "3" / "A", "B", "C") are included in the output for spreadsheet and database files. When set to false, no row and column headings are created.

Specified by:: setShowColumnHeadings in interface OptionsCache

Parameters:: ShowColumnHeadings - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getShowColumnHeadings

public boolean getShowColumnHeadings()

Description copied from interface: OptionsCache

Gets the ShowColumnHeadings option. When this option is set to true, row and column headings ("1", "2", "3" / "A", "B", "C") are included in the output for spreadsheet and database files. When set to false, no row and column headings are created.

Specified by:: getShowColumnHeadings in interface OptionsCache

Returns:: The current value for the ShowColumnHeadings option

setBorderMode

public OptionsCache setBorderMode(Options.BorderModeValue BorderMode)

Description copied from interface: OptionsCache

Sets the BorderMode option. This option determines how borders will be handled for spreadsheet and database files. There are three valid values for this option: CreateIfMissing: If a CSS output flavor is in use, this forces borders to be created if none are present in the (entire) table. By default, most apps do not include borders when creating these types of files. When needed, HTML Export will generate thin borders between cells. Otherwise, the borders specified in the table are used. Using borders makes it easier to read the output data by preventing values from running together when there is not much space between cells. This output appears in a browser in a format similar to that used by the original application when displaying the file on-screen. If a CSS output flavor is not in use, then borders are put around all cells no matter how the input document is formatted. This is because individual cell border information may not be specified in HTML without CSS. Off: This setting forces the borders always to be off, regardless of borders specified in the source document. This option setting does not distinguish between CSS and non-CSS output flavors being used. Turning borders off has the following advantages: - It allows HTML Export to use optimizations that speed up the conversion of large, sparse files. It does this by enabling rowspan and colspan table tag attributes to be used to span empty cells. It also reduces the amount of HTML needed to be written for individual cells. For large, mostly empty spreadsheets, this can result in greatly reduced conversion time and output file size(s). The output appears in a format similar to that used by the original application when printing the file. - For left aligned text and data cells, a special optimization has been made to merge those cells with any empty cells on the right. The following caveats apply to the optimization: - If the spreadsheet being processed stores data by row (such as Microsoft Excel spreadsheets with portrait page orientation) rather than by column (such as Quattro files), additional optimizations are possible. The technology will use colspan to shrink the output when two or more adjacent cells in a row are empty. When two or more adjacent rows are completely empty, the rows are skipped, and the row height of the next non-empty row is increased. - Note that if there are merged cells in the input document, the technology will not produce perfectly optimized output. Instead, colspan will not be used to compress empty cells until after the merged cells are processed. - The behavior of this option setting matches the old border behavior of the now discontinued SCCOPT_EX_SHOWSPREADSHEETBORDER option when it was set to FALSE. However, this option does not disable the creation of Row and Column headings ("1", "2", "3" / "A", "B", "C"). To do that, use the new SCCOPT_EX_SSDBROWCOLHEADINGS option. - If the current row has frames in it, we will not span those cells. SCCEX_SSDBBORDERS_USESOURCE: If a CSS output flavor is being used, then this value sets the borders according to what is specified in the source document. If a CSS output flavor is not in use, then borders are put around all cells no matter how the input document is formatted. This is because individual cell border information may not be specified in HTML without CSS.

Specified by:: setBorderMode in interface OptionsCache

Parameters:: BorderMode - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getBorderMode

public Options.BorderModeValue getBorderMode()

Description copied from interface: OptionsCache

Gets the BorderMode option. This option determines how borders will be handled for spreadsheet and database files. There are three valid values for this option: CreateIfMissing: If a CSS output flavor is in use, this forces borders to be created if none are present in the (entire) table. By default, most apps do not include borders when creating these types of files. When needed, HTML Export will generate thin borders between cells. Otherwise, the borders specified in the table are used. Using borders makes it easier to read the output data by preventing values from running together when there is not much space between cells. This output appears in a browser in a format similar to that used by the original application when displaying the file on-screen. If a CSS output flavor is not in use, then borders are put around all cells no matter how the input document is formatted. This is because individual cell border information may not be specified in HTML without CSS. Off: This setting forces the borders always to be off, regardless of borders specified in the source document. This option setting does not distinguish between CSS and non-CSS output flavors being used. Turning borders off has the following advantages: - It allows HTML Export to use optimizations that speed up the conversion of large, sparse files. It does this by enabling rowspan and colspan table tag attributes to be used to span empty cells. It also reduces the amount of HTML needed to be written for individual cells. For large, mostly empty spreadsheets, this can result in greatly reduced conversion time and output file size(s). The output appears in a format similar to that used by the original application when printing the file. - For left aligned text and data cells, a special optimization has been made to merge those cells with any empty cells on the right. The following caveats apply to the optimization: - If the spreadsheet being processed stores data by row (such as Microsoft Excel spreadsheets with portrait page orientation) rather than by column (such as Quattro files), additional optimizations are possible. The technology will use colspan to shrink the output when two or more adjacent cells in a row are empty. When two or more adjacent rows are completely empty, the rows are skipped, and the row height of the next non-empty row is increased. - Note that if there are merged cells in the input document, the technology will not produce perfectly optimized output. Instead, colspan will not be used to compress empty cells until after the merged cells are processed. - The behavior of this option setting matches the old border behavior of the now discontinued SCCOPT_EX_SHOWSPREADSHEETBORDER option when it was set to FALSE. However, this option does not disable the creation of Row and Column headings ("1", "2", "3" / "A", "B", "C"). To do that, use the new SCCOPT_EX_SSDBROWCOLHEADINGS option. - If the current row has frames in it, we will not span those cells. SCCEX_SSDBBORDERS_USESOURCE: If a CSS output flavor is being used, then this value sets the borders according to what is specified in the source document. If a CSS output flavor is not in use, then borders are put around all cells no matter how the input document is formatted. This is because individual cell border information may not be specified in HTML without CSS.

Specified by:: getBorderMode in interface OptionsCache

Returns:: The current value for the BorderMode option

setSuppressEmptyCells

public OptionsCache setSuppressEmptyCells(boolean SuppressEmptyCells)

Description copied from interface: OptionsCache

Sets the SuppressEmptyCells option. Option to suppress blank cells to the right and bottom of the last data cell.

Specified by:: setSuppressEmptyCells in interface OptionsCache

Parameters:: SuppressEmptyCells - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getSuppressEmptyCells

public boolean getSuppressEmptyCells()

Description copied from interface: OptionsCache

Gets the SuppressEmptyCells option. Option to suppress blank cells to the right and bottom of the last data cell.

Specified by:: getSuppressEmptyCells in interface OptionsCache

Returns:: The current value for the SuppressEmptyCells option

setDefaultPageSize

public OptionsCache setDefaultPageSize(PageInfo DefaultPageSize)

Description copied from interface: OptionsCache

Sets the DefaultPageSize option. This option allows the developer to specify the size of each page in the generated output file. The size may be specified in inches, points, centimeters or picas. This option is only valid when UseDocumentPageSettings is set to false. 1 inch = 6 picas = 72 points = ~ 2.54 cm.

Specified by:: setDefaultPageSize in interface OptionsCache

Parameters:: DefaultPageSize - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getDefaultPageSize

public PageInfo getDefaultPageSize()

Description copied from interface: OptionsCache

Gets the DefaultPageSize option. This option allows the developer to specify the size of each page in the generated output file. The size may be specified in inches, points, centimeters or picas. This option is only valid when UseDocumentPageSettings is set to false. 1 inch = 6 picas = 72 points = ~ 2.54 cm.

Specified by:: getDefaultPageSize in interface OptionsCache

Returns:: The current value for the DefaultPageSize option

setDefaultPageMargins

public OptionsCache setDefaultPageMargins(Margins DefaultPageMargins)

Description copied from interface: OptionsCache

Sets the DefaultPageMargins option. This option specifies the top, left, bottom and right margins in twips from the edges of the page. For instance, setting all the values to 1440 creates a 1-inch margin on all sides. Page margins will only be applied when formatting word processing, database and spreadsheet files. Please note all margins are applied before scaling with the PageFitMode option. This option is overridden when the UseDocumentPageSettings option is set to true and print margins are specified in the input document. This option does not affect the output of bitmap, presentation, vector or archive files.

Specified by:: setDefaultPageMargins in interface OptionsCache

Parameters:: DefaultPageMargins - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getDefaultPageMargins

public Margins getDefaultPageMargins()

Description copied from interface: OptionsCache

Gets the DefaultPageMargins option. This option specifies the top, left, bottom and right margins in twips from the edges of the page. For instance, setting all the values to 1440 creates a 1-inch margin on all sides. Page margins will only be applied when formatting word processing, database and spreadsheet files. Please note all margins are applied before scaling with the PageFitMode option. This option is overridden when the UseDocumentPageSettings option is set to true and print margins are specified in the input document. This option does not affect the output of bitmap, presentation, vector or archive files.

Specified by:: getDefaultPageMargins in interface OptionsCache

Returns:: The current value for the DefaultPageMargins option

setUseDocumentPageSettings

public OptionsCache setUseDocumentPageSettings(boolean UseDocumentPageSettings)

Description copied from interface: OptionsCache

Sets the UseDocumentPageSettings option. This option is used to select the document's page layout information when rendering. If true, the document's native (or author selected) page margins, paper size, page scaling and page orientation are used when available from the filter. The values of the DefaultPrintMargins, RenderGridlines, RenderHeadings, PageDirection, and PageFitMode options are overridden if this option is set to true and the properties associated with those options are specified in the input document. Additionally, print area and page breaks in spreadsheet documents are ignored unless this option is set to true. If false, the page margins, size, orientation and scaling are set to specific values rather than those in the native document. The page size is forced to 8 1/2" x 11" in portrait orientation, but this may be changed by setting the GraphicHeight and/or GraphicWidth options. The margins are forced 1" all around, but may be changed by setting the defaultMargins option. The scaling for the document will be set to 100%, although this may be changed by setting any of the various scaling options. It should be noted that this option also affects page orientation for both input spreadsheets and word processing documents.

Specified by:: setUseDocumentPageSettings in interface OptionsCache

Parameters:: UseDocumentPageSettings - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getUseDocumentPageSettings

public boolean getUseDocumentPageSettings()

Description copied from interface: OptionsCache

Gets the UseDocumentPageSettings option. This option is used to select the document's page layout information when rendering. If true, the document's native (or author selected) page margins, paper size, page scaling and page orientation are used when available from the filter. The values of the DefaultPrintMargins, RenderGridlines, RenderHeadings, PageDirection, and PageFitMode options are overridden if this option is set to true and the properties associated with those options are specified in the input document. Additionally, print area and page breaks in spreadsheet documents are ignored unless this option is set to true. If false, the page margins, size, orientation and scaling are set to specific values rather than those in the native document. The page size is forced to 8 1/2" x 11" in portrait orientation, but this may be changed by setting the GraphicHeight and/or GraphicWidth options. The margins are forced 1" all around, but may be changed by setting the defaultMargins option. The scaling for the document will be set to 100%, although this may be changed by setting any of the various scaling options. It should be noted that this option also affects page orientation for both input spreadsheets and word processing documents.

Specified by:: getUseDocumentPageSettings in interface OptionsCache

Returns:: The current value for the UseDocumentPageSettings option

setPageRange

public OptionsCache setPageRange(PageRange PageRange)

Description copied from interface: OptionsCache

Sets the PageRange option. This option indicates whether the whole file or a selected range of pages should be rendered.

Specified by:: setPageRange in interface OptionsCache

Parameters:: PageRange - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getPageRange

public PageRange getPageRange()

Description copied from interface: OptionsCache

Gets the PageRange option. This option indicates whether the whole file or a selected range of pages should be rendered.

Specified by:: getPageRange in interface OptionsCache

Returns:: The current value for the PageRange option

setLinearizePDFOutput

public OptionsCache setLinearizePDFOutput(boolean LinearizePDFOutput)

Description copied from interface: OptionsCache

Sets the LinearizePDFOutput option. option to produce linearized PDF Files

Specified by:: setLinearizePDFOutput in interface OptionsCache

Parameters:: LinearizePDFOutput - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getLinearizePDFOutput

public boolean getLinearizePDFOutput()

Description copied from interface: OptionsCache

Gets the LinearizePDFOutput option. option to produce linearized PDF Files

Specified by:: getLinearizePDFOutput in interface OptionsCache

Returns:: The current value for the LinearizePDFOutput option

setEmailHeaders

public OptionsCache setEmailHeaders(MailHeaders EmailHeaders)

Description copied from interface: OptionsCache

Sets the EmailHeaders option. Customized Mime Headers

Specified by:: setEmailHeaders in interface OptionsCache

Parameters:: EmailHeaders - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getEmailHeaders

public MailHeaders getEmailHeaders()

Description copied from interface: OptionsCache

Gets the EmailHeaders option. Customized Mime Headers

Specified by:: getEmailHeaders in interface OptionsCache

Returns:: The current value for the EmailHeaders option

setAppendEmailAttachments

public OptionsCache setAppendEmailAttachments(boolean AppendEmailAttachments)

Description copied from interface: OptionsCache

Sets the AppendEmailAttachments option. option to output email attachments as PDF Files

Specified by:: setAppendEmailAttachments in interface OptionsCache

Parameters:: AppendEmailAttachments - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getAppendEmailAttachments

public boolean getAppendEmailAttachments()

Description copied from interface: OptionsCache

Gets the AppendEmailAttachments option. option to output email attachments as PDF Files

Specified by:: getAppendEmailAttachments in interface OptionsCache

Returns:: The current value for the AppendEmailAttachments option

setStrokeOutText

public OptionsCache setStrokeOutText(boolean StrokeOutText)

Description copied from interface: OptionsCache

Sets the StrokeOutText option. This option is used to stroke out (display as graphical primitives) text in an AutoCAD file. Setting this option to FALSE would improve performance, but the visual fidelity may be compromised. If the export for the conversion is text only, text is never stroked out. If the export is not text only, and the drawing is perspective, text will always be stroked out (regardless of this option). This is due to the fact that in non-text only situations visual fidelity is of importance, and handling of textual objects in perspective drawings is more accurate with stroked out text. If the conversion is non-text only and the drawing is not perspective, this option determines if text should be stroked. Note that when this option is TRUE, some special characters appear as asterisks or question marks due to limited support of characters for stroking out text.

Specified by:: setStrokeOutText in interface OptionsCache

Parameters:: StrokeOutText - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getStrokeOutText

public boolean getStrokeOutText()

Description copied from interface: OptionsCache

Gets the StrokeOutText option. This option is used to stroke out (display as graphical primitives) text in an AutoCAD file. Setting this option to FALSE would improve performance, but the visual fidelity may be compromised. If the export for the conversion is text only, text is never stroked out. If the export is not text only, and the drawing is perspective, text will always be stroked out (regardless of this option). This is due to the fact that in non-text only situations visual fidelity is of importance, and handling of textual objects in perspective drawings is more accurate with stroked out text. If the conversion is non-text only and the drawing is not perspective, this option determines if text should be stroked. Note that when this option is TRUE, some special characters appear as asterisks or question marks due to limited support of characters for stroking out text.

Specified by:: getStrokeOutText in interface OptionsCache

Returns:: The current value for the StrokeOutText option

setRenderEmbeddedFonts

public OptionsCache setRenderEmbeddedFonts(boolean RenderEmbeddedFonts)

Description copied from interface: OptionsCache

Sets the RenderEmbeddedFonts option. This option allows you to disable the use of embedded fonts in PDF input files. If the option is set to true, the embedded fonts in the PDF input will be used to render text; if the option is set to false, the embedded fonts will not be used and the fallback is to use fonts available to Outside In to render text.

Specified by:: setRenderEmbeddedFonts in interface OptionsCache

Parameters:: RenderEmbeddedFonts - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getRenderEmbeddedFonts

public boolean getRenderEmbeddedFonts()

Description copied from interface: OptionsCache

Gets the RenderEmbeddedFonts option. This option allows you to disable the use of embedded fonts in PDF input files. If the option is set to true, the embedded fonts in the PDF input will be used to render text; if the option is set to false, the embedded fonts will not be used and the fallback is to use fonts available to Outside In to render text.

Specified by:: getRenderEmbeddedFonts in interface OptionsCache

Returns:: The current value for the RenderEmbeddedFonts option

setDefaultRenderFont

public OptionsCache setDefaultRenderFont(FontInfo DefaultRenderFont)

Description copied from interface: OptionsCache

Sets the DefaultRenderFont option. This option sets the font to use when the font specified by the filter is not available on the system.

Specified by:: setDefaultRenderFont in interface OptionsCache

Parameters:: DefaultRenderFont - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getDefaultRenderFont

public FontInfo getDefaultRenderFont()

Description copied from interface: OptionsCache

Gets the DefaultRenderFont option. This option sets the font to use when the font specified by the filter is not available on the system.

Specified by:: getDefaultRenderFont in interface OptionsCache

Returns:: The current value for the DefaultRenderFont option

setFontAliasList

public OptionsCache setFontAliasList(FontAliases FontAliasList)

Description copied from interface: OptionsCache

Sets the FontAliasList option. This option enables the capability to specify which font on the system should be used when a specific font referenced in the original file is not available. A different alias can be set for each font desired to be mapped.

Specified by:: setFontAliasList in interface OptionsCache

Parameters:: FontAliasList - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getFontAliasList

public FontAliases getFontAliasList()

Description copied from interface: OptionsCache

Gets the FontAliasList option. This option enables the capability to specify which font on the system should be used when a specific font referenced in the original file is not available. A different alias can be set for each font desired to be mapped.

Specified by:: getFontAliasList in interface OptionsCache

Returns:: The current value for the FontAliasList option

setEmbedFonts

public OptionsCache setEmbedFonts(Options.EmbedFontsValue EmbedFonts)

Description copied from interface: OptionsCache

Sets the EmbedFonts option. option whether or not to automatically embed Adobe Standard Base 14 fonts.

Specified by:: setEmbedFonts in interface OptionsCache

Parameters:: EmbedFonts - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getEmbedFonts

public Options.EmbedFontsValue getEmbedFonts()

Description copied from interface: OptionsCache

Gets the EmbedFonts option. option whether or not to automatically embed Adobe Standard Base 14 fonts.

Specified by:: getEmbedFonts in interface OptionsCache

Returns:: The current value for the EmbedFonts option

setFontDirectories

public OptionsCache setFontDirectories(java.util.List<java.io.File> FontDirectories)
                                throws OutsideInException

Sets the .

Specified by:: setFontDirectories in interface OptionsCache

Parameters:: FontDirectories - option to specify one or more font directories where fonts are located for use by PDF Export.
Returns:: Nothing
Throws:: OutsideInException

getFontDirectories

public java.util.List<java.io.File> getFontDirectories()

Gets the .

Specified by:: getFontDirectories in interface OptionsCache

Returns:: option to specify one or more font directories where fonts are located for use by PDF Export.

setFontFilter

public OptionsCache setFontFilter(FontList FontFilter)

Description copied from interface: OptionsCache

Sets the FontFilter option. This option allows the developer to specify a list of fonts to be included or excluded during the export process

Specified by:: setFontFilter in interface OptionsCache

Parameters:: FontFilter - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getFontFilter

public FontList getFontFilter()

Description copied from interface: OptionsCache

Gets the FontFilter option. This option allows the developer to specify a list of fonts to be included or excluded during the export process

Specified by:: getFontFilter in interface OptionsCache

Returns:: The current value for the FontFilter option

setWatermark

public OptionsCache setWatermark(Watermark Watermark)

Description copied from interface: OptionsCache

Sets the Watermark option. Watermark to be used

Specified by:: setWatermark in interface OptionsCache

Parameters:: Watermark - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getWatermark

public Watermark getWatermark()

Description copied from interface: OptionsCache

Gets the Watermark option. Watermark to be used

Specified by:: getWatermark in interface OptionsCache

Returns:: The current value for the Watermark option

setTempDirectory

public OptionsCache setTempDirectory(java.lang.String TempDirectory)

Description copied from interface: OptionsCache

Sets the TempDirectory option. Directory where temporary files are created

Specified by:: setTempDirectory in interface OptionsCache

Parameters:: TempDirectory - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getTempDirectory

public java.lang.String getTempDirectory()

Description copied from interface: OptionsCache

Gets the TempDirectory option. Directory where temporary files are created

Specified by:: getTempDirectory in interface OptionsCache

Returns:: The current value for the TempDirectory option

setDocumentMemoryMode

public OptionsCache setDocumentMemoryMode(Options.DocumentMemoryModeValue DocumentMemoryMode)

Description copied from interface: OptionsCache

Sets the DocumentMemoryMode option. This option determines the maximum amount of memory that the internal storage may use to store the document's data, from 4 MB to 1 GB. The more memory the internal storage has available to it, the less often it needs to re-read data from the document.

Specified by:: setDocumentMemoryMode in interface OptionsCache

Parameters:: DocumentMemoryMode - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getDocumentMemoryMode

public Options.DocumentMemoryModeValue getDocumentMemoryMode()

Description copied from interface: OptionsCache

Gets the DocumentMemoryMode option. This option determines the maximum amount of memory that the internal storage may use to store the document's data, from 4 MB to 1 GB. The more memory the internal storage has available to it, the less often it needs to re-read data from the document.

Specified by:: getDocumentMemoryMode in interface OptionsCache

Returns:: The current value for the DocumentMemoryMode option

setExportPerformanceMode

public OptionsCache setExportPerformanceMode(Options.ExportPerformanceModeValue ExportPerformanceMode)

Description copied from interface: OptionsCache

Sets the ExportPerformanceMode option. Option to skip the processing of some or all style information when possible. This should result in better performance, but certain output will no longer be available. Note that this option is only supported in Search Export. Attempting to use it with other products will lead to unpredictable results.

Specified by:: setExportPerformanceMode in interface OptionsCache

Parameters:: ExportPerformanceMode - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getExportPerformanceMode

public Options.ExportPerformanceModeValue getExportPerformanceMode()

Description copied from interface: OptionsCache

Gets the ExportPerformanceMode option. Option to skip the processing of some or all style information when possible. This should result in better performance, but certain output will no longer be available. Note that this option is only supported in Search Export. Attempting to use it with other products will lead to unpredictable results.

Specified by:: getExportPerformanceMode in interface OptionsCache

Returns:: The current value for the ExportPerformanceMode option

setEnableAllSubObjects

public OptionsCache setEnableAllSubObjects(boolean EnableAllSubObjects)

Description copied from interface: OptionsCache

Sets the EnableAllSubObjects option. Option to enable Oracle's Internal Optimization

Specified by:: setEnableAllSubObjects in interface OptionsCache

Parameters:: EnableAllSubObjects - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getEnableAllSubObjects

public boolean getEnableAllSubObjects()

Description copied from interface: OptionsCache

Gets the EnableAllSubObjects option. Option to enable Oracle's Internal Optimization

Specified by:: getEnableAllSubObjects in interface OptionsCache

Returns:: The current value for the EnableAllSubObjects option

setXXFormatOptions

public OptionsCache setXXFormatOptions(java.util.EnumSet<Options.XXFormatOptionValues> XXFormatOptions)

Description copied from interface: OptionsCache

Sets the XXFormatOptions option. This option is a set of flags that can be set to affect the XML Export output.

Specified by:: setXXFormatOptions in interface OptionsCache

Parameters:: XXFormatOptions - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getXXFormatOptions

public java.util.EnumSet<Options.XXFormatOptionValues> getXXFormatOptions()

Description copied from interface: OptionsCache

Gets the XXFormatOptions option. This option is a set of flags that can be set to affect the XML Export output.

Specified by:: getXXFormatOptions in interface OptionsCache

Returns:: The current value for the XXFormatOptions option

setXMLDefinitionReference

public OptionsCache setXMLDefinitionReference(XMLReference XMLDefinitionReference)

Description copied from interface: OptionsCache

Sets the XMLDefinitionReference option. option whether Flexiondoc will reference a SearchML or PageML schema, DTD, or no reference when generating output.

Specified by:: setXMLDefinitionReference in interface OptionsCache

Parameters:: XMLDefinitionReference - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getXMLDefinitionReference

public XMLReference getXMLDefinitionReference()

Description copied from interface: OptionsCache

Gets the XMLDefinitionReference option. option whether Flexiondoc will reference a SearchML or PageML schema, DTD, or no reference when generating output.

Specified by:: getXMLDefinitionReference in interface OptionsCache

Returns:: The current value for the XMLDefinitionReference option

setNullReplacementCharacter

public OptionsCache setNullReplacementCharacter(int NullReplacementCharacter)

Description copied from interface: OptionsCache

Sets the NullReplacementCharacter option. the character that will be used to replace null characters if null path separators are being used.

Specified by:: setNullReplacementCharacter in interface OptionsCache

Parameters:: NullReplacementCharacter - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getNullReplacementCharacter

public int getNullReplacementCharacter()

Description copied from interface: OptionsCache

Gets the NullReplacementCharacter option. the character that will be used to replace null characters if null path separators are being used.

Specified by:: getNullReplacementCharacter in interface OptionsCache

Returns:: The current value for the NullReplacementCharacter option

setPageMLFlags

public OptionsCache setPageMLFlags(java.util.EnumSet<Options.PageMLFlagValues> PageMLFlags)

Description copied from interface: OptionsCache

Sets the PageMLFlags option. options to control PageML output

Specified by:: setPageMLFlags in interface OptionsCache

Parameters:: PageMLFlags - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getPageMLFlags

public java.util.EnumSet<Options.PageMLFlagValues> getPageMLFlags()

Description copied from interface: OptionsCache

Gets the PageMLFlags option. options to control PageML output

Specified by:: getPageMLFlags in interface OptionsCache

Returns:: The current value for the PageMLFlags option

setPrinterName

public OptionsCache setPrinterName(java.lang.String PrinterName)

Description copied from interface: OptionsCache

Sets the PrinterName option. printer whose device context is used to render pages.

Specified by:: setPrinterName in interface OptionsCache

Parameters:: PrinterName - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getPrinterName

public java.lang.String getPrinterName()

Description copied from interface: OptionsCache

Gets the PrinterName option. printer whose device context is used to render pages.

Specified by:: getPrinterName in interface OptionsCache

Returns:: The current value for the PrinterName option

setIncludeCharacterAttributes

public OptionsCache setIncludeCharacterAttributes(java.util.EnumSet<Options.IncludeCharacterAttributeValues> IncludeCharacterAttributes)

Description copied from interface: OptionsCache

Sets the IncludeCharacterAttributes option. Character Attributes to track

Specified by:: setIncludeCharacterAttributes in interface OptionsCache

Parameters:: IncludeCharacterAttributes - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getIncludeCharacterAttributes

public java.util.EnumSet<Options.IncludeCharacterAttributeValues> getIncludeCharacterAttributes()

Description copied from interface: OptionsCache

Gets the IncludeCharacterAttributes option. Character Attributes to track

Specified by:: getIncludeCharacterAttributes in interface OptionsCache

Returns:: The current value for the IncludeCharacterAttributes option

setSearchMLFlags

public OptionsCache setSearchMLFlags(java.util.EnumSet<Options.SearchMLFlagValues> SearchMLFlags)

Description copied from interface: OptionsCache

Sets the SearchMLFlags option. options to control SearchML output

Specified by:: setSearchMLFlags in interface OptionsCache

Parameters:: SearchMLFlags - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getSearchMLFlags

public java.util.EnumSet<Options.SearchMLFlagValues> getSearchMLFlags()

Description copied from interface: OptionsCache

Gets the SearchMLFlags option. options to control SearchML output

Specified by:: getSearchMLFlags in interface OptionsCache

Returns:: The current value for the SearchMLFlags option

setIncludeSearchMLOffset

public OptionsCache setIncludeSearchMLOffset(boolean IncludeSearchMLOffset)

Description copied from interface: OptionsCache

Sets the IncludeSearchMLOffset option. option to include offset information in SearchML

Specified by:: setIncludeSearchMLOffset in interface OptionsCache

Parameters:: IncludeSearchMLOffset - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getIncludeSearchMLOffset

public boolean getIncludeSearchMLOffset()

Description copied from interface: OptionsCache

Gets the IncludeSearchMLOffset option. option to include offset information in SearchML

Specified by:: getIncludeSearchMLOffset in interface OptionsCache

Returns:: The current value for the IncludeSearchMLOffset option

setSearchMLParaAttributes

public OptionsCache setSearchMLParaAttributes(java.util.EnumSet<Options.SearchMLParaAttributeValues> SearchMLParaAttributes)

Description copied from interface: OptionsCache

Sets the SearchMLParaAttributes option. options to control SearchML output related to paragraph attributes

Specified by:: setSearchMLParaAttributes in interface OptionsCache

Parameters:: SearchMLParaAttributes - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getSearchMLParaAttributes

public java.util.EnumSet<Options.SearchMLParaAttributeValues> getSearchMLParaAttributes()

Description copied from interface: OptionsCache

Gets the SearchMLParaAttributes option. options to control SearchML output related to paragraph attributes

Specified by:: getSearchMLParaAttributes in interface OptionsCache

Returns:: The current value for the SearchMLParaAttributes option

setUnmappedText

public OptionsCache setUnmappedText(Options.UnmappedTextValue UnmappedText)

Description copied from interface: OptionsCache

Sets the UnmappedText option. option allows for the production of unmapped text (the original code points from the input document).

Specified by:: setUnmappedText in interface OptionsCache

Parameters:: UnmappedText - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getUnmappedText

public Options.UnmappedTextValue getUnmappedText()

Description copied from interface: OptionsCache

Gets the UnmappedText option. option allows for the production of unmapped text (the original code points from the input document).

Specified by:: getUnmappedText in interface OptionsCache

Returns:: The current value for the UnmappedText option

setSuppressFontAttributes

public OptionsCache setSuppressFontAttributes(java.util.EnumSet<Options.SuppressFontAttributeValues> SuppressFontAttributes)

Description copied from interface: OptionsCache

Sets the SuppressFontAttributes option. option is used to turn off specified font-related markup in the output.

Specified by:: setSuppressFontAttributes in interface OptionsCache

Parameters:: SuppressFontAttributes - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getSuppressFontAttributes

public java.util.EnumSet<Options.SuppressFontAttributeValues> getSuppressFontAttributes()

Description copied from interface: OptionsCache

Gets the SuppressFontAttributes option. option is used to turn off specified font-related markup in the output.

Specified by:: getSuppressFontAttributes in interface OptionsCache

Returns:: The current value for the SuppressFontAttributes option

setGenerateBulletsAndNumbering

public OptionsCache setGenerateBulletsAndNumbering(boolean GenerateBulletsAndNumbering)

Description copied from interface: OptionsCache

Sets the GenerateBulletsAndNumbering option. option to generate list numbers and/or bullets as needed rather than using list markup tags.

Specified by:: setGenerateBulletsAndNumbering in interface OptionsCache

Parameters:: GenerateBulletsAndNumbering - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getGenerateBulletsAndNumbering

public boolean getGenerateBulletsAndNumbering()

Description copied from interface: OptionsCache

Gets the GenerateBulletsAndNumbering option. option to generate list numbers and/or bullets as needed rather than using list markup tags.

Specified by:: getGenerateBulletsAndNumbering in interface OptionsCache

Returns:: The current value for the GenerateBulletsAndNumbering option

setGridWrap

public OptionsCache setGridWrap(GridWrapInfo GridWrap)

Description copied from interface: OptionsCache

Sets the GridWrap option. Options related to grids have no effect on the output unless a template that has been enabled with the {## unit} template macro is in use. This option allows the developer to specify how the "previous" and "next" relationships will work between grids at the edges of the spreadsheet or database. As such, it is only useful when a grid-enabled template has been selected with the SCCOPT_EX_TEMPLATE option. This option specifies whether the "previous" and "next" relationships "wrap" at the edges of the spreadsheet or database.

Specified by:: setGridWrap in interface OptionsCache

Parameters:: GridWrap - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getGridWrap

public GridWrapInfo getGridWrap()

Description copied from interface: OptionsCache

Gets the GridWrap option. Options related to grids have no effect on the output unless a template that has been enabled with the {## unit} template macro is in use. This option allows the developer to specify how the "previous" and "next" relationships will work between grids at the edges of the spreadsheet or database. As such, it is only useful when a grid-enabled template has been selected with the SCCOPT_EX_TEMPLATE option. This option specifies whether the "previous" and "next" relationships "wrap" at the edges of the spreadsheet or database.

Specified by:: getGridWrap in interface OptionsCache

Returns:: The current value for the GridWrap option

setGenerateJavascriptTabs

public OptionsCache setGenerateJavascriptTabs(boolean GenerateJavascriptTabs)

Description copied from interface: OptionsCache

Sets the GenerateJavascriptTabs option. Option to support tabs using JavaScript to calculate tab stops and position blocks of text accordingly

Specified by:: setGenerateJavascriptTabs in interface OptionsCache

Parameters:: GenerateJavascriptTabs - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getGenerateJavascriptTabs

public boolean getGenerateJavascriptTabs()

Description copied from interface: OptionsCache

Gets the GenerateJavascriptTabs option. Option to support tabs using JavaScript to calculate tab stops and position blocks of text accordingly

Specified by:: getGenerateJavascriptTabs in interface OptionsCache

Returns:: The current value for the GenerateJavascriptTabs option

setPreventGraphicOverlap

public OptionsCache setPreventGraphicOverlap(boolean PreventGraphicOverlap)

Description copied from interface: OptionsCache

Sets the PreventGraphicOverlap option. option to have text flowing around graphics.

Specified by:: setPreventGraphicOverlap in interface OptionsCache

Parameters:: PreventGraphicOverlap - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getPreventGraphicOverlap

public boolean getPreventGraphicOverlap()

Description copied from interface: OptionsCache

Gets the PreventGraphicOverlap option. option to have text flowing around graphics.

Specified by:: getPreventGraphicOverlap in interface OptionsCache

Returns:: The current value for the PreventGraphicOverlap option

setPageBreakLimit

public OptionsCache setPageBreakLimit(long PageBreakLimit)

Description copied from interface: OptionsCache

Sets the PageBreakLimit option. option for the suggested page size for the output generated. PageSize is in characters

Specified by:: setPageBreakLimit in interface OptionsCache

Parameters:: PageBreakLimit - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getPageBreakLimit

public long getPageBreakLimit()

Description copied from interface: OptionsCache

Gets the PageBreakLimit option. option for the suggested page size for the output generated. PageSize is in characters

Specified by:: getPageBreakLimit in interface OptionsCache

Returns:: The current value for the PageBreakLimit option

setWebViewStructure

public OptionsCache setWebViewStructure(Options.WebViewStructureValue WebViewStructure)

Description copied from interface: OptionsCache

Sets the WebViewStructure option. This option controls the the structure of the output files created by Web View Export

Specified by:: setWebViewStructure in interface OptionsCache

Parameters:: WebViewStructure - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getWebViewStructure

public Options.WebViewStructureValue getWebViewStructure()

Description copied from interface: OptionsCache

Gets the WebViewStructure option. This option controls the the structure of the output files created by Web View Export

Specified by:: getWebViewStructure in interface OptionsCache

Returns:: The current value for the WebViewStructure option

setURLPathResources

public OptionsCache setURLPathResources(java.lang.String URLPathResources)

Description copied from interface: OptionsCache

Sets the URLPathResources option. String option for specifying the base URL for Web View Export scripts, css files and other resources that do not vary with the converted file. The value of this option is used as a prefix for references to those resources in the primary output file. For example, if the resources' base URL is "/oit/", the script reference in the output file would look like this: <script src="/oit/oit.js"></script> By default, this value is empty, meaning all resources must be present in the same directory as the generated output.

Specified by:: setURLPathResources in interface OptionsCache

Parameters:: URLPathResources - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getURLPathResources

public java.lang.String getURLPathResources()

Description copied from interface: OptionsCache

Gets the URLPathResources option. String option for specifying the base URL for Web View Export scripts, css files and other resources that do not vary with the converted file. The value of this option is used as a prefix for references to those resources in the primary output file. For example, if the resources' base URL is "/oit/", the script reference in the output file would look like this: <script src="/oit/oit.js"></script> By default, this value is empty, meaning all resources must be present in the same directory as the generated output.

Specified by:: getURLPathResources in interface OptionsCache

Returns:: The current value for the URLPathResources option

setURLPathOutput

public OptionsCache setURLPathOutput(java.lang.String URLPathOutput)

Description copied from interface: OptionsCache

Sets the URLPathOutput option. String option for specifying the base URL for output files generated during the export process. The value of this option is used as a prefix for references to those resources in the primary output file. If the output base URL is "/exports/", an image tag in an exported document would look like this: <img src="/exports/doc01.doc.jpg" /> and URLs to the exported files within content.js would be of this form: {id:"page.1",name:"Page 1",type:"page",oid:"overlay.1",w:"816px",h:"1056px",src:"/exports/output.3.html"} By default, the output file base URL is empty, and all output will be specified without path information.

Specified by:: setURLPathOutput in interface OptionsCache

Parameters:: URLPathOutput - The option value
Returns:: This OptionsCache object (to allow for chaining set option methods)

getURLPathOutput

public java.lang.String getURLPathOutput()

Description copied from interface: OptionsCache

Gets the URLPathOutput option. String option for specifying the base URL for output files generated during the export process. The value of this option is used as a prefix for references to those resources in the primary output file. If the output base URL is "/exports/", an image tag in an exported document would look like this: <img src="/exports/doc01.doc.jpg" /> and URLs to the exported files within content.js would be of this form: {id:"page.1",name:"Page 1",type:"page",oid:"overlay.1",w:"816px",h:"1056px",src:"/exports/output.3.html"} By default, the output file base URL is empty, and all output will be specified without path information.

Specified by:: getURLPathOutput in interface OptionsCache

Returns:: The current value for the URLPathOutput option

setExternalStylesheets

public OptionsCache setExternalStylesheets(java.util.List<java.lang.String> ExternalStylesheets)

Sets the .

Specified by:: setExternalStylesheets in interface OptionsCache

Parameters:: ExternalStylesheets - option for specifying the url of a user supplied stylesheet to be included in the output html file.
Returns:: Nothing

getExternalStylesheets

public java.util.List<java.lang.String> getExternalStylesheets()

Gets the .

Specified by:: getExternalStylesheets in interface OptionsCache

Returns:: option for specifying the url of a user supplied stylesheet to be included in the output html file.

setPostLibraryScripts

public OptionsCache setPostLibraryScripts(java.util.List<java.lang.String> PostLibraryScripts)

Sets the .

Specified by:: setPostLibraryScripts in interface OptionsCache

Parameters:: PostLibraryScripts - option specifying the relative url of the customer's initialization script.
Returns:: Nothing

getPostLibraryScripts

public java.util.List<java.lang.String> getPostLibraryScripts()

Gets the .

Specified by:: getPostLibraryScripts in interface OptionsCache

Returns:: option specifying the relative url of the customer's initialization script.

setPreLibraryScripts

public OptionsCache setPreLibraryScripts(java.util.List<java.lang.String> PreLibraryScripts)

Sets the .

Specified by:: setPreLibraryScripts in interface OptionsCache

Parameters:: PreLibraryScripts - option specifying the url of a script file to be referenced via a

com.oracle.outsidein.options Class OptionsCacheImpl

m_srcInfoList

m_srcInfo

m_cumulativeInfo

m_dstFile

m_dstRedirect

m_dstFileId

m_bDoOpenInput

m_templatefile

bNextFile

OptionsCacheImpl

OptionsCacheImpl

setOptions

setPasswordAndNotesId

setSpecialOptionFlag

setSourceFile

setSourceFile

setSourceFile

addSourceFile

addSourceFile

addSourceFile

setSourceFormat

setDestinationFile

setDestinationFile

setDestinationFormat

getDestinationFormat

setCallbackHandler

setPasswordsList

setLotusNotesId

setOpenForNonSequentialAccess

setExportTemplate

setDefaultInputCharacterSet

getDefaultInputCharacterSet

setUnmappableCharacter

getUnmappableCharacter

setUnicodeByteOrder

getUnicodeByteOrder

setOutputCharacterSet

getOutputCharacterSet

setInternalRendering

getInternalRendering

setEnableAlphaBlending

getEnableAlphaBlending

setOutputChangeTracking

getOutputChangeTracking

setCollapseWhiteSpace

getCollapseWhiteSpace

setExtractEmbeddedFiles

getExtractEmbeddedFiles

setHTMLFlavor

getHTMLFlavor

setHTMLOutputFormatting

getHTMLOutputFormatting

setShowHiddenText

getShowHiddenText

setSimpleStyleNames

getSimpleStyleNames

setShowHiddenSpreadSheetData

getShowHiddenSpreadSheetData

setFallbackFormat

getFallbackFormat

setExtractXMPMetadata

getExtractXMPMetadata

setParseXMPMetadata

getParseXMPMetadata

setPerformExtendedFI

getPerformExtendedFI

setLotusNotesDirectory

getLotusNotesDirectory

setPDFReorderBiDi

getPDFReorderBiDi

setPDFWordSpacingFactor

getPDFWordSpacingFactor

setPDFInputMaxEmbeddedObjects

getPDFInputMaxEmbeddedObjects

setPDFInputMaxVectorPaths

getPDFInputMaxVectorPaths

setTimeZoneOffset

getTimeZoneOffset

setISODateTimes

com.oracle.outsidein.options
Class OptionsCacheImpl