Accessors for class IliHTMLReporter

Properties

• dataSourceName
• documentBackground
• documentCopyright
• documentTitle
• filename
• firstPagePictureName
• firstPageTitle
• model
• rowCount
• rowLocationName
• rowNumber
• tableOfContents
• tableOfContentsAtBeginning
• tableOfContentsColumnName
• tableOfContentsEntry
• tableOfContentsLocation
• tableOfContentsTitle

Methods

• getColumnName
• getColumnValue
• isColumnVisible
• report
• tagBar
• tagBeginBody
• tagBeginBold
• tagBeginCenter
• tagBeginCodeListing
• tagBeginFont
• tagBeginHead
• tagBeginHeader
• tagBeginHtml
• tagBeginItalic
• tagBeginList
• tagBeginListItem
• tagBeginListOrdered
• tagBeginStrong
• tagBeginTable
• tagBeginTableColumn
• tagBeginTableHeader
• tagBeginTableRow
• tagBeginUnderline
• tagDefineLocation
• tagEndBody
• tagEndBold
• tagEndCenter
• tagEndCodeListing
• tagEndFont
• tagEndHead
• tagEndHeader
• tagEndHtml
• tagEndItalic
• tagEndList
• tagEndListItem
• tagEndListOrdered
• tagEndStrong
• tagEndTable
• tagEndTableColumn
• tagEndTableHeader
• tagEndTableRow
• tagEndUnderline
• tagHeadTitle
• tagLinkToFile
• tagLinkToFileLocation
• tagLinkToLocation
• tagNewLine
• tagParagraph
• tagPicture
• tagSpace
• tagText
• tagTradeMark

Description

• Classic Table - The data is written into a table. The background is gray and the foreground is black.

• Table - The data is written into a table. The background is white and the foreground is blue.

• Classic Form - Each row of the data source is written into a form. The background is gray and the foreground is black.

• Form - Each row of the data source is written into a form. The background is white and the foreground is blue.

• If the model type is a classic table or a table, the calling order is the following:

reportBeginDocument

reportFirstPageHeading

reportFirstPageContents

reportFirstPageFooting

For documents with the table of contents at the beginning of the document:

reportTableHeading

reportTableTitle

reportTableBeginEntries

reportTableEntry is called for each entry of the table of contents

reportTableEndEntries

reportTableFooting

reportHeading

reportBeginRows

reportRowContent is called for each row of the data source

reportEndRows

reportFooting

For documents with the table of contents at the end of the document:

reportTableHeading

reportTableTitle

reportTableBeginEntries

reportTableEntry is called for each entry of the table of contents

reportTableEndEntries

reportTableFooting

reportLastPageHeading

reportLastPageContents

reportLastPageFooting

reportEndDocument

• If the model type is a classic form or a form, the calling order is the following:

reportBeginDocument

reportFirstPageHeading

reportFirstPageContents

reportFirstPageFooting

For documents with the table of contents at the beginning of the document:

reportTableHeading

reportTableTitle

reportTableBeginEntries

reportTableEntry is called for each entry of the table of contents

reportTableEndEntries

reportTableFooting

Calls for each row of the data source with the following functions:

reportHeading

reportBeginRows

reportRowContent

reportEndRows

reportFooting

For documents with the table of contents at the end of the document:

reportTableHeading

reportTableTitle

reportTableBeginEntries

reportTableEntry is called for each entry of the table of contents

reportTableEndEntries

reportTableFooting

reportLastPageHeading

reportLastPageContents

reportLastPageFooting

reportEndDocument

A column is not written if it is not visible. If you define the callback rowContent, you must call tagDefineLocation function within your row description to insert the row location (used by table of contents). The row location is provided by the rowLocationName property.

Type	Name	Description	Notes
Callback	dataSourceName	Contains the data source name.
Callback	documentBackground	Contains the document background.
Callback	documentCopyright	Contains the document copyright text.
Callback	documentTitle	Contains the document title.
Callback	filename	Contains the document file name.
Callback	firstPagePictureName	Contains the first-page picture file name.
Callback	firstPageTitle	Contains the first-page title.
Callback	model	Contains the document model.
Callback	rowCount	Contains the row count.
Callback	rowLocationName	Contains the row location name.
Callback	rowNumber	Contains the number of the current row.
Callback	tableOfContents	Contains true if the table of contents must be generated. In this case, the call to the tableOfContentsColumnName method is necessary.
Callback	tableOfContentsAtBeginning	Contains true if the table of contents must be inserted at the document beginning. Otherwise the table of contents is just before the last page.
Callback	tableOfContentsColumnName	Contains the column name used to generate the table of contents.
Callback	tableOfContentsEntry	Contains the table of contents entry text.
Callback	tableOfContentsLocation	Contains the table of contents entry location (it is an href).
Callback	tableOfContentsTitle	Contains the table of contents title.
String	getColumnName(Int colno)	Returns the column title if the title is defined; otherwise returns the column name.
String	getColumnValue(Int colno)	Returns the column value of the current row. If the column has a mapping, returns the mapped value.
IlvBoolean	isColumnVisible(Int colno)	Returns true if the column colno is visible.
void	report()	Creates the document.
void	tagBar(Int size)	Writes the HTML tag horizontal bar (<hr size=<size>>).
void	tagBeginBody(String color, String opt)	Writes the HTML tag delimiting the beginning of the visible document (<body bgcolor="color" opt>)
void	tagBeginBold()	Writes the HTML tag for begin bold (<b>).
void	tagBeginCenter()	Writes the HTML tag for begin center (<center>).
void	tagBeginCodeListing()	Writes the HTML tag for begin code listing (<pre>).
void	tagBeginFont(String opt)	Writes the HTML tag for begin font (<font opt>).
void	tagBeginHead()	Writes the HTML tag for begin head (<head>).
void	tagBeginHeader(Int size, IlvAlignment align)	Writes the HTML tag for begin headers, the most prominent header has the size at 1 and the least at 6. (<h<size> align=<align>>).
void	tagBeginHtml()	Writes the HTML tag for begin HTML document (<html>).
void	tagBeginItalic()	Writes the HTML tag for begin italic (<i>).
void	tagBeginList()	Writes the HTML tag for begin list (<ul>).
void	tagBeginListItem()	Writes the HTML tag for begin list item (<li>).
void	tagBeginListOrdered()	Writes the HTML tag for begin ordered list (<ol>).
void	tagBeginStrong()	Writes the HTML tag for begin strong (<strong>).
void	tagBeginTable(String opt)	Writes the HTML tag for begin table (<table opt>).
void	tagBeginTableColumn(String opt)	Writes the HTML tag for begin table column (<td opt>).
void	tagBeginTableHeader(String opt)	Writes the HTML tag for begin table header (<th opt>).
void	tagBeginTableRow(String opt)	Writes the HTML tag for begin table row (<tr opt>).
void	tagBeginUnderline()	Writes the HTML tag for begin underline (<u>).
void	tagDefineLocation(String location, String text)	Writes the HTML tag to define a location (<a name="location">text</a>).
void	tagEndBody()	Writes the HTML tag for end body (</body>).
void	tagEndBold()	Writes the HTML tag for end bold (</b>).
void	tagEndCenter()	Writes the HTML tag for end center (</center>).
void	tagEndCodeListing()	Writes the HTML tag for end code listing (</pre>).
void	tagEndFont()	Writes the HTML tag for end font (</font>).
void	tagEndHead()	Writes the HTML tag for end head (</head>).
void	tagEndHeader(Int size)	Writes the HTML tag for end headers, the most prominent header has the size at 1 and the least at 6 (</h<size>>).
void	tagEndHtml()	Writes the HTML tag for end HTML document (</html>).
void	tagEndItalic()	Writes the HTML tag for end italic (</i>).
void	tagEndList()	Writes the HTML tag for end list (</ul>).
void	tagEndListItem()	Writes the HTML tag for end list item (</li>).
void	tagEndListOrdered()	Writes the HTML tag for end ordered list (</ol>).
void	tagEndStrong()	Writes the HTML tag for end strong (</strong>).
void	tagEndTable()	Writes the HTML tag for end table (</table>).
void	tagEndTableColumn()	Writes the HTML tag for end table column (</td>).
void	tagEndTableHeader()	Writes the HTML tag for end table header (</th>).
void	tagEndTableRow()	Writes the HTML tag for end table row (</tr>).
void	tagEndUnderline()	Writes the HTML tag for end underline (</u>).
void	tagHeadTitle(String title)	Writes the HTML tag to define the document title (<title>title</title>).
void	tagLinkToFile(String file, String text)	Writes the HTML tag to define a link to a file (<a href="file">text</a>).
void	tagLinkToFileLocation(String file, String location, String text)	Writes the HTML tag to define a link to a location into a file (<a href="file#location">text</a>).
void	tagLinkToLocation(String location, String text)	Writes the HTML tag to define a link to a location (<a href="#location">text</a>).
void	tagNewLine(Int count)	Writes <count> times the HTML tag new line (<br>).
void	tagParagraph()	Writes the HTML tag new paragraph (<p>).
void	tagPicture(String filename, String opt)	Writes the HTML tag to insert a picture (<img src="filename">).
void	tagSpace()	Writes the HTML tag space (&nbsp;).
void	tagText(String text)	Writes text or HTML tags or both.
void	tagTradeMark()	Writes the HTML tag for a trade mark (&#174;).