SAP ABAP Interface IF_SALV_BS_LEX_FORMAT (ALV Lean Export - Format Interface)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-CMP-ALV-ABA (Application Component) Web Dynpro ALV for ABAP
     ⤷ SALV_BS_LEX (Package) Contains general Classes/Interfaces of ALV Lean Export

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SALV_BS_LEX_FORMAT_CSV	ALV Lean Export - Format CSV	20101007
2	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SALV_BS_LEX_FORMAT_MHTML	ALV Lean Export - Format MHTML	20100928
3	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SALV_BS_LEX_FORMAT_ODS	ALV Lean Export - Format Open Office Spreadsheet	20101007
4	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SALV_BS_LEX_FORMAT_XLSX	ALV Lean Export - Format Excel 2007 (XLSX)	20101004

Properties

Interface	IF_SALV_BS_LEX_FORMAT
Short Description	ALV Lean Export - Format Interface

General Data

Package	SALV_BS_LEX	Contains general Classes/Interfaces of ALV Lean Export
Created	20100924	SAP
Last changed	20110908	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	CL_SALV_BS_LEX_SUPPORT	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Interface IF_SALV_BS_LEX_FORMAT has no interface.

Friends

Interface IF_SALV_BS_LEX_FORMAT has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MC_CELL_EDITOR_DATE	Constant	Public	☐	Type reference (TYPE)	YS_CELL_EDITOR_TYPE	'D'	Spreadsheet Editor with Date Format	20100924
2	MC_CELL_EDITOR_IMAGE	Constant	Public	☐	Type reference (TYPE)	YS_CELL_EDITOR_TYPE	'I'	Spreadsheet Editor with Image Format	20100924
3	MC_CELL_EDITOR_NUMBER	Constant	Public	☐	Type reference (TYPE)	YS_CELL_EDITOR_TYPE	'N'	Spreadsheet Editor with Number Format	20100924
4	MC_CELL_EDITOR_TEXT	Constant	Public	☐	Type reference (TYPE)	YS_CELL_EDITOR_TYPE	'T'	Spreadsheet Editor with Text Format	20100924
5	MC_CELL_EDITOR_TIME	Constant	Public	☐	Type reference (TYPE)	YS_CELL_EDITOR_TYPE	'Z'	Spreadsheet Editor with Time Format	20100924
6	MC_FORMAT_CSV	Constant	Public	☐	Type reference (TYPE)	YS_FORMAT	'csv'	CSV Format	20101018
7	MC_FORMAT_MHTML	Constant	Public	☐	Type reference (TYPE)	YS_FORMAT	'mhtml'	MS MHTML Format	20101018
8	MC_FORMAT_ODS	Constant	Public	☐	Type reference (TYPE)	YS_FORMAT	'ods'	Open Document Spreadsheet Format	20101018
9	MC_FORMAT_XLSX	Constant	Public	☐	Type reference (TYPE)	YS_FORMAT	'xlsx'	MS Excel 2007 Format	20101018
10	MC_ROW_TYPE_DATA	Constant	Public	☐	Type reference (TYPE)	YS_ROW_TYPE	'D'		20101021
11	MC_ROW_TYPE_HEADER	Constant	Public	☐	Type reference (TYPE)	YS_ROW_TYPE	'H'		20101021
12	MC_ROW_TYPE_SUBTOTAL	Constant	Public	☐	Type reference (TYPE)	YS_ROW_TYPE	'S'		20101021
13	MC_ROW_TYPE_TOTAL	Constant	Public	☐	Type reference (TYPE)	YS_ROW_TYPE	'T'		20101021
14	MR_SUPPORT	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_SALV_BS_LEX_SUPPORT		Support class for ALV Lean Export	20100930

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_FILE_EXTENSION	Instance method	Public	Method	Returns the File Extension of the Format	20100929
2	GET_MIME_TYPE	Instance method	Public	Method	Returns the MIME Type of the Format	20100929
3	ON_AFTER_CREATE_DATA_ROW	Instance method	Public	Method	Called after a data row was rendered.	20100924
4	ON_AFTER_CREATE_HEADER_ROW	Instance method	Public	Method	Called after the header row was rendered.	20100924
5	ON_AFTER_CREATE_HIER_ROW	Instance method	Public	Method	Called after a hierarchy row was rendered.	20100924
6	ON_AFTER_CREATE_ROWS	Instance method	Public	Method	Called after all data rows were rendered.	20100924
7	ON_AFTER_CREATE_TOTAL_ROW	Instance method	Public	Method	Called after a total/subtotal row was rendered.	20100924
8	ON_AFTER_EXPORT	Instance method	Public	Method	Very last entry point. Happens before the file is returned.	20100924
9	ON_BEFORE_CREATE_DATA_ROW	Instance method	Public	Method	Called before a data row is getting rendered.	20100924
10	ON_BEFORE_CREATE_HEADER_ROW	Instance method	Public	Method	Called before the header row is getting rendered.	20100924
11	ON_BEFORE_CREATE_HIER_ROW	Instance method	Public	Method	Called before a hierarchy row is getting rendered.	20100924
12	ON_BEFORE_CREATE_ROWS	Instance method	Public	Method	Called before any rows are rendered.Header row already done.	20100924
13	ON_BEFORE_CREATE_TOTAL_ROW	Instance method	Public	Method	Called before a total row is getting rendered.	20100924
14	ON_BEFORE_EXPORT	Instance method	Public	Method	Very first entry point.	20100924
15	ON_CREATE_DATA_CELL	Instance method	Public	Method	Called when a data cell gets rendered.	20100924
16	ON_CREATE_HEADER_CELL	Instance method	Public	Method	Called when a header cell gets rendered.	20100924
17	ON_CREATE_HIER_CELL	Instance method	Public	Method	Called when a hierarchy cell gets rendered.	20100924
18	ON_CREATE_TOTAL_CELL	Instance method	Public	Method	Called when a total/subtotal cell gets rendered.	20100924
19	SET_SUPPORT	Instance method	Public	Method	Sets the Support Object	20100930

Events

Interface IF_SALV_BS_LEX_FORMAT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	YS_ATTRIBUTEINFO	Public	See coding			20100924	begin of ys_attributeinfo, is_keyf type abap_bool, inttype type inttype, convexit type convexit, end of ys_attributeinfo
2	YS_CELL_EDITOR_TYPE	Public	See coding			20100924	YS_CELL_EDITOR_TYPE type C length 1
3	YS_COLUMNINFO	Public	See coding			20100924	begin of ys_columninfo, columnid type string, field type string, width type i, colpos_number type i, colpos_alpha type string, is_hier_column type abap_bool, end of ys_columninfo
4	YS_FORMAT	Public	See coding			20101018	ys_format type C length 5
5	YS_ROW_TYPE	Public	See coding			20101021	ys_row_type type C length 1

Method Signatures

Method GET_FILE_EXTENSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_FILE_EXTENSION	Value transfer	☐	Type reference (TYPE)	STRING			20100929

Method GET_FILE_EXTENSION on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method GET_MIME_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_MIME_TYPE	Value transfer	☐	Type reference (TYPE)	STRING			20100929

Method GET_MIME_TYPE on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_AFTER_CREATE_DATA_ROW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_HIDDEN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100924
2	Importing	IS_LEVEL	Call by reference	☐	Type reference (TYPE)	I			20100924
3	Importing	IS_ROW_INDEX	Call by reference	☐	Type reference (TYPE)	I			20100924

Method ON_AFTER_CREATE_DATA_ROW on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_AFTER_CREATE_HEADER_ROW Signature

Method ON_AFTER_CREATE_HEADER_ROW on Interface IF_SALV_BS_LEX_FORMAT has no parameter.
Method ON_AFTER_CREATE_HEADER_ROW on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_AFTER_CREATE_HIER_ROW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_HIDDEN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100924
2	Importing	IS_LEVEL	Call by reference	☐	Type reference (TYPE)	I			20100924
3	Importing	IS_ROW_INDEX	Call by reference	☐	Type reference (TYPE)	I			20100924

Method ON_AFTER_CREATE_HIER_ROW on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_AFTER_CREATE_ROWS Signature

Method ON_AFTER_CREATE_ROWS on Interface IF_SALV_BS_LEX_FORMAT has no parameter.
Method ON_AFTER_CREATE_ROWS on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_AFTER_CREATE_TOTAL_ROW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_HIDDEN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100924
2	Importing	IS_LEVEL	Call by reference	☐	Type reference (TYPE)	I			20100924
3	Importing	IS_ROW_INDEX	Call by reference	☐	Type reference (TYPE)	I			20100924

Method ON_AFTER_CREATE_TOTAL_ROW on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_AFTER_EXPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_RESULT_XSTRING	Call by reference	☐	Object reference (TYPE REF TO)	XSTRING			20101018
2	Exporting	ET_EXPORT_ERRORS	Call by reference	☐	Type reference (TYPE)	CL_SALV_BS_LEX_SUPPORT=>YT_EXPORT_ERROR			20101018
3	Importing	IR_SUPPORT	Call by reference	☐	Object reference (TYPE REF TO)	CL_SALV_BS_LEX_SUPPORT		Support class for ALV Lean Export	20100928

Method ON_AFTER_EXPORT on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_BEFORE_CREATE_DATA_ROW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_HIDDEN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100924
2	Importing	IS_LEVEL	Call by reference	☐	Type reference (TYPE)	I			20100924
3	Importing	IS_ROW_INDEX	Call by reference	☐	Type reference (TYPE)	I			20100924

Method ON_BEFORE_CREATE_DATA_ROW on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_BEFORE_CREATE_HEADER_ROW Signature

Method ON_BEFORE_CREATE_HEADER_ROW on Interface IF_SALV_BS_LEX_FORMAT has no parameter.
Method ON_BEFORE_CREATE_HEADER_ROW on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_BEFORE_CREATE_HIER_ROW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_HIDDEN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100924
2	Importing	IS_LEVEL	Call by reference	☐	Type reference (TYPE)	I			20100924
3	Importing	IS_ROW_INDEX	Call by reference	☐	Type reference (TYPE)	I			20100924

Method ON_BEFORE_CREATE_HIER_ROW on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_BEFORE_CREATE_ROWS Signature

Method ON_BEFORE_CREATE_ROWS on Interface IF_SALV_BS_LEX_FORMAT has no parameter.
Method ON_BEFORE_CREATE_ROWS on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_BEFORE_CREATE_TOTAL_ROW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_HIDDEN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100924
2	Importing	IS_LEVEL	Call by reference	☐	Type reference (TYPE)	I			20100924
3	Importing	IS_ROW_INDEX	Call by reference	☐	Type reference (TYPE)	I			20100924

Method ON_BEFORE_CREATE_TOTAL_ROW on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_BEFORE_EXPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_HIERARCHY_MODE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Do we have a Hierarchy?	20101020
2	Importing	IS_IMAGES_EXIST	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Do we have Images?	20101020
3	Importing	IS_SUMMARY_ROWS_BELOW_DETAILS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Do we want to have Aggregation Rows below Data Rows?	20101020

Method ON_BEFORE_EXPORT on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_CREATE_DATA_CELL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_COLUMNINFO	Call by reference	☑	Object reference (TYPE REF TO)	YS_COLUMNINFO			20101015
2	Importing	IR_EXTERNAL_VALUE	Call by reference	☐	Object reference (TYPE REF TO)	STRING			20101015
3	Importing	IR_HYPERLINK	Call by reference	☑	Object reference (TYPE REF TO)	STRING			20101015
4	Importing	IR_IMAGE_DATA	Call by reference	☐	Object reference (TYPE REF TO)	CL_SALV_BS_LEX_SUPPORT=>YS_IMAGE_DATA			20101015
5	Importing	IR_IMAGE_PATH	Call by reference	☑	Object reference (TYPE REF TO)	STRING			20101015
6	Importing	IR_INTERNAL_VALUE	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20101015
7	Importing	IS_CELL_EDITOR_TYPE	Call by reference	☐	Type reference (TYPE)	YS_CELL_EDITOR_TYPE			20100924
8	Importing	IS_DECIMALS	Call by reference	☑	Type reference (TYPE)	I			20100924
9	Importing	IS_HIDDEN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100924
10	Importing	IS_LEVEL	Call by reference	☐	Type reference (TYPE)	I			20100924
11	Importing	IS_ROW_INDEX	Call by reference	☐	Type reference (TYPE)	I			20100924

Method ON_CREATE_DATA_CELL on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_CREATE_HEADER_CELL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_COLUMNINFO	Call by reference	☐	Object reference (TYPE REF TO)	YS_COLUMNINFO			20101014
2	Importing	IS_COLUMN_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20101014

Method ON_CREATE_HEADER_CELL on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_CREATE_HIER_CELL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_COLUMNINFO	Call by reference	☐	Object reference (TYPE REF TO)	YS_COLUMNINFO			20101014
2	Importing	IR_EXTERNAL_VALUE	Call by reference	☐	Object reference (TYPE REF TO)	STRING			20101014
3	Importing	IR_HYPERLINK	Call by reference	☐	Object reference (TYPE REF TO)	STRING			20101019
4	Importing	IR_IMAGE_DATA	Call by reference	☐	Object reference (TYPE REF TO)	CL_SALV_BS_LEX_SUPPORT=>YS_IMAGE_DATA			20101019
5	Importing	IR_IMAGE_PATH	Call by reference	☐	Object reference (TYPE REF TO)	STRING			20101019
6	Importing	IS_CELL_EDITOR_TYPE	Call by reference	☐	Type reference (TYPE)	YS_CELL_EDITOR_TYPE			20100924
7	Importing	IS_DECIMALS	Call by reference	☐	Type reference (TYPE)	I			20100924
8	Importing	IS_HIDDEN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100924
9	Importing	IS_LEVEL	Call by reference	☐	Type reference (TYPE)	I			20100924
10	Importing	IS_ROW_INDEX	Call by reference	☐	Type reference (TYPE)	I			20100924

Method ON_CREATE_HIER_CELL on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method ON_CREATE_TOTAL_CELL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_COLUMNINFO	Call by reference	☐	Object reference (TYPE REF TO)	YS_COLUMNINFO			20101014
2	Importing	IR_EXTERNAL_VALUE	Call by reference	☐	Object reference (TYPE REF TO)	STRING			20101014
3	Importing	IR_HYPERLINK	Call by reference	☐	Object reference (TYPE REF TO)	STRING			20101019
4	Importing	IR_IMAGE_DATA	Call by reference	☐	Object reference (TYPE REF TO)	CL_SALV_BS_LEX_SUPPORT=>YS_IMAGE_DATA			20101019
5	Importing	IR_IMAGE_PATH	Call by reference	☐	Object reference (TYPE REF TO)	STRING			20101019
6	Importing	IR_INTERNAL_VALUE	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20101111
7	Importing	IS_CELL_EDITOR_TYPE	Call by reference	☐	Type reference (TYPE)	YS_CELL_EDITOR_TYPE			20100924
8	Importing	IS_DECIMALS	Call by reference	☐	Type reference (TYPE)	I			20100924
9	Importing	IS_HIDDEN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100924
10	Importing	IS_LEVEL	Call by reference	☐	Type reference (TYPE)	I			20100924
11	Importing	IS_ROW_INDEX	Call by reference	☐	Type reference (TYPE)	I			20100924

Method ON_CREATE_TOTAL_CELL on Interface IF_SALV_BS_LEX_FORMAT has no exception.

Method SET_SUPPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_SUPPORT	Call by reference	☐	Object reference (TYPE REF TO)	CL_SALV_BS_LEX_SUPPORT		Support class for ALV Lean Export	20101005

Method SET_SUPPORT on Interface IF_SALV_BS_LEX_FORMAT has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	731