SAP ABAP Class CL_SALV_EXPORT_COL_CONF (Export Tool Column Configuration)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-CMP-ATS (Application Component) ABAP Table/Tree Services
     ⤷ SALV_STX (Package) ALV Services for Tables: Export Tools impl.

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SALV_EXPORT_COLUMN_CONF	Column configuration for export service tool	20090904

Properties

Class	CL_SALV_EXPORT_COL_CONF
Short Description	Export Tool Column Configuration
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	SALV_STX	ALV Services for Tables: Export Tools impl.
Created	20090904	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
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_EXPORT_TOOL	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_WD_TABLE_COLUMN	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
4	IF_SALV_EXPORT_COLUMN_CONF	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
5	IF_SALV_EXPORT_CONFIGURATION	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SALV_EXPORT_COLUMN_CONF	☐	☐	Column configuration for export service tool	20090904

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SALV_EXPORT_CONF	☐	20090904	Export Tool Configuration Object

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CELL_DESIGN	Instance attribute	Private	☐	Attribute reference (LIKE)	CL_WD_TABLE_COLUMN=>T_CELL_DESIGN		Static cell design to apply for the column	20091013
2	CELL_DESIGN_SRC_FIELD_NAME	Instance attribute	Private	☐	Type reference (TYPE)	Y_FIELD_NAME		Name of the field providing the cell design	20091013
3	DISPLAY_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	Y_DISPLAY_TYPE			20091013
4	DISPLAY_TYPES	Instance attribute	Public	☐	Attribute reference (LIKE)				20090904
5	FIELD_NAME	Instance attribute	Private	☐	Type reference (TYPE)	Y_FIELD_NAME			20091013
6	HEADER_ACC_DESCRIPTION	Instance attribute	Private	☐	Type reference (TYPE)	Y_TEXT		Accessibility description of the column header	20091013
7	HEADER_TEXT	Instance attribute	Private	☐	Type reference (TYPE)	Y_TEXT			20091013
8	HYPERLINK	Instance attribute	Private	☐	Type reference (TYPE)	Y_HYPERLINK		Static hyperlink of the column	20091013
9	HYPERLINK_SRC_FIELD_NAME	Instance attribute	Private	☐	Type reference (TYPE)	Y_FIELD_NAME		Name of the field providing the hyperlink	20091013
10	H_ALIGN	Instance attribute	Private	☐	Attribute reference (LIKE)	CL_WD_TABLE_COLUMN=>T_H_ALIGN		Horizontal alignment	20091013
11	IMAGE_FIRST	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		abap_true to display the image before the text	20091013
12	IMAGE_FIRST_SRC_FIELD_NAME	Instance attribute	Private	☐	Type reference (TYPE)	Y_FIELD_NAME		Name of the field providing the image first property values	20091013
13	IMAGE_SRC	Instance attribute	Private	☐	Type reference (TYPE)	Y_IMAGE		Static image source path	20091013
14	IMAGE_SRC_FIELD_NAME	Instance attribute	Private	☐	Type reference (TYPE)	Y_FIELD_NAME		Name of the field providing the image source	20091013
15	INVALID	Instance attribute	Private	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20091210
16	REFERENCE_FIELD_NAME	Instance attribute	Private	☐	Type reference (TYPE)	Y_FIELD_NAME		Name of the field providing the unit for the column	20091013
17	REFERENCE_FIELD_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	Y_REFERENCE_TYPE		Type of reference (currency, quantity)	20091013
18	REFERENCE_TYPE	Instance attribute	Public	☐	Attribute reference (LIKE)				20090904
19	TEXT	Instance attribute	Private	☐	Type reference (TYPE)	Y_TEXT		Static text to display in the column	20091013
20	TEXT_SRC_FIELD	Instance attribute	Private	☐	Type reference (TYPE)	Y_FIELD_NAME		Name of the field providing the column text	20091013
21	VALUE_SET	Instance attribute	Private	☐	Type reference (TYPE)	Y_VALUE_SET		Value set of the column	20091013

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_TO_CONFIG_MODEL	Instance method	Public	Method	add column definition to ALV configuration model	20090904
2	CONSTRUCTOR	Instance method	Protected	Constructor		20090904
3	GET_FIELD_NAME	Instance method	Public	Method	specifies the horizontal alignment (WebDynpro constants)	20091210
4	GET_INVALID	Instance method	Private	Method		20091210
5	GET_REFERENCE_FIELD	Instance method	Public	Method	specifies the reference field (for CURR and QUAN)	20091210
6	GET_VALUE_SET	Instance method	Public	Method	specifies a value set for translating values into texts	20091210
7	SET_CELL_DESIGN	Instance method	Public	Method		20090904
8	SET_HEADER_ACCESSIBILITY_DESC	Instance method	Public	Method		20090904
9	SET_HYPERLINK	Instance method	Public	Method		20090904
10	SET_H_ALIGN	Instance method	Public	Method		20090904
11	SET_IMAGE	Instance method	Public	Method		20090904
12	SET_INVALID	Instance method	Private	Method		20091210
13	SET_REFERENCE_FIELD	Instance method	Public	Method		20090904
14	SET_TEXT	Instance method	Public	Method		20090904
15	SET_VALUE_SET	Instance method	Public	Method		20090904

Events

Class CL_SALV_EXPORT_COL_CONF has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	Y_DISPLAY_TYPE	Public	Attribute reference (LIKE)			20090904
2	Y_FIELD_NAME	Public	Attribute reference (LIKE)			20090904
3	Y_HYPERLINK	Public	Attribute reference (LIKE)			20090904
4	Y_IMAGE	Public	Attribute reference (LIKE)			20090904
5	Y_REFERENCE_TYPE	Public	Attribute reference (LIKE)			20090904
6	Y_TEXT	Public	Attribute reference (LIKE)			20090904
7	Y_VALUE_SET	Public	Attribute reference (LIKE)			20090904

Method Signatures

Method ADD_TO_CONFIG_MODEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CR_MODEL	Call by reference	☐	Object reference (TYPE REF TO)	CL_SALV_WD_MODEL_TABLE		ModelController	20091013
2	Changing	CT_MESSAGES_INFO	Call by reference	☐	Type reference (TYPE)	CL_SALV_EXPORT_TOOL=>YT_MSG		Table of T100 messages	20091210
3	Changing	CT_MESSAGES_WARNING	Call by reference	☐	Type reference (TYPE)	CL_SALV_EXPORT_TOOL=>YT_MSG		Table of T100 messages	20091210
4	Importing	IV_POSITION	Call by reference	☐	Type reference (TYPE)	I		column position	20091013

Method ADD_TO_CONFIG_MODEL on class CL_SALV_EXPORT_COL_CONF has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DISPLAY_TYPE	Call by reference	☐	Type reference (TYPE)	Y_DISPLAY_TYPE			20090904
2	Importing	FIELD_NAME	Call by reference	☐	Type reference (TYPE)	Y_FIELD_NAME			20090904
3	Importing	HEADER_TEXT	Call by reference	☐	Type reference (TYPE)	Y_TEXT			20090904

Method CONSTRUCTOR on class CL_SALV_EXPORT_COL_CONF has no exception.

Method GET_FIELD_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	FIELD_NAME	Value transfer	☐	Type reference (TYPE)	Y_FIELD_NAME			20091210

Method GET_FIELD_NAME on class CL_SALV_EXPORT_COL_CONF has no exception.

Method GET_INVALID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INVALID	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20091210

Method GET_INVALID on class CL_SALV_EXPORT_COL_CONF has no exception.

Method GET_REFERENCE_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	FIELD_NAME	Call by reference	☐	Type reference (TYPE)	Y_FIELD_NAME			20091210
2	Exporting	TYPE	Call by reference	☐	Type reference (TYPE)	Y_REFERENCE_TYPE		use constant REFERENCE_TYPE	20091210

Method GET_REFERENCE_FIELD on class CL_SALV_EXPORT_COL_CONF has no exception.

Method GET_VALUE_SET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	VALUE_SET	Value transfer	☐	Type reference (TYPE)	Y_VALUE_SET			20091210

Method GET_VALUE_SET on class CL_SALV_EXPORT_COL_CONF has no exception.

Method SET_CELL_DESIGN Signature

Method SET_CELL_DESIGN on class CL_SALV_EXPORT_COL_CONF has no parameter.
Method SET_CELL_DESIGN on class CL_SALV_EXPORT_COL_CONF has no exception.

Method SET_HEADER_ACCESSIBILITY_DESC Signature

Method SET_HEADER_ACCESSIBILITY_DESC on class CL_SALV_EXPORT_COL_CONF has no parameter.
Method SET_HEADER_ACCESSIBILITY_DESC on class CL_SALV_EXPORT_COL_CONF has no exception.

Method SET_HYPERLINK Signature

Method SET_HYPERLINK on class CL_SALV_EXPORT_COL_CONF has no parameter.
Method SET_HYPERLINK on class CL_SALV_EXPORT_COL_CONF has no exception.

Method SET_H_ALIGN Signature

Method SET_H_ALIGN on class CL_SALV_EXPORT_COL_CONF has no parameter.
Method SET_H_ALIGN on class CL_SALV_EXPORT_COL_CONF has no exception.

Method SET_IMAGE Signature

Method SET_IMAGE on class CL_SALV_EXPORT_COL_CONF has no parameter.
Method SET_IMAGE on class CL_SALV_EXPORT_COL_CONF has no exception.

Method SET_INVALID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INVALID	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20091210

Method SET_INVALID on class CL_SALV_EXPORT_COL_CONF has no exception.

Method SET_REFERENCE_FIELD Signature

Method SET_REFERENCE_FIELD on class CL_SALV_EXPORT_COL_CONF has no parameter.
Method SET_REFERENCE_FIELD on class CL_SALV_EXPORT_COL_CONF has no exception.

Method SET_TEXT Signature

Method SET_TEXT on class CL_SALV_EXPORT_COL_CONF has no parameter.
Method SET_TEXT on class CL_SALV_EXPORT_COL_CONF has no exception.

Method SET_VALUE_SET Signature

Method SET_VALUE_SET on class CL_SALV_EXPORT_COL_CONF has no parameter.
Method SET_VALUE_SET on class CL_SALV_EXPORT_COL_CONF has no exception.

History

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