class sap.ui.core.util.ExportType

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/core/util/ExportType
Application Component: CA-UI5-TBL

Base export type. Subclasses can be used for Export.


Constructor

Constructor for a new ExportType.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.core.util.ExportType(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
byteOrderMark boolean undefined

Whether to prepend an unicode byte order mark when saving as a file (only applies for utf-8 charset).

Visibility: public
charset string

Charset.

Visibility: public
fileExtension string

File extension.

Visibility: public
mimeType string

MIME type.

Visibility: public

Methods Overview

Method Description
_generate

Handles the generation process of the file.

cellGenerator

Creates a cell "generator" (inspired by ES6 Generators)

columnGenerator

Creates a column "generator" (inspired by ES6 Generators)

sap.ui.core.util.ExportType.extend

Creates a new subclass of class sap.ui.core.util.ExportType with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.ManagedObject.extend.

generate

Generates the file content.
Should be implemented by the individual types!

getByteOrderMark

Gets current value of property byteOrderMark.

Whether to prepend an unicode byte order mark when saving as a file (only applies for utf-8 charset).

Default value is undefined.

getCharset

Gets current value of property charset.

Charset.

getColumnCount

Returns the number of columns.

getFileExtension

Gets current value of property fileExtension.

File extension.

sap.ui.core.util.ExportType.getMetadata

Returns a metadata object for class sap.ui.core.util.ExportType.

getMimeType

Gets current value of property mimeType.

MIME type.

getRowCount

Returns the number of rows.

rowGenerator

Creates a row "generator" (inspired by ES6 Generators)

setByteOrderMark

Sets a new value for property byteOrderMark.

Whether to prepend an unicode byte order mark when saving as a file (only applies for utf-8 charset).

When called with a value of null or undefined, the default value of the property will be restored.

Default value is undefined.

setCharset

Sets a new value for property charset.

Charset.

When called with a value of null or undefined, the default value of the property will be restored.

setFileExtension

Sets a new value for property fileExtension.

File extension.

When called with a value of null or undefined, the default value of the property will be restored.

setMimeType

Sets a new value for property mimeType.

MIME type.

When called with a value of null or undefined, the default value of the property will be restored.

_generate

Handles the generation process of the file.

Param Type DefaultValue Description
oExport sap.ui.core.util.Export

export instance

cellGenerator

Creates a cell "generator" (inspired by ES6 Generators)

columnGenerator

Creates a column "generator" (inspired by ES6 Generators)

sap.ui.core.util.ExportType.extend

Creates a new subclass of class sap.ui.core.util.ExportType with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.ManagedObject.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

generate

Generates the file content.
Should be implemented by the individual types!

getByteOrderMark

Gets current value of property byteOrderMark.

Whether to prepend an unicode byte order mark when saving as a file (only applies for utf-8 charset).

Default value is undefined.

getCharset

Gets current value of property charset.

Charset.

getColumnCount

Returns the number of columns.

getFileExtension

Gets current value of property fileExtension.

File extension.

sap.ui.core.util.ExportType.getMetadata

Returns a metadata object for class sap.ui.core.util.ExportType.

getMimeType

Gets current value of property mimeType.

MIME type.

getRowCount

Returns the number of rows.

rowGenerator

Creates a row "generator" (inspired by ES6 Generators)

setByteOrderMark

Sets a new value for property byteOrderMark.

Whether to prepend an unicode byte order mark when saving as a file (only applies for utf-8 charset).

When called with a value of null or undefined, the default value of the property will be restored.

Default value is undefined.

Param Type DefaultValue Description
bByteOrderMark boolean

New value for property byteOrderMark

setCharset

Sets a new value for property charset.

Charset.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sCharset string

New value for property charset

setFileExtension

Sets a new value for property fileExtension.

File extension.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sFileExtension string

New value for property fileExtension

setMimeType

Sets a new value for property mimeType.

MIME type.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sMimeType string

New value for property mimeType