jp.co.antenna.XfoJavaCtl
Class XfoObj

java.lang.Object
  extended by jp.co.antenna.XfoJavaCtl.XfoObj

public class XfoObj
extends java.lang.Object

XfoObj Class is the object class of AH Formatter

Version:
3.0 2003/07/17
Author:
Copyright (C) 2002-2003, Antenna House, Inc. All Rights Reserved.

Field Summary
static int S_FORMATTERTYPE_AUTO
          Formatter Type AUTO
static int S_FORMATTERTYPE_HTML
          Formatter Type HTML
static int S_FORMATTERTYPE_XHTML
          Formatter Type XHTML
static int S_FORMATTERTYPE_XMLCSS
          Formatter Type XML+CSS
static int S_FORMATTERTYPE_XSLFO
          Formatter Type XSL-FO
static int S_INX_OUTPUTMODE_BLOCK
          INX block output mode
static int S_INX_OUTPUTMODE_LINE
          INX line output mode
static int S_INX_OUTPUTMODE_TEXT
          INX text output mode
static int S_MIF_IMAGEPROCMODE_EMBED
          MIF image embed mode
static int S_MIF_IMAGEPROCMODE_LINK
          MIF image link mode
static int S_MIF_OUTPUTMODE_BLOCK
          MIF block output mode
static int S_MIF_OUTPUTMODE_LINE
          MIF line output mode
static int S_MIF_OUTPUTMODE_TEXT
          MIF text output mode
static int S_PDF_EMBALLFONT_ALL
          Embed all fonts without Base14 font
static int S_PDF_EMBALLFONT_BASE14
          Embed all fonts
static int S_PDF_EMBALLFONT_PART
          Embed specified font
static int S_PDF_ENCLEVEL_128
          Same as S_PDF_ENCLEVEL_128RC4
static int S_PDF_ENCLEVEL_128AES
          PDF encrypt level 128-bit AES
static int S_PDF_ENCLEVEL_128RC4
          PDF encrypt level 128-bit RC4
static int S_PDF_ENCLEVEL_256AES
          PDF encrypt level 256-bit AES
static int S_PDF_ENCLEVEL_40
          Same as S_PDF_ENCLEVEL_40RC4
static int S_PDF_ENCLEVEL_40RC4
          PDF encrypt level 40-bit RC4
static int S_PDF_IMGCMPR_AUTO
          ImageCompression Auto
static int S_PDF_IMGCMPR_JPEG
          ImageCompression JPEG compression
static int S_PDF_IMGCMPR_JPEG2K
          ImageCompression JPEG2000 compression
static int S_PDF_IMGCMPR_ZLIB
          ImageCompression ZLIB compression
static int S_PDF_IMGDOWNSAMPLING_AVERAGE
          Downsampling biliner
static int S_PDF_IMGDOWNSAMPLING_BICUBIC
          Downsampling bicubic
static int S_PDF_IMGDOWNSAMPLING_NONE
          Downsampling none
static int S_PDF_IMGDOWNSAMPLING_SUBSAMPLING
          Downsampling nearest neighbor
static int S_PDF_MONOCMPR_CCITT3
          Monochrome-compression CCITTFaxDecode group 3 filter
static int S_PDF_MONOCMPR_CCITT4
          Monochrome-compression CCITTFaxDecode group 4 filter
static int S_PDF_MONOCMPR_OFF
          Monochrome-compression no filter
static int S_PDF_MONOCMPR_RUNLENGTH
          Monochrome-compression RunLengthDecode filter
static int S_PDF_MONOCMPR_ZLIB
          Monochrome-compression FlateDecode filter
static int S_PDF_PRALLOW_HIGH
          High Resolution Printing
static int S_PDF_PRALLOW_LOW
          Low Resolution Printing
static int S_PDF_PRALLOW_NONE
          Printing Not Allowed
static int S_PDF_RGBCONV_ALL
          All RGB to DeviceGray
static int S_PDF_RGBCONV_BLACK
          Black to DeviceGray
static int S_PDF_RGBCONV_GRAY
          Gray to DeviceGray
static int S_PDF_RGBCONV_NONE
          No Conversion
static int S_PDF_VERSION_13
          PDF version 1.3
static int S_PDF_VERSION_14
          PDF version 1.4
static int S_PDF_VERSION_15
          PDF version 1.5
static int S_PDF_VERSION_16
          PDF version 1.6
static int S_PDF_VERSION_17
          PDF version 1.7
static int S_PDF_VERSION_A_1a_2005
          ISO 19005-1:2005 (based on PDF1.4)
static int S_PDF_VERSION_A_1b_2005
          ISO 19005-1:2005 (based on PDF1.4)
static int S_PDF_VERSION_X_1a_2001
          ISO 15930-1:2001 PDF/X-1a-2001 (based on PDF1.3)
static int S_PDF_VERSION_X_1a_2003
          ISO 15930-4:2003 PDF/X-1a-2003 (based on PDF1.4)
static int S_PDF_VERSION_X_2_2003
          ISO 15930-5:2003 PDF/X-2-2003 (based on PDF1.4)
static int S_PDF_VERSION_X_3_2002
          ISO 15930-3:2002 PDF/X-3-2002 (based on PDF1.3)
static int S_PDF_VERSION_X_3_2003
          ISO 15930-6:2003 PDF/X-3-2003 (based on PDF1.4)
static int S_PDF_VERSION_X_4_2008
          ISO 15930-7:2008 PDF/X-4-2008 (based on PDF1.6)
static int S_SVG_IMGCNV_AUTO
          Image-conversion Auto
static int S_SVG_IMGCNV_JPEG
          Image-conversion JPEG
static int S_SVG_IMGCNV_PNG
          Image-conversion PNG
static int S_SVG_IMGDOWNSAMPLING_AVERAGE
          Downsampling biliner
static int S_SVG_IMGDOWNSAMPLING_BICUBIC
          Downsampling bicubic
static int S_SVG_IMGDOWNSAMPLING_SUBSAMPLING
          Downsampling nearest neighbor
static int S_SVG_IMGPT_COPY
          Image-processing copy linked image
static int S_SVG_IMGPT_COPY_ALL
          Image-processing copy all images
static int S_SVG_IMGPT_EMBED_ALL
          Image-processing embed all images
static int S_SVG_IMGPT_LINK
          Image-processing link linked images
static int S_SVG_VERSION_11
          SVG version 1.1
static int S_SVG_VERSION_BASIC
          SVG Basic
static int S_SVG_VERSION_TINY
          SVG Tiny
 
Constructor Summary
XfoObj()
          Create the instance of XfoObj, and initialize it.
 
Method Summary
 void addOptionFileURI(java.lang.String path)
          Set the path name of option setting URI.
 void addUserStylesheetURI(java.lang.String uri)
          Add the URI of user stylesheet that is used when formatting.
 void clear()
          Cleanup (initialize) AH Formatter engine.
 void clearFontAlias()
          Clear all substitutions of font name.
 void clearXSLTParam()
          Clear all parameter names and values of xsl:param.
 void eraseFontAlias(java.lang.String src)
          Erase the substitution of font name.
 void execute()
          Execute formatting and outputs to a PDF.
 java.lang.String getAlternateStyleTags()
          Get alternate style tags.
 java.lang.String getBaseURI()
          Get the default base URI.
 boolean getBatchPrint()
          Get the setting of whether print dialog box is displayed or not when printing.
 java.lang.String getDocumentURI()
          Get the URI of XML document to be formatted.
 int getEndPage()
          Get the end page number of document to output.
 int getEndVolume()
          Get the end volume of document to output.
 int getErrorCode()
          Get the error code of the error that occurred during the formatting process.
 int getErrorLevel()
          Get the error level to abort formatting process.
 java.lang.String getErrorMessage()
          Get the error message of the error that occurred during the formatting process.
 int getErrorStreamType()
          Get the error output.
 int getExitLevel()
          Get the error level to abort formatting process.
 java.lang.String getExternalXSLT()
          Get command-line string for external XSLT processor.
 boolean getFlashHidePageButton()
          Get specifies of the FlashHidePageButton.
 boolean getFlashPartiallyOutput()
          [en]Get specifies of the FlashPartiallyOutput.
 int getFormattedPages()
          [en]Get formatted total pages.
 int getFormatterType()
          Get formatter type.
 boolean getGdiImageSmoothing()
          Get html default charset.
 int getInitialPageNumber()
          Gets the initial page number.
 int getInitialVolumeNumber()
          Gets the initial volume number.
 int getInxOutputMode()
          Gets the INX output mode.
 int getMifIpMode()
          Gets the MIF image processing mode.
 int getMifOutputMode()
          Gets the MIF output mode.
 boolean getMultiVolume()
          Get multiple volume of PDF output.
 int getOptionFileCount()
          Counts the number of Option Setting File you specified.
 java.lang.String getOptionFileURI()
          Get the path name of option setting file.
 java.lang.String getOptionFileURI(int n)
          Get the path name of option setting file.
 java.lang.String getOutputFilePath()
          Get the path name of the output file that is the result of formatting.
 java.lang.String getOutputFOPath()
          Get the path name of output FO file as the result of XSLT.
 int getOutputVolumeCount()
          Gets the number of the actual separate volumes when outputting PDF to multiple separate volumes.
 int getPageNumberFromID(java.lang.String id)
          Gets the page number from ID.
 boolean getPartialVolume()
          Gets the partial volume mode.
 java.lang.String getPdfCertificateName()
          Gets the value of a certificate information name.
 boolean getPdfCompressContentStream()
          Gets the value of whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not.
 boolean getPdfConvertImageColorSpace()
          Gets the value of whether to convert image color space or not.
 boolean getPdfEmbedAllFonts()
          [en]Gets the value of whether to embed all embeddable fonts in PDF.
 int getPdfEmbedAllFontsEx()
          Gets the value of whether to embed all embeddable fonts.
 java.lang.String getPdfEmbedFonts()
          Gets the font specified to be embedded in PDF.
 int getPdfEmbedSubsetFontPercentage()
          Gets the value of percentage to embed subset fonts.
 int getPdfEncryptLevel()
          [en]Get the key length when encrypting the PDF file during outputting.
 boolean getPdfErrorOnEmbedFault()
          Gets the value of whether to issues the error when failing to embed fonts.
 boolean getPdfErrorOnMissingGlyph()
          Gets the value of whether to issues the error when missing glyph.
 boolean getPdfErrorOnPDFXFault()
          Gets the value of whether to issue error or not when PDF/X is generating.
 int getPdfGrayscaleImageCompression()
          Gets the value of how to compress the grayscale images embedded in PDF.
 int getPdfGrayscaleImageDownSampling()
          Gets the value of method to downsample the grayscale image.
 int getPdfGrayscaleImageDownSamplingDPI()
          Gets resolution of the grayscale image which performs a downsampling.
 int getPdfGrayscaleImageDownSamplingTarget()
          Gets resolution when the grayscale image is downsampled.
 int getPdfGrayscaleJPEGQuality()
          Gets the value of the quality of JPEG format that is specified by setPdfGrayscaleImageCompression stored in PDF.
 int getPdfImageCompression()
          Gets the value of how to compress the color images embedded in PDF.
 int getPdfImageDownSampling()
          Gets the value of method to downsample the color image.
 int getPdfImageDownSamplingDPI()
          Gets resolution of the grayscale image which performs a downsampling.
 int getPdfImageDownSamplingTarget()
          Gets resolution when the color image is downsampled.
 boolean getPdfImport3DAnnotation()
          Gets the value of whether to import 3D annotations or not.
 int getPdfJPEGQuality()
          [en]Gets the value of the quality of JPEG format that is specified by setPdfImageCompression() stored in PDF.
 boolean getPdfLinearize()
          Gets the value of whether to output linearize PDF or not.
 int getPdfMonochromeImageCompression()
          Gets the value of how to compress the monochrome images embedded in PDF.
 int getPdfMonochromeImageDownSampling()
          Gets the value of method to downsample the monochrome image.
 int getPdfMonochromeImageDownSamplingDPI()
          Gets resolution of the monochrome image which performs a downsampling.
 int getPdfMonochromeImageDownSamplingTarget()
          Gets resolution when the monochrome image is downsampled.
 boolean getPdfNoAccessibility()
          Get the specification that disables text access for screen reader devices of the PDF file.
 boolean getPdfNoAddingOrChangingComments()
          Get the specification that disables adding comments and form fields to the PDF file.
 boolean getPdfNoAssembleDoc()
          Get the specification that disables inserting, deleting and rotating the PDF pages.
 boolean getPdfNoChanging()
          Get the specification that disables making changes of the PDF file.
 boolean getPdfNoContentCopying()
          Get the specification that disables copying the content of the PDF file.
 boolean getPdfNoFillForm()
          Get the specification that disables adding comments and form fields to the PDF file.
 boolean getPdfNoPrinting()
          Get the specification that disables printing the PDF file.
 java.lang.String getPdfOutputHeight()
          Gets the height of PDF to output.
 java.lang.String getPdfOutputWidth()
          Gets the width of PDF to output.
 int getPdfPrintingAllowed()
          Gets the value of whether to print the resulting PDF file or not.
 boolean getPdfPutImageColorProfile()
          Gets specification whether to embed to PDF the color profile of the color image that will be embedded to PDF.
 int getPdfRasterizeResolution()
          Gets the value of the rasterised-resolution of the transformed raster images.
 boolean getPdfReversePage()
          Gets the value of whether to output reverse page or not.
 int getPdfRGBConversion()
          [en]Gets the value of how to convert the RGB color space (DebiceRGB) to DeviceGray.
 boolean getPdfSignature()
          Gets the value of whether to sign a signature to PDF or not.
 java.lang.String getPdfSignatureName()
          Gets the value of a signature information name.
 boolean getPdfTag()
          Gets the value of whether to output Tagged PDF or not.
 boolean getPdfUseLaunchForRelativeURI()
          Gets the value of how to transform external link specified by the relative address in the PDF link.
 int getPdfVersion()
          Get the version of PDF.
 java.lang.String getPrinterName()
          Get the printer name where the formatted result is outputted.
 java.lang.String getPrinterSettingURI()
          Get the printer setting URI.
 boolean getPrnCollate()
          Get the collation of multiple copies.
 int getPrnCopies()
          Get the number of copies.
 int getSplitPages()
          [en]Gets the split-by-pages setting.
 int getStartPage()
          Get the start page number of document to output.
 int getStartVolume()
          Get the start volume of document to output.
 java.lang.String getStylesheetTitle()
          Get prior Stylesheet PI title.
 java.lang.String getStylesheetURI()
          Get the URI of XSL stylesheet that is used when formatting.
 boolean getSvgEmbedAllFonts()
          Gets the setting indicating whether to embed fonts in the outputted SVG.
 java.lang.String getSvgEmbedFonts()
          Gets the font specified to be embedded in SVG.
 boolean getSvgErrorOnEmbedFault()
          Gets the value of whether to issues the error when failing to embed fonts.
 java.lang.String getSvgFormat()
          Gets the format for naming files when the outputted SVG becomes multiple.
 boolean getSvgGzipCompression()
          Gets the setting indicating whether to compress the outputted SVG into gzip format or not.
 int getSvgImageConversion()
          Gets the value of how to convert the images embedded in SVG.
 java.lang.String getSvgImageCopyPath()
          Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.
 java.lang.String getSvgImagePrefix()
          Gets the prefix of the file name when images are copied to the directory specified by setSvgImageCopyPath and processed.
 int getSvgImageProcessingType()
          Gets specification how to treat the referred image.
 boolean getSvgImageRename()
          Gets specification whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name.
 int getSvgJPEGQuality()
          Gets the value of the quality of JPEG format that is specified by setSvgImageConversion() stored in SVG.
 int getSvgRasterizeResolution()
          Gets the value of the rasterised-resolution of the transformed raster images.
 boolean getSvgSingleFile()
          Gets Specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.
 boolean getSvgSinglePageNumber()
          Gets specification whether to add sequential number to the output SVG even if it has only one-page.
 int getSvgVersion()
          Get the version of SVG..
 int getTotalVolumeCount()
          Gets the number of all the separate volumes when outputting PDF to multiple separate volumes.
 boolean getTwoPassFormatting()
          Get the specification of two pass format.
 java.lang.String getVersion()
          Get the version string of AHFormatter.
 java.lang.String getWatermarkFontFamily()
           Acquires the font family to the character string which you set to watermark-text.
 java.lang.String getWatermarkFontStyle()
           [en].
 java.lang.String getWatermarkFontWeight()
           Acquires the opacity of the character string which you set to watermark-text.
 java.lang.String getWatermarkText()
           [en]Acquires the watermark text specified for each page.
 java.lang.String getXSLTParamFormat()
          [en]Get the parameter format of xsl:param when using External XSLT Processor.
 void releaseObject()
          Release the instance of XfoObj.
 void releaseObjectEx()
          Release the instance of XfoObj.
 void render(java.io.InputStream xmlSrc, java.io.InputStream xslSrc, java.io.OutputStream dst, java.lang.String outDevice)
          Transforms an XML document specified to xmlSrc using an XSL stylesheet specified to xslSrc.
 void render(java.io.InputStream src, java.io.OutputStream dst, java.lang.String outDevice)
          Executes the formatting of XSL-FO document specified for src, and outputs it to dst in the output form specified for dst.
 void setAlternateStyleTags(java.lang.String alternateStyleTags)
          Set alternate style tags.
 void setBaseURI(java.lang.String uri)
          Set the default base URI.
 void setBatchPrint(boolean bat)
          Set whether the print dialog box is displayed or not when printing.
 void setDocumentURI(java.lang.String uri)
          Set the URI of XML document to be formatted.
 void setEndPage(int num)
          Set the end page number of document to output.
 void setEndVolume(int num)
          Set the end volume of document to output.
 void setErrorStreamType(int type)
          Set the error output.
 void setExitLevel(int level)
          Set the error level to abort formatting process.
 void setExternalXSLT(java.lang.String cmd)
          Set the command-line string for external XSLT processor.
 void setFlashHidePageButton(boolean newVal)
          Sets the substitution of font name.
 void setFormatPageListener(XfoFormatPageListener listener)
          Register the XfoFormatPageListener interface to the instance of implemented class.
 void setFormatterType(int formatterType)
          Set formatter type.
 void setGdiImageSmoothing(boolean newVal)
          Set html default charset.
 void setInitialPageNumber(int newVal)
          Sets the initial page number.
 void setInitialVolumeNumber(int newVal)
          Sets the initial volume number.
 void setInxOutputMode(int newVal)
          Specifies the INX output mode.
 void setMessageListener(MessageListener listener)
          Register the MessageListener interface to the instance of implemented class.
 void setMifIpMode(int newVal)
          Specifies the MIF image processing mode.
 void setMifOutputMode(int newVal)
          Specifies the MIF output mode.
 void setMultiVolume(boolean newVal)
          Specifies multiple volume of PDF output.
 void setOptionFileURI(java.lang.String path)
          Set the path name of option setting URI.
 void setOutputFilePath(java.lang.String path)
          Specifies the output file path of the formatted result.
 void setOutputFOPath(java.lang.String path)
          Set the path name of output FO file as the result of XSLT.
 void setPartialVolume(boolean newVal)
          Sets the partial volume mode.
 void setPdfCertificateName(java.lang.String name)
          Sets a certificate information name.
 void setPdfCompressContentStream(boolean newVal)
          Specifies whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not.
 void setPdfConvertImageColorSpace(boolean newVal)
          Sets the value of whether to convert image color space or not.
 void setPdfEmbedAllFonts(boolean newVal)
          [en]Embeds all embeddable fonts in PDF to create.
 void setPdfEmbedAllFontsEx(int newVal)
          Specifies whether to embed the all outline data of fonts in PDF or not, which are True type fonts and Type1 Fonts and are embeddable in the formatted result.
 void setPdfEmbedFonts(java.lang.String newVal)
          Embeds the specified font in PDF to create.
 void setPdfEmbedSubsetFontPercentage(int newVal)
          Set percentage to embed subset fonts.
 void setPdfEncryptLevel(int newVal)
          [en]Specifies the key length when encrypting the PDF file during outputting.
 void setPdfErrorOnEmbedFault(boolean newVal)
          an error is issued in case of failing to embed fonts.
 void setPdfErrorOnMissingGlyph(boolean newVal)
          an error is issued in case of missing glyph.
 void setPdfErrorOnPDFXFault(boolean newVal)
          An error is not issued when PDF/X is generating.
 void setPdfGrayscaleImageCompression(int newVal)
          Specifies how to compress the grayscale images embedded in PDF.
 void setPdfGrayscaleImageDownSampling(int newVal)
          Specifies the following either of method to downsample the grayscale image that is put into PDF.
 void setPdfGrayscaleImageDownSamplingDPI(int newVal)
          Set resolution of the grayscale image which performs a downsampling.
 void setPdfGrayscaleImageDownSamplingTarget(int newVal)
          Set resolution when the grayscale image is downsampled.
 void setPdfGrayscaleJPEGQuality(int newVal)
          For the grayscale image format that can not be stored directly in PDF, specifies the image quality by the numerical value within the range of 1-100 when IMGCMPR_JPEG is specified by setPdfGrayscaleImageCompression.
 void setPdfImageCompression(int newVal)
          Specifies how to compress the color images embedded in PDF.
 void setPdfImageDownSampling(int newVal)
          Specifies the following either of method to downsample the color image that is put into PDF.
 void setPdfImageDownSamplingDPI(int newVal)
          Set resolution of the grayscale image which performs a downsampling.
 void setPdfImageDownSamplingTarget(int newVal)
          Set resolution when the color image is downsampled.
 void setPdfImport3DAnnotation(boolean newVal)
          Sets the value of whether to import 3D annotations or not.
 void setPdfJPEGQuality(int newVal)
          [en]For the color image format that can not be stored directly in PDF, specifies the image quality by the numerical value within the range of 1-100 when IMGCMPR_JPEG is specified by setPdfImageCompression.
 void setPdfLinearize(boolean newVal)
          Specifies whether to output linearize PDF or not.
 void setPdfMonochromeImageCompression(int newVal)
          Specifies how to compress the monochrome images embedded in PDF.
 void setPdfMonochromeImageDownSampling(int newVal)
          monochrom.
 void setPdfMonochromeImageDownSamplingDPI(int newVal)
          Set resolution of the monochrome image which performs a downsampling.
 void setPdfMonochromeImageDownSamplingTarget(int newVal)
          Set resolution when the monochrome image is downsampled.
 void setPdfNoAccessibility(boolean newVal)
          Disables text access for screen reader devices of the PDF file.
 void setPdfNoAddingOrChangingComments(boolean newVal)
          Disables adding comments and form fields to the PDF file.
 void setPdfNoAssembleDoc(boolean newVal)
          Disables inserting, deleting and rotating the PDF pages.
 void setPdfNoChanging(boolean newVal)
          Disables making changes of the PDF file.
 void setPdfNoContentCopying(boolean newVal)
          Disables copying the content of the PDF file.
 void setPdfNoFillForm(boolean newVal)
          Disables adding comments and form fields to the PDF file.
 void setPdfNoPrinting(boolean newVal)
          Disables printing the PDF file.
 void setPdfOutputHeight(java.lang.String newVal)
          Scales the height of PDF to output.
 void setPdfOutputScale(java.lang.String newVal)
          Specifies the scaling ratio of the PDF to output.
 void setPdfOutputWidth(java.lang.String newVal)
          Scales the width of PDF to output.
 void setPdfOwnerPassword(java.lang.String newVal)
          Specifies the owner password for PDF.
 void setPdfPrintingAllowed(int newVal)
          Spesifies whether to permit printing PDF to create.
 void setPdfPutImageColorProfile(boolean newVal)
          Specifies whether to embed to PDF the color profile of the color image that will be embedded to PDF.
 void setPdfRasterizeResolution(int newVal)
          Specifies the value of the rasterised-resolution of the transformed raster images in the range from 70 to 500(dpi).
 void setPdfReversePage(boolean newVal)
          Sets the value of whether to output reverse page or not.
 void setPdfRGBConversion(int newVal)
          [en]Specifies how to convert the RGB color space (DeviceRGB) to DeviceGray.
 void setPdfSignature(boolean newVal)
          Specifies whether to sign a signature to PDF or not.
 void setPdfSignatureName(java.lang.String name)
          Sets a signature information name.
 void setPdfTag(boolean newVal)
          Generates Tagged PDF.
 void setPdfUseLaunchForRelativeURI(boolean newVal)
          Specifies whether the external link specified by the relative address is transformed into 'Open the file' or into 'World Wide Web link' in the PDF link properties.
 void setPdfUserPassword(java.lang.String newVal)
          Specifies the user password for PDF.
 void setPdfVersion(int newVal)
          Enables specifying whether the version of PDF.
 void setPrinterName(java.lang.String prn)
          Specifies the output format or the printer name to output.
 void setPrinterSettingURI(java.lang.String prn)
          Set the printer setting URI.
 void setPrnCollate(boolean col)
          Set collation of multiple copies.
 void setPrnCopies(int num)
          Set the number of copies.
 void setSplitPages(int newVal)
          Set the split-by-pages setting.
 void setStartPage(int num)
          Set the start page number of document to output.
 void setStartVolume(int num)
          Set the start volume of document to output.
 void setStylesheetTitle(java.lang.String title)
          Set prior Stylesheet PI title.
 void setStylesheetURI(java.lang.String uri)
          Set the URI of XSL stylesheet that is used when formatting.
 void setSvgEmbedAllFonts(boolean newVal)
          Specifies whether to embed fonts in the outputted SVG.
 void setSvgEmbedFonts(java.lang.String newVal)
          Embeds the specified font in SVG to create.
 void setSvgErrorOnEmbedFault(boolean newVal)
          an error is issued in case of failing to embed fonts.
 void setSvgFormat(java.lang.String newVal)
          Specifies the format for naming files when the outputted SVG becomes multiple.
 void setSvgGzipCompression(boolean newVal)
          Specifies whether to compress the outputted SVG into gzip format or not.
 void setSvgImageConversion(int newVal)
          Specifies how to convert the images embedded in SVG to create.
 void setSvgImageCopyPath(java.lang.String newVal)
          Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.
 void setSvgImagePrefix(java.lang.String newVal)
          When images are copied to the directory specified by setSvgImageCopyPath and processed, specifies the prefix of the file name.
 void setSvgImageProcessingType(int newVal)
          Specifies how to treat the referred image.
 void setSvgImageRename(boolean newVal)
          When images are copied to the directory specified by setSvgImageCopyPath etc. and processed, specifies whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name.
 void setSvgJPEGQuality(int newVal)
          Specifies the quality of the Raster graphics when stored in JPEG format using the range of 1-100.
 void setSvgRasterizeResolution(int newVal)
          Specifies the value of the rasterised-resolution of the transformed raster images in the range from 70 to 500(dpi).
 void setSvgSingleFile(boolean newVal)
          Specifies whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.
 void setSvgSinglePageNumber(boolean newVal)
          When setSvgSingleFile = 0 is specified, specifies whether to add sequential number to the output SVG even if it has only one-page.
 void setSvgVersion(int newVal)
          Enables specifying whether the version of SVG.
 void setTwoPassFormatting(boolean val)
          Specifies the two pass format.
 void setWatermarkFontFamily(java.lang.String newVal)
          Set the parameter name and value for xsl:param.
 void setXSLTParamFormat(java.lang.String form)
          Set the parameter format of xsl:param when using External XSLT Processor.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

S_FORMATTERTYPE_AUTO

public static final int S_FORMATTERTYPE_AUTO
Formatter Type AUTO

See Also:
Constant Field Values

S_FORMATTERTYPE_HTML

public static final int S_FORMATTERTYPE_HTML
Formatter Type HTML

See Also:
Constant Field Values

S_FORMATTERTYPE_XHTML

public static final int S_FORMATTERTYPE_XHTML
Formatter Type XHTML

See Also:
Constant Field Values

S_FORMATTERTYPE_XMLCSS

public static final int S_FORMATTERTYPE_XMLCSS
Formatter Type XML+CSS

See Also:
Constant Field Values

S_FORMATTERTYPE_XSLFO

public static final int S_FORMATTERTYPE_XSLFO
Formatter Type XSL-FO

See Also:
Constant Field Values

S_INX_OUTPUTMODE_BLOCK

public static final int S_INX_OUTPUTMODE_BLOCK
INX block output mode

See Also:
Constant Field Values

S_INX_OUTPUTMODE_LINE

public static final int S_INX_OUTPUTMODE_LINE
INX line output mode

See Also:
Constant Field Values

S_INX_OUTPUTMODE_TEXT

public static final int S_INX_OUTPUTMODE_TEXT
INX text output mode

See Also:
Constant Field Values

S_MIF_IMAGEPROCMODE_EMBED

public static final int S_MIF_IMAGEPROCMODE_EMBED
MIF image embed mode

See Also:
Constant Field Values

S_MIF_IMAGEPROCMODE_LINK

public static final int S_MIF_IMAGEPROCMODE_LINK
MIF image link mode

See Also:
Constant Field Values

S_MIF_OUTPUTMODE_BLOCK

public static final int S_MIF_OUTPUTMODE_BLOCK
MIF block output mode

See Also:
Constant Field Values

S_MIF_OUTPUTMODE_LINE

public static final int S_MIF_OUTPUTMODE_LINE
MIF line output mode

See Also:
Constant Field Values

S_MIF_OUTPUTMODE_TEXT

public static final int S_MIF_OUTPUTMODE_TEXT
MIF text output mode

See Also:
Constant Field Values

S_PDF_EMBALLFONT_ALL

public static final int S_PDF_EMBALLFONT_ALL
Embed all fonts without Base14 font

See Also:
Constant Field Values

S_PDF_EMBALLFONT_BASE14

public static final int S_PDF_EMBALLFONT_BASE14
Embed all fonts

See Also:
Constant Field Values

S_PDF_EMBALLFONT_PART

public static final int S_PDF_EMBALLFONT_PART
Embed specified font

See Also:
Constant Field Values

S_PDF_ENCLEVEL_128

public static final int S_PDF_ENCLEVEL_128
Same as S_PDF_ENCLEVEL_128RC4

See Also:
Constant Field Values

S_PDF_ENCLEVEL_128AES

public static final int S_PDF_ENCLEVEL_128AES
PDF encrypt level 128-bit AES

See Also:
Constant Field Values

S_PDF_ENCLEVEL_128RC4

public static final int S_PDF_ENCLEVEL_128RC4
PDF encrypt level 128-bit RC4

See Also:
Constant Field Values

S_PDF_ENCLEVEL_256AES

public static final int S_PDF_ENCLEVEL_256AES
PDF encrypt level 256-bit AES

See Also:
Constant Field Values

S_PDF_ENCLEVEL_40

public static final int S_PDF_ENCLEVEL_40
Same as S_PDF_ENCLEVEL_40RC4

See Also:
Constant Field Values

S_PDF_ENCLEVEL_40RC4

public static final int S_PDF_ENCLEVEL_40RC4
PDF encrypt level 40-bit RC4

See Also:
Constant Field Values

S_PDF_IMGCMPR_AUTO

public static final int S_PDF_IMGCMPR_AUTO
ImageCompression Auto

See Also:
Constant Field Values

S_PDF_IMGCMPR_JPEG

public static final int S_PDF_IMGCMPR_JPEG
ImageCompression JPEG compression

See Also:
Constant Field Values

S_PDF_IMGCMPR_JPEG2K

public static final int S_PDF_IMGCMPR_JPEG2K
ImageCompression JPEG2000 compression

See Also:
Constant Field Values

S_PDF_IMGCMPR_ZLIB

public static final int S_PDF_IMGCMPR_ZLIB
ImageCompression ZLIB compression

See Also:
Constant Field Values

S_PDF_IMGDOWNSAMPLING_AVERAGE

public static final int S_PDF_IMGDOWNSAMPLING_AVERAGE
Downsampling biliner

See Also:
Constant Field Values

S_PDF_IMGDOWNSAMPLING_BICUBIC

public static final int S_PDF_IMGDOWNSAMPLING_BICUBIC
Downsampling bicubic

See Also:
Constant Field Values

S_PDF_IMGDOWNSAMPLING_NONE

public static final int S_PDF_IMGDOWNSAMPLING_NONE
Downsampling none

See Also:
Constant Field Values

S_PDF_IMGDOWNSAMPLING_SUBSAMPLING

public static final int S_PDF_IMGDOWNSAMPLING_SUBSAMPLING
Downsampling nearest neighbor

See Also:
Constant Field Values

S_PDF_MONOCMPR_CCITT3

public static final int S_PDF_MONOCMPR_CCITT3
Monochrome-compression CCITTFaxDecode group 3 filter

See Also:
Constant Field Values

S_PDF_MONOCMPR_CCITT4

public static final int S_PDF_MONOCMPR_CCITT4
Monochrome-compression CCITTFaxDecode group 4 filter

See Also:
Constant Field Values

S_PDF_MONOCMPR_OFF

public static final int S_PDF_MONOCMPR_OFF
Monochrome-compression no filter

See Also:
Constant Field Values

S_PDF_MONOCMPR_RUNLENGTH

public static final int S_PDF_MONOCMPR_RUNLENGTH
Monochrome-compression RunLengthDecode filter

See Also:
Constant Field Values

S_PDF_MONOCMPR_ZLIB

public static final int S_PDF_MONOCMPR_ZLIB
Monochrome-compression FlateDecode filter

See Also:
Constant Field Values

S_PDF_PRALLOW_HIGH

public static final int S_PDF_PRALLOW_HIGH
High Resolution Printing

See Also:
Constant Field Values

S_PDF_PRALLOW_LOW

public static final int S_PDF_PRALLOW_LOW
Low Resolution Printing

See Also:
Constant Field Values

S_PDF_PRALLOW_NONE

public static final int S_PDF_PRALLOW_NONE
Printing Not Allowed

See Also:
Constant Field Values

S_PDF_RGBCONV_ALL

public static final int S_PDF_RGBCONV_ALL
All RGB to DeviceGray

See Also:
Constant Field Values

S_PDF_RGBCONV_BLACK

public static final int S_PDF_RGBCONV_BLACK
Black to DeviceGray

See Also:
Constant Field Values

S_PDF_RGBCONV_GRAY

public static final int S_PDF_RGBCONV_GRAY
Gray to DeviceGray

See Also:
Constant Field Values

S_PDF_RGBCONV_NONE

public static final int S_PDF_RGBCONV_NONE
No Conversion

See Also:
Constant Field Values

S_PDF_VERSION_13

public static final int S_PDF_VERSION_13
PDF version 1.3

See Also:
Constant Field Values

S_PDF_VERSION_14

public static final int S_PDF_VERSION_14
PDF version 1.4

See Also:
Constant Field Values

S_PDF_VERSION_15

public static final int S_PDF_VERSION_15
PDF version 1.5

See Also:
Constant Field Values

S_PDF_VERSION_16

public static final int S_PDF_VERSION_16
PDF version 1.6

See Also:
Constant Field Values

S_PDF_VERSION_17

public static final int S_PDF_VERSION_17
PDF version 1.7

See Also:
Constant Field Values

S_PDF_VERSION_A_1a_2005

public static final int S_PDF_VERSION_A_1a_2005
ISO 19005-1:2005 (based on PDF1.4)

See Also:
Constant Field Values

S_PDF_VERSION_A_1b_2005

public static final int S_PDF_VERSION_A_1b_2005
ISO 19005-1:2005 (based on PDF1.4)

See Also:
Constant Field Values

S_PDF_VERSION_X_1a_2001

public static final int S_PDF_VERSION_X_1a_2001
ISO 15930-1:2001 PDF/X-1a-2001 (based on PDF1.3)

See Also:
Constant Field Values

S_PDF_VERSION_X_1a_2003

public static final int S_PDF_VERSION_X_1a_2003
ISO 15930-4:2003 PDF/X-1a-2003 (based on PDF1.4)

See Also:
Constant Field Values

S_PDF_VERSION_X_2_2003

public static final int S_PDF_VERSION_X_2_2003
ISO 15930-5:2003 PDF/X-2-2003 (based on PDF1.4)

See Also:
Constant Field Values

S_PDF_VERSION_X_3_2002

public static final int S_PDF_VERSION_X_3_2002
ISO 15930-3:2002 PDF/X-3-2002 (based on PDF1.3)

See Also:
Constant Field Values

S_PDF_VERSION_X_3_2003

public static final int S_PDF_VERSION_X_3_2003
ISO 15930-6:2003 PDF/X-3-2003 (based on PDF1.4)

See Also:
Constant Field Values

S_PDF_VERSION_X_4_2008

public static final int S_PDF_VERSION_X_4_2008
ISO 15930-7:2008 PDF/X-4-2008 (based on PDF1.6)

See Also:
Constant Field Values

S_SVG_IMGCNV_AUTO

public static final int S_SVG_IMGCNV_AUTO
Image-conversion Auto

See Also:
Constant Field Values

S_SVG_IMGCNV_JPEG

public static final int S_SVG_IMGCNV_JPEG
Image-conversion JPEG

See Also:
Constant Field Values

S_SVG_IMGCNV_PNG

public static final int S_SVG_IMGCNV_PNG
Image-conversion PNG

See Also:
Constant Field Values

S_SVG_IMGDOWNSAMPLING_AVERAGE

public static final int S_SVG_IMGDOWNSAMPLING_AVERAGE
Downsampling biliner

See Also:
Constant Field Values

S_SVG_IMGDOWNSAMPLING_BICUBIC

public static final int S_SVG_IMGDOWNSAMPLING_BICUBIC
Downsampling bicubic

See Also:
Constant Field Values

S_SVG_IMGDOWNSAMPLING_SUBSAMPLING

public static final int S_SVG_IMGDOWNSAMPLING_SUBSAMPLING
Downsampling nearest neighbor

See Also:
Constant Field Values

S_SVG_IMGPT_COPY

public static final int S_SVG_IMGPT_COPY
Image-processing copy linked image

See Also:
Constant Field Values

S_SVG_IMGPT_COPY_ALL

public static final int S_SVG_IMGPT_COPY_ALL
Image-processing copy all images

See Also:
Constant Field Values

S_SVG_IMGPT_EMBED_ALL

public static final int S_SVG_IMGPT_EMBED_ALL
Image-processing embed all images

See Also:
Constant Field Values

S_SVG_IMGPT_LINK

public static final int S_SVG_IMGPT_LINK
Image-processing link linked images

See Also:
Constant Field Values

S_SVG_VERSION_11

public static final int S_SVG_VERSION_11
SVG version 1.1

See Also:
Constant Field Values

S_SVG_VERSION_BASIC

public static final int S_SVG_VERSION_BASIC
SVG Basic

See Also:
Constant Field Values

S_SVG_VERSION_TINY

public static final int S_SVG_VERSION_TINY
SVG Tiny

See Also:
Constant Field Values
Constructor Detail

XfoObj

public XfoObj()
       throws XfoException
Create the instance of XfoObj, and initialize it.

Throws:
XfoException
Method Detail

addOptionFileURI

public void addOptionFileURI(java.lang.String path)
                      throws XfoException
Set the path name of option setting URI.

Parameters:
path - Path name of option setting file
Throws:
XfoException
Since:
3.1

addUserStylesheetURI

public void addUserStylesheetURI(java.lang.String uri)
                          throws XfoException
Add the URI of user stylesheet that is used when formatting.

Parameters:
uri - URI of user stylesheet
Throws:
XfoException

clear

public void clear()
           throws XfoException
Cleanup (initialize) AH Formatter engine.

Throws:
XfoException

clearFontAlias

public void clearFontAlias()
                    throws XfoException
Clear all substitutions of font name.

Throws:
XfoException

clearXSLTParam

public void clearXSLTParam()
                    throws XfoException
Clear all parameter names and values of xsl:param.

Throws:
XfoException

eraseFontAlias

public void eraseFontAlias(java.lang.String src)
                    throws XfoException
Erase the substitution of font name.

Parameters:
src - The font name of original
Throws:
XfoException

execute

public void execute()
             throws XfoException
Execute formatting and outputs to a PDF. The PDF file is specified by setOutputFilePath() or printer that is specified by setPrinterName().

Throws:
XfoException

getAlternateStyleTags

public java.lang.String getAlternateStyleTags()
                                       throws XfoException
Get alternate style tags.

Returns:
Alternate style tags
Throws:
XfoException
Since:
6.1

getBaseURI

public java.lang.String getBaseURI()
                            throws XfoException
Get the default base URI.

Returns:
Base URI
Throws:
XfoException

getBatchPrint

public boolean getBatchPrint()
                      throws XfoException
Get the setting of whether print dialog box is displayed or not when printing.
This method is available only in Windows version.

Returns:
If "true", the print dialog box is displayed. If "false", the print dialog box is not displayed.
Throws:
XfoException

getDocumentURI

public java.lang.String getDocumentURI()
                                throws XfoException
Get the URI of XML document to be formatted.

Returns:
URI of XML document
Throws:
XfoException

getEndPage

public int getEndPage()
               throws XfoException
Get the end page number of document to output.

Returns:
End page number
Throws:
XfoException

getEndVolume

public int getEndVolume()
                 throws XfoException
Get the end volume of document to output.

Returns:
End volume
Throws:
XfoException
Since:
3.2

getErrorCode

public int getErrorCode()
                 throws XfoException
Get the error code of the error that occurred during the formatting process. Zero means no error. Non-zero indicates any error occurred.

Returns:
Error code
Throws:
XfoException

getErrorLevel

public int getErrorLevel()
                  throws XfoException
Get the error level to abort formatting process.

Returns:
Error level
0. No Error
1. Information
2. Warning
3. Recoverable Error
4. Fatal Error
Throws:
XfoException

getErrorMessage

public java.lang.String getErrorMessage()
                                 throws XfoException
Get the error message of the error that occurred during the formatting process.

Returns:
Error message
Throws:
XfoException

getErrorStreamType

public int getErrorStreamType()
                       throws XfoException
Get the error output.

Returns:
Error output
S_EST_NONE : No error output
S_EST_STDOUT : Error output is stdout
S_EST_STDERR : Error output is stderr
Throws:
XfoException

getExitLevel

public int getExitLevel()
                 throws XfoException
Get the error level to abort formatting process.

Returns:
Error level
Throws:
XfoException

getExternalXSLT

public java.lang.String getExternalXSLT()
                                 throws XfoException
Get command-line string for external XSLT processor.

Returns:
Command-line string for external XSLT processor
Throws:
XfoException

getFlashHidePageButton

public boolean getFlashHidePageButton()
                               throws XfoException
Get specifies of the FlashHidePageButton..
Effective when outputting to Flash.

Returns:
specifies of FlashHidePageButton.
Throws:
XfoException

getFlashPartiallyOutput

public boolean getFlashPartiallyOutput()
                                throws XfoException
Get specifies of the FlashPartiallyOutput..
Effective when outputting to Flash.

Returns:
specifies of FlashPartiallyOutput.
Throws:
XfoException

getFormattedPages

public int getFormattedPages()
                      throws XfoException
Get formatted total pages.

Returns:
Start page number
Throws:
XfoException
Since:
3.2

getFormatterType

public int getFormatterType()
                     throws XfoException
Get formatter type.

Returns:
type of formatter
Throws:
XfoException
Since:
5.0

getGdiImageSmoothing

public boolean getGdiImageSmoothing()
                             throws XfoException
Acquires the setting of the smoothing processing to images..
This setting is effective only with Windows.

Returns:
Specify whether to perform the smoothing processing to images.
Throws:
XfoException
Since:
6.0

getGdiLineartSmoothing

public boolean getGdiLineartSmoothing()
                               throws XfoException
Acquires the setting of the smoothing processing to borders..
This setting is effective only with Windows.

Returns:
Specify whether to perform the smoothing processing to borders.
Throws:
XfoException
Since:
6.0

getGdiTextAntialias

public boolean getGdiTextAntialias()
                            throws XfoException
Acquires the setting of the smoothing processing to text..
This setting is effective only with Windows.

Returns:
Specify whether to perform the smoothing processing to text.
Throws:
XfoException
Since:
6.0

getHtmlDefaultCharset

public java.lang.String getHtmlDefaultCharset()
                                       throws XfoException
Get html default charset.

Returns:
Html default charset
Throws:
XfoException
Since:
5.0

getInitialPageNumber

public int getInitialPageNumber()
                         throws XfoException
Gets the initial page number.

Returns:
initial page number
Throws:
XfoException
Since:
6.1

getInitialVolumeNumber

public int getInitialVolumeNumber()
                           throws XfoException
Gets the initial volume number.

Returns:
initial volume number
Throws:
XfoException
Since:
6.1

getInxOutputMode

public int getInxOutputMode()
                     throws XfoException
Gets the INX output mode.

Returns:
the INX output mode
S_INX_OUTPUTMODE_TEXT : Text area output mode
S_INX_OUTPUTMODE_LINE : Line area output mode
S_INX_OUTPUTMODE_BLOCK : Block area output mode
Throws:
XfoException

getMifIpMode

public int getMifIpMode()
                 throws XfoException
Gets the MIF image processing mode.

Returns:
the MIF image processing mode
Throws:
XfoException

getMifOutputMode

public int getMifOutputMode()
                     throws XfoException
Gets the MIF output mode.

Returns:
the MIF output mode
Throws:
XfoException

getMultiVolume

public boolean getMultiVolume()
                       throws XfoException
Get multiple volume of PDF output.

Throws:
XfoException
Since:
3.2 return Specification of multiple volume of PDF output

getOptionFileCount

public int getOptionFileCount()
                       throws XfoException
Counts the number of Option Setting File you specified.

Returns:
Path name of option setting file
Throws:
XfoException
Since:
3.1

getOptionFileURI

public java.lang.String getOptionFileURI()
                                  throws XfoException
Get the path name of option setting file.

Returns:
Path name of option setting file
Throws:
XfoException

getOptionFileURI

public java.lang.String getOptionFileURI(int n)
                                  throws XfoException
Get the path name of option setting file.

Returns:
Path name of option setting file
Throws:
XfoException
Since:
3.1

getOutputFilePath

public java.lang.String getOutputFilePath()
                                   throws XfoException
Get the path name of the output file that is the result of formatting.

Returns:
Path name of the output file
Throws:
XfoException

getOutputFOPath

public java.lang.String getOutputFOPath()
                                 throws XfoException
Get the path name of output FO file as the result of XSLT.

Returns:
Path name of output FO file
Throws:
XfoException

getOutputVolumeCount

public int getOutputVolumeCount()
                         throws XfoException
Gets the number of the actual separate volumes when outputting PDF to multiple separate volumes.

Returns:
Output volume count
Throws:
XfoException
Since:
3.2

getPageNumberFromID

public int getPageNumberFromID(java.lang.String id)
                        throws XfoException
Gets the page number from ID.

Parameters:
id - ID
Returns:
the page number if ID is found in a formatted page, 0 otherwise.
Throws:
XfoException
Since:
6.1

getPartialVolume

public boolean getPartialVolume()
                         throws XfoException
Gets the partial volume mode.

Returns:
partial volume mode
Throws:
XfoException
Since:
6.1

getPdfCertificateName

public java.lang.String getPdfCertificateName()
                                       throws XfoException
Gets the value of a certificate information name.

Returns:
the value of a certificate information name
Throws:
XfoException
Since:
3.3

getPdfCompressContentStream

public boolean getPdfCompressContentStream()
                                    throws XfoException
Gets the value of whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not.

Returns:
the value of whether make the size of PDF smaller or not
Throws:
XfoException
Since:
3.1

getPdfConvertImageColorSpace

public boolean getPdfConvertImageColorSpace()
                                     throws XfoException
Gets the value of whether to convert image color space or not.

Returns:
the value of whether to convert image color space.
Throws:
XfoException
Since:
5.2

getPdfEmbedAllFonts

public boolean getPdfEmbedAllFonts()
                            throws XfoException
Gets the value of whether to embed all embeddable fonts in PDF.

Returns:
the value of whether to embed all embeddable fonts
Throws:
XfoException
Since:
3.1

getPdfEmbedAllFontsEx

public int getPdfEmbedAllFontsEx()
                          throws XfoException
Gets the value of whether to embed all embeddable fonts.

Returns:
the value of whether to embed fonts
S_PDF_EMBALLFONT_PART : Specified fonts
S_PDF_EMBALLFONT_ALL : Embed All fonts except Base14 fonts
S_PDF_EMBALLFONT_BASE14 : All fonts
Throws:
XfoException
Since:
3.3

getPdfEmbedFonts

public java.lang.String getPdfEmbedFonts()
                                  throws XfoException
Gets the font specified to be embedded in PDF.

Returns:
the font specified to be embedded
Throws:
XfoException
Since:
3.1

getPdfEmbedSubsetFontPercentage

public int getPdfEmbedSubsetFontPercentage()
                                    throws XfoException
Gets the value of percentage to embed subset fonts.

Returns:
the percentage of when subset embedded fonts.
Throws:
XfoException
Since:
5.2

getPdfEncryptLevel

public int getPdfEncryptLevel()
                       throws XfoException
Get the key length when encrypting the PDF file during outputting.

Returns:
Key length when encrypting the PDF file during outputting
S_PDF_ENCLEVEL_40 : PDF encrypt level 40-bit RC4
S_PDF_ENCLEVEL_40RC4 : PDF encrypt level 40-bit RC4
S_PDF_ENCLEVEL_128 : PDF encrypt level 128-bit RC4
S_PDF_ENCLEVEL_128RC4 : PDF encrypt level 128-bit RC4
S_PDF_ENCLEVEL_128AES : PDF encrypt level 128-bit AES
S_PDF_ENCLEVEL_256AES : PDF encrypt level 256-bit AES
Throws:
XfoException
Since:
3.1

getPdfErrorOnEmbedFault

public boolean getPdfErrorOnEmbedFault()
                                throws XfoException
Gets the value of whether to issues the error when failing to embed fonts.

Returns:
the value of whether to issues the error
Throws:
XfoException
Since:
3.1

getPdfErrorOnMissingGlyph

public boolean getPdfErrorOnMissingGlyph()
                                  throws XfoException
Gets the value of whether to issues the error when missing glyph.

Returns:
the value of whether to issues the error
Throws:
XfoException
Since:
3.3

getPdfErrorOnPDFXFault

public boolean getPdfErrorOnPDFXFault()
Gets the value of whether to issue error or not when PDF/X is generating.
Effective when outputting to PDF.

Returns:
the value of whether to issue error.
Since:
4.0

getPdfGrayscaleImageCompression

public int getPdfGrayscaleImageCompression()
                                    throws XfoException
Gets the value of how to compress the grayscale images embedded in PDF.

Returns:
the value of how raster graphics are compressed and stored
S_PDF_IMGCMPR_AUTO : Auto
S_PDF_IMGCMPR_JPEG : JPEG compression
S_PDF_IMGCMPR_ZLIB : ZLIB compression
S_PDF_IMGCMPR_JPEG2000 : JPEG2000 compression
Throws:
XfoException
Since:
3.3

getPdfGrayscaleImageDownSampling

public int getPdfGrayscaleImageDownSampling()
                                     throws XfoException
Gets the value of method to downsample the grayscale image.

Returns:
the value of method to downsample
S_PDF_IMGDOWNSAMPLING_NONE : none
S_PDF_IMGDOWNSAMPLING_AVERAGE : biliner
S_PDF_IMGDOWNSAMPLING_BICUBIC : bicubic
S_PDF_IMGDOWNSAMPLING_SUBSAMPLING : nearest neighbor
Throws:
XfoException
Since:
3.3

getPdfGrayscaleImageDownSamplingDPI

public int getPdfGrayscaleImageDownSamplingDPI()
                                        throws XfoException
Gets resolution of the grayscale image which performs a downsampling.

Returns:
resolution
Throws:
XfoException
Since:
3.3

getPdfGrayscaleImageDownSamplingTarget

public int getPdfGrayscaleImageDownSamplingTarget()
                                           throws XfoException
Gets resolution when the grayscale image is downsampled.

Returns:
resolution
Throws:
XfoException
Since:
3.3

getPdfGrayscaleJPEGQuality

public int getPdfGrayscaleJPEGQuality()
                               throws XfoException
Gets the value of the quality of JPEG format that is specified by setPdfGrayscaleImageCompression stored in PDF.

Returns:
the value of the quality of JPEG format
Throws:
XfoException
Since:
3.3

getPdfImageCompression

public int getPdfImageCompression()
                           throws XfoException
Gets the value of how to compress the color images embedded in PDF.

Returns:
the value of how raster graphics are compressed and stored
S_PDF_IMGCMPR_AUTO : Auto
S_PDF_IMGCMPR_JPEG : JPEG compression
S_PDF_IMGCMPR_ZLIB : ZLIB compression
S_PDF_IMGCMPR_JPEG2000 : JPEG2000 compression
Throws:
XfoException
Since:
3.1

getPdfImageDownSampling

public int getPdfImageDownSampling()
                            throws XfoException
Gets the value of method to downsample the color image.

Returns:
the value of method to downsample the color image
S_PDF_IMGDOWNSAMPLING_NONE : none
S_PDF_IMGDOWNSAMPLING_AVERAGE : biliner
S_PDF_IMGDOWNSAMPLING_BICUBIC : bicubic
S_PDF_IMGDOWNSAMPLING_SUBSAMPLING : nearest neighbor
Throws:
XfoException
Since:
3.3

getPdfImageDownSamplingDPI

public int getPdfImageDownSamplingDPI()
                               throws XfoException
Gets resolution of the grayscale image which performs a downsampling.

Returns:
resolution
Throws:
XfoException
Since:
3.3

getPdfImageDownSamplingTarget

public int getPdfImageDownSamplingTarget()
                                  throws XfoException
Gets resolution when the color image is downsampled.

Returns:
resolution
Throws:
XfoException
Since:
3.3

getPdfImport3DAnnotation

public boolean getPdfImport3DAnnotation()
                                 throws XfoException
Gets the value of whether to import 3D annotations or not.

Returns:
the value of whether to import 3D annotations.
Throws:
XfoException
Since:
5.2

getPdfJPEGQuality

public int getPdfJPEGQuality()
                      throws XfoException
Gets the value of the quality of JPEG format that is specified by setPdfImageCompression() stored in PDF.

Returns:
the value of the quality of JPEG format
Throws:
XfoException
Since:
3.1

getPdfLinearize

public boolean getPdfLinearize()
                        throws XfoException
Gets the value of whether to output linearize PDF or not.

Returns:
the value of whether to output linearize PDF or not
Throws:
XfoException
Since:
3.3

getPdfMonochromeImageCompression

public int getPdfMonochromeImageCompression()
                                     throws XfoException
Gets the value of how to compress the monochrome images embedded in PDF.

Returns:
the value of how raster graphics are compressed and stored
S_PDF_MONOCMPR_CCITT4 : CCITTFaxDecode group 4 filter
S_PDF_MONOCMPR_CCITT3 : CCITTFaxDecode group 3 filter
S_PDF_MONOCMPR_RUNLENGTH : RunLengthDecode filter
S_PDF_MONOCMPR_ZLIB : FlateDecode filter
S_PDF_MONOCMPR_OFF : no filter
Throws:
XfoException
Since:
3.3

getPdfMonochromeImageDownSampling

public int getPdfMonochromeImageDownSampling()
                                      throws XfoException
Gets the value of method to downsample the monochrome image.

Returns:
the value of method to downsample
S_PDF_IMGDOWNSAMPLING_NONE : none
S_PDF_IMGDOWNSAMPLING_AVERAGE : biliner
S_PDF_IMGDOWNSAMPLING_BICUBIC : bicubic
S_PDF_IMGDOWNSAMPLING_SUBSAMPLING : nearest neighbor
Throws:
XfoException
Since:
3.3

getPdfMonochromeImageDownSamplingDPI

public int getPdfMonochromeImageDownSamplingDPI()
                                         throws XfoException
Gets resolution of the monochrome image which performs a downsampling.

Returns:
resolution
Throws:
XfoException
Since:
3.3

getPdfMonochromeImageDownSamplingTarget

public int getPdfMonochromeImageDownSamplingTarget()
                                            throws XfoException
Gets resolution when the monochrome image is downsampled.

Returns:
resolution
Throws:
XfoException
Since:
3.3

getPdfNoAccessibility

public boolean getPdfNoAccessibility()
                              throws XfoException
Get the specification that disables text access for screen reader devices of the PDF file.

Returns:
Specification that disables text access for screen reader devices of the PDF file
Throws:
XfoException
Since:
3.1

getPdfNoAddingOrChangingComments

public boolean getPdfNoAddingOrChangingComments()
                                         throws XfoException
Get the specification that disables adding comments and form fields to the PDF file.

Returns:
Specification that disables adding comments and form fields to the PDF file
Throws:
XfoException
Since:
3.1

getPdfNoAssembleDoc

public boolean getPdfNoAssembleDoc()
                            throws XfoException
Get the specification that disables inserting, deleting and rotating the PDF pages.

Returns:
Specification that disables inserting, deleting and rotating the PDF pages
Throws:
XfoException
Since:
3.1

getPdfNoChanging

public boolean getPdfNoChanging()
                         throws XfoException
Get the specification that disables making changes of the PDF file.

Returns:
Specification that disables making changes of the PDF file
Throws:
XfoException
Since:
3.1

getPdfNoContentCopying

public boolean getPdfNoContentCopying()
                               throws XfoException
Get the specification that disables copying the content of the PDF file.

Returns:
Specification that disables copying the content of the PDF file
Throws:
XfoException
Since:
3.1

getPdfNoFillForm

public boolean getPdfNoFillForm()
                         throws XfoException
Get the specification that disables adding comments and form fields to the PDF file.
Effective when outputting to PDF.

Returns:
Specification that disables adding comments and form fields to the PDF file
Throws:
XfoException
Since:
3.1

getPdfNoPrinting

public boolean getPdfNoPrinting()
                         throws XfoException
Get the specification that disables printing the PDF file.

Returns:
Specification that disables printing the PDF file
Throws:
XfoException
Since:
3.1

getPdfOutputHeight

public java.lang.String getPdfOutputHeight()
                                    throws XfoException
Gets the height of PDF to output.

Returns:
the height of PDF
Throws:
XfoException
Since:
4.0

getPdfOutputWidth

public java.lang.String getPdfOutputWidth()
                                   throws XfoException
Gets the width of PDF to output.

Returns:
the width of PDF
Throws:
XfoException
Since:
4.0

getPdfPrintingAllowed

public int getPdfPrintingAllowed()
                          throws XfoException
Gets the value of whether to print the resulting PDF file or not.

Returns:
the value of printing allowed
S_PDF_PRALLOW_NONE : Not Allowed
S_PDF_PRALLOW_LOW : Low Resolution Printing
S_PDF_PRALLOW_HIGH : High Resolution Printing
Throws:
XfoException
Since:
3.1

getPdfPutImageColorProfile

public boolean getPdfPutImageColorProfile()
                                   throws XfoException
Gets specification whether to embed to PDF the color profile of the color image that will be embedded to PDF.

Returns:
specification whether to embed to PDF
Throws:
XfoException
Since:
3.3

getPdfRasterizeResolution

public int getPdfRasterizeResolution()
                              throws XfoException
Gets the value of the rasterised-resolution of the transformed raster images.
This method is available only in Windows version.

Returns:
Rasterised-resolution
Throws:
XfoException
Since:
3.1

getPdfReversePage

public boolean getPdfReversePage()
                          throws XfoException
Gets the value of whether to output reverse page or not.

Returns:
the value of whether to output reverse page.
Throws:
XfoException
Since:
5.2

getPdfRGBConversion

public int getPdfRGBConversion()
                        throws XfoException
Gets the value of how to convert the RGB color space (DebiceRGB) to DeviceGray.

Returns:
the value of how to convert
S_PDF_RGBCONV_NONE : No Conversion
S_PDF_RGBCONV_BLACK : Black to DeviceGray
S_PDF_RGBCONV_GRAY : Gray to DeviceGray
S_PDF_RGBCONV_ALL : All RGB to DeviceGray
Throws:
XfoException
Since:
3.1

getPdfSignature

public boolean getPdfSignature()
                        throws XfoException
Gets the value of whether to sign a signature to PDF or not.

Returns:
the value of whether to sign a signature to PDF or not
Throws:
XfoException
Since:
3.3

getPdfSignatureName

public java.lang.String getPdfSignatureName()
                                     throws XfoException
Gets the value of a signature information name.

Returns:
the value of a signature information name
Throws:
XfoException
Since:
3.3

getPdfTag

public boolean getPdfTag()
                  throws XfoException
Gets the value of whether to output Tagged PDF or not.

Returns:
the value of whether to output Tagged pdf or not
Throws:
XfoException
Since:
4.0

getPdfUseLaunchForRelativeURI

public boolean getPdfUseLaunchForRelativeURI()
                                      throws XfoException
Gets the value of how to transform external link specified by the relative address in the PDF link.

Returns:
the value of how to transform external link
Throws:
XfoException
Since:
3.1

getPdfVersion

public int getPdfVersion()
                  throws XfoException
Get the version of PDF.

Returns:
PDF version
S_PDF_VERSION_13 : PDF version 1.3
S_PDF_VERSION_14 : PDF version 1.4
S_PDF_VERSION_15 : PDF version 1.5
S_PDF_VERSION_16 : PDF version 1.6
S_PDF_VERSION_17 : PDF version 1.7
S_PDF_VERSION_X_1a_2001 : ISO 15930-1:2001 PDF/X-1a-2001 (based on PDF1.3)
S_PDF_VERSION_X_3_2002 : ISO 15930-3:2002 PDF/X-3-2002 (based on PDF1.3)
S_PDF_VERSION_X_1a_2003 : ISO 15930-4:2003 PDF/X-1a-2003 (based on PDF1.4)
S_PDF_VERSION_X_2_2003 : ISO 15930-5:2003 PDF/X-2-2003 (based on PDF1.4)
S_PDF_VERSION_X_3_2003 : ISO 15930-6:2003 PDF/X-3-2003 (based on PDF1.4)
S_PDF_VERSION_X_4_2008 : ISO 15930-7:2008 PDF/X-4-2008 (based on PDF1.6)
S_PDF_VERSION_A_1a_2005 : ISO 19005-1:2005 (based on PDF1.4)
S_PDF_VERSION_A_1b_2005 : ISO 19005-1:2005 (based on PDF1.4)
Throws:
XfoException
Since:
3.1

getPrinterName

public java.lang.String getPrinterName()
                                throws XfoException
Get the printer name where the formatted result is outputted.

Returns:
Printer name
Throws:
XfoException

getPrinterSettingURI

public java.lang.String getPrinterSettingURI()
                                      throws XfoException
Get the printer setting URI.

Returns:
Printer setting URI
Throws:
XfoException

getPrnCollate

public boolean getPrnCollate()
                      throws XfoException
Get the collation of multiple copies.
This method is available only in Windows version.

Returns:
If 'false' is returned, the same page is multi-copied continuously. If 'true' is returned, the pages specified from start to end are printed repeatedly.
Throws:
XfoException

getPrnCopies

public int getPrnCopies()
                 throws XfoException
Get the number of copies. Effective when outputting to printer.
This method is available only in Windows version.

Returns:
Number of copies
Throws:
XfoException

getSplitPages

public int getSplitPages()
                  throws XfoException
Gets the split-by-pages setting.

Returns:
split-by-pages setting (0:No split 1:Split by each page)
Throws:
XfoException
Since:
6.1

getStartPage

public int getStartPage()
                 throws XfoException
Get the start page number of document to output.

Returns:
Start page number
Throws:
XfoException

getStartVolume

public int getStartVolume()
                   throws XfoException
Get the start volume of document to output.

Returns:
Start volume
Throws:
XfoException
Since:
3.2

getStylesheetTitle

public java.lang.String getStylesheetTitle()
                                    throws XfoException
Get prior Stylesheet PI title.

Returns:
Stylesheet PI title
Throws:
XfoException
Since:
5.0

getStylesheetURI

public java.lang.String getStylesheetURI()
                                  throws XfoException
Get the URI of XSL stylesheet that is used when formatting.

Returns:
URI of XSL stylesheet
Throws:
XfoException

getSvgEmbedAllFonts

public boolean getSvgEmbedAllFonts()
                            throws XfoException
Gets the setting indicating whether to embed fonts in the outputted SVG.

Returns:
whether embeds fonts or not.
Throws:
XfoException
Since:
3.3

getSvgEmbedFonts

public java.lang.String getSvgEmbedFonts()
                                  throws XfoException
Gets the font specified to be embedded in SVG.

Returns:
the font specified to be embedded
Throws:
XfoException
Since:
3.3

getSvgErrorOnEmbedFault

public boolean getSvgErrorOnEmbedFault()
                                throws XfoException
Gets the value of whether to issues the error when failing to embed fonts.

Returns:
the value of whether to issues the error
Throws:
XfoException
Since:
3.3

getSvgFormat

public java.lang.String getSvgFormat()
                              throws XfoException
Gets the format for naming files when the outputted SVG becomes multiple.

Returns:
format for naming files
Throws:
XfoException
Since:
3.3

getSvgGzipCompression

public boolean getSvgGzipCompression()
                              throws XfoException
Gets the setting indicating whether to compress the outputted SVG into gzip format or not.
Effective when outputting to SVG.

Returns:
whether gzip compression or not.
Throws:
XfoException
Since:
3.3

getSvgImageConversion

public int getSvgImageConversion()
                          throws XfoException
Gets the value of how to convert the images embedded in SVG.

Returns:
the value of how raster graphics are converted and stored
S_SVG_IMGCNV_AUTO : Auto
S_SVG_IMGCNV_JPEG : JPEG conversion
S_SVG_IMGCNV_PNG : PNG conversion
Throws:
XfoException
Since:
3.3

getSvgImageCopyPath

public java.lang.String getSvgImageCopyPath()
                                     throws XfoException
Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.

Returns:
the copy destination of image
Throws:
XfoException
Since:
3.3

getSvgImagePrefix

public java.lang.String getSvgImagePrefix()
                                   throws XfoException
Gets the prefix of the file name when images are copied to the directory specified by setSvgImageCopyPath and processed.

Returns:
the prefix of the file name.
Throws:
XfoException
Since:
3.3

getSvgImageProcessingType

public int getSvgImageProcessingType()
                              throws XfoException
Gets specification how to treat the referred image.

Returns:
specification how to treat the referred image.
S_SVG_IMGPT_EMBED_ALL : Embeds all images to SVG.
S_SVG_IMGPT_COPY_ALL : Copies all image files to the destination that is specified by setSvgImageCopyPath, and then links.
S_SVG_IMGPT_LINK : Links images that have been linked, and embeds the embedded image. However, the raster images other than JPEG and PNG are always embedded.
S_SVG_IMGPT_COPY : Copies images that have been linked to the destination that is specified by setSvgImageCopyPath, and links. The embedded image are embedded.
Throws:
XfoException
Since:
3.3

getSvgImageRename

public boolean getSvgImageRename()
                          throws XfoException
Gets specification whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name.

Returns:
specification whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name.
Throws:
XfoException
Since:
3.3

getSvgJPEGQuality

public int getSvgJPEGQuality()
                      throws XfoException
Gets the value of the quality of JPEG format that is specified by setSvgImageConversion() stored in SVG.

Returns:
JPEG quality
Throws:
XfoException
Since:
3.3

getSvgRasterizeResolution

public int getSvgRasterizeResolution()
                              throws XfoException
Gets the value of the rasterised-resolution of the transformed raster images. This setting is effective only with Windows version.

Returns:
Rasterised-resolution
Throws:
XfoException
Since:
3.3

getSvgSingleFile

public boolean getSvgSingleFile()
                         throws XfoException
Gets Specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.

Returns:
Specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.
Throws:
XfoException
Since:
3.3

getSvgSinglePageNumber

public boolean getSvgSinglePageNumber()
                               throws XfoException
Gets specification whether to add sequential number to the output SVG even if it has only one-page.

Returns:
specification whether to add sequential number to the output SVG even if it has only one-page.
Throws:
XfoException
Since:
3.3

getSvgVersion

public int getSvgVersion()
                  throws XfoException
Get the version of SVG..

Returns:
SVG version
S_SVG_VERSION_11 : SVG version 1.1
S_SVG_VERSION_BASIC : SVG Basic
S_SVG_VERSION_TINY : SVG Tiny
Throws:
XfoException
Since:
3.3

getTotalVolumeCount

public int getTotalVolumeCount()
                        throws XfoException
Gets the number of all the separate volumes when outputting PDF to multiple separate volumes.

Returns:
Total volume count
Throws:
XfoException
Since:
3.2

getTwoPassFormatting

public boolean getTwoPassFormatting()
                             throws XfoException
Get the specification of two pass format.

Returns:
specification of two pass format.
Throws:
XfoException
Since:
4.1

getVersion

public java.lang.String getVersion()
                            throws XfoException
Get the version string of AHFormatter.

Returns:
Version string
Throws:
XfoException

getWatermarkFontFamily

public java.lang.String getWatermarkFontFamily()
                                        throws XfoException
Acquires the font family to the character string which you set to watermark-text. .

Returns:
The font family of the character string which you set to watermark-text.
Throws:
XfoException

getWatermarkFontStyle

public java.lang.String getWatermarkFontStyle()
                                       throws XfoException
.

Returns:
Acquires the font style of the character string which you set to watermark-text.
Throws:
XfoException

getWatermarkFontWeight

public java.lang.String getWatermarkFontWeight()
                                        throws XfoException
Acquires the font weight to the character string which you set to watermark-text. .

Returns:
The font weight of the character string which you set to watermark-text.
Throws:
XfoException

getWatermarkOpacity

public java.lang.String getWatermarkOpacity()
                                     throws XfoException
Acquires the opacity of the character string which you set to watermark-text..

Returns:
The opacity of the character string which you set to watermark-text.
Throws:
XfoException

getWatermarkText

public java.lang.String getWatermarkText()
                                  throws XfoException
Acquires the watermark text specified for each page..

Returns:
The watermark text specified for each page.
Throws:
XfoException

getXSLTParamFormat

public java.lang.String getXSLTParamFormat()
                                    throws XfoException
Get the parameter format of xsl:param when using External XSLT Processor.

Returns:
Parameter format of xsl:param
Throws:
XfoException

releaseObject

public void releaseObject()
Release the instance of XfoObj. The instance becomes void when this method was called.


releaseObjectEx

public void releaseObjectEx()
                     throws XfoException
Release the instance of XfoObj. This method throw XfoException. The instance becomes void when this method was called.

Throws:
XfoException

render

public void render(java.io.InputStream xmlSrc,
                   java.io.InputStream xslSrc,
                   java.io.OutputStream dst,
                   java.lang.String outDevice)
            throws XfoException
Transforms an XML document specified to xmlSrc using an XSL stylesheet specified to xslSrc. Then executes the formatting of XSL-FO document and outputs it to dst in the output form specified for outDevice. Xalan of JAXP (Java API for XML Processing) is used for the XSLT conversion. The setExternalXSLT method and the setting of XSLT processor in the option setting file is disregarded.

Parameters:
xmlSrc - XML Document
xslSrc - XSL Stylesheet
dst - output stream
outDevice - output device. Please refer to a setPrinterName method about the character string to specify.
Throws:
XfoException
Since:
3.3

render

public void render(java.io.InputStream src,
                   java.io.OutputStream dst,
                   java.lang.String outDevice)
            throws XfoException
Executes the formatting of XSL-FO document specified for src, and outputs it to dst in the output form specified for dst.

Parameters:
src - XSL-FO Document
dst - output stream
outDevice - output device. Please refer to a setPrinterName method about the character string to specify.
Throws:
XfoException
Since:
3.3

setAlternateStyleTags

public void setAlternateStyleTags(java.lang.String alternateStyleTags)
                           throws XfoException
Set alternate style tags.

Parameters:
alternateStyleTags - Alternate style tags
Throws:
XfoException
Since:
6.1

setBaseURI

public void setBaseURI(java.lang.String uri)
                throws XfoException
Set the default base URI.

Parameters:
uri - Base URI
Throws:
XfoException

setBatchPrint

public void setBatchPrint(boolean bat)
                   throws XfoException
Set whether the print dialog box is displayed or not when printing. Default setting is "true". This setting is effective only with Windows version.

Parameters:
bat - If "true", the print dialog box is displayed. If "false", the print dialog box is not displayed.
Throws:
XfoException

setDocumentURI

public void setDocumentURI(java.lang.String uri)
                    throws XfoException
Set the URI of XML document to be formatted.
If specified "@STDIN", XML document reads from stdin. The document that is read from stdin is assumed to be FO.

Parameters:
uri - URI of XML document
Throws:
XfoException

setEndPage

public void setEndPage(int num)
                throws XfoException
Set the end page number of document to output.
If the end page is omitted or the specified value exceeds the actual page number, the end page is considered as the last page.

Parameters:
num - End page number
Throws:
XfoException

setEndVolume

public void setEndVolume(int num)
                  throws XfoException
Set the end volume of document to output.
If the end volume is omitted or the specified value exceeds the actual volume, the end volume is considered as the last volume.

Parameters:
num - End volume
Throws:
XfoException
Since:
3.2

setErrorStreamType

public void setErrorStreamType(int type)
                        throws XfoException
Set the error output. Default setting is EST_NONE.

Parameters:
type - Error output
S_EST_NONE : No error output
S_EST_STDOUT : Error output is stdout
S_EST_STDERR : Error output is stderr
Throws:
XfoException

setExitLevel

public void setExitLevel(int level)
                  throws XfoException
Set the error level to abort formatting process.
AH Formatter will stop formatting when the detected error level is equal to setExitLevel setting or higher.
The default value is 2 (Warning). Thus if an error occurred and error level is 2 (Warning) or higher, the formatting process will be aborted. Please use the value from 1 to 4. When the value of 5 or more is specified, it is considered to be the value of 4. If a error-level:4 (fatal error) occurs, the formatting process will be aborted unconditionally. Note: An error is not displayed regardless what value may be specified to be this property.

Parameters:
level - Error level to abort
Throws:
XfoException

setExternalXSLT

public void setExternalXSLT(java.lang.String cmd)
                     throws XfoException
Set the command-line string for external XSLT processor. For example:
xslt -o %3 %1 %2 %param
%1 to %3 means following:
%1 : XML Document
%2 : XSL Stylesheet
%3 : XSLT Output File
%param : xsl:param
%1 to %3 are used to express only parameter positions. Do not replace them with actual file names.
In case you use XSL:param for external XSLT processor, set the name and value here.
In Windows version, default MSXML3 will be used.

Parameters:
cmd - Command-line string for external XSLT processor
Throws:
XfoException

setFlashHidePageButton

public void setFlashHidePageButton(boolean newVal)
                            throws XfoException
Output a no page button..
Effective when outputting to Flash.

Parameters:
newVal - If the value is 'true' is specified, output a no page button.
Throws:
XfoException

setFlashPartiallyOutput

public void setFlashPartiallyOutput(boolean newVal)
                             throws XfoException
When an error occurs within the document, the flash file in process will be outputted..
Effective when outputting to Flash.

Parameters:
newVal - If the value is 'true' is specified, output the flash file.
Throws:
XfoException

setFontAlias

public void setFontAlias(java.lang.String src,
                         java.lang.String dst)
                  throws XfoException
Sets the substitution of font name. This substitution acts on the font names existing in FO. The font name 'fontName' is replaced to 'aliasName'.

Parameters:
src - The font name of original
dst - The alias font name
Throws:
XfoException

setFormatPageListener

public void setFormatPageListener(XfoFormatPageListener listener)
Register the XfoFormatPageListener interface to the instance of implemented class.
The page number that formatted during the formatting process can be received as the event.

Parameters:
listener - The instance of implemented class
Since:
3.3MR1

setFormatterType

public void setFormatterType(int formatterType)
                      throws XfoException
Set formatter type.
S_FORMATTERTYPE_AUTO
S_FORMATTERTYPE_HTML
S_FORMATTERTYPE_XHTML
S_FORMATTERTYPE_XMLCSS
S_FORMATTERTYPE_XSLFO

Parameters:
formatterType - type of formatter
Throws:
XfoException
Since:
5.0

setGdiImageSmoothing

public void setGdiImageSmoothing(boolean newVal)
                          throws XfoException
Performs the smoothing processing to images..
Effective only when printing and outputting images.
This setting is effective only with Windows.

Parameters:
newVal - Performs the smoothing processing when true is specified.
Throws:
XfoException
Since:
6.0

setGdiLineartSmoothing

public void setGdiLineartSmoothing(boolean newVal)
                            throws XfoException
Performs the smoothing processing to borders..
Effective only when printing and outputting images.
This setting is effective only with Windows.

Parameters:
newVal - Performs the smoothing processing when true is specified.
Throws:
XfoException
Since:
6.0

setGdiTextAntialias

public void setGdiTextAntialias(boolean newVal)
                         throws XfoException
Performs the smoothing processing to text..
Effective only when printing and outputting images.
This setting is effective only with Windows.

Parameters:
newVal - Performs the smoothing processing when true is specified.
Throws:
XfoException
Since:
6.0

setHtmlDefaultCharset

public void setHtmlDefaultCharset(java.lang.String charset)
                           throws XfoException
Set html default charset.

Parameters:
charset - html default charset
Throws:
XfoException
Since:
5.0

setInitialPageNumber

public void setInitialPageNumber(int newVal)
                          throws XfoException
Sets the initial page number.

Parameters:
newVal - initial page number
Throws:
XfoException
Since:
6.1

setInitialVolumeNumber

public void setInitialVolumeNumber(int newVal)
                            throws XfoException
Sets the initial volume number.

Parameters:
newVal - initial volume number
Throws:
XfoException
Since:
6.1

setInxOutputMode

public void setInxOutputMode(int newVal)
                      throws XfoException
Specifies the INX output mode. If this parameter is omitted, "S_INX_OUTPUTMODE_TEXT" is considered as specified.

Parameters:
newVal - the INX output mode
S_INX_OUTPUTMODE_TEXT : Text area output mode
S_INX_OUTPUTMODE_LINE : Line area output mode
S_INX_OUTPUTMODE_BLOCK : Block area output mode
Throws:
XfoException

setMessageListener

public void setMessageListener(MessageListener listener)
Register the MessageListener interface to the instance of implemented class.
The error that occurred during the formatting process can be received as the event.

Parameters:
listener - The instance of implemented class

setMifIpMode

public void setMifIpMode(int newVal)
                  throws XfoException
Specifies the MIF image processing mode.
S_MIF_IMAGEPROCMODE_EMBED : MIF image embed mode
S_MIF_IMAGEPROCMODE_LINK : MIF image link mode
If this parameter is omitted, "S_MIF_IMAGEPROCMODE_EMBED" is considered as specified.

Parameters:
newVal - the MIF output mode
Throws:
XfoException

setMifOutputMode

public void setMifOutputMode(int newVal)
                      throws XfoException
Specifies the MIF output mode.
S_MIF_OUTPUTMODE_TEXT : text output mode
S_MIF_OUTPUTMODE_LINE : line output mode
S_MIF_OUTPUTMODE_BLOCK : block output mode
If this parameter is omitted, "S_MIF_OUTPUTMODE_TEXT" is considered as specified.

Parameters:
newVal - the MIF output mode
Throws:
XfoException

setMultiVolume

public void setMultiVolume(boolean newVal)
                    throws XfoException
Specifies multiple volume of PDF output.

Parameters:
newVal - If the value is 'true' is specified, output PDF byt multiple volume
Throws:
XfoException
Since:
3.2

setOptionFileURI

public void setOptionFileURI(java.lang.String path)
                      throws XfoException
Set the path name of option setting URI.

Parameters:
path - Path name of option setting file
Throws:
XfoException

setOutputFilePath

public void setOutputFilePath(java.lang.String path)
                       throws XfoException
Specifies the output file path of the formatted result.
When the printer is specified as an output format by setPrinterName, a printing result is saved to the specified file by the printer driver .
When output format other than a printer is specified, it is saved at the specified file with the specified output format.
When omitted, or when "@STDOUT" is specified, it comes to standard output.

Parameters:
path - Path name of output file
Throws:
XfoException

setOutputFOPath

public void setOutputFOPath(java.lang.String path)
                     throws XfoException
Set the path name of output FO file as the result of XSLT.
FO file is outputted as the result of XSLT when the input files are an XML document and XSL an stylesheet.
If the input file is FO, no file is outputted. "@STDOUT" is specified, it is considered as stdout. Default is nothing outputs.

Parameters:
path - Path name of output FO file
Throws:
XfoException

setPartialVolume

public void setPartialVolume(boolean newVal)
                      throws XfoException
Sets the partial volume mode.

Parameters:
newVal - partial volume mode
Throws:
XfoException
Since:
6.1

setPdfCertificateName

public void setPdfCertificateName(java.lang.String name)
                           throws XfoException
Sets a certificate information name.
Effective when outputting to PDF.

Parameters:
name - the value of a certificate information name
Throws:
XfoException
Since:
3.3

setPdfCompressContentStream

public void setPdfCompressContentStream(boolean newVal)
                                 throws XfoException
Specifies whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not.
Effective when outputting to PDF.

Parameters:
newVal - If the value is 'true' is specified, make the PDF compress
Throws:
XfoException
Since:
3.1

setPdfConvertImageColorSpace

public void setPdfConvertImageColorSpace(boolean newVal)
                                  throws XfoException
Sets the value of whether to convert image color space or not.

Parameters:
newVal - the value of whether to convert image color space.
Throws:
XfoException
Since:
5.2

setPdfEmbedAllFonts

public void setPdfEmbedAllFonts(boolean newVal)
                         throws XfoException
Embeds all embeddable fonts in PDF to create.
Effective when outputting to PDF.

Parameters:
newVal - If the value is 'true' is specified, Embeds all embeddable fonts
Throws:
XfoException
Since:
3.1

setPdfEmbedAllFontsEx

public void setPdfEmbedAllFontsEx(int newVal)
                           throws XfoException
Specifies whether to embed the all outline data of fonts in PDF or not, which are True type fonts and Type1 Fonts and are embeddable in the formatted result.
Effective when outputting to PDF.

Parameters:
newVal - the value of whether to embed fonts
S_PDF_EMBALLFONT_PART : Specified fonts
S_PDF_EMBALLFONT_ALL : Embed All fonts except Base14 fonts
S_PDF_EMBALLFONT_BASE14 : All fonts
If the value is EMBALLFONT_PART, only fonts specified in setPdfEmbedFonts are embedded. If the value is EMBALLFONT_ALL, all fonts that can be embedded except Base 14 fonts will be embedded. If the value is EMBALLFONT_BASE14, all fonts including Base 14 fonts that can be embedded will be embedded.
Throws:
XfoException
Since:
3.3

setPdfEmbedFonts

public void setPdfEmbedFonts(java.lang.String newVal)
                      throws XfoException
Embeds the specified font in PDF to create. If you want to specify plural fonts, put commas between fonts.
Effective when outputting to PDF.

Parameters:
newVal - fonts specified to embed
Throws:
XfoException
Since:
3.1

setPdfEmbedSubsetFontPercentage

public void setPdfEmbedSubsetFontPercentage(int newVal)
                                     throws XfoException
Set percentage to embed subset fonts.
Subset embedded fonts when percent of characters used is less than value.

Parameters:
newVal - the percentage of when subset embedded fonts.
Throws:
XfoException
Since:
5.2

setPdfEncryptLevel

public void setPdfEncryptLevel(int newVal)
                        throws XfoException
Specifies the key length when encrypting the PDF file during outputting.
Effective when outputting to PDF.

Parameters:
newVal - key length when encrypting the PDF file during outputting
S_PDF_ENCLEVEL_40 : PDF encrypt level 40-bit RC4
S_PDF_ENCLEVEL_40RC4 : PDF encrypt level 40-bit RC4
S_PDF_ENCLEVEL_128 : PDF encrypt level 128-bit RC4
S_PDF_ENCLEVEL_128RC4 : PDF encrypt level 128-bit RC4
S_PDF_ENCLEVEL_128AES : PDF encrypt level 128-bit AES
S_PDF_ENCLEVEL_256AES : PDF encrypt level 256-bit AES
Throws:
XfoException
Since:
3.1

setPdfErrorOnEmbedFault

public void setPdfErrorOnEmbedFault(boolean newVal)
                             throws XfoException
an error is issued in case of failing to embed fonts.
Effective when outputting to PDF.

Parameters:
newVal - If the value is 'true' is specified, an error is issued.
Throws:
XfoException
Since:
3.1

setPdfErrorOnMissingGlyph

public void setPdfErrorOnMissingGlyph(boolean newVal)
                               throws XfoException
an error is issued in case of missing glyph.
Effective when outputting to PDF.

Parameters:
newVal - If the value is 'true' is specified, an error is issued.
Throws:
XfoException
Since:
3.3

setPdfErrorOnPDFXFault

public void setPdfErrorOnPDFXFault(boolean newVal)
An error is not issued when PDF/X is generating.
Effective when outputting to PDF.

Parameters:
newVal - If the value is 'true' is specified, no error is issued.
Since:
4.0

setPdfGrayscaleImageCompression

public void setPdfGrayscaleImageCompression(int newVal)
                                     throws XfoException
Specifies how to compress the grayscale images embedded in PDF. When the grayscale image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.
When IMGCMPR_AUTO is selected, the process is automatically done and creates the image data according to the setting of setPdfGrayscaleJPEGQuality and setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected.
This is the setting for the grayscale image. Spesify setPdfImageCompression for the color image, and setPdfMonochromeImageCompression for the monochrome image.
Effective when outputting to PDF.

Parameters:
newVal - the value of how raster graphics are compressed and stored
S_PDF_IMGCMPR_AUTO : Auto
S_PDF_IMGCMPR_JPEG : JPEG compression
S_PDF_IMGCMPR_ZLIB : ZLIB compression
S_PDF_IMGCMPR_JPEG2000 : JPEG2000 compression
Throws:
XfoException
Since:
3.3

setPdfGrayscaleImageDownSampling

public void setPdfGrayscaleImageDownSampling(int newVal)
                                      throws XfoException
Specifies the following either of method to downsample the grayscale image that is put into PDF.
When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by setPdfGrayscaleImageDownSamplingDPI will be downsampled into the resolution specified by setPdfGrayscaleImageDownSamplingTarget.
This is the setting for the grayscale image. Spesify setPdfImageDownSampling for the color image, and setPdfMonochromeImageDownSampling for the monochrome image.
Effective when outputting to PDF.

Parameters:
newVal - the value of method to downsample the grayscale image
S_PDF_IMGDOWNSAMPLING_NONE : none
S_PDF_IMGDOWNSAMPLING_AVERAGE : biliner
S_PDF_IMGDOWNSAMPLING_BICUBIC : bicubic
S_PDF_IMGDOWNSAMPLING_SUBSAMPLING : nearest neighbor
Throws:
XfoException
Since:
3.3

setPdfGrayscaleImageDownSamplingDPI

public void setPdfGrayscaleImageDownSamplingDPI(int newVal)
                                         throws XfoException
Set resolution of the grayscale image which performs a downsampling.
Effective when outputting to PDF.

Parameters:
newVal - resolution
Throws:
XfoException
Since:
3.3

setPdfGrayscaleImageDownSamplingTarget

public void setPdfGrayscaleImageDownSamplingTarget(int newVal)
                                            throws XfoException
Set resolution when the grayscale image is downsampled.
Effective when outputting to PDF.

Parameters:
newVal - resolution
Throws:
XfoException
Since:
3.3

setPdfGrayscaleJPEGQuality

public void setPdfGrayscaleJPEGQuality(int newVal)
                                throws XfoException
For the grayscale image format that can not be stored directly in PDF, specifies the image quality by the numerical value within the range of 1-100 when IMGCMPR_JPEG is specified by setPdfGrayscaleImageCompression. The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.
CAUTION: It is not for changing the quality of a JPEG format image.
This is the setting for the grayscale image. Spesify setPdfJPEGQuality for the color image.
Effective when outputting to PDF.

Parameters:
newVal - the value of the quality of JPEG format (1 to 100)
Throws:
XfoException
Since:
3.3

setPdfImageCompression

public void setPdfImageCompression(int newVal)
                            throws XfoException
Specifies how to compress the color images embedded in PDF. When the color image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.
When IMGCMPR_AUTO is selected, the process is automatically done and creates the image data according to the setting of setPdfJPEGQuality and setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected.
This is the setting for the color image. Spesify setPdfGrayscaleImageCompression for the grayscale image, and setPdfMonochromeImageCompression for the monochrome image.
Effective when outputting to PDF.

Parameters:
newVal - the value of how raster graphics are compressed and stored
S_PDF_IMGCMPR_AUTO : Auto
S_PDF_IMGCMPR_JPEG : JPEG compression
S_PDF_IMGCMPR_ZLIB : ZLIB compression
S_PDF_IMGCMPR_JPEG2000 : JPEG2000 compression
Throws:
XfoException
Since:
3.1

setPdfImageDownSampling

public void setPdfImageDownSampling(int newVal)
                             throws XfoException
Specifies the following either of method to downsample the color image that is put into PDF.
When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by setPdfImageDownSamplingDPI will be downsampled into the resolution specified by setPdfImageDownSamplingTarget.
This is the setting for the color image. Spesify setPdfGrayscaleImageDownSampling for the grayscale image, and setPdfMonochromeImageDownSampling for the monochrome image.
Effective when outputting to PDF.

Parameters:
newVal - the value of method to downsample the color image
S_PDF_IMGDOWNSAMPLING_NONE : none
S_PDF_IMGDOWNSAMPLING_AVERAGE : biliner
S_PDF_IMGDOWNSAMPLING_BICUBIC : bicubic
S_PDF_IMGDOWNSAMPLING_SUBSAMPLING : nearest neighbor
Throws:
XfoException
Since:
3.3

setPdfImageDownSamplingDPI

public void setPdfImageDownSamplingDPI(int newVal)
                                throws XfoException
Set resolution of the grayscale image which performs a downsampling.
Effective when outputting to PDF.

Parameters:
newVal - resolution
Throws:
XfoException
Since:
3.3

setPdfImageDownSamplingTarget

public void setPdfImageDownSamplingTarget(int newVal)
                                   throws XfoException
Set resolution when the color image is downsampled.
Effective when outputting to PDF.

Parameters:
newVal - resolution
Throws:
XfoException
Since:
3.3

setPdfImport3DAnnotation

public void setPdfImport3DAnnotation(boolean newVal)
                              throws XfoException
Sets the value of whether to import 3D annotations or not.

Parameters:
newVal - the value of whether to import 3D annotations.
Throws:
XfoException
Since:
5.2

setPdfJPEGQuality

public void setPdfJPEGQuality(int newVal)
                       throws XfoException
For the color image format that can not be stored directly in PDF, specifies the image quality by the numerical value within the range of 1-100 when IMGCMPR_JPEG is specified by setPdfImageCompression. The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.
CAUTION: It is not for changing the quality of a JPEG format image.
This is the setting for the color image. Spesify setPdfGrayscaleJPEGQuality for the grayscale image.
Effective when outputting to PDF.

Parameters:
newVal - the value of the quality of JPEG format (1 to 100)
Throws:
XfoException
Since:
3.1

setPdfLinearize

public void setPdfLinearize(boolean newVal)
                     throws XfoException
Specifies whether to output linearize PDF or not.
Effective when outputting to PDF.

Parameters:
newVal - If the value is 'true' is specified, output linearlize PDF
Throws:
XfoException
Since:
3.3

setPdfMonochromeImageCompression

public void setPdfMonochromeImageCompression(int newVal)
                                      throws XfoException
Specifies how to compress the monochrome images embedded in PDF. When the monochrome image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.
This is the setting for the monochrome image. Spesify setPdfGrayscaleImageCompression for the grayscale image, and setPdfImageCompression for the color image.
Effective when outputting to PDF.

Parameters:
newVal - the value of how raster graphics are compressed and stored
S_PDF_MONOCMPR_CCITT4 : CCITTFaxDecode group 4 filter
S_PDF_MONOCMPR_CCITT3 : CCITTFaxDecode group 3 filter
S_PDF_MONOCMPR_RUNLENGTH : RunLengthDecode filter
S_PDF_MONOCMPR_ZLIB : FlateDecode filter
S_PDF_MONOCMPR_OFF : no filter
Throws:
XfoException
Since:
3.3

setPdfMonochromeImageDownSampling

public void setPdfMonochromeImageDownSampling(int newVal)
                                       throws XfoException
monochrom. Specifies the following either of method to downsample the monochrome image that is put into PDF.
When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by setPdfMonochromeImageDownSamplingDPI will be downsampled into the resolution specified by setPdfMonochromeImageDownSamplingTarget.
This is the setting for the monochrome image. Spesify setPdfImageDownSampling for the color image, and setPdfGrayscaleImageDownSampling for the grayscale image.
Effective when outputting to PDF.

Parameters:
newVal - the value of method to downsample the monochrome image
S_PDF_IMGDOWNSAMPLING_NONE : none
S_PDF_IMGDOWNSAMPLING_AVERAGE : biliner
S_PDF_IMGDOWNSAMPLING_BICUBIC : bicubic
S_PDF_IMGDOWNSAMPLING_SUBSAMPLING : nearest neighbor
Throws:
XfoException
Since:
3.3

setPdfMonochromeImageDownSamplingDPI

public void setPdfMonochromeImageDownSamplingDPI(int newVal)
                                          throws XfoException
Set resolution of the monochrome image which performs a downsampling.
Effective when outputting to PDF.

Parameters:
newVal - resolution
Throws:
XfoException
Since:
3.3

setPdfMonochromeImageDownSamplingTarget

public void setPdfMonochromeImageDownSamplingTarget(int newVal)
                                             throws XfoException
Set resolution when the monochrome image is downsampled.
Effective when outputting to PDF.

Parameters:
newVal - resolution
Throws:
XfoException
Since:
3.3

setPdfNoAccessibility

public void setPdfNoAccessibility(boolean newVal)
                           throws XfoException
Disables text access for screen reader devices of the PDF file.
Effective when outputting to PDF.
This parameter is effective only when you specify PDF1.4 or later to PDF version (setPdfVersion).

Parameters:
newVal - If the value is 'true' is specified, disables text access for screen reader devices of the PDF file
Throws:
XfoException
Since:
3.1

setPdfNoAddingOrChangingComments

public void setPdfNoAddingOrChangingComments(boolean newVal)
                                      throws XfoException
Disables adding comments and form fields to the PDF file.
Effective when outputting to PDF.

Parameters:
newVal - If the value is 'true' is specified, disables adding comments and form fields to the PDF file
Throws:
XfoException
Since:
3.1

setPdfNoAssembleDoc

public void setPdfNoAssembleDoc(boolean newVal)
                         throws XfoException
Disables inserting, deleting and rotating the PDF pages.
Effective when outputting to PDF.
This parameter is effective only when you specify PDF1.4 or later to PDF version (setPdfVersion).

Parameters:
newVal - If the value is 'true' is specified, disables inserting, deleting and rotating the PDF pages
Throws:
XfoException
Since:
3.1

setPdfNoChanging

public void setPdfNoChanging(boolean newVal)
                      throws XfoException
Disables making changes of the PDF file.
Effective when outputting to PDF.

Parameters:
newVal - If the value is 'true' is specified, disables making changes of the PDF file
Throws:
XfoException
Since:
3.1

setPdfNoContentCopying

public void setPdfNoContentCopying(boolean newVal)
                            throws XfoException
Disables copying the content of the PDF file.
Effective when outputting to PDF.

Parameters:
newVal - If the value is 'true' is specified, disables copying the content of the PDF file
Throws:
XfoException
Since:
3.1

setPdfNoFillForm

public void setPdfNoFillForm(boolean newVal)
                      throws XfoException
Disables adding comments and form fields to the PDF file.
Effective when outputting to PDF.
This parameter is effective only when you specify PDF1.4 or later to PDF version (setPdfVersion).

Parameters:
newVal - If the value is 'true' is specified, disables adding comments and form fields to the PDF file
Throws:
XfoException
Since:
3.1

setPdfNoPrinting

public void setPdfNoPrinting(boolean newVal)
                      throws XfoException
Disables printing the PDF file.
Effective when outputting to PDF.

Parameters:
newVal - If the value is 'true' is specified, disables printing the PDF file
Throws:
XfoException
Since:
3.1

setPdfOutputHeight

public void setPdfOutputHeight(java.lang.String newVal)
                        throws XfoException
Scales the height of PDF to output. A value with a unit or % value can be specified as length.
Effective when outputting to PDF.

Parameters:
newVal - the height of PDF
Throws:
XfoException
Since:
4.0

setPdfOutputScale

public void setPdfOutputScale(java.lang.String newVal)
                       throws XfoException
Specifies the scaling ratio of the PDF to output. A value with a unit or % value can be specified as length.
Effective when outputting to PDF.

Parameters:
newVal - the scaling ratio of the PDF
Throws:
XfoException
Since:
4.1

setPdfOutputWidth

public void setPdfOutputWidth(java.lang.String newVal)
                       throws XfoException
Scales the width of PDF to output. A value with a unit or % value can be specified as length.
Effective when outputting to PDF.

Parameters:
newVal - the width of PDF
Throws:
XfoException
Since:
4.0

setPdfOwnerPassword

public void setPdfOwnerPassword(java.lang.String newVal)
                         throws XfoException
Specifies the owner password for PDF. The password must be within 32 bytes.
Effective when outputting to PDF.

Parameters:
newVal - Owner password
Throws:
XfoException
Since:
3.1

setPdfPrintingAllowed

public void setPdfPrintingAllowed(int newVal)
                           throws XfoException
Spesifies whether to permit printing PDF to create.
Effective when outputting to PDF.
This parameter is effective only when you specify PDF1.4 or later to PDF version (setPdfVersion).

Parameters:
newVal - the value of printing allowed
S_PDF_PRALLOW_NONE : Not Allowed
S_PDF_PRALLOW_LOW : Low Resolution Printing
S_PDF_PRALLOW_HIGH : High Resolution Printing
Throws:
XfoException
Since:
3.1

setPdfPutImageColorProfile

public void setPdfPutImageColorProfile(boolean newVal)
                                throws XfoException
Specifies whether to embed to PDF the color profile of the color image that will be embedded to PDF.
Effective when outputting to PDF.

Parameters:
newVal - If the value is true it is embedded. If the value is false it is not embedded.
Throws:
XfoException
Since:
3.3

setPdfRasterizeResolution

public void setPdfRasterizeResolution(int newVal)
                               throws XfoException
Specifies the value of the rasterised-resolution of the transformed raster images in the range from 70 to 500(dpi). SVG, EMF and WMF are drawn in PDF as vectors without being transformed to raster images.
Effective when outputting to PDF. This setting is effective only with Windows version.

Parameters:
newVal - Rasterised-resolution (70 to 500)
Throws:
XfoException
Since:
3.1

setPdfReversePage

public void setPdfReversePage(boolean newVal)
                       throws XfoException
Sets the value of whether to output reverse page or not.

Parameters:
newVal - the value of whether to output reverse page.
Throws:
XfoException
Since:
5.2

setPdfRGBConversion

public void setPdfRGBConversion(int newVal)
                         throws XfoException
Specifies how to convert the RGB color space (DeviceRGB) to DeviceGray.
Effective when outputting to PDF.

Parameters:
newVal - the value of how to convert
S_PDF_RGBCONV_NONE : No Conversion
S_PDF_RGBCONV_BLACK : Black to DeviceGray
S_PDF_RGBCONV_GRAY : Gray to DeviceGray
S_PDF_RGBCONV_ALL : All RGB to DeviceGray
Throws:
XfoException
Since:
3.1

setPdfSignature

public void setPdfSignature(boolean newVal)
                     throws XfoException
Specifies whether to sign a signature to PDF or not.
Effective when outputting to PDF.

Parameters:
newVal - If the value is 'true' is specified, sign a signature to PDF
Throws:
XfoException
Since:
3.3

setPdfSignatureName

public void setPdfSignatureName(java.lang.String name)
                         throws XfoException
Sets a signature information name.
Effective when outputting to PDF.

Parameters:
name - the value of a signature information name
Throws:
XfoException
Since:
3.3

setPdfTag

public void setPdfTag(boolean newVal)
               throws XfoException
Generates Tagged PDF. Ignored if PDF cannot be tagged depending on the PDF versions.
Effective when outputting to PDF.

Parameters:
newVal - If the value is 'true' is specified, output Tagged PDF
Throws:
XfoException
Since:
4.0

setPdfUseLaunchForRelativeURI

public void setPdfUseLaunchForRelativeURI(boolean newVal)
                                   throws XfoException
Specifies whether the external link specified by the relative address is transformed into 'Open the file' or into 'World Wide Web link' in the PDF link properties.
Effective when outputting to PDF.

Parameters:
newVal - If the value is 'true', it is transformed to 'Open the file'. If the value is 'false', it is transformed to 'World Wide Web link'
Throws:
XfoException
Since:
3.1

setPdfUserPassword

public void setPdfUserPassword(java.lang.String newVal)
                        throws XfoException
Specifies the user password for PDF. The password must be within 32 bytes.
Effective when outputting to PDF.

Parameters:
newVal - user password
Throws:
XfoException
Since:
3.1

setPdfVersion

public void setPdfVersion(int newVal)
                   throws XfoException
Enables specifying whether the version of PDF.
Effective when outputting to PDF.

Parameters:
newVal - PDF version
S_PDF_VERSION_13 : PDF version 1.3
S_PDF_VERSION_14 : PDF version 1.4
S_PDF_VERSION_15 : PDF version 1.5
S_PDF_VERSION_16 : PDF version 1.6
S_PDF_VERSION_17 : PDF version 1.7
S_PDF_VERSION_X_1a_2001 : ISO 15930-1:2001 PDF/X-1a-2001 (based on PDF1.3)
S_PDF_VERSION_X_3_2002 : ISO 15930-3:2002 PDF/X-3-2002 (based on PDF1.3)
S_PDF_VERSION_X_1a_2003 : ISO 15930-4:2003 PDF/X-1a-2003 (based on PDF1.4)
S_PDF_VERSION_X_2_2003 : ISO 15930-5:2003 PDF/X-2-2003 (based on PDF1.4)
S_PDF_VERSION_X_3_2003 : ISO 15930-6:2003 PDF/X-3-2003 (based on PDF1.4)
S_PDF_VERSION_X_4_2008 : ISO 15930-7:2008 PDF/X-4-2008 (based on PDF1.6)
S_PDF_VERSION_A_1a_2005 : ISO 19005-1:2005 (based on PDF1.4)
S_PDF_VERSION_A_1b_2005 : ISO 19005-1:2005 (based on PDF1.4)
Throws:
XfoException
Since:
3.1

setPrinterName

public void setPrinterName(java.lang.String prn)
                    throws XfoException
Specifies the output format or the printer name to output.
When a printer name is specified, the formatted result is outputted to that printer.
When "@STDPRN" is specified, the formatted result is outputted to the currently used printer.
When "@PDF" is specified, the formatted result is outputted to PDF.
When "@SVG" is specified, the formatted result is outputted to SVG.
When "@PS" is specified, the formatted result is outputted to PostScript.
When "@INX" is specified, the formatted result is outputted to INX.
When "@MIF" is specified, the formatted result is outputted to MIF.
When "@TEXT" is specified, the formatted result is outputted to a text format file.

When "@AreaTree" is specified, the AreaTree will be outputted.
When omitted, it is considered as "@PDF" was specified. It's impossible to output to the printer with any OS's other than Windows.

Parameters:
prn - Printer name or output format
Throws:
XfoException

setPrinterSettingURI

public void setPrinterSettingURI(java.lang.String prn)
                          throws XfoException
Set the printer setting URI. This setting is effective only with Windows version.

Parameters:
prn - Printer setting URI
Throws:
XfoException

setPrnCollate

public void setPrnCollate(boolean col)
                   throws XfoException
Set collation of multiple copies.
Effective when outputting to printer and the number of copies is plural. Default setting is 'false'. This setting is effective only with Windows version.

Parameters:
col - If the value 'false' is specified, the same page is multi-copied continuously. If 'true' is specified, the pages specified from start to end are printed repeatedly.
Throws:
XfoException

setPrnCopies

public void setPrnCopies(int num)
                  throws XfoException
Set the number of copies. Default is 1. This setting is effective only with Windows version.

Parameters:
num - Number of copies
Throws:
XfoException

setSplitPages

public void setSplitPages(int newVal)
                   throws XfoException
Set the split-by-pages setting.

Parameters:
newVal - split-by-pages setting (0:No split 1:Split by each page)
Throws:
XfoException
Since:
6.1

setStartPage

public void setStartPage(int num)
                  throws XfoException
Set the start page number of document to output.
If the start page is omitted or the specified value is 0 or less, the start page is considered from the first page.

Parameters:
num - Start page number
Throws:
XfoException

setStartVolume

public void setStartVolume(int num)
                    throws XfoException
Set the start volume of document to output.
If the start volume is omitted or the specified value is 0 or less, the start volume is considered from the first volume.

Parameters:
num - Start volume
Throws:
XfoException
Since:
3.2

setStylesheetTitle

public void setStylesheetTitle(java.lang.String title)
                        throws XfoException
Set prior Stylesheet PI title.

Parameters:
title - Stylesheet PI title
Throws:
XfoException
Since:
5.0

setStylesheetURI

public void setStylesheetURI(java.lang.String uri)
                      throws XfoException
Set the URI of XSL stylesheet that is used when formatting.
This is ignored when: Otherwise, XSL stylesheet is required.

Parameters:
uri - URI of XSL stylesheet
Throws:
XfoException

setSvgEmbedAllFonts

public void setSvgEmbedAllFonts(boolean newVal)
                         throws XfoException
Specifies whether to embed fonts in the outputted SVG.
Effective when outputting to SVG.

Parameters:
newVal - If the value is 'true' is specified, embeds fonts.
Throws:
XfoException
Since:
3.3

setSvgEmbedFonts

public void setSvgEmbedFonts(java.lang.String newVal)
                      throws XfoException
Embeds the specified font in SVG to create. If you want to specify plural fonts, put commas between fonts.
Effective when outputting to SVG.

Parameters:
newVal - fonts specified to embed
Throws:
XfoException
Since:
3.3

setSvgErrorOnEmbedFault

public void setSvgErrorOnEmbedFault(boolean newVal)
                             throws XfoException
an error is issued in case of failing to embed fonts.
Effective when outputting to SVG.

Parameters:
newVal - If the value is 'true' is specified, an error is issued.
Throws:
XfoException
Since:
3.3

setSvgFormat

public void setSvgFormat(java.lang.String newVal)
                  throws XfoException
Specifies the format for naming files when the outputted SVG becomes multiple.
Effective when outputting to SVG.

Parameters:
newVal - format for naming files
Throws:
XfoException
Since:
3.3

setSvgGzipCompression

public void setSvgGzipCompression(boolean newVal)
                           throws XfoException
Specifies whether to compress the outputted SVG into gzip format or not.
Effective when outputting to SVG.

Parameters:
newVal - If the value is 'true' is specified, enables to compress data into gzip format.
Throws:
XfoException
Since:
3.3

setSvgImageConversion

public void setSvgImageConversion(int newVal)
                           throws XfoException
Specifies how to convert the images embedded in SVG to create.
Effective when outputting to SVG.

Parameters:
newVal - the value of how raster graphics are converted and stored
S_SVG_IMGCNV_AUTO : Auto
S_SVG_IMGCNV_JPEG : JPEG conversion
S_SVG_IMGCNV_PNG : PNG conversion
Throws:
XfoException
Since:
3.3

setSvgImageCopyPath

public void setSvgImageCopyPath(java.lang.String newVal)
                         throws XfoException
Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.
Effective when outputting to SVG.

Parameters:
newVal - the copy destination of image
Throws:
XfoException
Since:
3.3

setSvgImagePrefix

public void setSvgImagePrefix(java.lang.String newVal)
                       throws XfoException
When images are copied to the directory specified by setSvgImageCopyPath and processed, specifies the prefix of the file name. The file name will be prefix with sequence numbers. Default is empty character string with only sequential numbers.

Parameters:
newVal - the prefix of the file name.
Throws:
XfoException
Since:
3.3

setSvgImageProcessingType

public void setSvgImageProcessingType(int newVal)
                               throws XfoException
Specifies how to treat the referred image.
Effective when outputting to SVG.

Parameters:
newVal - specification how to treat the referred image.
S_SVG_IMGPT_EMBED_ALL : Embeds all images to SVG.
S_SVG_IMGPT_COPY_ALL : Copies all image files to the destination that is specified by setSvgImageCopyPath, and then links.
S_SVG_IMGPT_LINK : Links images that have been linked, and embeds the embedded image. However, the raster images other than JPEG and PNG are always embedded.
S_SVG_IMGPT_COPY : Copies images that have been linked to the destination that is specified by setSvgImageCopyPath, and links. The embedded image are embedded.
Throws:
XfoException
Since:
3.3

setSvgImageRename

public void setSvgImageRename(boolean newVal)
                       throws XfoException
When images are copied to the directory specified by setSvgImageCopyPath etc. and processed, specifies whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name. When the file name overlaps, sequential number is added. When true is specified, all files are renamed.

Parameters:
newVal - specification whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name.
Throws:
XfoException
Since:
3.3

setSvgJPEGQuality

public void setSvgJPEGQuality(int newVal)
                       throws XfoException
Specifies the quality of the Raster graphics when stored in JPEG format using the range of 1-100. The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger. The initial value is 80.
Effective when outputting to SVG.

Parameters:
newVal - JPEG quality (1 to 100)
Throws:
XfoException
Since:
3.3

setSvgRasterizeResolution

public void setSvgRasterizeResolution(int newVal)
                               throws XfoException
Specifies the value of the rasterised-resolution of the transformed raster images in the range from 70 to 500(dpi). SVG, EMF and WMF are drawn in SVG as vectors without being transformed to raster images.
Effective when outputting to SVG.
This method is available only in Windows version.

Parameters:
newVal - Rasterised-resolution (70 to 500)
Throws:
XfoException
Since:
3.3

setSvgSingleFile

public void setSvgSingleFile(boolean newVal)
                      throws XfoException
Specifies whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.
If the value is true, outputs one SVG. If the value is false, outputs multiple SVG. When multiple SVG is output, the file name is modified by specifying setSvgFormat.
Effective only when outputting to the file. It is invalid in the output without the file name like the stream etc.
Effective when outputting to SVG.

Parameters:
newVal - Specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.
Throws:
XfoException
Since:
3.3

setSvgSinglePageNumber

public void setSvgSinglePageNumber(boolean newVal)
                            throws XfoException
When setSvgSingleFile = 0 is specified, specifies whether to add sequential number to the output SVG even if it has only one-page. It is not added in case of false.
Effective when outputting to SVG.

Parameters:
newVal - specification whether to add sequential number to the output SVG even if it has only one-page.
Throws:
XfoException
Since:
3.3

setSvgVersion

public void setSvgVersion(int newVal)
                   throws XfoException
Enables specifying whether the version of SVG.
Effective when outputting to SVG.

Parameters:
newVal - SVG version
S_SVG_VERSION_11 : SVG version 1.1
S_SVG_VERSION_BASIC : SVG Basic
S_SVG_VERSION_TINY : SVG Tiny
Throws:
XfoException
Since:
3.3

setTwoPassFormatting

public void setTwoPassFormatting(boolean val)
                          throws XfoException
Specifies the two pass format.

Parameters:
val - specification of two pass format.
Throws:
XfoException
Since:
4.1

setWatermarkFontFamily

public void setWatermarkFontFamily(java.lang.String newVal)
                            throws XfoException
Specifies the font family to the character string which you set to watermark-text. .

Parameters:
newVal - The font family of the character string which you set to watermark-text.
Throws:
XfoException

setWatermarkFontStyle

public void setWatermarkFontStyle(java.lang.String newVal)
                           throws XfoException
Specifies the font style to the character string which you set to watermark-text. normal or italic can be specified. .

Parameters:
newVal - The font style of the character string which you set to watermark-text.
Throws:
XfoException

setWatermarkFontWeight

public void setWatermarkFontWeight(java.lang.String newVal)
                            throws XfoException
Specifies the font weight to the character string which you set to watermark-text. Possible to specify normal, bold or the numerical value from 100 to 900. .

Parameters:
newVal - The font weight of the character string which you set to watermark-text.
Throws:
XfoException

setWatermarkOpacity

public void setWatermarkOpacity(java.lang.String newVal)
                         throws XfoException
Specifies the opacity to the character string which you set to watermark-text. .

Parameters:
newVal - The opacity to the character string which you set to watermark-text.
Throws:
XfoException

setWatermarkText

public void setWatermarkText(java.lang.String newVal)
                      throws XfoException
Displays the specified watermark text on each page. Possible to make it multiple lines by delimiting with the line feed \n. This setting is invalid with the evaluation version. .

Parameters:
newVal - The watermark text specified for each page.
Throws:
XfoException

setXSLTParam

public void setXSLTParam(java.lang.String paramName,
                         java.lang.String value)
                  throws XfoException
Set the parameter name and value for xsl:param.

Parameters:
paramName - Parameter
value - Value
Throws:
XfoException

setXSLTParamFormat

public void setXSLTParamFormat(java.lang.String form)
                        throws XfoException
Set the parameter format of xsl:param when using External XSLT Processor.

Parameters:
form - Parameter format of xsl:param
Throws:
XfoException