Home Reference Source
public class | source

HtmlExporter

Extends:

TypedObjectExporter → HtmlExporter

Direct Subclass:

DocExporter, ExcelExporter

Exports the grid in HTML format

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

Method Summary

Public Methods
public

buildTh(grid: *): String: *

public

escapeHtml(val: *): String | XML

Escapes html characters to make valid html string

public
public

Returns the content type so the browser launches when the exporter is run.

public

Extension of the download file.

public

Name of the exporter

public

startDocument(grid: *)

public

uploadForEcho(body: *, exportOptions: *)

public

writeFooter(grid: *, dataProvider: *): String

Writes the footer in HTML format

public

writeHeader(grid: *): String: *

public

writeRecord(grid: IExtendedDataGrid, record: *): String

Builds the html representation of a header row.

Inherited Summary

From class TypedObject
public

typeCache: {}

public
public

Returns a list of strings that represent the object hierarchy for this object.

public

Returns true if the class name to check is in the list of class names defined for this class.

From class Exporter
public static

getColumnHeader(col: *, colIndex: *): *

Gets the header for the row

public

allRecords: *[]

public
public
public
public
public
public

Returns the content type so the appropriate application launches when the exporter is run.

public

Extension of the download file.

public

Name of the exporter

public

The current nest depth of the record being exported

public

The nest indent on basis of the nest depth

public

getSpaces(col: *, spChar: *): String

Depending on the level, gets indentation spaces

public

Checks whether this column should be exported

public

saveFile(body: *, fileName: *, exportOptions: *): *

Saves the file to disk, or sends it to a remote server to buffer back.

public

uploadForEcho(body: *, exportOptions: *)

Just in case in the client wants to customize the upload behavior of their exporters.

public

uploadToServer(body: *, exportOptions: *)

Not used

public

writeFooter(grid: *, dataProvider: *): String

Writes out the footer for the row

public

writeHeader(grid: *): String

Writes out the header for the row

public

writeRecord(grid: *, record: *): String

Writes out the record for the row

Public Constructors

public constructor() source

Override:

Exporter#constructor

Public Members

public index: number source

Public Methods

public buildTh(grid: *): String: * source

Params:

NameTypeAttributeDescription
grid *

Return:

String

public escapeHtml(val: *): String | XML source

Escapes html characters to make valid html string

Params:

NameTypeAttributeDescription
val *

Return:

String | XML

public getClassNames(): Array source

Returns a list of strings that represent the object hierarchy for this object.

Override:

Exporter#getClassNames

Return:

Array

public getContentType(): String source

Returns the content type so the browser launches when the exporter is run.

Override:

Exporter#getContentType

Return:

String

public getExtension(): String source

Extension of the download file.

Override:

Exporter#getExtension

Return:

String

public getName(): String source

Name of the exporter

Override:

Exporter#getName

Return:

String

public startDocument(grid: *) source

Params:

NameTypeAttributeDescription
grid *

public uploadForEcho(body: *, exportOptions: *) source

Just in case in the client wants to customize the upload behavior of their exporters.

Override:

Exporter#uploadForEcho

Params:

NameTypeAttributeDescription
body *
exportOptions *

public writeFooter(grid: *, dataProvider: *): String source

Writes the footer in HTML format

Override:

Exporter#writeFooter

Params:

NameTypeAttributeDescription
grid *
dataProvider *

Return:

String

public writeHeader(grid: *): String: * source

Writes out the header for the row

Override:

Exporter#writeHeader

Params:

NameTypeAttributeDescription
grid *

Return:

String

public writeRecord(grid: IExtendedDataGrid, record: *): String source

Builds the html representation of a header row.

Override:

Exporter#writeRecord

Params:

NameTypeAttributeDescription
grid IExtendedDataGrid
record *

Return:

String