Views
Data Access Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Static Public Member Functions
IliHTMLReporter Class Reference

Gadget class. More...

#include <ilviews/dataccess/gadgets/htmlrep.h>

Inheritance diagram for IliHTMLReporter:
IliDataGem IlvGadget IlvSimpleGraphic IlvStylable IlvGraphic IlvValueInterface

Public Member Functions

 IliHTMLReporter (IlvDisplay *display, const IlvPoint &at, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 This constructor creates an HTML reporter with a classic table model type. More...
 
virtual IlvBitmapgetBitmap () const
 Returns the bitmap that is displayed during the design phase in Rogue Wave Views Data Access. More...
 
const char * getColumnName (IlInt colno) const
 Returns a column title. More...
 
const char * getColumnValue (IlInt colno) const
 Returns the column value of the current row. More...
 
const char * getColumnValue (IliTableBuffer *buff, IlInt colno) const
 Returns a column value of one buffer. More...
 
IliDataSourcegetDataSource () const
 Returns the data source that will be used to create the document. More...
 
const char * getDataSourceName () const
 Return the data source name that will be used to create the document. More...
 
const char * getDocumentBackground () const
 Returns the document background color. More...
 
const char * getDocumentCopyright () const
 Returns the document copyright. More...
 
const char * getDocumentTitle () const
 Returns the document title. More...
 
const char * getFilename () const
 Returns the document file name. More...
 
const char * getFirstPagePictureName () const
 Returns the file name for the first page picture. More...
 
const char * getFirstPageTitle () const
 Returns the title for the first page. More...
 
const char * getModelName () const
 Returns the document model name. More...
 
IliHTMLModelName getPredefinedModel () const
 Returns the document model type. More...
 
IlInt getRowCount () const
 Returns the row count of the table. More...
 
const char * getRowLocationName () const
 Returns the row location name. More...
 
IlInt getRowNumber () const
 Returns the number of the current row. More...
 
std::ostream & getStream () const
 Returns the stream associated with the file. More...
 
const IliTablegetTable () const
 Returns the table used to create the document. More...
 
const IliTableBuffergetTableBuffer () const
 Returns the data of the current row. More...
 
const char * getTableOfContentsColumnName () const
 Returns the column name of the data source. More...
 
const char * getTableOfContentsEntry () const
 Returns the text for an entry of the table of contents. More...
 
const char * getTableOfContentsLocation () const
 Returns the table of contents entry location. More...
 
const char * getTableOfContentsTitle () const
 Returns the table of contents title. More...
 
IlBoolean hasTableOfContents () const
 Returns IlTrue if a table of contents will be created. More...
 
IlBoolean isColumnVisible (IlInt colno) const
 Returns IlTrue if a column is visible. More...
 
IlBoolean isTableOfContentsAtBeginning () const
 Returns IlTrue if the table of contents begins just after the first page. More...
 
void report ()
 Creates the document.
 
virtual void reportBeginDocument ()
 Called at the beginning of the document.
 
virtual void reportBeginRows ()
 Called just before the first row is created if the model is a table style. Otherwise, it is called just after each row is created.
 
virtual void reportEndDocument ()
 Called at the end of the document.
 
virtual void reportEndRows ()
 Called just after the last row is created if the model is a table style. Otherwise, it is called just after each row is created.
 
virtual void reportFirstPageContents ()
 Called to create the first page contents.
 
virtual void reportFirstPageFooting ()
 Called to create the first page footing.
 
virtual void reportFirstPageHeading ()
 Called to create the first page heading.
 
virtual void reportFooting ()
 Called to create the page footing.
 
virtual void reportHeading ()
 Called to create the page heading.
 
virtual void reportLastPageContents ()
 Called to create the contents of the last page.
 
virtual void reportLastPageFooting ()
 Called to create the last page footing.
 
virtual void reportLastPageHeading ()
 Called to create the last page heading.
 
virtual void reportRowContent ()
 Called to create the row contents.
 
virtual void reportTableBeginEntries ()
 Called just before the first entry is created.
 
virtual void reportTableEndEntries ()
 Called just after the last entry is created.
 
virtual void reportTableEntry ()
 Called to create an entry of the table of contents.
 
virtual void reportTableFooting ()
 Called to create the table of contents footing.
 
virtual void reportTableHeading ()
 Called to create the table of contents heading.
 
virtual void reportTableTitle ()
 Called to create the table of contents title.
 
void setDataSource (IliDataSource *ds)
 Sets the data source that will be used to create the document. More...
 
void setDataSourceName (const char *name)
 Sets the data source name that will be used to create the document. More...
 
void setDocumentBackground (const char *color)
 Sets the document background color. More...
 
void setDocumentCopyright (const char *cop)
 Sets the document copyright. More...
 
void setDocumentTitle (const char *title)
 Sets the document title. More...
 
void setFilename (const char *name)
 Sets the document file name. More...
 
void setFirstPagePictureName (const char *name)
 Sets the file name for the first page picture. More...
 
void setFirstPageTitle (const char *title)
 Sets the title for the first page. More...
 
void setModelName (const char *mod)
 Sets the document model name. More...
 
void setPredefinedModel (IliHTMLModelName mod)
 Sets the document model type. More...
 
void setTableOfContents (IlBoolean has)
 Indicates if the table of contents must be created. More...
 
void setTableOfContentsAtBeginning (IlBoolean beginning)
 Specifies the location of the table of contents. More...
 
void setTableOfContentsColumnName (const char *name)
 Sets the column name of the data source. More...
 
void setTableOfContentsTitle (const char *title)
 Sets the table of contents title. More...
 
void tagBar (IlInt size=2)
 Writes the HTML tag horizontal bar. More...
 
void tagBeginBody (const char *color=0, const char *opt=0)
 Writes the HTML tag to define the beginning of the visible document. More...
 
void tagBeginBold ()
 Writes the HTML tag for begin bold. More...
 
void tagBeginCenter ()
 Writes the HTML tag for begin center. More...
 
void tagBeginCodeListing ()
 Writes the HTML tag for begin code listing. More...
 
void tagBeginFont (const char *opt=0)
 Writes the HTML tag for begin font. More...
 
void tagBeginForm (const char *opt=0)
 Writes the HTML tag for begin form. More...
 
void tagBeginHead ()
 Writes the HTML tag for begin head. More...
 
void tagBeginHeader (IlInt size=2, IlvAlignment align=IlvLeft)
 Writes the HTML tag to begin the headers. More...
 
void tagBeginHtml ()
 Writes the HTML tag for begin HTML document. More...
 
void tagBeginItalic ()
 Writes the HTML tag for begin italic. More...
 
void tagBeginList ()
 Writes the HTML tag for begin list. More...
 
void tagBeginListItem ()
 Writes the HTML tag for begin list item. More...
 
void tagBeginListOrdered ()
 Writes the HTML tag for begin ordered list. More...
 
void tagBeginScript (const char *opt=0)
 Writes the HTML tag for begin script. More...
 
void tagBeginStrong ()
 Writes the HTML tag for begin strong. More...
 
void tagBeginTable (const char *opt=0)
 Writes the HTML tag for begin table. More...
 
void tagBeginTableColumn (const char *opt=0)
 Writes the HTML tag for begin table column. More...
 
void tagBeginTableHeader (const char *opt=0)
 Writes the HTML tag for begin table header. More...
 
void tagBeginTableRow (const char *opt=0)
 Writes the HTML tag for begin table row. More...
 
void tagBeginUnderline ()
 Writes the HTML tag for begin underline. More...
 
void tagDefineLocation (const char *loc, const char *text)
 Writes the HTML tag to define a location. More...
 
void tagEndBody ()
 Writes the HTML tag for end body. More...
 
void tagEndBold ()
 Writes the HTML tag for end bold. More...
 
void tagEndCenter ()
 Writes the HTML tag for end center. More...
 
void tagEndCodeListing ()
 Writes the HTML tag for end code listing. More...
 
void tagEndFont ()
 Writes the HTML tag for end font. More...
 
void tagEndHead ()
 Writes the HTML tag for end head. More...
 
void tagEndHeader (IlInt size=2)
 Writes the HTML tag to end headers. More...
 
void tagEndHtml ()
 Writes the HTML tag for end HTML document. More...
 
void tagEndItalic ()
 Writes the HTML tag for end italic. More...
 
void tagEndList ()
 Writes the HTML tag for end list. More...
 
void tagEndListItem ()
 Writes the HTML tag for end list item. More...
 
void tagEndListOrdered ()
 Writes the HTML tag for end ordered list. More...
 
void tagEndStrong ()
 Writes the HTML tag for end strong. More...
 
void tagEndTable ()
 Writes the HTML tag for end table. More...
 
void tagEndTableColumn ()
 Writes the HTML tag for end table column. More...
 
void tagEndTableHeader ()
 Writes the HTML tag for end table header. More...
 
void tagEndTableRow ()
 Writes the HTML tag for end table row. More...
 
void tagEndUnderline ()
 Writes the HTML tag for end underline. More...
 
void tagHeadTitle (const char *title)
 Writes the HTML tag to define the document title. More...
 
void tagLinkToFile (const char *file, const char *text)
 Writes the HTML tag to define a link to a file. More...
 
void tagLinkToFileLocation (const char *file, const char *loc, const char *txt)
 Writes the HTML tag to define a link to a location in a file. More...
 
void tagLinkToLocation (const char *link, const char *text)
 Writes the HTML tag to define a link to a location. More...
 
void tagNewLine (IlInt count=1)
 Writes several times the HTML tag new line. More...
 
void tagParagraph ()
 Writes the HTML tag new paragraph. More...
 
void tagPicture (const char *filename, const char *opt=0)
 Writes the HTML tag to insert a picture. More...
 
void tagSpace ()
 Writes the HTML tag for a space. More...
 
void tagText (const char *text)
 Writes text or HTML tags or both. More...
 
void tagTradeMark ()
 Writes the HTML tag for Trade Mark. More...
 
- Public Member Functions inherited from IliDataGem
IlBoolean hasGlobalScope () const
 Indicates the data source scope. More...
 
IlBoolean isSystemUsage () const
 Indicates the system usage flag. More...
 
virtual void setGlobalScope (IlBoolean global)
 Specifies whether the scope of the name of the data gem is local to the container in which it is located or globally visible. More...
 
virtual void usedBySystem (IlBoolean usage)
 Specifies if the object is a system object. More...
 

Static Public Member Functions

static IlvSymbolReportBeginDocumentSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportBeginRowsSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportEndDocumentSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportEndRowsSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportFirstPageContentsSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportFirstPageFootingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportFirstPageHeadingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportFootingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportHeadingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportLastPageContentsSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportLastPageFootingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportLastPageHeadingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportRowContentSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportTableBeginEntriesSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportTableEndEntriesSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportTableEntrySymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportTableFootingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportTableHeadingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 
static IlvSymbolReportTableTitleSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IliDataGem
 IliDataGem (IlvDisplay *display, const IlvPoint &at, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Initializes a new data gem. More...
 

Detailed Description

Gadget class.

Library: dbgadget

The IliHTMLReporter class defines a gadget that can be used to generate an HTML document containing the data of a data source. You can specify if you want a table of contents and if the table of contents is positioned after the first page of the document or before the last page of the document. There are four models of document:

Each part of the document is associated with a virtual function and a callback. The calling order depends on the type of document model:

Note
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.

About table of contents To create the table of contents, the HTML reporter uses the data of a data source column. For each row, there is a table of contents entry. The entry text is the content of the column for the row.

See also
IliDataGem, IliXML.

Accessors\nAccessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods <tt>IlvValueInterface::queryValue()</tt>, <tt>IlvValueInterface::queryValues()</tt>, <tt>IlvValueInterface::changeValue()</tt>, <tt>IlvValueInterface::changeValues()</tt>.\n\nThis class defines the following accessors:

Data accessors

Name Type Equivalent methods
dataSourceName String getDataSourceName(), setDataSourceName()
documentBackground String getDocumentBackground(), setDocumentBackground()
documentCopyright String getDocumentCopyright(), setDocumentCopyright()
documentTitle String getDocumentTitle(), setDocumentTitle()
filename String getFilename(), setFilename()
firstPagePictureName String getFirstPagePictureName(), setFirstPagePictureName()
firstPageTitle String getFirstPageTitle(), setFirstPageTitle()
model IliValueModelName getPredefinedModel(), setPredefinedModel()
rowCount Int getRowCount()
rowLocationName String getRowLocationName()
rowNumber Int getRowNumber()
tableOfContents Boolean hasTableOfContents(), setTableOfContents()
tableOfContentsAtBeginning Boolean isTableOfContentsAtBeginning(), setTableOfContentsAtBeginning()
tableOfContentsColumnName String getTableOfContentsColumnName(), setTableOfContentsColumnName()
tableOfContentsEntry String getTableOfContentsEntry()
tableOfContentsLocation String getTableOfContentsLocation()
tableOfContentsTitle String getTableOfContentsTitle(), setTableOfContentsTitle()

Method accessors

Name Return type Equivalent methods
getColumnName(Int col) String getColumnName(col)
getColumnValue(Int col) String getColumnValue(col) const
isColumnVisible(Int col) Boolean isColumnVisible(col) const
report() Void report()
tagBar(Int size) Void tagBar(size)
tagBeginBody(String color, String opt) Void tagBeginBody(color, opt)
tagBeginBold() Void tagBeginBold()
tagBeginCenter() Void tagBeginCenter()
tagBeginCodeListing() Void tagBeginCodeListing()
tagBeginFont(String opt) Void tagBeginFont(opt)
tagBeginHead() Void tagBeginHead()
tagBeginHeader(Int size, IlvAlignment align) Void tagBeginHeader(size, align)
tagBeginHtml() Void tagBeginHtml()
tagBeginItalic() Void tagBeginItalic()
tagBeginList() Void tagBeginList()
tagBeginListItem() Void tagBeginListItem()
tagBeginListOrdered() Void tagBeginListOrdered()
tagBeginStrong() Void tagBeginStrong()
tagBeginTable(String opt) Void tagBeginTable(opt)
tagBeginTableColumn(String opt) Void tagBeginTableColumn(opt)
tagBeginTableHeader(String opt) Void tagBeginTableHeader(opt)
tagBeginTableRow(String opt) Void tagBeginTableRow(opt)
tagBeginUnderline() Void tagBeginUnderline()
tagDefineLocation(String location, String text) Void tagDefineLocation(location, text)
tagEndBody() Void tagEndBody()
tagEndBold() Void tagEndBold()
tagEndCenter() Void tagEndCenter()
tagEndCodeListing() Void tagEndCodeListing()
tagEndFont() Void tagEndFont()
tagEndHead() Void tagEndHead()
tagEndHeader(Int size) Void tagEndHeader(size)
tagEndHtml() Void tagEndHtml()
tagEndItalic() Void tagEndItalic()
tagEndList() Void tagEndList()
tagEndListItem() Void tagEndListItem()
tagEndListOrdered() Void tagEndListOrdered()
tagEndStrong() Void tagEndStrong()
tagEndTable() Void tagEndTable()
tagEndTableColumn() Void tagEndTableColumn()
tagEndTableHeader() Void tagEndTableHeader()
tagEndTableRow() Void tagEndTableRow()
tagEndUnderline() Void tagEndUnderline()
tagHeadTitle(String title) Void tagHeadTitle(title)
tagLinkToFile(String file, String text) Void tagLinkToFile(file, text)
tagLinkToFileLocation(String file, String location, String text) Void tagLinkToFileLocation(file, location, text)
tagLinkToLocation(String location, String text) Void tagLinkToLocation(location, text)
tagNewLine(Int count) Void tagNewLine(count)
tagParagraph() Void tagParagraph()
tagPicture(String filename, String opt) Void tagPicture(filename, opt)
tagSpace() Void tagSpace()
tagText(String text) Void tagText(text)
tagTradeMark() Void tagTradeMark()

Constructor & Destructor Documentation

◆ IliHTMLReporter()

IliHTMLReporter::IliHTMLReporter ( IlvDisplay display,
const IlvPoint at,
IlUShort  thickness = IlvDefaultGadgetThickness,
IlvPalette palette = 0 
)

This constructor creates an HTML reporter with a classic table model type.

Parameters
displayThe display.
atThe position.
thicknessThe border thickness.
paletteThe palette.

Member Function Documentation

◆ getBitmap()

virtual IlvBitmap* IliHTMLReporter::getBitmap ( ) const
virtual

Returns the bitmap that is displayed during the design phase in Rogue Wave Views Data Access.

Returns
The bitmap.

Reimplemented from IliDataGem.

◆ getColumnName()

const char* IliHTMLReporter::getColumnName ( IlInt  colno) const

Returns a column title.

Parameters
colnoThe column position.
Returns
The column title if the title is defined. Otherwise, it returns the column name.

◆ getColumnValue() [1/2]

const char* IliHTMLReporter::getColumnValue ( IlInt  colno) const

Returns the column value of the current row.

Parameters
colnoThe column position.
Returns
The column value of the current row. If the column has a mapping, it returns the mapped value.

◆ getColumnValue() [2/2]

const char* IliHTMLReporter::getColumnValue ( IliTableBuffer buff,
IlInt  colno 
) const

Returns a column value of one buffer.

Returns
The column value of the buffer. If the column has a mapping, it returns the mapped value.

◆ getDataSource()

IliDataSource* IliHTMLReporter::getDataSource ( ) const

Returns the data source that will be used to create the document.

Returns
The data source.

◆ getDataSourceName()

const char* IliHTMLReporter::getDataSourceName ( ) const

Return the data source name that will be used to create the document.

Returns
The data source name.

◆ getDocumentBackground()

const char * IliHTMLReporter::getDocumentBackground ( ) const

Returns the document background color.

Returns
The color.

◆ getDocumentCopyright()

const char * IliHTMLReporter::getDocumentCopyright ( ) const

Returns the document copyright.

Returns
The copyright.

◆ getDocumentTitle()

const char * IliHTMLReporter::getDocumentTitle ( ) const

Returns the document title.

Returns
The title.

◆ getFilename()

const char* IliHTMLReporter::getFilename ( ) const

Returns the document file name.

Returns
The file name.

◆ getFirstPagePictureName()

const char * IliHTMLReporter::getFirstPagePictureName ( ) const

Returns the file name for the first page picture.

Returns
The file name.

◆ getFirstPageTitle()

const char * IliHTMLReporter::getFirstPageTitle ( ) const

Returns the title for the first page.

Returns
The title.

◆ getModelName()

const char* IliHTMLReporter::getModelName ( ) const

Returns the document model name.

Returns
The model name.

◆ getPredefinedModel()

IliHTMLModelName IliHTMLReporter::getPredefinedModel ( ) const

Returns the document model type.

Obsolete Function

Returns
The model name.

◆ getRowCount()

IlInt IliHTMLReporter::getRowCount ( ) const

Returns the row count of the table.

Returns
The count.

◆ getRowLocationName()

const char* IliHTMLReporter::getRowLocationName ( ) const

Returns the row location name.

The location name is used by the table of contents.

Returns
The row location name.

◆ getRowNumber()

IlInt IliHTMLReporter::getRowNumber ( ) const

Returns the number of the current row.

Returns
The row position.

◆ getStream()

std::ostream& IliHTMLReporter::getStream ( ) const

Returns the stream associated with the file.

The stream is valid only during the document creation.

Returns
The stream.

◆ getTable()

const IliTable* IliHTMLReporter::getTable ( ) const

Returns the table used to create the document.

The table is valid only during the document creation.

Returns
The table.

◆ getTableBuffer()

const IliTableBuffer* IliHTMLReporter::getTableBuffer ( ) const

Returns the data of the current row.

This buffer is valid only during the document creation.

Warning
You must not release this buffer and must not call the rowToBuffer function on this buffer.
Returns
The table buffer.

◆ getTableOfContentsColumnName()

const char * IliHTMLReporter::getTableOfContentsColumnName ( ) const

Returns the column name of the data source.

Returns
The column name.

◆ getTableOfContentsEntry()

const char* IliHTMLReporter::getTableOfContentsEntry ( ) const

Returns the text for an entry of the table of contents.

Returns
The text.

◆ getTableOfContentsLocation()

const char* IliHTMLReporter::getTableOfContentsLocation ( ) const

Returns the table of contents entry location.

The location name is used to create the HTML link between the table of contents and the information in the document.

Returns
The table of contents entry location.

◆ getTableOfContentsTitle()

const char * IliHTMLReporter::getTableOfContentsTitle ( ) const

Returns the table of contents title.

Returns
The title.

◆ hasTableOfContents()

IlBoolean IliHTMLReporter::hasTableOfContents ( ) const

Returns IlTrue if a table of contents will be created.

Returns
IlTrue if a table of contents will be created.

◆ isColumnVisible()

IlBoolean IliHTMLReporter::isColumnVisible ( IlInt  colno) const

Returns IlTrue if a column is visible.

Parameters
colnoThe column position.

◆ isTableOfContentsAtBeginning()

IlBoolean IliHTMLReporter::isTableOfContentsAtBeginning ( ) const

Returns IlTrue if the table of contents begins just after the first page.

Returns
IlTrue if the table of contents begins just after the first page.

◆ ReportBeginDocumentSymbol()

static IlvSymbol* IliHTMLReporter::ReportBeginDocumentSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportBeginRowsSymbol()

static IlvSymbol* IliHTMLReporter::ReportBeginRowsSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportEndDocumentSymbol()

static IlvSymbol* IliHTMLReporter::ReportEndDocumentSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportEndRowsSymbol()

static IlvSymbol* IliHTMLReporter::ReportEndRowsSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportFirstPageContentsSymbol()

static IlvSymbol* IliHTMLReporter::ReportFirstPageContentsSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportFirstPageFootingSymbol()

static IlvSymbol* IliHTMLReporter::ReportFirstPageFootingSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportFirstPageHeadingSymbol()

static IlvSymbol* IliHTMLReporter::ReportFirstPageHeadingSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportFootingSymbol()

static IlvSymbol* IliHTMLReporter::ReportFootingSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportHeadingSymbol()

static IlvSymbol* IliHTMLReporter::ReportHeadingSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportLastPageContentsSymbol()

static IlvSymbol* IliHTMLReporter::ReportLastPageContentsSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportLastPageFootingSymbol()

static IlvSymbol* IliHTMLReporter::ReportLastPageFootingSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportLastPageHeadingSymbol()

static IlvSymbol* IliHTMLReporter::ReportLastPageHeadingSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportRowContentSymbol()

static IlvSymbol* IliHTMLReporter::ReportRowContentSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportTableBeginEntriesSymbol()

static IlvSymbol* IliHTMLReporter::ReportTableBeginEntriesSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportTableEndEntriesSymbol()

static IlvSymbol* IliHTMLReporter::ReportTableEndEntriesSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportTableEntrySymbol()

static IlvSymbol* IliHTMLReporter::ReportTableEntrySymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportTableFootingSymbol()

static IlvSymbol* IliHTMLReporter::ReportTableFootingSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportTableHeadingSymbol()

static IlvSymbol* IliHTMLReporter::ReportTableHeadingSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ ReportTableTitleSymbol()

static IlvSymbol* IliHTMLReporter::ReportTableTitleSymbol ( )
static

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns
The callback name.

◆ setDataSource()

void IliHTMLReporter::setDataSource ( IliDataSource ds)

Sets the data source that will be used to create the document.

Parameters
dsThe data source.

◆ setDataSourceName()

void IliHTMLReporter::setDataSourceName ( const char *  name)

Sets the data source name that will be used to create the document.

Parameters
nameThe data source name.

◆ setDocumentBackground()

void IliHTMLReporter::setDocumentBackground ( const char *  color)

Sets the document background color.

The format of the color is #rrggbb. (For more information, see your HTML documentation.)

Parameters
colorThe color.

◆ setDocumentCopyright()

void IliHTMLReporter::setDocumentCopyright ( const char *  cop)

Sets the document copyright.

Parameters
copThe copyright.

◆ setDocumentTitle()

void IliHTMLReporter::setDocumentTitle ( const char *  title)

Sets the document title.

Parameters
titleThe title.

◆ setFilename()

void IliHTMLReporter::setFilename ( const char *  name)

Sets the document file name.

Parameters
nameThe file name.

◆ setFirstPagePictureName()

void IliHTMLReporter::setFirstPagePictureName ( const char *  name)

Sets the file name for the first page picture.

Parameters
nameThe picture file name.

◆ setFirstPageTitle()

void IliHTMLReporter::setFirstPageTitle ( const char *  title)

Sets the title for the first page.

Parameters
titleThe title.

◆ setModelName()

void IliHTMLReporter::setModelName ( const char *  mod)

Sets the document model name.

Parameters
modThe model name. The predefined models are:
  • IliHTMLModelTableClassic
  • IliHTMLModelFormClassic
  • IliHTMLModelTable
  • IliHTMLModelForm
  • IliHTMLModelFormDynamic

◆ setPredefinedModel()

void IliHTMLReporter::setPredefinedModel ( IliHTMLModelName  mod)

Sets the document model type.

Obsolete Function

Parameters
modThe model name.

◆ setTableOfContents()

void IliHTMLReporter::setTableOfContents ( IlBoolean  has)

Indicates if the table of contents must be created.

The default value is IlFalse.

Parameters
hasIf IlTrue, the table of contents is created. In this case, a call to the setTableOfContentsColumnName method is required.

◆ setTableOfContentsAtBeginning()

void IliHTMLReporter::setTableOfContentsAtBeginning ( IlBoolean  beginning)

Specifies the location of the table of contents.

The default value is IlTrue.

Parameters
beginningIf IlTrue, the table of contents should begin just after the first page. Otherwise, the table of contents begins just before the last page.

◆ setTableOfContentsColumnName()

void IliHTMLReporter::setTableOfContentsColumnName ( const char *  name)

Sets the column name of the data source.

Parameters
nameThe column name.

◆ setTableOfContentsTitle()

void IliHTMLReporter::setTableOfContentsTitle ( const char *  title)

Sets the table of contents title.

The default value is "<tt>Table of contents</tt>".

Parameters
titleThe title.

◆ tagBar()

void IliHTMLReporter::tagBar ( IlInt  size = 2)

Writes the HTML tag horizontal bar.

HTML: <hr size=<size>>
Parameters
sizeThe bar size.

◆ tagBeginBody()

void IliHTMLReporter::tagBeginBody ( const char *  color = 0,
const char *  opt = 0 
)

Writes the HTML tag to define the beginning of the visible document.

HTML: <body bgcolor="color" opt>
Parameters
colorThe color.
optThe options (see HTML documentation).

◆ tagBeginBold()

void IliHTMLReporter::tagBeginBold ( )

Writes the HTML tag for begin bold.

HTML: <b>

◆ tagBeginCenter()

void IliHTMLReporter::tagBeginCenter ( )

Writes the HTML tag for begin center.

HTML: <center>

◆ tagBeginCodeListing()

void IliHTMLReporter::tagBeginCodeListing ( )

Writes the HTML tag for begin code listing.

HTML: <pre>

◆ tagBeginFont()

void IliHTMLReporter::tagBeginFont ( const char *  opt = 0)

Writes the HTML tag for begin font.

HTML: <font opt>
Parameters
optThe options (see HTML documentation).

◆ tagBeginForm()

void IliHTMLReporter::tagBeginForm ( const char *  opt = 0)

Writes the HTML tag for begin form.

HTML: <form opt>
Parameters
optThe options (see HTML documentation).

◆ tagBeginHead()

void IliHTMLReporter::tagBeginHead ( )

Writes the HTML tag for begin head.

HTML: <head>

◆ tagBeginHeader()

void IliHTMLReporter::tagBeginHeader ( IlInt  size = 2,
IlvAlignment  align = IlvLeft 
)

Writes the HTML tag to begin the headers.

The most prominent header has the size set to 1 and the least prominent header has the size set to 6.

HTML: <h<size> align=<align>>
Parameters
sizeThe size (from 1 to 6).
alignThe alignment.

◆ tagBeginHtml()

void IliHTMLReporter::tagBeginHtml ( )

Writes the HTML tag for begin HTML document.

HTML: <html>

◆ tagBeginItalic()

void IliHTMLReporter::tagBeginItalic ( )

Writes the HTML tag for begin italic.

HTML: <i>

◆ tagBeginList()

void IliHTMLReporter::tagBeginList ( )

Writes the HTML tag for begin list.

HTML: <ul>

◆ tagBeginListItem()

void IliHTMLReporter::tagBeginListItem ( )

Writes the HTML tag for begin list item.

HTML: <li>

◆ tagBeginListOrdered()

void IliHTMLReporter::tagBeginListOrdered ( )

Writes the HTML tag for begin ordered list.

HTML: <ol>

◆ tagBeginScript()

void IliHTMLReporter::tagBeginScript ( const char *  opt = 0)

Writes the HTML tag for begin script.

HTML: <script opt>
Parameters
optThe options (see HTML documentation).

◆ tagBeginStrong()

void IliHTMLReporter::tagBeginStrong ( )

Writes the HTML tag for begin strong.

HTML: <strong>

◆ tagBeginTable()

void IliHTMLReporter::tagBeginTable ( const char *  opt = 0)

Writes the HTML tag for begin table.

HTML: <table opt>
Parameters
optThe options (see HTML documentation).

◆ tagBeginTableColumn()

void IliHTMLReporter::tagBeginTableColumn ( const char *  opt = 0)

Writes the HTML tag for begin table column.

HTML: <td opt>
Parameters
optThe options (see HTML documentation).

◆ tagBeginTableHeader()

void IliHTMLReporter::tagBeginTableHeader ( const char *  opt = 0)

Writes the HTML tag for begin table header.

HTML: <th opt>
Parameters
optThe options (see HTML documentation).

◆ tagBeginTableRow()

void IliHTMLReporter::tagBeginTableRow ( const char *  opt = 0)

Writes the HTML tag for begin table row.

HTML: <tr opt>
Parameters
optThe options (see HTML documentation).

◆ tagBeginUnderline()

void IliHTMLReporter::tagBeginUnderline ( )

Writes the HTML tag for begin underline.

HTML: <u>

◆ tagDefineLocation()

void IliHTMLReporter::tagDefineLocation ( const char *  loc,
const char *  text 
)

Writes the HTML tag to define a location.

HTML: <a name="location">text</a>
Parameters
locThe location.
textThe text.

◆ tagEndBody()

void IliHTMLReporter::tagEndBody ( )

Writes the HTML tag for end body.

HTML: </body>

◆ tagEndBold()

void IliHTMLReporter::tagEndBold ( )

Writes the HTML tag for end bold.

HTML: </b>

◆ tagEndCenter()

void IliHTMLReporter::tagEndCenter ( )

Writes the HTML tag for end center.

HTML: </center>

◆ tagEndCodeListing()

void IliHTMLReporter::tagEndCodeListing ( )

Writes the HTML tag for end code listing.

HTML: &lt;/pre&gt;

◆ tagEndFont()

void IliHTMLReporter::tagEndFont ( )

Writes the HTML tag for end font.

HTML: </font>

◆ tagEndHead()

void IliHTMLReporter::tagEndHead ( )

Writes the HTML tag for end head.

HTML: </head>

◆ tagEndHeader()

void IliHTMLReporter::tagEndHeader ( IlInt  size = 2)

Writes the HTML tag to end headers.

The most prominent header has the size set to 1 and the least prominent header has the size set to 6.

HTML: </h<size>>
Parameters
sizeThe size (from 1 to 6).

◆ tagEndHtml()

void IliHTMLReporter::tagEndHtml ( )

Writes the HTML tag for end HTML document.

HTML: </html>

◆ tagEndItalic()

void IliHTMLReporter::tagEndItalic ( )

Writes the HTML tag for end italic.

HTML: </i>

◆ tagEndList()

void IliHTMLReporter::tagEndList ( )

Writes the HTML tag for end list.

HTML: </ul>

◆ tagEndListItem()

void IliHTMLReporter::tagEndListItem ( )

Writes the HTML tag for end list item.

HTML: </li>

◆ tagEndListOrdered()

void IliHTMLReporter::tagEndListOrdered ( )

Writes the HTML tag for end ordered list.

HTML: </ol>

◆ tagEndStrong()

void IliHTMLReporter::tagEndStrong ( )

Writes the HTML tag for end strong.

HTML: </strong>

◆ tagEndTable()

void IliHTMLReporter::tagEndTable ( )

Writes the HTML tag for end table.

HTML: </table>

◆ tagEndTableColumn()

void IliHTMLReporter::tagEndTableColumn ( )

Writes the HTML tag for end table column.

HTML: </td>

◆ tagEndTableHeader()

void IliHTMLReporter::tagEndTableHeader ( )

Writes the HTML tag for end table header.

HTML: </th>

◆ tagEndTableRow()

void IliHTMLReporter::tagEndTableRow ( )

Writes the HTML tag for end table row.

HTML: </tr>

◆ tagEndUnderline()

void IliHTMLReporter::tagEndUnderline ( )

Writes the HTML tag for end underline.

HTML: </u>

◆ tagHeadTitle()

void IliHTMLReporter::tagHeadTitle ( const char *  title)

Writes the HTML tag to define the document title.

HTML: <title>title</title>
Parameters
titleThe title.

◆ tagLinkToFile()

void IliHTMLReporter::tagLinkToFile ( const char *  file,
const char *  text 
)

Writes the HTML tag to define a link to a file.

HTML: <a href="file">text</a>
Parameters
fileThe file name.
textThe text.

◆ tagLinkToFileLocation()

void IliHTMLReporter::tagLinkToFileLocation ( const char *  file,
const char *  loc,
const char *  txt 
)

Writes the HTML tag to define a link to a location in a file.

HTML: <a href="file#location">text</a>
Parameters
fileThe file name.
locThe location.
txtThe text.

◆ tagLinkToLocation()

void IliHTMLReporter::tagLinkToLocation ( const char *  link,
const char *  text 
)

Writes the HTML tag to define a link to a location.

HTML: <a href="#location">text</a>
Parameters
linkThe link.
textThe text.

◆ tagNewLine()

void IliHTMLReporter::tagNewLine ( IlInt  count = 1)

Writes several times the HTML tag new line.

HTML: <br>
Parameters
countThe number of times.

◆ tagParagraph()

void IliHTMLReporter::tagParagraph ( )

Writes the HTML tag new paragraph.

HTML: <p>

◆ tagPicture()

void IliHTMLReporter::tagPicture ( const char *  filename,
const char *  opt = 0 
)

Writes the HTML tag to insert a picture.

HTML: <img src="filename">
Parameters
filenameThe file name.
optThe options (see HTML documentation).

◆ tagSpace()

void IliHTMLReporter::tagSpace ( )

Writes the HTML tag for a space.

HTML: &nbsp;

◆ tagText()

void IliHTMLReporter::tagText ( const char *  text)

Writes text or HTML tags or both.

Parameters
textThe text.

◆ tagTradeMark()

void IliHTMLReporter::tagTradeMark ( )

Writes the HTML tag for Trade Mark.

HTML: &#174;