Skip navigation links

com.oracle.outsidein.options
Enum Options

java.lang.Object
java.lang.Enum<Options>
com.oracle.outsidein.options.Options

All Implemented Interfaces:

Option, OptionImpl, java.io.Serializable, java.lang.Comparable<Options>

public enum Options

extends java.lang.Enum<Options>

implements OptionImpl

List of options available in Outside In. Not all options are used for all destination file formats. See product documentation for which technologies support a specific option.

Nested Class Summary

static class	Options.BiDiReorderMethodValue Values for the byte order of Unicode characters in the output files when Unicode is chosen as the output character set.
static class	Options.BorderModeValue Values indicating how borders are handled for spreadsheet and database files.
static class	Options.DefaultInputCharacterSetValue Values for the default character set used when Outside In cannot determine the character set used to encode the text of a source file.
static class	Options.DocumentMemoryModeValue Values for specifying the maximum amount of memory the technology may use to store the document's data.
static class	Options.EmailAttachmentHandlingValue Values for specifying the action to take when attachments are encountered in the source document.
static class	Options.EmbedFontsValue Values indicating which fonts to embed in the destination file.
static class	Options.ExportPerformanceModeValue Values indicating the performance mode to be used.
static class	Options.ExtractEmbeddedFilesValue Values used to control the extraction of attachments to email documents.
static class	Options.FallbackFormatValue Values to control how unknown files are handled.
static class	Options.FontReferenceMethodValue Values to control the way fonts are present (or not) in HTML5 output.
static class	Options.GraphicSizeMethodValue Values indicating the general algorithm to use when scaling graphics.
static class	Options.HTMLFlavorValue Values to tailor html output to a specific browser.
static class	Options.IECondCommentFlagValues Values to control special types of comments that will be read by particular versions of browsers or other products.
static class	Options.IncludeCharacterAttributeValues The character attribute values that may be tracked and output to XML tags when exporting to SEARCHML destination file formats.
static class	Options.OutputCharacterSetValue Available character sets to use in the destination file.
static class	Options.OutputGraphicTypeValue Available formats for graphic files that are produced by the technology.
static class	Options.PageDirectionValue Values indicating the order of that pages are rendered for spreadsheet and database source files.
static class	Options.PageFitModeValue Values indicating how to scale spreadsheet and database files in the rendered output.
static class	Options.PageMLFlagValues Flags that control the behavior of PageML output.
static class	Options.PDFReorderBiDiValue Available methods of handling bidirectional text runs.
static class	Options.ProcessOLEEmbeddingModeValue Values indicating how to handle native (OLE) embedded documents.
static class	Options.SearchMLFlagValues Flags that control the output when exporting to a SearchML destination file format
static class	Options.SearchMLParaAttributeValues Flags that control the output related to paragraph attributes when exporting to a SearchML destination file format
static class	Options.SpecialOptionFlag Used internally by the Outside In API and not to be used externally.
static class	Options.SuppressFontAttributeValues Flags indicating what font-related markup to exclude from the output when exporting to the HTML destination file format.
static class	Options.TIFFByteOrderValue Values for specifying the byte brder used in the output file when exporting to the TIFF destination file format.
static class	Options.TIFFColorSpaceValue Values for specifying the color depth and color options in the output file when exporting to the TIFF destination file format.
static class	Options.TIFFCompressionValue Values for specifying the compression used in the output file when exporting to the TIFF destinatio file format.
static class	Options.TIFFFillOrderValue Values for specifying the fill order used in the output file when exporting to the TIFF destination file format.
static class	Options.UnicodeByteOrderValue Values that indicate the byte order of Unicode characters in the output files when Unicode is chosen as the output character set.
static class	Options.UnmappedTextValue Values for indicating how unmapped text is output when exporting to a SEARCHML destination file format.
static class	Options.WebFontPermissionValues Flags to control the use of embedded fonts in the output file when exporting to the HTML5 file format.
static class	Options.WebViewStructureValue Values for controlling the structure of the output files created when using HTML5 as the destination file format.
static class	Options.XXFormatOptionValues Flags that can affect the output when exporting to the FLEXIONDOC destination file format.

Nested classes/interfaces inherited from interface com.oracle.outsidein.options.OptionImpl

OptionImpl.OptionScopeValue

Nested classes/interfaces inherited from interface com.oracle.outsidein.options.Option

Option.OutsideInProducts

Enum Constant Summary

AcceptAlternateGraphics

AppendEmailAttachments

ApplyZLIBCompression

BiDiReorderMethod

BorderMode

CollapseWhiteSpace

CropToContent

DefaultInputCharacterSet

DefaultPageMargins

DefaultPageSize

DefaultRenderFont

DetectGrayScaleAsColor

DocumentMemoryMode

DropPDFHyphens

EmailAttachmentHandling

EmailHeaders

EmbedFonts

EnableAllSubObjects

EnableAlphaBlending

ExportPerformanceMode

ExternalStylesheets

ExtractEmbeddedFiles

ExtractXMPMetadata

FallbackFormat

FitHeightToPages

FitWidthToPages

FontAliasList

FontBaseURL

FontDirectories

FontFilter

FontReferenceMethod

GenerateBulletsAndNumbering

GenerateExcelRevisions

GenerateJavascriptTabs

GraphicHeight

GraphicHeightLimit

GraphicOutputDPI

GraphicRenderAsPage

GraphicSizeLimit

GraphicSizeMethod

GraphicWidth

GraphicWidthLimit

GridMaxPageHeight

GridMaxPageWidth

GridWrap

HTMLFlavor

HTMLOutputFormatting

IECondCommentMode

IgnorePassword

ImagePassthrough

IncludeCharacterAttributes

IncludeSearchMLOffset

InterlacedGIFs

InternalRendering

ISODateTimes

JPEGQuality

LinearizePDFOutput

LotusNotesDirectory

MarginText

MarginTextFont

NullReplacementCharacter

OutputChangeTracking

OutputCharacterSet

OutputGraphicType

OutputRawtext

PageBreakLimit

PageDirection

PageFitMode

PageMLFlags

PageRange

PageScalePercent

ParseXMPMetadata

PDFInputMaxEmbeddedObjects

PDFInputMaxVectorPaths

PDFReorderBiDi

PDFWordSpacingFactor

PerformExtendedFI

PostLibraryScripts

PreLibraryScripts

PreventGraphicOverlap

PrinterName

ProcessOLEEmbeddingMode

QuickThumbnail

RawTextBufferSize

RedactionColor

RedactionLabelFont

RedactionLabelsVisible

RedactionsEnabled

RenderEmbeddedFonts

RenderGridlines

RenderHeadings

SearchMLFlags

SearchMLParaAttributes

ShowArchiveFullPath

ShowColumnHeadings

ShowHiddenCells

ShowHiddenSpreadSheetData

ShowHiddenText

SimpleStyleNames

StrictFile

StrokeOutText

SuppressEmptyCells

SuppressFontAttributes

TempDirectory

TIFFByteOrder

TIFFColorSpace

TIFFCompression

TIFFFillOrder

TIFFMultiPage

TimeZoneOffset

TransparencyColor

UnicodeByteOrder

UnmappableCharacter

UnmappedText

URLPathOutput

URLPathResources

UseDocumentPageSettings

VectorObjectLimit

Watermark

WebFontPermissions

WebViewLibraryName

WebViewStructure

WebViewStylesheetName

XMLDefinitionReference

XXFormatOptions

Method Summary

java.lang.Object	get(OptionsCache exporter) Gets the current option value from the specified Exporter object.
java.lang.Class<?>	getDataType() Gets the type of data that an option takes.
java.lang.Object	getDefault()
java.lang.String	getDescription() Obtains a brief, human readable description of this option.
java.lang.Class<?>[]	getItemTypes() Gets the type parameters for option values that are generics.
java.lang.String	getName() Obtains the unique name of this option.
OptionImpl.OptionScopeValue	getOptionScope()
java.util.EnumSet<Option.OutsideInProducts>	getSupportingProducts() Gets the set of products that support this option
void	set(OptionsCache exporter, java.lang.Object objValue) Sets an option value and checks the value type at runtime instead of compile-time.
static Options	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Options[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DefaultInputCharacterSet

public static final Options DefaultInputCharacterSet

UnmappableCharacter

public static final Options UnmappableCharacter

UnicodeByteOrder

public static final Options UnicodeByteOrder

OutputCharacterSet

public static final Options OutputCharacterSet

InternalRendering

public static final Options InternalRendering

EnableAlphaBlending

public static final Options EnableAlphaBlending

OutputChangeTracking

public static final Options OutputChangeTracking

CollapseWhiteSpace

public static final Options CollapseWhiteSpace

ExtractEmbeddedFiles

public static final Options ExtractEmbeddedFiles

HTMLFlavor

public static final Options HTMLFlavor

HTMLOutputFormatting

public static final Options HTMLOutputFormatting

ShowHiddenText

public static final Options ShowHiddenText

SimpleStyleNames

public static final Options SimpleStyleNames

ShowHiddenSpreadSheetData

public static final Options ShowHiddenSpreadSheetData

FallbackFormat

public static final Options FallbackFormat

ExtractXMPMetadata

public static final Options ExtractXMPMetadata

ParseXMPMetadata

public static final Options ParseXMPMetadata

PerformExtendedFI

public static final Options PerformExtendedFI

LotusNotesDirectory

public static final Options LotusNotesDirectory

PDFReorderBiDi

public static final Options PDFReorderBiDi

PDFWordSpacingFactor

public static final Options PDFWordSpacingFactor

PDFInputMaxEmbeddedObjects

public static final Options PDFInputMaxEmbeddedObjects

PDFInputMaxVectorPaths

public static final Options PDFInputMaxVectorPaths

TimeZoneOffset

public static final Options TimeZoneOffset

ISODateTimes

public static final Options ISODateTimes

StrictFile

public static final Options StrictFile

IgnorePassword

public static final Options IgnorePassword

BiDiReorderMethod

public static final Options BiDiReorderMethod

IECondCommentMode

public static final Options IECondCommentMode

ShowArchiveFullPath

public static final Options ShowArchiveFullPath

GenerateExcelRevisions

public static final Options GenerateExcelRevisions

ProcessOLEEmbeddingMode

public static final Options ProcessOLEEmbeddingMode

DropPDFHyphens

public static final Options DropPDFHyphens

ApplyZLIBCompression

public static final Options ApplyZLIBCompression

InterlacedGIFs

public static final Options InterlacedGIFs

CropToContent

public static final Options CropToContent

GraphicHeight

public static final Options GraphicHeight

GraphicHeightLimit

public static final Options GraphicHeightLimit

GraphicOutputDPI

public static final Options GraphicOutputDPI

GraphicSizeLimit

public static final Options GraphicSizeLimit

TransparencyColor

public static final Options TransparencyColor

GraphicWidth

public static final Options GraphicWidth

GraphicWidthLimit

public static final Options GraphicWidthLimit

GraphicRenderAsPage

public static final Options GraphicRenderAsPage

GraphicSizeMethod

public static final Options GraphicSizeMethod

TIFFColorSpace

public static final Options TIFFColorSpace

TIFFCompression

public static final Options TIFFCompression

TIFFMultiPage

public static final Options TIFFMultiPage

TIFFByteOrder

public static final Options TIFFByteOrder

TIFFFillOrder

public static final Options TIFFFillOrder

JPEGQuality

public static final Options JPEGQuality

QuickThumbnail

public static final Options QuickThumbnail

ImagePassthrough

public static final Options ImagePassthrough

AcceptAlternateGraphics

public static final Options AcceptAlternateGraphics

OutputGraphicType

public static final Options OutputGraphicType

DetectGrayScaleAsColor

public static final Options DetectGrayScaleAsColor

PageFitMode

public static final Options PageFitMode

RenderGridlines

public static final Options RenderGridlines

RenderHeadings

public static final Options RenderHeadings

GridMaxPageHeight

public static final Options GridMaxPageHeight

GridMaxPageWidth

public static final Options GridMaxPageWidth

PageDirection

public static final Options PageDirection

PageScalePercent

public static final Options PageScalePercent

FitHeightToPages

public static final Options FitHeightToPages

FitWidthToPages

public static final Options FitWidthToPages

ShowHiddenCells

public static final Options ShowHiddenCells

ShowColumnHeadings

public static final Options ShowColumnHeadings

BorderMode

public static final Options BorderMode

SuppressEmptyCells

public static final Options SuppressEmptyCells

DefaultPageSize

public static final Options DefaultPageSize

DefaultPageMargins

public static final Options DefaultPageMargins

UseDocumentPageSettings

public static final Options UseDocumentPageSettings

PageRange

public static final Options PageRange

LinearizePDFOutput

public static final Options LinearizePDFOutput

EmailHeaders

public static final Options EmailHeaders

AppendEmailAttachments

public static final Options AppendEmailAttachments

StrokeOutText

public static final Options StrokeOutText

RenderEmbeddedFonts

public static final Options RenderEmbeddedFonts

DefaultRenderFont

public static final Options DefaultRenderFont

FontAliasList

public static final Options FontAliasList

EmbedFonts

public static final Options EmbedFonts

FontDirectories

public static final Options FontDirectories

FontFilter

public static final Options FontFilter

Watermark

public static final Options Watermark

TempDirectory

public static final Options TempDirectory

DocumentMemoryMode

public static final Options DocumentMemoryMode

ExportPerformanceMode

public static final Options ExportPerformanceMode

EnableAllSubObjects

public static final Options EnableAllSubObjects

XXFormatOptions

public static final Options XXFormatOptions

XMLDefinitionReference

public static final Options XMLDefinitionReference

NullReplacementCharacter

public static final Options NullReplacementCharacter

PageMLFlags

public static final Options PageMLFlags

PrinterName

public static final Options PrinterName

IncludeCharacterAttributes

public static final Options IncludeCharacterAttributes

SearchMLFlags

public static final Options SearchMLFlags

IncludeSearchMLOffset

public static final Options IncludeSearchMLOffset

SearchMLParaAttributes

public static final Options SearchMLParaAttributes

UnmappedText

public static final Options UnmappedText

SuppressFontAttributes

public static final Options SuppressFontAttributes

GenerateBulletsAndNumbering

public static final Options GenerateBulletsAndNumbering

GridWrap

public static final Options GridWrap

GenerateJavascriptTabs

public static final Options GenerateJavascriptTabs

PreventGraphicOverlap

public static final Options PreventGraphicOverlap

PageBreakLimit

public static final Options PageBreakLimit

WebViewStructure

public static final Options WebViewStructure

URLPathResources

public static final Options URLPathResources

URLPathOutput

public static final Options URLPathOutput

ExternalStylesheets

public static final Options ExternalStylesheets

PostLibraryScripts

public static final Options PostLibraryScripts

PreLibraryScripts

public static final Options PreLibraryScripts

OutputRawtext

public static final Options OutputRawtext

FontBaseURL

public static final Options FontBaseURL

WebFontPermissions

public static final Options WebFontPermissions

FontReferenceMethod

public static final Options FontReferenceMethod

EmailAttachmentHandling

public static final Options EmailAttachmentHandling

WebViewStylesheetName

public static final Options WebViewStylesheetName

WebViewLibraryName

public static final Options WebViewLibraryName

RawTextBufferSize

public static final Options RawTextBufferSize

VectorObjectLimit

public static final Options VectorObjectLimit

RedactionColor

public static final Options RedactionColor

RedactionLabelsVisible

public static final Options RedactionLabelsVisible

RedactionLabelFont

public static final Options RedactionLabelFont

RedactionsEnabled

public static final Options RedactionsEnabled

MarginTextFont

public static final Options MarginTextFont

MarginText

public static final Options MarginText

Method Detail

values

public static Options[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Options c : Options.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Options valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getName

public java.lang.String getName()

Description copied from interface: Option

Obtains the unique name of this option.

Specified by:

getName in interface Option

Returns:

the option name as a String

getDescription

public java.lang.String getDescription()

Description copied from interface: Option

Obtains a brief, human readable description of this option.

Specified by:

getDescription in interface Option

Returns:

the option description as a String

getDefault

public java.lang.Object getDefault()

Specified by:

getDefault in interface OptionImpl

getOptionScope

public OptionImpl.OptionScopeValue getOptionScope()

Specified by:

getOptionScope in interface OptionImpl

getSupportingProducts

public java.util.EnumSet<Option.OutsideInProducts> getSupportingProducts()

Description copied from interface: Option

Gets the set of products that support this option

Specified by:

getSupportingProducts in interface Option

Returns:

the products that support this option

getDataType

public java.lang.Class<?> getDataType()

Description copied from interface: Option

Gets the type of data that an option takes. If the returned type is a generic, then Option.getItemTypes() should be called to retrieve its type parameters.

Specified by:

getDataType in interface Option

Returns:

the type of the option data

getItemTypes

public java.lang.Class<?>[] getItemTypes()

Description copied from interface: Option

Gets the type parameters for option values that are generics.

Specified by:

getItemTypes in interface Option

Returns:

the type parameters for generic values returned by Option.getDataType(), or null if that type is not a generic.

set

public void set(OptionsCache exporter,
                java.lang.Object objValue)
         throws OutsideInException

Description copied from interface: Option

Sets an option value and checks the value type at runtime instead of compile-time. The type should be compatible with the type returned by Option.getDataType(). This method may be used in place of the OptionCache.set[OptionName] methods that provide compile-time type checking of option values.

Specified by:

set in interface Option

Parameters:

exporter - the exporter that contains the option to set

objValue - the new option value

Throws:

OutsideInException - If the value cannot be converted to the type expected by the specific option.

get

public java.lang.Object get(OptionsCache exporter)
                     throws OutsideInException

Description copied from interface: Option

Gets the current option value from the specified Exporter object.

Specified by:

get in interface Option

Parameters:

exporter - the exporter that contains the option value requested

Returns:

the option value as an opaque Object that can be cast using Option.getDataType()

Throws:

OutsideInException

Skip navigation links