ProcessHtml (Windward Reports 20.3 API)

java.lang.Object
- net.windward.xmlreport.ProcessReport
- - net.windward.xmlreport.ProcessHtml

All Implemented Interfaces:

ProcessHtmlAPI, ProcessReportAPI, ProcessReportAPIBase
```
public class ProcessHtml
extends ProcessReport
implements ProcessHtmlAPI
```
This class is the main program that takes a template stream and a datasource and merges them to create an html report stream. The way to use this is to construct a ProcessHtml object, set any options, then call process.
Images are separate files for html. So this object has a list of HtmlImage objects, one for each image in the report document. (Note: in the case of an image inside a while/end, it does not create multiple image files for each iteration. The same file is used each time the image is rendered in the report). These HtmlImage objects can either be streams that get the image as it is rendered, or they can be file names of the images that are already written to the hard disk.
So you can pass in these objects beforehand giving the filename, and optionally a stream to write the image to. And after the report is processed, the same objects will now have the filenames (if they were not set before the call) and the streams will hold the image file data (if set).
The calling method must close all streams after calling process. process will flush the output (report) stream before returning.

Version:

2.0 2 January 2004

Nested Class Summary
- Nested classes/interfaces inherited from class net.windward.xmlreport.ProcessReport
  ProcessReport.CleanDatasource, ProcessReport.DrillDownTemplate, ProcessReport.PhoneHomeStats

Field Summary
- Fields inherited from class net.windward.xmlreport.ProcessReport
  NUM_HOURS_BETWEEN_LICENSE_CHECK_INS, NUM_HOURS_BETWEEN_LICENSE_CHECK_INS_PREV_FAILED, TEMPLATE_TYPE_DOCM, TEMPLATE_TYPE_DOCX, TEMPLATE_TYPE_HTML, TEMPLATE_TYPE_PPTM, TEMPLATE_TYPE_PPTX, TEMPLATE_TYPE_UNKNOWN, TEMPLATE_TYPE_XLSM, TEMPLATE_TYPE_XLSX
- Fields inherited from interface net.windward.xmlreport.ProcessHtmlAPI
  CSS_EXISTS, CSS_INCLUDE, CSS_NO, CSS_SEPARATE, HTML_2, HTML_4_1, IE5, IE5_5, IE6, XHTML
- Fields inherited from interface net.windward.xmlreport.ProcessReportAPI
  CHARSET_DEFAULT, CHARSET_RTF, CHARSET_UNICODE, COPY_METADATA_ALWAYS, COPY_METADATA_IF_NO_DATASOURCE, COPY_METADATA_NEVER, DATA_MODE_ALL_ATTRIBUTES, DATA_MODE_DATA, DATA_MODE_EMBED, DATA_MODE_INCLUDE_BITMAPS, DATA_MODE_SELECT, ERROR_HANDLING_ALL, ERROR_HANDLING_NONE, ERROR_HANDLING_ONLY, ERROR_HANDLING_TRACK_ERRORS, ERROR_HANDLING_VERIFY, HIDDEN_IGNORE_PRINT_RANGE, HIDDEN_SHOW_ALL_ROWS_COLUMNS, HIDDEN_SHOW_HIDDEN_SHEETS, HIDDEN_SHOW_NO_PRINT, HYPHENATE_OFF, HYPHENATE_ON, HYPHENATE_TEMPLATE, LOCALE_DEFAULT, LOCALE_SYSTEM, MODE_PROCESS_EMBEDDED_ALWAYS, MODE_PROCESS_EMBEDDED_COPY, MODE_PROCESS_EMBEDDED_DROP, MODE_PROCESS_EMBEDDED_IF_DATA_APPLIED, MODE_PROCESS_EMBEDDED_KEEP_ORIGINAL_SCREENSHOT, RENDER_EXTENT_ALL, RENDER_EXTENT_CROP_EVERYTHING, RENDER_EXTENT_CROP_HEADER_AND_FOOTER, RENDER_EXTENT_CROP_MARGINS, RENDER_EXTENT_CROP_TO_CONTENT, TAG_STYLE_FIELD, TAG_STYLE_FIELD_2007, TAG_STYLE_TEXT, TYP_CSV, TYP_DOCX, TYP_HTML, TYP_IMAGE, TYP_PDF, TYP_PPTX, TYP_PRINTER, TYP_PS, TYP_RTF, TYP_TXT, TYP_XLSX

Constructor Summary

Constructors
Constructor and Description
`ProcessHtml(java.io.InputStream template)` Create a ProcessHtml object with the passed in template.
`ProcessHtml(java.io.InputStream template, java.util.ArrayList<java.io.ByteArrayOutputStream> reportPages)` Create a ProcessHtml object with the passed in template.
`ProcessHtml(java.io.InputStream xmlData, java.io.InputStream template, java.util.ArrayList<java.io.ByteArrayOutputStream> reportPages)` Create a ProcessReport object with the passed in template & data streams.
`ProcessHtml(java.io.InputStream xmlData, java.io.InputStream template, java.io.OutputStream report)` Create a ProcessReport object with the passed in template & data streams, writing it to the passed in report stream.
`ProcessHtml(java.io.InputStream template, java.io.OutputStream report)` Create a ProcessHtml object with the passed in template, writing it to the passed in report stream.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addImageName(HtmlImage img)` Deprecated. This will be eliminated - use embedded images.
`void`	`addImageNames(java.util.ArrayList<HtmlImage> imgs)` Deprecated. This will be eliminated - use embedded images.
`ProcessReportAPIBase`	`duplicate(java.io.OutputStream out)` Creates and returns a copy of this object.
`ProcessHtmlAPI`	`duplicate(java.io.OutputStream out, java.io.OutputStream cssStream)` Creates and returns a copy of this object.
`java.lang.String`	`getCssFilename()` Returns the css filename.
`java.io.OutputStream`	`getCssStream()` Returns the css stream.
`int`	`getCssType()` Returns if the css information will be written to a separate file, as part of the html file, or skipped (because the file already exists).
`java.lang.String`	`getFilePath()` Get the path that all images will be saved to on the disk.
`java.lang.String`	`getFilePrefix()` Get the prefix that will be part of the filename of all images saved to disk and listed in the html file.
`boolean`	`getHeadersFooters()` Deprecated. This will be eliminated.
`java.lang.String`	`getHtmlPath()` Get the path that all images will be prefixed with in the html file.
`java.util.ArrayList<HtmlImage>`	`getImageNames()` Get the image names/streams for the images in a report.
`java.util.ArrayList<java.io.ByteArrayOutputStream>`	`getPages()` Get the array of OutputStreams representing each page in this generated HTML document if html.split_pages is set.
`byte[][]`	`getPagesByteArrays()` Get an array of pages where each page is represented by a byte array (for easy file output).
`int`	`getReportType()` Get the report format of the output stream.
`java.lang.String`	`getReportTypeString()` Get the report format of the output as a string.
`int`	`getSpec()` Deprecated. We have never used this inside the engine. Use getProperties(HTML_SET_XHTML) for XHTML output.
`boolean`	`getUseTemplatePageWidth()` Deprecated. This will be eliminated. Use getProperties(REPORT_RENDER_EXTENT) instead.
`boolean`	`isEmbedImages()` When set to true, tells the engine to embed all images in the HTML file instead of using separate image files; more information found on Wikipedia: http://en.wikipedia.org/wiki/Data_URI_scheme
`boolean`	`isFullFile()` The report can be generated as either a complete html file, or as just the body.
`boolean`	`isHeaders()` Deprecated. This will be replaced by getProperties(REPORT_RENDER_EXTENT)
`boolean`	`isIE()` Deprecated. We have never used this inside the engine.
`boolean`	`isPageBasedReport()` true if the generated report is page based.
`boolean`	`isSplitPages()` When set to true, tells the engine to split HTML output into multiple documents, one for each page of the document.
`static boolean`	`isSplitPagesFromProperties()` Deprecated. There is no global value for this now.
`void`	`process()` Create a report from the input template and datasource(s) streams, writing it to the output (report) stream.
`void`	`setCss(int cssMethod, java.io.OutputStream cssStream, java.lang.String cssFileName)` Sets if the css information will be written to a separate file, as part of the html file, or skipped (because the file already exists).
`void`	`setEmbededDataMode(int mode)` Set the embed data setting.
`void`	`setEmbedImages(boolean setEmbedImages)` When set to true, tells the engine to embed all images in the HTML file instead of using separate image files; more information found on Wikipedia: http://en.wikipedia.org/wiki/Data_URI_scheme
`void`	`setFullFile(boolean fullDoc)` The report can be generated as either a complete html file, or as just the body.
`void`	`setHeadersFooters(boolean headerOn)` Deprecated. This will be eliminated.
`void`	`setImagePath(java.lang.String file, java.lang.String html, java.lang.String prefix)` Set a path that all images will be saved to.
`void`	`setSpec(int spec)` Deprecated. We have never used this inside the engine. Use getProperties(HTML_SET_XHTML) for XHTML output.
`void`	`setSplitPages(boolean setSplitPages)` When set to true, tells the engine to split HTML output into multiple documents, one for each page of the document.
`void`	`setUseTemplatePageWidth(boolean setUsePageWidth)` Deprecated. This will be eliminated. Use getProperties(REPORT_RENDER_EXTENT) instead.

Methods inherited from class net.windward.xmlreport.ProcessReport
abort, addImportInfo, adjustFontName, adjustFontSize, applyLicenseKey, batchNext, batchSetup, buildSchema, checkTimeout, clean, clean, clean, cleanSelects, cleanSelects, close, findPodsUsed, getBaseDirectory, getCharset, getChartProvider, getChartRenderType, getCompany, getCopyMetadata, getDataMode, getDataStream, getDataWriter, getDebugHandler, getDescription, getDrillDownInfo, getErrorInfo, getEventHandler, getHiddenMode, getHyphenate, getImportInfo, getKeywords, getLocale, getMaxReportPages, getModeProcessEmbedded, getNumPages, getOutputBuilderData, getParameters, getProperties, getRenderExtent, getRenderPages, getReport, getSubject, getTagTree, getTemplateMetrics, getTemplateMetrics, getTemplateMetrics, getTemplateMetrics, getTemplateTypeString, getTemplateVersion, getTimeout, getTitle, getVersion, getVersionMajor, getVersionMinor, getVersionRelease, getWriteTags, hasDatasourcesApplied, hasProcessedTags, init, isDebugMode, isIgnoreTags, isLayoutDocument, isPreservePodFraming, isRemoveUnusedFormats, isReportTypeDocx, isReportTypeExcel, isReportTypeOpenXml, isReportTypePpt, isReportTypeWord, isSameOpenXml, isTemplateTypeDOCX, isTemplateTypeEqualsReportType, isTemplateTypeOpenXml, isTemplateTypePPTX, isTemplateTypeXLSX, isTrackImports, isUseExternalOutputBuilder, loadTemplate, mergePodItemStyles, performLayout, processComplete, processComplete, processData, processData, processSetup, processSetup, setBaseDirectory, setCharset, setCopyMetadata, setDataMode, setDataStream, setDebugHandler, setDebugMode, setDescription, setDrillDownInfo, setEventHandler, setHiddenMode, setHyphenate, setIgnoreTags, setKeywords, setLayoutDocument, setLicense, setLocale, setModeProcessEmbedded, setOutputBuilder, setOutputBuilderData, setParameters, setPreservePodFraming, setRemoveUnusedFormats, setRenderExtent, setRenderPages, setSubject, setTemplateVersion, setTimeout, setTitle, setTrackErrors, setTrackImports, setUseExternalOutputBuilder, setWriteTags, shutdown, statBanner, statLine, updatePods

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

Methods inherited from interface net.windward.xmlreport.ProcessReportAPIBase
batchNext, batchSetup, buildSchema, close, findPodsUsed, getBaseDirectory, getCharset, getCopyMetadata, getDataMode, getDataStream, getDescription, getDrillDownInfo, getErrorInfo, getEventHandler, getHiddenMode, getHyphenate, getImportInfo, getKeywords, getLocale, getModeProcessEmbedded, getNumPages, getOutputBuilderData, getParameters, getProperties, getRenderExtent, getRenderPages, getReport, getSubject, getTemplateVersion, getTimeout, getTitle, getWriteTags, hasProcessedTags, isDebugMode, isLayoutDocument, isPreservePodFraming, isRemoveUnusedFormats, isReportTypeExcel, isReportTypeWord, isTrackImports, isUseExternalOutputBuilder, processComplete, processData, processData, processSetup, processSetup, setBaseDirectory, setCharset, setCopyMetadata, setDataMode, setDataStream, setDebugMode, setDescription, setDrillDownInfo, setEventHandler, setHiddenMode, setHyphenate, setKeywords, setLayoutDocument, setLicense, setLocale, setModeProcessEmbedded, setOutputBuilderData, setParameters, setPreservePodFraming, setRemoveUnusedFormats, setRenderExtent, setRenderPages, setSubject, setTemplateVersion, setTimeout, setTitle, setTrackErrors, setTrackImports, setUseExternalOutputBuilder, setWriteTags, updatePods

- Constructor Detail
  - ProcessHtml
```
public ProcessHtml(java.io.InputStream template)
            throws LicenseException,
                   SetupException
```
    Create a ProcessHtml object with the passed in template. Objects created with this constructor must call processSetup, processData, and processComplete. Objects created with this constructor cannot call process. The report will be in the html format.
    
    Parameters:
    
    template - The report template.
    
    Throws:
    
    LicenseException - thrown if the license licenseKey check fails. The message will list the license check that failed.
    
    SetupException
  - ProcessHtml
```
public ProcessHtml(java.io.InputStream template,
                   java.io.OutputStream report)
            throws LicenseException,
                   SetupException
```
    Create a ProcessHtml object with the passed in template, writing it to the passed in report stream. Objects created with this constructor must call processSetup, processData, and processComplete. Objects created with this constructor cannot call process. The report will be in the html format.
    
    Parameters:
    
    template - The report template.
    
    report - The stream to write the report to.
    
    Throws:
    
    LicenseException - thrown if the license licenseKey check fails. The message will list the license check that failed.
    
    java.lang.IllegalArgumentException - thrown if html.split_pages is set; call ProcessHtml(InputStream, ArrayList) instead.
    
    SetupException
  - ProcessHtml
```
public ProcessHtml(java.io.InputStream template,
                   java.util.ArrayList<java.io.ByteArrayOutputStream> reportPages)
            throws LicenseException,
                   SetupException
```
    Create a ProcessHtml object with the passed in template. If html.split_pages is enabled, each page will be created as a separate object in the ArrayList passed in. If not, output will be written to the first object in the array. Objects created with this constructor must call processSetup, processData, and processComplete. Objects created with this constructor cannot call process. The report will be in the html format.
    
    Parameters:
    
    template - The report template
    
    reportPages - The array of streams to write pages to.
    
    Throws:
    
    LicenseException
    
    SetupException
  - ProcessHtml
```
public ProcessHtml(java.io.InputStream xmlData,
                   java.io.InputStream template,
                   java.io.OutputStream report)
            throws java.lang.IllegalArgumentException,
                   DataConnectionException,
                   LicenseException,
                   SetupException
```
    Create a ProcessReport object with the passed in template & data streams, writing it to the passed in report stream. The report will be in the html format.
    
    Parameters:
    
    xmlData - The xml data that will be placed into the report where there are xml elements.
    
    template - The report template.
    
    report - The stream to write the report to.
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if an illegal argument is given, or if html.split_pages is enabled. If split_pages is enabled, use ProcessHtml(InputStream, ArrayList) instead.
    
    DataSourceException - thrown if there is a problem with the datasource.
    
    LicenseException - thrown if the license licenseKey check fails. The message will list the license check that failed.
    
    DataConnectionException
    
    SetupException
  - ProcessHtml
```
public ProcessHtml(java.io.InputStream xmlData,
                   java.io.InputStream template,
                   java.util.ArrayList<java.io.ByteArrayOutputStream> reportPages)
            throws DataConnectionException,
                   LicenseException,
                   SetupException
```
    Create a ProcessReport object with the passed in template & data streams. If html.split_pages is enabled, each page will be created as a separate object in the ArrayList passed in. If not, output will be written to the first object in the array. Objects created with this constructor must call processSetup, processData, and processComplete. Objects created with this constructor cannot call process. The report will be in the html format.
    
    Parameters:
    
    xmlData - The xml data that will be placed into the report where there are xml elements.
    
    template - The report template
    
    reportPages - The array of streams to write pages to.
    
    Throws:
    
    DataConnectionException - thrown if there is a problem with the datasource.
    
    LicenseException - thrown if the license licenseKey check fails. The message will list the license check that failed.
    
    SetupException
- Method Detail
  - duplicate
```
public ProcessReportAPIBase duplicate(java.io.OutputStream out)
                               throws AlreadyProcessedException,
                                      LicenseException,
                                      SetupException
```
    Creates and returns a copy of this object. You may call this before or after calling processData(). You may then call processData() on the created object. You must call this after calling processSetup() and before calling processComplete(). While this mostly does a deep copy, it does not do a deep copy of image data. This will always return a ProcessHtml object.
    
    Specified by:
    
    duplicate in interface ProcessReportAPIBase
    
    Parameters:
    
    out - The stream to write the report to. If null will create a ByteArrayOutputStream.
    
    Returns:
    
    A duplicated report object.
    
    Throws:
    
    AlreadyProcessedException - thrown if call the process steps out of order or call ones other than data twice.
    
    LicenseException - thrown if the license licenseKey check fails. The message will list the license check that failed.
    
    SetupException
  - duplicate
```
public ProcessHtmlAPI duplicate(java.io.OutputStream out,
                                java.io.OutputStream cssStream)
                         throws AlreadyProcessedException,
                                LicenseException,
                                SetupException
```
    Creates and returns a copy of this object. You may call this before or after calling processData(). You may then call processData() on the created object. You must call this after calling processSetup() and before calling processComplete(). While this mostly does a deep copy, it does not do a deep copy of image data. This will always return a ProcessHtml object.
    
    Specified by:
    
    duplicate in interface ProcessHtmlAPI
    
    Parameters:
    
    out - The stream to write the report to. If null will create a ByteArrayOutputStream.
    
    cssStream - The css stream to write to. Can be null.
    
    Throws:
    
    AlreadyProcessedException - thrown if call the process steps out of order or call ones other than data twice.
    
    LicenseException - thrown if the license licenseKey check fails. The message will list the license check that failed.
    
    SetupException
  - process
```
public void process()
             throws LicenseException,
                    java.io.IOException,
                    TemplateParseException,
                    java.lang.IllegalArgumentException,
                    TagException,
                    AlreadyProcessedException,
                    DataSourceException,
                    OutputLimitationException,
                    TinyException
```
    Create a report from the input template and datasource(s) streams, writing it to the output (report) stream. This should only be called once for a given ProcessReport object!
    
    Specified by:
    
    process in interface ProcessReportAPIBase
    
    Overrides:
    
    process in class ProcessReport
    
    Throws:
    
    java.io.IOException - thrown if have problems accessing the xml, template, or report streams.
    
    LicenseException - thrown if called too often for the license type.
    
    java.lang.IllegalArgumentException - thrown if come across an unknown element type or an illegal reportType value is used.
    
    TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.
    
    AlreadyProcessedException - thrown if call process multiple times on an object.
    
    DataSourceException - thrown if there is a problem with the datasource.
    
    TemplateParseException
    
    OutputLimitationException
    
    TinyException
  - setEmbededDataMode
```
public void setEmbededDataMode(int mode)
```
    Set the embed data setting. Uses flags of EMBED_* constant ints. 0 for no embed.
    
    Parameters:
    
    mode - the embed data setting. You can only pass a 0.
  - isIE
```
public boolean isIE()
```
    Deprecated. We have never used this inside the engine.
    
    Returns true if the spec is set to a version of Internet Explorer.
    
    Returns:
    
    true if building for IE, false otherwise.
  - isHeaders
```
public boolean isHeaders()
```
    Deprecated. This will be replaced by getProperties(REPORT_RENDER_EXTENT)
    
    Returns:
    
    true if headers/footers are turned on
  - isPageBasedReport
```
public boolean isPageBasedReport()
```
    true if the generated report is page based. true if split pages.
    
    Specified by:
    
    isPageBasedReport in interface ProcessReportAPIBase
    
    Overrides:
    
    isPageBasedReport in class ProcessReport
    
    Returns:
    
    true if the generated report is page based.
  - getReportType
```
public int getReportType()
```
    Get the report format of the output stream.
    
    Specified by:
    
    getReportType in interface ProcessHtmlAPI
    
    Specified by:
    
    getReportType in interface ProcessReportAPIBase
    
    Returns:
    
    The type (format) of the output report. Will be TYP_HTML.
  - getReportTypeString
```
public java.lang.String getReportTypeString()
```
    Get the report format of the output as a string.
    
    Specified by:
    
    getReportTypeString in interface ProcessReportAPIBase
    
    Returns:
    
    "html"
  - addImageName
```
public void addImageName(HtmlImage img)
```
    Deprecated. This will be eliminated - use embedded images.
    
    Set a single image name. If there are no images, this is it. If there are already images, this adds this name to the end of the list. This method can only be called before processing a report.
    
    Specified by:
    
    addImageName in interface ProcessHtmlAPI
    
    Parameters:
    
    img - The image to add to the list of images for this file.
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown if setImageName(s) already called
  - addImageNames
```
public void addImageNames(java.util.ArrayList<HtmlImage> imgs)
```
    Deprecated. This will be eliminated - use embedded images.
    
    Set several image names. If there are no images, this is it. If there are already images, this adds these to the end of the list. This method can only be called before processing a report.
    
    Specified by:
    
    addImageNames in interface ProcessHtmlAPI
    
    Parameters:
    
    imgs - The images to add to the list of images for this file.
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown if setImageName(s) already called
  - setImagePath
```
public void setImagePath(java.lang.String file,
                         java.lang.String html,
                         java.lang.String prefix)
```
    Set a path that all images will be saved to. All images will be written to the disk as they are read from the template. If this is called, you may not also call addImageName. You can however after processing call getImageNames and the filenames will be in there (but not the streams).
    The path can be just a series of folders like "c:/dir1/dir2/" or it can include the begining of the filename like "c:/dir1/dir2/tmp". The first will create the file "c:/dir1/dir2/00001.jpg" while the second will create the file "c:/dir1/dir2/tmp00001.jpg".
    Note: file and prefix should not end with a /
    Note: as Windward Reports has no idea when the created file is no longer needed, it will not delete any files created.
    Note: The path seperator should be /, not \ (to work on unix and windows).
    
    Specified by:
    
    setImagePath in interface ProcessHtmlAPI
    
    Parameters:
    
    file - The path of the file on the disk relative to the default directory of your program. It can be an absolute path.
    If it's null, images won't be written. You'll need to call getImageNames to obtain a list of images and write them to the disk yourself.
    
    html - The path of the file relative to the default directory of the client browser.
    
    prefix - The prefix to use when creating the filename. This can be null.
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown if addImageName(s) already called
  - getFilePath
```
public java.lang.String getFilePath()
```
    Get the path that all images will be saved to on the disk. The path can be just a series of folders like "c:/dir1/dir2/" or it can include the begining of the filename like "c:/dir1/dir2/tmp". The first should be used to create the file "c:/dir1/dir2/00001.jpg" while the second to create the file "c:/dir1/dir2/tmp00001.jpg".
    Note: as Windward Reports has no idea when the created file is no longer needed, it will not delete any files created.
    
    Specified by:
    
    getFilePath in interface ProcessHtmlAPI
  - getHtmlPath
```
public java.lang.String getHtmlPath()
```
    Get the path that all images will be prefixed with in the html file. The path can be just a series of folders like "c:/dir1/dir2/" or it can include the begining of the filename like "c:/dir1/dir2/tmp". The first should be used to include the file "c:/dir1/dir2/00001.jpg" while the second to include the file "c:/dir1/dir2/tmp00001.jpg".
    
    Specified by:
    
    getHtmlPath in interface ProcessHtmlAPI
  - getFilePrefix
```
public java.lang.String getFilePrefix()
```
    Get the prefix that will be part of the filename of all images saved to disk and listed in the html file. In this case the file will be "c:/dir1/dir2/tmp00001.jpg" where tmp is the prefix.
    
    Specified by:
    
    getFilePrefix in interface ProcessHtmlAPI
  - getImageNames
```
public java.util.ArrayList<HtmlImage> getImageNames()
```
    Get the image names/streams for the images in a report. This method can only be called after processing a report. This will have an entry for every image in the template. However, if Windward Reports is naming the files and/or creating the OutputStream then images that are not needed in the final report will have a filename of "" and an OutputStream size of 0.
    
    Specified by:
    
    getImageNames in interface ProcessHtmlAPI
    
    Returns:
    
    The images for this report.
  - getPages
```
public java.util.ArrayList<java.io.ByteArrayOutputStream> getPages()
```
    Get the array of OutputStreams representing each page in this generated HTML document if html.split_pages is set.
    
    Returns:
    
    Array of pages if html.split_pages is set. null otherwise.
  - getPagesByteArrays
```
public byte[][] getPagesByteArrays()
```
    Get an array of pages where each page is represented by a byte array (for easy file output). This only returns the array of pages if html.split_pages is enabled, otherwise it returns null. This will also close all page output streams.
    
    Returns:
    
    Array of pages if html.split_pages is set; null otherwise.
  - setFullFile
```
public void setFullFile(boolean fullDoc)
```
    The report can be generated as either a complete html file, or as just the body. If it is set to full file, the report will have everything from <html> to </html>. If not set, it will be a body, and can be included with additional html as just part of the body of a final html file. In this case the returned stream must be placed inside a <body>...</body>. Default is true.
    
    Specified by:
    
    setFullFile in interface ProcessHtmlAPI
    
    Parameters:
    
    fullDoc - Set to true to return a complete html file, false otherwise.
  - isFullFile
```
public boolean isFullFile()
```
    The report can be generated as either a complete html file, or as just the body. If it is set to full file, the report will have everything from <html> to </html>. If not set, it will be a body, and can be included with additional html as just part of the body of a final html file. In this case the returned stream must be placed inside a <body>...</body>. Default is true.
    
    Specified by:
    
    isFullFile in interface ProcessHtmlAPI
    
    Returns:
    
    true if will return a complete html file, false otherwise.
  - setCss
```
public void setCss(int cssMethod,
                   java.io.OutputStream cssStream,
                   java.lang.String cssFileName)
            throws java.lang.IllegalArgumentException
```
    Sets if the css information will be written to a separate file, as part of the html file, or skipped (because the file already exists). Default is CSS_NO.
    
    Specified by:
    
    setCss in interface ProcessHtmlAPI
    
    Parameters:
    
    cssMethod - Must be one of the values CSS_NO, CSS_INCLUDE, CSS_SEPARATE, or CSS_EXISTS.
    
    cssStream - The stream to write the css file to. This can (and must) only be set if cssMethod is CSS_SEPARATE. This file will always be the same every time a given template is run so it can be generated the first time and just reused without being regenerated after that.
    
    cssFileName - The name of the file when cssMethod is CSS_SEPARATE or CSS_EXISTS. This is only needed if the report will write the full file. Set to "" or null for other methods.
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown if an illegal reportType value is passed in.
  - getCssType
```
public int getCssType()
```
    Returns if the css information will be written to a separate file, as part of the html file, or skipped (because the file already exists). Default is CSS_NO.
    
    Specified by:
    
    getCssType in interface ProcessHtmlAPI
    
    Returns:
    
    Will be one of the values CSS_NO, CSS_INCLUDE, CSS_SEPARATE, or CSS_EXISTS.
  - getCssFilename
```
public java.lang.String getCssFilename()
```
    Returns the css filename. Null if there is no separate css file.
    
    Specified by:
    
    getCssFilename in interface ProcessHtmlAPI
    
    Returns:
    
    The css filename.
  - getCssStream
```
public java.io.OutputStream getCssStream()
```
    Returns the css stream. Null if not CSS_SEPARATE.
    
    Specified by:
    
    getCssStream in interface ProcessHtmlAPI
    
    Returns:
    
    The css stream.
  - setSpec
```
public void setSpec(int spec)
             throws java.lang.IllegalArgumentException
```
    Deprecated. We have never used this inside the engine. Use getProperties(HTML_SET_XHTML) for XHTML output.
    
    Sets the spec that the produced report must run under. The produced report will not use any html tags that are not supported by the set spec. Default is HTML_4_1.
    
    Specified by:
    
    setSpec in interface ProcessHtmlAPI
    
    Parameters:
    
    spec - Must be one of the spec final int's from this class: HTML*, NN*, IE*, ...
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown if an illegal spec value is passed in.
  - getSpec
```
public int getSpec()
```
    Deprecated. We have never used this inside the engine. Use getProperties(HTML_SET_XHTML) for XHTML output.
    
    Gets the spec that the produced report must run under. The produced report will not use any html tags that are not supported by this spec. Default is HTML_4_1.
    
    Specified by:
    
    getSpec in interface ProcessHtmlAPI
    
    Returns:
    
    Will be one of the spec final int's from this class: HTML*, NN*, IE*, ...
  - setHeadersFooters
```
public void setHeadersFooters(boolean headerOn)
```
    Deprecated. This will be eliminated.
    
    When set true tells the engine to grab the first header and footer it finds and places them at the beggining and end of the html document respectivley.
    
    Specified by:
    
    setHeadersFooters in interface ProcessHtmlAPI
    
    Parameters:
    
    headerOn - true=on false=off, off by default
  - getHeadersFooters
```
public boolean getHeadersFooters()
```
    Deprecated. This will be eliminated.
    
    Specified by:
    
    getHeadersFooters in interface ProcessHtmlAPI
    
    Returns:
    
    true if headers footers are to be used
  - setUseTemplatePageWidth
```
public void setUseTemplatePageWidth(boolean setUsePageWidth)
```
    Deprecated. This will be eliminated. Use getProperties(REPORT_RENDER_EXTENT) instead.
    
    When set true tells the engine to put the entire page into a container with margins the same as the template document page width
    
    Specified by:
    
    setUseTemplatePageWidth in interface ProcessHtmlAPI
    
    Parameters:
    
    setUsePageWidth - true=on false=off, on by default
  - getUseTemplatePageWidth
```
public boolean getUseTemplatePageWidth()
```
    Deprecated. This will be eliminated. Use getProperties(REPORT_RENDER_EXTENT) instead.
    
    Specified by:
    
    getUseTemplatePageWidth in interface ProcessHtmlAPI
    
    Returns:
    
    true if engine to puts entire page into a container with margins the same as the template document page width
  - isEmbedImages
```
public boolean isEmbedImages()
```
    When set to true, tells the engine to embed all images in the HTML file instead of using separate image files; more information found on Wikipedia: http://en.wikipedia.org/wiki/Data_URI_scheme
    
    Specified by:
    
    isEmbedImages in interface ProcessHtmlAPI
    
    Returns:
    
    true if engine will embed images
  - setEmbedImages
```
public void setEmbedImages(boolean setEmbedImages)
```
    When set to true, tells the engine to embed all images in the HTML file instead of using separate image files; more information found on Wikipedia: http://en.wikipedia.org/wiki/Data_URI_scheme
    
    Specified by:
    
    setEmbedImages in interface ProcessHtmlAPI
    
    Parameters:
    
    setEmbedImages - true=embed images; false=separate images, on by default
  - isSplitPages
```
public boolean isSplitPages()
```
    When set to true, tells the engine to split HTML output into multiple documents, one for each page of the document.
    
    Specified by:
    
    isSplitPages in interface ProcessHtmlAPI
    
    Returns:
    
    true if engine will split pages into multiple documents
  - isSplitPagesFromProperties
```
public static boolean isSplitPagesFromProperties()
```
    Deprecated. There is no global value for this now.
    
    Gets html.split_pages property from properties file Different from isSplitPages() as this is a static method intended for use before the creation of a ProcessHtml object.
    
    Returns:
    
    true if engine will split pages into multiple documents
  - setSplitPages
```
public void setSplitPages(boolean setSplitPages)
```
    When set to true, tells the engine to split HTML output into multiple documents, one for each page of the document.
    
    Specified by:
    
    setSplitPages in interface ProcessHtmlAPI
    
    Parameters:
    
    setSplitPages - true=split pages; false=produce one full document

Class ProcessHtml

Nested Class Summary

Nested classes/interfaces inherited from class net.windward.xmlreport.ProcessReport

Field Summary

Fields inherited from class net.windward.xmlreport.ProcessReport

Fields inherited from interface net.windward.xmlreport.ProcessHtmlAPI

Fields inherited from interface net.windward.xmlreport.ProcessReportAPI

Constructor Summary

Method Summary

Methods inherited from class net.windward.xmlreport.ProcessReport

Methods inherited from class java.lang.Object

Methods inherited from interface net.windward.xmlreport.ProcessReportAPIBase

Constructor Detail

ProcessHtml

ProcessHtml

ProcessHtml

ProcessHtml

ProcessHtml

Method Detail

duplicate

duplicate

process

setEmbededDataMode

isIE

isHeaders

isPageBasedReport

getReportType

getReportTypeString

addImageName

addImageNames

setImagePath

getFilePath

getHtmlPath

getFilePrefix

getImageNames

getPages

getPagesByteArrays

setFullFile

isFullFile

setCss

getCssType

getCssFilename

getCssStream

setSpec

getSpec

setHeadersFooters

getHeadersFooters

setUseTemplatePageWidth

getUseTemplatePageWidth

isEmbedImages

setEmbedImages

isSplitPages

isSplitPagesFromProperties

setSplitPages