ProcessHtmlAPI (Windward Reports 16.1 API)

All Superinterfaces:

ProcessReportAPI, ProcessReportAPIBase

All Known Implementing Classes:

ProcessHtml
```
public interface ProcessHtmlAPI
extends ProcessReportAPI
```
This class is a subclass of ProcessReportAPI specifically for creating an output in the html format.

Version:

2.0 2 January 2004

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CSS_EXISTS` Assume they have the css file already.
`static int`	`CSS_INCLUDE` Put the css contents in the output (html) file.
`static int`	`CSS_NO` No css.
`static int`	`CSS_SEPARATE` Put the css contents in the css stream.
`static int`	`HTML_2` Create a HTML file that conforms to html 2.0.
`static int`	`HTML_4_1` Create a HTML file that conforms to 4.01.
`static int`	`IE5` Create a HTML file that conforms to the IE 5.0 spec.
`static int`	`IE5_5` Create a HTML file that conforms to the IE 5.5 spec.
`static int`	`IE6` Create a HTML file that conforms to the IE 6.0 spec.
`static int`	`XHTML` Create a HTML file that conforms to the XHTML spec.

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_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, RENDER_EXTENT_ALL, RENDER_EXTENT_CROP_CONTENT, RENDER_EXTENT_CROP_MARGINS, TAG_STYLE_CONTROL_2007, 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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addImageName(HtmlImage img)` Set a single image name.
`void`	`addImageNames(java.util.ArrayList imgs)` Set several image names.
`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()`
`java.lang.String`	`getHtmlPath()` Get the path that all images will be prefixed with in the html file.
`java.util.ArrayList`	`getImageNames()` Get the image names/streams for the images in a report.
`int`	`getReportType()` Get the report format of the output stream.
`int`	`getSpec()` Gets the spec that the produced report must run under.
`boolean`	`getUseTemplatePageWidth()`
`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`	`isSplitPages()` When set to true, tells the engine to split HTML output into multiple documents, one for each page of the document.
`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`	`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)` 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.
`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)` Sets the spec that the produced report must run under.
`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)` When set true tells the engine to put the entire page into a container with margins the same as the template document page width

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

- Field Detail
  - HTML_2
```
static final int HTML_2
```
    Create a HTML file that conforms to html 2.0.
    
    See Also:
    
    Constant Field Values
  - HTML_4_1
```
static final int HTML_4_1
```
    Create a HTML file that conforms to 4.01. This is Netscape 4 and IE 4 and later.
    
    See Also:
    
    Constant Field Values
  - IE5
```
static final int IE5
```
    Create a HTML file that conforms to the IE 5.0 spec.
    
    See Also:
    
    Constant Field Values
  - IE5_5
```
static final int IE5_5
```
    Create a HTML file that conforms to the IE 5.5 spec.
    
    See Also:
    
    Constant Field Values
  - IE6
```
static final int IE6
```
    Create a HTML file that conforms to the IE 6.0 spec.
    
    See Also:
    
    Constant Field Values
  - XHTML
```
static final int XHTML
```
    Create a HTML file that conforms to the XHTML spec.
    
    See Also:
    
    Constant Field Values
  - CSS_NO
```
static final int CSS_NO
```
    No css. For browsers that don't support css.
    
    See Also:
    
    Constant Field Values
  - CSS_INCLUDE
```
static final int CSS_INCLUDE
```
    Put the css contents in the output (html) file.
    
    See Also:
    
    Constant Field Values
  - CSS_SEPARATE
```
static final int CSS_SEPARATE
```
    Put the css contents in the css stream.
    
    See Also:
    
    Constant Field Values
  - CSS_EXISTS
```
static final int CSS_EXISTS
```
    Assume they have the css file already. Don't need to rebuild it.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - duplicate
```
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.
    
    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
  - getReportType
```
int getReportType()
```
    Get the report format of the output stream.
    
    Specified by:
    
    getReportType in interface ProcessReportAPIBase
    
    Returns:
    
    The type (format) of the output report. Will be TYP_HTML.
  - addImageName
```
void addImageName(HtmlImage img)
```
    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.
    
    Parameters:
    
    img - The image to add to the list of images for this file.
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown if addImageName(s) already called
  - addImageNames
```
void addImageNames(java.util.ArrayList imgs)
```
    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.
    
    Parameters:
    
    imgs - The images to add to the list of images for this file.
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown if addImageName(s) already called
  - setImagePath
```
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).
    
    Parameters:
    
    file - The path of the file on the disk relative to the default directory of your program.
    
    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
```
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.
  - getHtmlPath
```
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".
  - getFilePrefix
```
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.
  - getImageNames
```
java.util.ArrayList 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.
    
    Returns:
    
    The images for this report.
  - setFullFile
```
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.
    
    Parameters:
    
    fullDoc - Set to true to return a complete html file, false otherwise.
  - isFullFile
```
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.
    
    Returns:
    
    true if will return a complete html file, false otherwise.
  - setCss
```
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.
    
    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
```
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.
    
    Returns:
    
    Will be one of the values CSS_NO, CSS_INCLUDE, CSS_SEPARATE, or CSS_EXISTS.
  - getCssFilename
```
java.lang.String getCssFilename()
```
    Returns the css filename. Null if there is no separate css file.
    
    Returns:
    
    The css filename.
  - getCssStream
```
java.io.OutputStream getCssStream()
```
    Returns the css stream. Null if not CSS_SEPARATE.
    
    Returns:
    
    The css stream.
  - setSpec
```
void setSpec(int spec)
      throws java.lang.IllegalArgumentException
```
    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.
    
    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
```
int getSpec()
```
    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.
    
    Returns:
    
    Will be one of the spec final int's from this class: HTML*, NN*, IE*, ...
  - setHeadersFooters
```
void setHeadersFooters(boolean headerOn)
```
    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.
    
    Parameters:
    
    headerOn - true=on false=off, off by default
  - getHeadersFooters
```
boolean getHeadersFooters()
```
    Returns:
    
    true if headers footers are to be used
  - setUseTemplatePageWidth
```
void setUseTemplatePageWidth(boolean setUsePageWidth)
```
    When set true tells the engine to put the entire page into a container with margins the same as the template document page width
    
    Parameters:
    
    setUsePageWidth - true=on false=off, on by default
  - getUseTemplatePageWidth
```
boolean getUseTemplatePageWidth()
```
    Returns:
    
    true if engine to puts entire page into a container with margins the same as the template document page width
  - isEmbedImages
```
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
    
    Returns:
    
    true if engine will embed images
  - setEmbedImages
```
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
    
    Parameters:
    
    setEmbedImages - true=embed images; false=separate images, on by default
  - isSplitPages
```
boolean isSplitPages()
```
    When set to true, tells the engine to split HTML output into multiple documents, one for each page of the document.
    
    Returns:
    
    true if engine will split pages into multiple documents
  - setSplitPages
```
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.
    
    Parameters:
    
    setSplitPages - true=split pages; false=produce one full document

Interface ProcessHtmlAPI

Field Summary

Fields inherited from interface net.windward.xmlreport.ProcessReportAPI

Method Summary

Methods inherited from interface net.windward.xmlreport.ProcessReportAPIBase

Field Detail

HTML_2

HTML_4_1

IE5

IE5_5

IE6

XHTML

CSS_NO

CSS_INCLUDE

CSS_SEPARATE

CSS_EXISTS

Method Detail

duplicate

getReportType

addImageName

addImageNames

setImagePath

getFilePath

getHtmlPath

getFilePrefix

getImageNames

setFullFile

isFullFile

setCss

getCssType

getCssFilename

getCssStream

setSpec

getSpec

setHeadersFooters

getHeadersFooters

setUseTemplatePageWidth

getUseTemplatePageWidth

isEmbedImages

setEmbedImages

isSplitPages

setSplitPages