This chapter describes the Image Export Java classes.
The following classes are covered:
Annotation is an abstract base class for the Annotation objects.
Namespace
com.oracle.outsidein.annotations
Accessors
Height (long) Height of area in coordinates or rows
void setHeight(long) long getHeight()
Left (long) Leftmost coordinate or column
void setLeft(long) long getLeft()
Opacity (float) Opacity of the annotation. Range 0.0 - 1.0; setting opacity to 0 makes the annotation invisible
void setOpacity(float) throws OutsideInException float getOpacity()
SectionIndex (long) 0-based page/sheet/image/slide index
void setSectionIndex(long) long getSectionIndex()
Top (long) Top coordinate or row
void setTop(long) long getTop()
Units (Annotation.UnitTypeValue) Unit type
void setUnits(Annotation.UnitTypeValue) Annotation.UnitTypeValue getUnits()
UserId (long) User Data
void setUserId(long) long getUserId()
Width (long) Width of area in coordinates or columns
void setWidth(long) long getWidth()
Annotation.UnitTypeValue Enumeration
The UnitTypeValue is an enumeration of the various unit types that annotation positions can be described in.
Pixels: Units specified in Pixels
Twips: Units specified in Twips (1/1440th of an inch)
Cells: Units specified in cell positions
ArchiveNode provides information about an archive node. This is a read-only class where the technology fills in all the values.
Namespace
com.oracle.outsidein
Accessors
boolean isFolder() - A value of true indicates that the record is an archive node.
int getFileSize() - File size of the archive node
java.util.Date getTime() - Time the archive node was created
int getNodeNum() - Serial number of the archive node in the archive
String getNodeName() - The name of the archive node
Callback messages are notifications that come from Outside In during the export process, providing information and sometimes the opportunity to customize the generated output.
Namespace
com.oracle.outsidein
To access callback messages, your code must create an object that inherits from Callback and pass it through the API's SetCallbackHandler method. Your object can implement methods that override the default behavior for whichever methods your application is interested in.
Callback has two methods that you can override: createNewFile and newFileInfo.
CreateNewFileResponse createNewFile( FileFormat parentOutputId, FileFormat outputId, AssociationValue association, String path) throws IOException
This callback is made any time a new output file needs to be generated. This gives the developer the chance to affect where the new output file is created, how it is named, and the URL (if any) used to reference the file.
Parameters
parentOutputId: File format identifier of the parent file
outputId: File format identifier of the file created
association: An AssociationValue that describes relationship between the primary output file and the new file.
path: Full path of the file to be created
Return Value
To take action in response to this notification, return a CreateNewFileResponse object with the new file information. If you wish to accept the defaults for the path and URL, you may return null.
This is a class to define a new output file location in response to a CreateNewFile callback. If you do not wish to change the path to the new output file, you may use the path as received. If you do not wish to specify the URL for the new file, you many specify it as null.
Constructor
CreateNewFileResponse(File file, String url) throws IOException
file: File object containing the full path to the new file
url: A new URL that references the newly created file. This parameter can be null.
CreateNewFileResponse(SeekableByteChannel6 redirect, String url) throws IOException
redirect: Object that will be written to as the destination of the transform
url: A new URL that references the newly created file.This parameter can be null.
AssociationValue Enumeration
This enumeration defines, for a new file created by an export process, the different possible associations between the new file and the primary output file. Its value may be one of the following:
ROOT - indicates the primary output file
CHILD - a new file linked (directly or indirectly) from the primary output file
SIBLING - indicates new files not linked from the primary output file
COPY - the file was copied as a part of a template macro operation.
REQUIREDNAME - not used
Note that some of these relationships will not be possible in all Outside In Export SDKs.
void newFileInfo( FileFormat parentOutputId, FileFormat outputId,
AssociationValue association, String path, String url) throws IOException
This informational callback is made just after each new file has been created.
Parameters
parentOutputId: File format identifier of the parent file
outputId: File format identifier of the file created
association: An AssociationValue that describes relationship between the primary output file and the new file.
path: Full path of the file created
url: URL that references the newly created file
Example
Here is a basic callback handler that notifies an application that it has received newFileInfo notifications.
public static class CallbackHandler extends Callback
{
myApplication m_theApp;
public CallbackHandler( myApplication app )
{
m_theApp = app;
}
public void newFileInfo(FileFormat parentOutputId,
FileFormat outputId, AssociationValue association,
String path, String url) throws IOException
{
if( association == AssociationValue.ROOT )
m_theApp.primaryOutputIsReady(true);
m_theApp.newOutputFile(path);
}
}
NewPageResponse PrepareNewPage(long PageNumber)
This callback is made at the beginning of processing a new output page. This gives the developer the chance to add or modify the Margin Text to be placed on the page.
Parameters
PageNumber: the zero-based index of the page about to be rendered.
Return Value
To add or modify the Margin Text, respond to this notification with a NewPageResponse object with the margin text information. If you wish to not change the currently set values, you may return null.
void pageInfoSlideNotes(long PageNumber, string[] SlideNotes)
This informational callback is made after each slide if the last processed slide has any notes (such as speaker notes) associated with it. (Note that a request for this callback should be made through setPageInformationRequired.)
Parameters
PageNumber: The zero-based index of the page about to be rendered.
SlideNotes: The notes associated with this slide.
void PageInfoVisibility(long PageNumber, bool IsVisible)
This informational callback is made when the current page being processed has information about the visibility of the page. (Note that a request for this callback should be made through setPageInformationRequired.)
OpenFileResponse openFile(FileTypeFalue fileType, String fileName) throws IOException
This callback is made any time a new file needs to be opened.
Parameters
fileType: Type of file being requested to be opened
fileName: Name of the file to be opened
Return Value
To take action in response to this method, return an OpenFileResponse object.
FileTypeValue Enumeration
This enumeration defines the type of file being requested to be opened. Its value may be one of the following:
INPUT: File to be opened (path unknown)
TEMPLATE: Template file to be opened
PATH: Full file name of the file to be opened
OTHER: Not used
This is a class to define a new file or redirected I/O object in response to an openFile() callback.
Constructors
OpenFileResponse(File file)
file: File object with full path to the new file
OpenFileResponse(SeekableByteChannel6 redirect)
redirect: A redirected I/O object to which the file data will be written
CreateTempFileResponse createTempFile() throws IOException
This callback is made any time a new temporary file needs to be generated. This gives the developer the chance to handle the reading and writing of the temporary file.
Return Value
To take action in response to this notification, return a CreateTempFileResponse object with the temporary file information.
ColorInfo is a class to define a color or to use a default color in appropriate cases.
Namespace
com.oracle.outsidein
Constructors
ColorInfo()
Initializes a ColorInfo object to use the default color.
public ColorInfo(byte red, byte green, byte blue)
Initializes a ColorInfo object with the specified RGB values.
Accessors
byte getBlue() - Blue component of the color
byte getGreen() - Green component of the color
byte getRed() - Red component of the color
boolean isDefaultColor() - Returns true if the default color is used
This section describes the properties and methods of Exporter.
All of Outside In's Exporter functionality can be accessed through the Exporter Interface. The object returned by OutsideIn class is an implementation of this interface. This class derives from the Document Interface, which in turn is derived from the OptionsCache Interface.
Namespace
com.oracle.outsidein
Methods
getExportStatus
ExportStatus getExportStatus()
This function is used to determine if there were conversion problems during an export. The ExportStatus object returned may have information about sub-document failures, areas of a conversion that may not have high fidelity with the original document. When applicable the number of pages in the output is also provided.
newSubDocumentExporter
Exporter newSubDocumentExporter(
int SubDocId,
SubDocumentIdentifierTypeValue idType
) throws OutsideInException
Create a new Exporter for a subdocument.
SubDocId: Identifier of the subdocument
idType: Type of subdocument
SubDocumentIdentifierTypeValue: This is an enumeration for the type of subdocument being opened.
XMLEXPORTLOCATOR: Subdocument to be opened is based on output of XML Export (SubdocId is the value of the object_id attribute of a locator element.)
ATTACHMENTLOCATOR: Subdocument to be opened is based on the locator value provided by the one of the Export SDKs.
EMAILATTACHMENTINDEX: Subdocument to be opened is based on the index of the attachment from an email message. (SubdocId is the zero-based index of the attachment from an email message file. The first attachment presented by OutsideIn has the index value 0, the second has the index value 1, etc.)
Returns: A new Exporter object for the subdocument
newSubObjectExporter
Exporter newSubObjectExporter(
SubObjectTypeValue objType,
int data1,
int data2,
int data3,
int data4
) throws OutsideInException
Create a new Exporter for a subobject.
objType: Type of subobject
data1: Data identifying the subobject from SearchML
data2: Data identifying the subobject from SearchML
data3: Data identifying the subobject from SearchML
data4: Data identifying the subobject from SearchML
Returns: A new Exporter object for the subobject
SubObjectTypeValue: An enumeration to describe the type of SubObject to open.
LinkedObject
EmbeddedObject
CompressedFile
Attachment
newArchiveNodeExporter
Exporter newArchiveNodeExporter(
int dwRecordNum
) throws OutsideInException
Create a new Exporter for an archive node. You may get the number of nodes in an archive using getArchiveNodeCount. The nodes are numbered from 0 to getArchiveNodeCount -1.
dwRecordNum: The number of the record to retrieve information about. The first node is node 0 and the total number of nodes may be obtained from getArchiveNodeCount.
Returns: A new Exporter object for the archive node
newArchiveNodeExporter with Search Export Data
Exporter newArchiveNodeExporter(
int flags,
int params1,
int params2
) throws OutsideInException
Create a new Exporter for an archive node. To use this function, you must first process the archive with Search Export and save the Node data for later use in this function.
Flags: Special flags value from Search Export
Params1: Data1 from Search Export
Params2: Data2 from Search Export
Returns: A new Exporter object for the archive node
export
void export() throws OutsideInException
Perform the conversion and close the export process keeping the source document open.
void export(boolean bLeaveSourceOpen) throws OutsideInException
Perform the conversion and keep the source document open or close it based on the value of bLeaveSourceOpen.
bLeaveSourceOpen: If set to true, keeps the source document open for next export process.
Note:
Before Release 8.5.3, calling Export() with no parameters, would leave the source document open. The default behavior starting with Release 8.5.3 is to close the document after exporting the file. If you would like to keep the file open for other conversions, use this method with "bLeaveSourceOpen" set to true.setDestinationFile
OptionsCache setDestinationFile(
String filename
) throws OutsideInException
Set the location of the destination file
filename: Full path to the destination file
Returns: The updated options object
setExportTimeout
OptionsCache setExportTimeout(int millisecondsTimeout)
This method sets the time that the export process should wait for a response from the Outside In export engine to complete the export of a document, setting an upper limit on the time that will elapse during a call to export(). If the specified length of time is reached before the export has completed, the export operation will be terminated and an OutsideInException will be thrown. If this option is not set, the default timeout is 5 minutes.
newLocalExporter
static Exporter newLocalExporter(Exporter source)
This method creates and returns an instance of an Exporter object based on the source Exporter. All the options of source are copied to the new Exporter. The source and destination file information will not be copied.
All of the Outside In annotation-related methods are accessed through the Annotatable Interface.
NameSpace
com.oracle.outsidein.annotations
Methods
addStampImageFile
void addStampImageFile(
Map<String, File> stamps
)throws OutsideInException
This method maps a stamp name to an image file.
stamps: Key value pairs of stamp names and image files
applyHighlights
void applyHighlights(
String HighlightJsonData
)
This method applies a set of highlights from a JSON-encoded text stream previously generated from the Web View Export Javascript library.
HighlightJsonData: stream of highlight (and comment) information that was obtained via the Web View Export Javascript API function OIT.highlights.serialize.
All of the Outside In document-related methods are accessed through the Document Interface.
Namespace
com.oracle.outsidein
Methods
close
void close()
Closes the currently open document.
getArchiveNodeCount
int getArchiveNodeCount() throws OutsideInException
Retrieves the number of nodes in an archive file.
Returns the number of nodes in the archive file or 0 if the file is not an archive file.
getFileId
FileFormat getFileId(FileIdInfoFlagValue dwFlags) throws OutsideInException
Gets the format of the file based on the technology's content-based file identification process.
dwFlags: Option to retrieve the file identification pre-Extended or post-Extended Test
Returns the format identifier of the file.
getArchiveNode
ArchiveNode getArchiveNode(int nNodeNum) throws OutsideInException
Retrieves information about a record in an archive file. You may get the number of nodes in an archive using getArchiveNodeCount.
nNodeNum: The number of the record to retrieve information about. The first node is node 0.
Return Value: An ArchiveNode object with the information about the record
saveArchiveNode
void saveArchiveNode(
int nNodeNum,
File file) throws OutsideInException
Extracts a record in an archive file to disk.
nNodeNumType: The number of the record to retrieve information about. The first node is node 0.
file: The destination file to which the file will be extracted.
setSourceFile
OptionsCache setSourceFile( String filename) throws OutsideInException
Set the source document.
filename: Full path of the source document
Returns: The options cache object associated with this document
Enables API users to handle I/O for the source and destination documents. Implement this interface to control I/O operations such as reading, writing, and seeking. This interface mimics the java.nio.channels.SeekableByteChannel interface which is only available in Java 7 and later. Note that SeekableByteChannel6 will be removed in favor of java.nio.channels.SeekableByteChannel if support for Java 6 is dropped in a future release of the Outside In Java API. Until then, this interface must be used if redirected I/O is required.
Namespace
com.oracle.outsidein
Methods
Get position
long position()
Returns this channel's position.
Set position
SeekableByteChannel6 position(long newPosition)
Sets this channel's position.
read
int read(java.nio.ByteBuffer dst)
Reads a sequence of bytes from this channel into the given buffer. Bytes are read starting at this channel's current position, and then the position is updated with the number of bytes actually read.
size
long size()
Returns the current size of the entity to which this channel is connected.
truncate
SeekableByteChannel6 truncate(long size)
Truncates the entity, to which this channel is connected, to the given size. Never invoked by Outside In and may be implemented by just returning this.
write
int write(java.io.nio.ByteBuffer src)
Writes a sequence of bytes to this channel from the given buffer. Bytes are written starting at this channel's current position. The entity to which the channel is connected is grown, if necessary, to accommodate the written bytes, and then the position is updated with the number of bytes actually written.
close
void close()
Closes this channel. If this channel is already closed then invoking this method has no effect.
isOpen
boolean isOpen()
Tells whether or not this channel is open.
This section describes the OptionsCache class.
The options that configure the way outputs are generated are accessed through the OptionsCache class.
All of the options described in the following subsections are available through this interface. Other methods in this interface are described below.
Namespace
com.oracle.outsidein.options
Methods
OptionsCache setSourceFile(File file) throws OutsideInException
Sets the source document to be opened.
file: Full path to source file
OptionsCache setSourceFile(SeekableByteChannel6 redirect) throws OutsideInException
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).
redirect: Object implementing SeekableByteChannel6 to be used to read the source data containing the input file
OptionsCache setSourceFile(SeekableByteChannel6 redirect, String filename) throws OutsideInException
Sets an object that implements SeekableByteChannel6 to be used as the source document and provides information about the filename.
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
OptionsCache addSourceFile(File file) throws OutsideInException
Sets the next source document file to be exported in sequence. This allows multiple documents to be exported to the same output destination.
file: Full path to source file
OptionsCache addSourceFile(SeekableByteChannel6 redirect)
Set a redirected channel as the next source document to be exported to the original destination file. This method has the same limitations as the similar setSourceFile(SeekableByteChannel6 redirect) method.
OptionsCache addSourceFile(SeekableByteChannel6 redirect, String Filename)
Set a redirected channel as the next source document to be exported to the original destination file. The file name provided is used as in the method setSourceFile(SeekableByteChannel6 redirect, String Filename)
OptionsCache setSourceFormat(FileFormat fileId)
Sets the source format to process the input file as, ignoring the algorithmic detection of the file type.
fileId: the format to treat the input document as.
OptionsCache setDestinationFile(File file) throws OutsideInException
Sets the location of the destination file.
file: Full path to the destination file
OptionsCache setDestinationFile(SeekableByteChannel6 redirect) throws OutsideInException
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.
redirect: Object implementing SeekableByteChannel6 to be used as the destination document written during an Exporter.export() operation
OptionsCache setDestinationFormat(FileFormat fileId)
Sets the destination file format to which the file should be converted.
fileId: the format to convert the input document(s) to.
OptionsCache setCallbackHandler(Callback callback)
Sets the object to use to handle callbacks.
callback: the callback handling object.
OptionsCache setPasswordsList(List<String> Passwords)
Provides a list of strings to use as passwords for encrypted documents. The technology will cycle through this list until a successful password is found or the list is exhausted.
Passwords: List of strings to be used as passwords.
OptionsCache setLotusNotesId(String NotesIdFile)
Sets the Lotus Notes ID file location.
NotesIdFile: Full path to the Notes ID file.
OptionsCache setOpenForNonSequentialAccess(boolean bOpenForNonSequentialAccess)
Setting this option causes the technology to open archive files in a special mode that is only usable for non-sequential access of nodes.
bOpenForNonSequentialAccess : If set to true would open the archive file in the special access mode. Note that turning this flag on a non-archive file will throw an exception at RunExport time.
OIT Option ID: SCCOPT_REORDERMETHOD
This option controls how the technology reorders bidirectional text.
Data Type
BiDiReorderMethodValue
BiDiReorderMethodValue Enumeration
One of the following values:
UNICODEOFF: This disables any processing for bidirectional characters. This option is the default.
UNICODELTOR: Characters displayed using the Unicode bidirectional algorithm assuming a base left-to-right order. Use this option to enable bidirectional rendering.
UNICODERTOL: Characters displayed using the Unicode bidirectional algorithm assuming a base right-to-left order. Use this option to force starting bidirectional rendering in the right-to-left.
Default
UNICODEOFF
OIT Option ID: SCCOPT_GRAPHIC_CROPPING
When set to True, this option forces Image Export to crop 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.
Data Type
boolean
OIT Option ID: SCCOPT_DEFAULTINPUTCHARSET
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.
Data Type
DefaultInputCharacterSetValue
DefaultInputCharacterSetValue Enumeration
DefaultInputCharacterSetValue can be one of the following enumerations:
SYSTEMDEFAULT
UNICODE
BIGENDIANUNICODE
LITTLEEENDIANUNICODE
UTF8
UTF7
ASCII
UNIXJAPANESE
UNIXJAPANESEEUC
UNIXCHINESETRAD1
UNIXCHINESEEUCTRAD1
UNIXCHINESETRAD2
UNIXCHINESEEUCTRAD2
UNIXKOREAN
UNIXCHINESESIMPLE
EBCDIC37
EBCDIC273
EBCDIC274
EBCDIC277
EBCDIC278
EBCDIC280
EBCDIC282
EBCDIC284
EBCDIC285
EBCDIC297
EBCDIC500
EBCDIC1026
DOS437
DOS737
DOS850
DOS852
DOS855
DOS857
DOS860
DOS861
DOS863
DOS865
DOS866
DOS869
WINDOWS874
WINDOWS932
WINDOWS936
WINDOWS949
WINDOWS950
WINDOWS1250
WINDOWS1251
WINDOWS1252
WINDOWS1253
WINDOWS1254
WINDOWS1255
WINDOWS1256
WINDOWS1257
ISO8859_1
ISO8859_2
ISO8859_3
ISO8859_4
ISO8859_5
ISO8859_6
ISO8859_7
ISO8859_8
ISO8859_9
MACROMAN
MACCROATIAN
MACROMANIAN
MACTURKISH
MACICELANDIC
MACCYRILLIC
MACGREEK
MACCE
MACHEBREW
MACARABIC
MACJAPANESE
HPROMAN8
BIDIOLDCODE
BIDIPC8
BIDIE0
RUSSIANKOI8
JAPANESEX0201
Default
SYSTEMDEFAULT
OIT Option ID: SCCOPT_DEFAULTPRINTFONT
This option sets the font to use when the chunker-specified font is not available on the system. It is also the font used when the font in source file is not available on the system performing the conversion.
Class members:
string strFaceName
UInt16 FontHeight
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.
Data Type
Margins
Data
A Margins object with the margins on the 4 sides defined.
Default
1 inch for all margins (1440, 1440, 1440, 1440)
OIT Option ID: SCCOPT_DOCUMENTMEMORYMODE
This option determines the maximum amount of memory that the chunker may use to store the document's data, from 4 MB to 1 GB. The more memory the chunker has available to it, the less often it needs to re-read data from the document.
Data
SMALLEST: 1 - 4MB
SMALL: 2 - 16MB
MEDIUM: 3 - 64MB
LARGE: 4 - 256MB
LARGEST: 5 - 1 GB
Default
LARGE: 4 - 256MB
OIT Option ID: SCCOPT_WPEMAILHEADEROUTPUT
This option controls rendering of email headers.
Data
ALL: Displays all available email headers.
STANDARD: Displays "To," "From," "Subject," "CC," "BCC," "Date Sent," and "Attachments" header fields only. The filter outputs any fields not listed above as hidden fields, so they will not display.
NONE: Displays no email header fields.
CUSTOM
Default
STANDARD
This option allows the user to enable alpha-channel blending (transparency) in rendering vector images. This is primarily useful to improve fidelity when rendering with a slower graphics engine, such as X-Windows over a network when performance is not an issue.
Data
Boolean
Default
False
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.
Data Type
FallbackFormatValue
FallbackFormatValue Enumeration
TEXT: Unidentified file types will be treated as text files.
NONE: Outside In will not attempt to process files whose type cannot be identified
Default
TEXT
OIT Option ID: SCCOPT_SSPRINTSCALEXHIGH
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 SSPrintFitToPage option is set to FitToPages.
Data Type
long
Default
1
OIT Option ID: SCCOPT_SSPRINTSCALEXWIDE
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 SSPrintFitToPage option is set to FitToPages.
Data Type
long
Default
1
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.
Data Type
FontAliases
Data
A FontAliases object with a list of font matchings.
Default
Windows and Unix PrintAlias defaults
OIT Option ID: SCCOPT_GRAPHIC_HEIGHT
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 GraphicHeightLimit and GraphicWidth options can override the setting for GraphicHeight.
Data Type
long
OIT Option ID: SCCOPT_GRAPHIC_HEIGHTLIMIT
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.
Data Type
long
OIT Option ID: SCCOPT_GRAPHIC_OUTPUTDPI
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, the special #define of SCCGRAPHIC_MAINTAIN_IMAGE_DPI, which is defined as 0, 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 SCCGRAPHIC_MAINTAIN_IMAGE_DPI 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 the SCCGRAPHIC_MAINTAIN_IMAGE_DPI setting 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; the default is 96 DPI.
Data Type
long
OIT Option ID: SCCOPT_GRAPHIC_RENDERASPAGE
GraphicRenderAsPage 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 GraphicRenderAsPage is enabled, 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.
Data Type
boolean
Data
true: Raster file images are fit to page.
false: Raster file images are not fit to page.
Default
false
OIT Option ID: SCCOPT_GRAPHIC_SIZELIMIT
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 setting 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.
Data Type
long
OIT Option ID: SCCOPT_GRAPHIC_SIZEMETHOD
This option determines the method used to size graphics. The developer can choose among three methods, each of which involves some degree of trade off between the quality of the resulting image and speed of conversion.
Using the quick sizing option results in the fastest conversion of color graphics, though the quality of the converted graphic will be somewhat degraded. The smooth sizing option results in a more accurate representation of the original graphic, as it uses anti-aliasing. Antialiased images may appear smoother and can be easier to read, but rendering when this option is set will require additional processing time. The grayscale only option also uses antialiasing, but only for grayscale graphics, and the quick sizing option for any color graphics.
The smooth sizing option does not work on images which have a width or height of more than 4096 pixels.
Data
QUICKSIZING
SMOOTHSIZING
SMOOTHGRAYSCALESIZING
OIT Option ID: SCCOPT_GRAPHIC_WIDTH
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 GraphicHeight 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 GraphicHeightLimit and GraphicWidthLimit options can override the setting for GraphicWidth.
Data Type
long
OIT Option ID: SCCOPT_GRAPHIC_WIDTHLIMIT
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.
Data Type
long
OIT Option ID: SCCOPT_MAXSSDBPAGEHEIGHT
Normally, the size of images 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 UseDocumentPageSettings, GraphicWidth and GraphicHeight options are 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 GridMaxPageWidth and GridMaxPageHeight options 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.
Data Type
long
Data
The maximum page height (including margins) specified in twips (1440 twips are in 1 inch). If the value specified is smaller than the page height, then an error will be returned.
OIT Option ID: SCCOPT_MAXSSDBPAGEWIDTH
See the documentation for GridMaxPageHeight for a full discussion of how this option works and interacts with other options affecting the page size of images generated from spreadsheet and database pages.
Data Type
long
Data
The maximum page width (including margins) specified in twips (1440 twips are in 1 inch). If the value specified is smaller than the page width, then Image Export will return an error.
OIT Option ID: SCCOPT_HTML_COND_COMMENT_MODE
Some HTML input files may include "conditional comments", which are HTML comments that mark areas of HTML to be interpreted in specific versions of Internet Explorer, while being ignored by other browsers. This option allows you to control how the content contained within conditional comments will be interpreted by Outside In's HTML parsing code.
Data
NONE: Don't output any conditional comment
IE5: Include the IE5 comments
IE6: Include the IE6 comments
IE7: Include the IE7 comments
IE8: Include the IE8 comments
IE9: Include the IE9 comments
ALL: Include all conditional comments
OIT Option ID: SCCOPT_IGNORE_PASSWORD
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 should prompt for a password if it handles password-protected files.
Data Type
boolean
Note:
This option is no longer relevant. Outside In no longer performs graphic rendering through X11 on Linux/Unix platforms.The internal rendering engine is available on all of these platforms. If this option is set, the results will always use the internal rendering engine regardless of the value of this option. The $GDFONTPATH environment variable must be set to specify where to reference fonts. On Windows systems, the Windows graphical rendering engine is always used.
OIT Option ID: SCCOPT_FORMATFLAGS
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.
Data Type
boolean
Default
false
OIT Option ID: SCCOPT_JPEG_QUALITY
This option allows the developer to specify the lossyness of JPEG compression. The option is only valid if the dwOutputID parameter of the EXOpenExport function is set to FI_JPEGFIF, FI_PDF, FI_PDFA, or FI_PDFA_2.
Data Type
long
Data
A value from 1 to 100, with 100 being the highest quality but the least compression, and 1 being the lowest quality but the most compression.
Default
100
OIT Option ID: SCCOPT_LOTUSNOTESDIRECTORY
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.
Type (Common): String
Data
A path to the Lotus Notes directory.
Default
If this option isn't set, then OIT will first attempt to load the Lotus library according to the operating system's PATH environment variable, and then attempt to find and load the Lotus library as indicated in HKEY_CLASSES_ROOT\Notes.Link.
This option lets you specify a text string for margin text.
Data Type
MarginText
Default
None
This option lets you set the font and font size for margin text.
Data Type
FontInfo
Default
Arial, 9 pt.
OIT Option ID: SCCOPT_SSPRINTDIRECTION
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 UseDocumentPageSettings option is set to TRUE and print direction is specified in the input document.
Data
PageDirectionValue.ACROSS: Specifies that pages are printed across first and then down.
PageDirectionValue.DOWN: Specifies that pages are printed down first and then across.
Default
PageDirectionValue.DOWN
OIT Option ID: SCCOPT_DBPRINTFITTOPAGE
OIT Option ID: SCCOPT_SSPRINTFITTOPAGE
This option scales a spreadsheet file or database image to a certain percent or to a page width or height. However, in an effort to preserve readability after scaling, Image 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 DefaultPageMargins option will be included in any scaling that is applied to the output image as a result of settings for this option.
This option is overridden when the UseDocumentPageSettings option is set to TRUE and fitting the page to the printer's image limits is specified in the input document.
Data
NOMAP: No scaling is performed on the spreadsheet or database image. It will render in its original size onto as many pages as are required to fit the data.
FITTOWIDTH: Scale the spreadsheet or database image in the rendered image so it is no larger than one page wide.
FITTOHEIGHT: Scale the spreadsheet or database image in the rendered image so it is no larger than one page high.
SCALE: Scale the spreadsheet or the database image in the rendered image using the scale value stored in the PageScalePercent option.
FITTOPAGES: Scale the spreadsheet or the database image in the rendered image to fit to the number of pages specified in the FitHeightToPages and FitWidthToPages options. Since aspect ratio is maintained, the lesser of the two dimensions (width or height) will determine the scale factor. Note that if either FitHeightToPages or FitWidthToPages is set to 0, the value in the other option will be nullified.
Default
SCALE: Scales the rendered image of the spreadsheet or database image using the scale value stored in the PageScalePercent option (which is 100 by default).
OIT Option ID: SCCOPT_WHATTOPRINT
OIT Option ID: SCCOPT_PRINTSTARTPAGE
OIT Option ID: SCCOPT_PRINTENDPAGE
This option indicates whether the whole file or a selected range of pages should be rendered. When selecting a range, the start and ending pages are specified.
Data Type
PageRange
Data
The page range to be exported.
Default
All pages are printed
OIT Option ID: SCCOPT_SSPRINTSCALEPERCENT
This option will scale spreadsheet pages by the percentage specified. The option has no effect unless the SSPrintFitToPage option is set to Scale.
This option must take a value between 1 and 100. If any value outside of this range is used, the option will be ignored.
Data Type
long
Default
100
This option allows the user to limit the number of embedded objects that are produced in a PDF file.
Data Type
long
Data
The maximum number of embedded objects to produce in PDF output. Setting this to 0 would produce an all embedded objects in the input document.
Default
0 – produce all objects.
This option allows the user to limit the number of vector paths that are produced in a PDF file.
Data Type
long
Data
The maximum number of paths to produce in PDF output. Setting this to 0 would produce an all vector objects in the input document.
Default
0 – produce all vector objects.
OIT Option ID: SCCOPT_PDF_FILTER_REORDER_BIDI
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.
PDFReorderBiDiValue Enumeration
This enumeration defines the type of Bidirection text reordering the PDF filter should perform.
STANDARDBIDI: Do not attempt to reorder bidirectional text runs.
REORDEREDBIDI: Attempt to reorder bidirectional text runs.
This option controls the spacing threshold in PDF input documents. Most PDF documents do not have an explicit character denoting a word break. The PDF filter calculates the distance between two characters to determine if they are part of the same word or if there should be a word break inserted. The space between characters is compared to the length of the space character in the current font multiplied by this fraction. If the space between characters is larger, then a word break character is inserted into the text stream. Otherwise, the characters are considered to be part of the same word and no word break is inserted.
Data Type
float
Data
A value representing the percentage of the space character used to trigger a word break. Valid values are positive values less than 2.
Default
0.85
OIT Option ID: SCCOPT_FIFLAGS
This option affects how an input file's internal format (application type) is identified when the file is first opened by the 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.)
Data Type
boolean
Data
One of the following values:
false: When this is set, standard file identification behavior occurs.
true: If set, the File Identification code will run an extended test on all files that are not identified.
Default
true
OIT Option ID: SCCOPT_QUICKTHUMBNAIL
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.
Data Type
boolean
Data
true: Render scaled images as quick thumbnails.
false: Render scaled images completely.
Default
true
This option provides the ability to specify the color used for a redaction rectangle (black or white) as well as the color used (black or white) for the redaction code. When the colors match, the redaction code is effectively invisible. Settings should default to Black redactions with White codes if not explicitly set. The values may be set on each redaction individually, both in the UI and in the rendered output.
Value
ColorInfo
Data
Any valid CSS color
This option sets the name and size of font to use for redaction labels. The font size may be reduced to allow text to fit within a redaction rectangle.
Data Type
FontInfo
Default
Default display font, 9 pt.
This option allows you to display redaction labels in your output.
Data Type
boolean
Default
False (no labels)This option tells the export to format the output to be redaction-capable. In practical terms what this means is that all embeddings will be rasterized (routed through sccimg) so that a rectangle in an embedding is consistent across all output formats.
Data Type
boolean
Default
False
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 are used to render text; if the option is set to false, the embedded fonts are not used and the fallback is to use fonts available to Outside In to render text.
Data Type
boolean
Default
true
OIT Option ID: SCCOPT_DBPRINTGRIDLINES
OIT Option ID: SCCOPT_SSPRINTGRIDLINES
If this option is TRUE, a line is generated between cells in the rendered image.
This option is overridden when the UseDocumentPageSettings option is set to TRUE and printing grid lines between cells is specified in the input document.
Data Type
boolean
Default
true
OIT Option ID: SCCOPT_DBPRINTHEADINGS
OIT Option ID: SCCOPT_SSPRINTHEADINGS
If this option is TRUE, field, row and column headings will be generated along with the data.
This option is overridden when the UseDocumentPageSettings option is set to TRUE and printing column and row headers is specified in the input document.
Data Type
boolean
Default
true
OIT Option ID: SCCOPT_ARCFULLPATH
This option causes the full path of a node to be returned in "GetArchiveNodeInfo" and "GetObjectInfo".
Data Type
boolean
Data
true: Provide the full path.
false: Do not provide the path.
Default
false
OIT Option ID: SCCOPT_SSSHOWHIDDENCELLS
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. This is a Boolean option that will leave the data hidden when it is FALSE, and show all hidden rows and columns when it is TRUE, displayed using the default row width or default column height.
Data Type
boolean
Default
false
The setting for this option determines whether or not hidden data (hidden columns, rows or 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.
Data Type
boolean
Default
false
When an embedded file or URL can't be opened with the full path, OutsideIn 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.
Data Type
boolean
Default
false
This option determines the byte order used within the file.
Data
BIGENDIAN: This will use big-endian (Motorola) byte ordering.
LITTLEENDIAN: This will use little-endian (Intel) byte ordering (this is the default value for this parameter).
This option allows the developer to control the TIFF color depth and color options.
Data Type
TIFFColorSpaceValue
TIFFColorSpaceValue Enumeration
BLKWHITE: 1 bit black and white
PALETTE8BIT: 8 bit palette
RGB24BIT: 24 bit RGB (this is the default value for this parameter)
This option will specify the type of compression used in the TIFF file that is generated.
Data
NONE
PACKBITS
LZW
CCITT_1D
CCITT_GROUP3
CCITT_GROUP4
This option determines the fill order used within the file. The value of this element only affects TIFF output when the TIFFCompression option is set to CCITT_GROUP3 and the TIFFColorSpace element is set to BLKWHITE.
Data Type
TIFFFillOrderValue
TIFFFillOrderValue Enumeration
The following set of flags:
FILESTORE: TIFF files intended for file stores
TRANSMISSION: TIFF files intended for electronic transmission (example fax)
Default
FILESTORE
This allows the developer to specify whether the output creates a single multi-page TIFF file or individual single page files. When this flag is true, the output of multiple pages from one input document will generate a single file with a separate image for each page converted.
Data Type
boolean
Default
false
OIT Option ID: SCCOPT_TIMEZONE
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:
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.
Data Type
long
Data
Integer parameter from -96 to 96, representing 15-minute offsets from GMT. To query the operating system for the time zone set on the machine, specify SCC_TIMEZONE_USENATIVE.
Default
0: GMT time
OIT Option ID: SCCOPT_GRAPHIC_TRANSPARENCYCOLOR
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.
Use the (r, g, b) macro to create the color value to pass to this option. The red, green and blue values are percentages of the color from 0-255 (with 255 being 100%). Note that this macro should be used to set a variable and that variable should then be passed to the set option routine (instead of trying to use the macro as part of the set option call directly).
Since there is no way to "unset" an option once it has been set, the developer may set the option to DefaultTransparencyColor if they wish to revert to the default behavior.
Class members:
byte Red
byte Green
byte Blue
Data
ColorInfo
Default
new ColorInfo(): Use the same tranparency color as the source document.
OIT Option ID: SCCOPT_UNMAPPABLECHAR
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.
Data Type
int
Data
The Unicode value for the character to use.
Default
0x002a = "*"
OIT Option ID: SCCOPT_USEDOCPAGESETTINGS
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 DefaultPageMargins, 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.
Data Type
boolean
Default
true
The ExportStatus class provides access to information about a conversion. This information may include information about sub-document failures, areas of a conversion that may not have high fidelity with the original document. When applicable the number of pages in the output is also provided.
Namespace
com.oracle.outsidein
Accessors
long getPageCount() - A count of all of the output pages produced during an export operation.
EnumSet<ExportStatusFlags> getStatusFlags() - Gets the information about possible fidelity issues with the original document.
long getSubDocsFailed() - Number of sub documents that were not converted.
long getSubDocsPassed() - Number of sub documents that were successfully converted.
ExportStatusFlags Enumeration
This enumeration is the set of possible known problems that can occur during an export process.
NoInformationAvailable: No Information is available
MissingMap: A PDF text run was missing the toUnicode table
VerticalText: A vertical text run was present
TextEffects: A run that had unsupported text effects applied. One example is Word Art
UnsupportedCompression: A graphic had an unsupported compression
UnsupportedColorSpace: A graphic had an unsupported color space
Forms: A sub documents had forms
RightToLeftTables: A table had right to left columns
Equations: A file had equations
AliasedFont: The desired font was missing, but a font alias was used
MissingFont: The desired font wasn't present on the system
SubDocFailed: a sub-document was not converted
TypeThreeFont: A type 3 font was encountered.
UnsupportedShading: An unsupported shading pattern was encountered.
InvalidHTML: An HTML parse error, as defined by the W3C, was encountered.
bInvalidAnnotationNotApplied: Unsupported annotation/redaction wasn't rendered.
This class defines the identifiers for file formats.
Namespace
com.oracle.outsidein
Methods
GetDescription
String GetDescription()
This method returns the description of the format.
GetId
int GetId()
This method returns the numeric identifier of the format.
ForId
FileFormat ForId(int id)
This method returns the FileFormat object for the given identifier.
id: The numeric identifier for which the corresponding FileFormat object is returned.
FontAliases is a class for providing font matching of unknown fonts.
Namespace
com.oracle.outsidein.options
Constructor
FontAliases(boolean clearDefaults, Map<String, String> aliasList) useDefaults Option whether to initialize the list to a set of platform-specific default aliases (true) or to an empty list (false) aliasList Aliases list as a key-value pair with original name as key
Accessors
Map<String, String> getAliasList() - List of font aliases set.
Map<String, String> getDefaultAliases() - List of platform-specific default font aliases that are applied when "true" is passed as the first argument of the constructor.
FontInfo is a class to define a font for use in the OutsideIn API.
Namespace
com.oracle.outsidein.options
Constructors
FontInfo(String fontface, int height) fontface The name of the font height Size of the font in half points
FontInfo()
Constructs a FontInfo object with a 10 point Arial Font.
Accessors
String getFontface() - The name of the font
int getHeight() - Size of the font in half points
FontList is a class for inclusion or exclusion of fonts in exported documents.
Namespace
com.oracle.outsidein.options
Constructor
FontList(boolean isExclusion, String[] fonts) IsExclusion If set then accompanying list is an exclusion list fonts List of fonts to include or exclude
Accessors
boolean isExcludeList() - If set, then accompanying list is an exclusion list.
String[] getFontsList - List of fonts to include or exclude.
HighlightTextAnnotation is a class for defining Text highlighted Annotations. This class derives from the Annotation class.
Namespace
com.oracle.outsidein.annotations
Constructors
HighlightTextAnnotation(long StartCharCount,
long EndCharCount,
EnumSet<CharAttributeValues> CharAttrs,
Enumset<CharAttributeValues> CharMask)
HighlightTextAnnotation(long StartCharCount,
long EndCharCount,
ColorInfo Foreground,
ColorInfo Background)
HighlightTextAnnotation(long StartCharCount,
long EndCharCount,
ColorInfo Foreground,
ColorInfo Background,
EnumSet<CharAttributeValues> CharAttrs,
EnumSet<CharAttributeValues> CharMask)
StartCharCount The character count of the starting position
EndCharCount The character count of the end position
Foreground The text color of the highlight
Background The background color of the highlight
CharAttrs the character attributes to use
CharMask character attributes to change
Initializes a new instance of the HighlightTextAnnotation class.
Accessors
StartCharCount: The character count of the starting position
EndCharCount: The character count of the end position
Foreground: The text color of the highlight
Background: The background color of the highlight
CharAttrs: The character attributes to use
CharMask: Character attributes to change
CharAttributeValues Enumeration
This enumeration is the list of all character attributes to apply for the text highlight.
NORMAL: Normal text - All attributes off
UNDERLINE: Underline attribute
ITALIC: Italic attribute
BOLD: Bold attribute
STRIKEOUT: Strike out text
SMALLCAPS: Small caps
OUTLINE: Outline Text
SHADOW: Shadow text
CAPS: All Caps
SUBSCRIPT: Subscript text
SUPERSCRIPT: Superscript text
DUNDERLINE: Double Underline
WORDUNDERLINE: Word Underline
DOTUNDERLINE: Dotted Underline
DASHUNDERLINE: Dashed Underline
ALL: All attributes
MailHeaders class is a class describing the Mail Headers to be displayed, hidden or modified.
Namespace
com.oracle.outsidein.options
Constructors
MailHeaders()
Constructs a MailHeaders object with standard headers only.
MailHeaders(MailHeaders.BaselineValue baseline) baseline The starting point to add or delete headers.
Accessors
void setBaseline(MailHeaders.BaselineValue) MailHeaders.BaselineValue getBaseline()
The starting point to add or delete headers.
Methods
MailHeaders excludeHeader(MailHeaders.MailTypeValue mtype, MailHeaders.MailHeaderValue mhdr)
This method adds a standard header to the hidden list.
mtype: The type of documents in which to hide this header
mhdr: The header to hide
This method returns a reference to the updated MailHeaders object.
MailHeaders excludeHeader(MailHeaders.MailTypeValue mtype, String Exclusion)
This method adds a custom header to be the hidden list.
mtype: The type of documents in which to hide this header
Exclusion: User-specified MIME header name to be excluded
This method returns a reference to the updated MailHeaders object.
MailHeaders includeHeader(MailHeaders.MailTypeValue mtype, MailHeaders.MailHeaderValue mhdr)
This method adds a standard header to the visible list.
mtype: The type of documents in which to show this header
mhdr: The header to hide
This method returns a reference to the updated MailHeaders object.
MailHeaders includeHeader(MailHeaders.MailTypeValue mtype, String Original, String Replacement)
This method adds a custom header to the visible list.
mtype: The type of documents in which to show this header
Original: User-specified MIME header name
Replacement: String that will be used as the label for the user-defined MIME header
This method returns a reference to the updated MailHeaders object.
void setVisibleHeaders(Map<MailHeaders.MailTypeValue, Map<String, String>> headers)
This method sets a series of custom headers to the visible headers list.
headers: A key value pair of user-specified MIME headers and their replacement strings
void setHiddenHeaders(Map<MailHeaderValue.MailTypeValue, List<String>> headers)
This method sets a series of custom headers to the hidden headers list.
headers: A list of user-specified MIME headers to be hidden
MailHeaders.BaselineValue Enumeration
The BaselineValue is an enumeration of the possible baselines (starting points to add or exclude headers).
MailHeaders.MailTypeValue Enumeration
The MailTypeValue is an enumeration of the types of mail documents.
The Margins Class is used to describe the page margins.
Namespace
com.oracle.outsidein.options
Constructors
Margins()
Constructs a Margins object with a 1 inch margins for top, bottom, left and right margins.
Margins(long top,
long bottom,
long left,
long right)
top Margin from the top edge of the page (in twips)
bottom Margin from the bottom edge of the page (in twips)
left Margin from the left edge of the page (in twips)
right Margin from the right edge of the page (in twips)
Accessors
long getTop() - Margin from the top edge of the page (in twips)
long getBottom() - Margin from the bottom edge of the page (in twips)
long getLeft() - Margin from the left edge of the page (in twips)
long getRight() - Margin from the right edge of the page (in twips)
This class provides a mechanism to define the Margin text to be applied to a page/document.
Namespace
OutsideIn
Constructors
MarginText(Map<MarginText.Location, String>)
Constructs a Margin text object with a list of lines.
MarginText(MarginText.Location, String)
Constructs a Margin text object with a single line.
Methods
void addMarginText(Map<MarginText.Location, String>)
Adds a set of Margin text lines.
void addMarginText(MarginText.Location, String)
Adds a line of Margin text.
Location Enumeration
This enumeration is the list of all the locations margin text can be applied to.
TOPLEFTLINE1 : Line 1 of Top Left Corner of page
TOPLEFTLINE2 : Line 2 of Top Left Corner of page
TOPLEFTLINE3 : Line 3 of Top Left Corner of page
TOPCENTERLINE1 : Line 1 of Top Center of page
TOPCENTERLINE2 : Line 2 of Top Center of page
TOPCENTERLINE3 : Line 3 of Top Center of page
TOPRIGHTLINE1 : Line 1 of Top Right Corner of page
TOPRIGHTLINE2 : Line 2 of Top Right Corner of page
TOPRIGHTLINE3 : Line 3 of Top Right Corner of page
BOTTOMLEFTLINE1 : Line 1 of Bottom Left Corner of page
BOTTOMLEFTLINE2 : Line 2 of Bottom Left Corner of page
BOTTOMLEFTLINE3 : Line 3 of Bottom Left Corner of page
BOTTOMCENTERLINE1 : Line 1 of Bottom Center of page
BOTTOMCENTERLINE2 : Line 2 of Bottom Center of page
BOTTOMCENTERLINE3 : Line 3 of Bottom Center of page
BOTTOMRIGHTLINE1 : Line 1 of Bottom Right Corner of page
BOTTOMRIGHTLINE2 : Line 2 of Bottom Right Corner of page
BOTTOMRIGHTLINE3 : Line 3 of Bottom Right Corner of page
The Option Interface provides the methods and properties to retrieve information about an Outside In Option.
Package
com.oracle.outsidein.options
Accessors
String getName() — Gets the name of the option
String getDescription() — Gets the description of the option
Class<?> getDataType() — Gets the type of the option value.
Class<?>[] getItemTypes() — Gets the type parameters for option values that are generics
EnumSet<Option.OutsideInProducts> getSupportingProducts() — Gets the list of products that support this option
Methods
void set(OptionsCache exporter, Object objValue) throws OutsideInException;
This method sets the option to the exporter object and returns the exporter object itself.
exporter — The exporter object
objValue — Value of the option
Note:
If the type of objValue cannot be converted to the data type the option is expecting, an OutsideInException is thrown.
Object get(OptionsCache exporter)
This method gets the currently set value for the option.
exporter: The exporter object who’s option value is requested.
OutsideInProducts Enumeration
HTMLEXPORT — Outside In HTML Export
IMAGEEXPORT — Outside In Image Export
PDFEXPORT — Outside In PDF Export
SEARCHEXPORT — Outside In Search Export
WEBVIEWEXPORT — Outside In Web View Export
XMLEXPORT — Outside In XML Export
This is a utility class that creates an instance of an Exporter object on request.
Namespace
com.oracle.outsidein
Methods
static Exporter newLocalExporter()
This method creates an instance of an Exporter object. It returns a newly created Exporter object.
static Exporter newLocalExporter(Exporter source)
This method creates and returns an instance of an Exporter object based on the source Exporter. All the options of source are copied to the new Exporter. The source and destination file information will not be copied.
OutsideInVersion getCoreVersion()
This static method returns an OutsideInVersion object with information describingthe Outside In Core Technology used.
void setLocation(File oilinkDir)
Sets an explicit path to the native Outside In libraries and oilink.exe. If used, this method must be called prior to any other Outside In method or this method will throw an exception. If setLocation() is not used, the location will be determined by searching for the Outside In libraries in the following order:
the location specified in the 'OILinkLocation' Java property
the 'oit' subdirectory under the directory containing oilink.jar
the directory containing oilink.jar
The OutsideIn Class is used to describe the version of the Outside In Core Module.
Namespace
com.oracle.outsidein
Methods
String GetVersion()
This method returns the version information as a string in the format of “MajorVersion.MinorVersion.DotVersion”.
int getMajorVersion()
The major version component.
int getMinorVersion()
The minor version component.
int getDotVersion()
The dot version component.
This is the exception that is thrown when an Outside In Technology error occurs.
This class derives from the Exception class. This class has no public methods or properties except those of the parent Exception class.
Namespace
com.oracle.outsidein
PageInfo is a class for defining page dimensions.
Namespace
com.oracle.outsidein.options
Constructor
PageInfo(PageInfo.PageSizeUnitsValue units,
float width,
float height)
units Units used to specify width and height
width Width of the page
height Height of the page
Accessors
PageInfo.PageSizeUnitsValue getUnits() - Units used to specify width and height
float getWidth() - Width of the page
float getHeight() - Height of the page
PageInfo.PageSizeUnitsValue Enumeration
PageSizeUnitsValue is an enumeration of the various units that can be used to specify the width and height of a page.
Inches: Units are in Inches
Points: Units are in Points (1/72th of an inch)
Centimeters: Units are in Centimeters
Picas: Units are in Picas (1/6th of an inch)
PageRange is a class for defining page ranges for exporting purposes.
Namespace
com.oracle.outsidein.options
Constructors
PageRange()
Creates an instance of the PageRangeObject for printing all pages.
PageRange(long StartPage) StartPage Starting page number of the print range
Creates an instance of the PageRangeObject for printing from a page until end of document.
PageRange(
long StartPage,
long StopPage) throws OutsideInException
StartPage Starting page number of the print range
StopPage End page number of the print range
Creates an instance of the PageRangeObject for printing a range of pages.
Accessors
boolean getPrintAll() - If set to true, all pages of the document will be printed
long getStartPage() - The start page of the print range. 0 indicates printing will begin with the first page of the document.
long getStopPage() - The last page of the print range. 0 indicates the last page at the end of the document.
This class describes the watermark to be applied to a document.
Namespace
com.oracle.outsidein.options
Constructors
Watermark(File file) throws OutsideInException
Creates a watermark object with the image to be used.
file: A File object with the image file to be used as a watermark.
Watermark(SeekableByteChannel6 redirect) throws OutsideInException
Creates a watermark object with the image to be used.
redirect: A redirected I/O object with the image to be used as a watermark.
Watermark(File file, int opacity, int percent, AnchorPosition anchor, int vertOffset, int horzOffset) throws OutsideInException
file: A File object with the image file to be used as a watermark.
opacity: The opacity of the watermark. Opacity is in the range of 1-255.
percent: The percentage the watermark image is scaled by. A value of 0 indicates no scaling.
anchor: The position from which the watermark image is offset.
vertOffset: The vertical offset to shift the image by
horzOffset: The horizontal offset to shift the image by.
Watermark(SeekableByteChannel6 redirect, int opacity, int percent, AnchorPosition anchor, int vertOffset, int horzOffset) throws OutsideInException
redirect: A redirected I/O objectwith the image to be used as a watermark.
opacity: The opacity of the watermark. Opacity is in the range of 1-255.
percent: The percentage the watermark image is scaled by. A value of 0 indicates no scaling.
anchor: The position from which the watermark image is offset.
vertOffset: The vertical offset to shift the image by.
horzOffset: The horizontal offset to shift the image by
Methods
AnchorPosition getAnchorPosition()
Retrieves the Watermark's Anchor position. This is the position from which the horizontal and vertical offsets are applied.
void setAnchorPosition(AnchorPosition position)
Sets the Watermark's Anchor position. This is the position from which the horizontal and vertical offsets are applied.
int getHorzOffset()
Gets the horizontal offset to shift the image by.
void setHorzOffset(int offset)
Sets the horizontal offset to shift the image by.
int getOpacity()
Gets the opacity of the watermark. Opacity is in the range of 1-255. 0 disables the watermark.
void setOpacity(int opacity)
Sets the opacity of the watermark. Opacity is in the range of 1-255. 0 disables the watermark.
int getPercent()
Gets the percentage amount by which the image is to be scaled. A value of 0 indicates no scaling.
void setPercent(int percent)
Sets the percentage amount by which the image is to be scaled. A value of 0 indicates no scaling.
int getVertOffset()
Gets the vertical offset to shift the image by.
void setVertOffset(int offset)
Sets the vertical offset to shift the image by.