SAP ABAP Class /TDAG/CPCL_TM_DOCS_VIEW_CTRL (CP: Item details control)

Hierarchy

☛ TDAGBCA (Software Component) TechniData Basic Components
   ⤷ EHS (Application Component) Environment, Health and Safety
     ⤷ /TDAG/CP (Package) Compliance for products

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	/TDAG/CPCL_TM_VIEW_CTRL	CP: Task management generic view controller	20060807

Properties

Class	/TDAG/CPCL_TM_DOCS_VIEW_CTRL
Short Description	CP: Item details control
Super Class	/TDAG/CPCL_TM_VIEW_CTRL	CP: Task management generic view controller
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/TDAG/CP	Compliance for products
Created	20060710	SAP
Last change	20141109
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ESP1	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no interface implemented.

Friends

Class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MC_CONTAINER_NAME	Constant	Private	☐	Type reference (TYPE)	CHAR30	'TASKDOC_CONTAINER'	Custom container name	20060713
2	MC_SAPSCRIPT_DID	Constant	Private	☐	Type reference (TYPE)	TDID	'0001'	Texts: text ID	20060728
3	MC_SAPSCRIPT_OBJECT	Constant	Private	☐	Type reference (TYPE)	TDOBJECT	'/TDAG/TTXT'	Texts: application object	20060728
4	MC_STRUCTURE_NAME	Constant	Private	☐	Type reference (TYPE)	DD02L-TABNAME	'/TDAG/CPS_TASKD'	ALV grid structure name	20060715
5	MO_ALV_FLT_HELPER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/TDAG/CPCL_ALV_FILT_ROW_HELPER		CP: Filtered ALV grid wrapper	20060925
6	MO_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CUSTOM_CONTAINER		Container for Custom Controls in the Screen Area	20060713
7	MO_DOCS_LIST	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_ALV_GRID		Documents list	20060713
8	MO_TOOLBAR_CREATOR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	/TDAG/CPCL_TOOLBAR_CREATOR		Toolbar creator for the document grid	20070124
9	MS_CUR_TASKI	Instance attribute	Private	☐	Type reference (TYPE)	/TDAG/CPS_TASKI		Current item data	20060728
10	MS_TASKH	Instance attribute	Private	☐	Type reference (TYPE)	/TDAG/CPS_TASKH		CP: Struktur für Aufgabenköpfe	20070204
11	MT_DOCS_DATA	Instance attribute	Public	☐	Type reference (TYPE)	/TDAG/CPY_TASKD		ALV grid: internal table	20060716
12	MT_FIELD_CATALOG	Instance attribute	Protected	☐	Type reference (TYPE)	LVC_T_FCAT		Field catalog for ListViewer control	20070413
13	M_GRID_EDITABLE	Instance attribute	Private	☐	Type reference (TYPE)	ESEBOOLE		Boolean flag for the grid editability	20070124

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTION_APPLICATION_LOG	Instance method	Private	Method	Displays item's application log	20060925
2	ACTION_EDIT_DOCUMENTS	Instance method	Private	Method	Toggles document grid editability	20070124
3	ACTION_IMPORT_DOCUMENTS	Instance method	Private	Method	Imports a document (link a document to a product spec)	20070219
4	ACTION_LONG_TEXT	Instance method	Private	Method	Displays long text for a task item	20060925
5	ACTION_NAVIGATE_ITEMS	Instance method	Private	Method	Navigates through items in item list	20060925
6	ADJUST_FIELD_CATALOG	Instance method	Protected	Method	Erstellt den Feldkatalog für das ALV-Grid	20060921
7	CREATE_TOOLBAR	Instance method	Protected	Method	Modifies buttons of grid toolbar	20060921
8	GET_DATA_OBJECT	Instance method	Private	Method	Casts data object from interface to concrete class	20060809
9	ON_CONTEXT_MENU_REQUEST	Instance method	Private	Event handling method	Handles context menu requests	20070220
10	ON_DATA_CHANGED	Instance method	Private	Event handling method	Document data change handler	20070125
11	ON_DATA_CHANGED_FINISHED	Instance method	Private	Event handling method	Writes updated doc data to DB	20070130
12	ON_HEADER_READ	Instance method	Private	Event handling method	Receives a header data from task list	20070204
13	ON_HOTSPOT_CLICK	Instance method	Private	Event handling method	Handles hotspot clicks in doc attachments ALV grid	20060823
14	ON_TASKS_CHANGED	Instance method	Private	Event handling method	Takes actions to ensure data consistency on changes	20060828
15	ON_TASK_ITEM_CHANGED	Instance method	Public	Event handling method	Synch. detail and item tabs on sel. change in item list	20060710
16	ON_USER_COMMAND	Instance method	Private	Event handling method	Handles user defined functions	20070124
17	SET_GRID_TITLE	Instance method	Private	Method	Sets the grid title to the passed one	20070126

Events

#	Event	Type	Visibility	Description	Created on
1	DOCS_UPDATE	Instance Event (0)	Public (2)	Raised before a task update is going to take place	20070204
2	TASK_ITEM_NAVIG	Instance Event (0)	Public (2)	Raised on arrow button navigation through items	20060710

Types

Class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no local type.

Method Signatures

Method ACTION_APPLICATION_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FLG_FAIL	Call by reference	☐	Type reference (TYPE)	ESP1_BOOLEAN		Error flag	20060925
2	Changing	XT_MESSAGE	Call by reference	☐	Type reference (TYPE)	BAL_T_MSG		Application Log: Table with Messages	20060925
3	Changing	X_FLG_NEED_REFRESH	Call by reference	☐	Type reference (TYPE)	ESP1_BOOLEAN		Flag indicating whether a refresh is needed	20060925
4	Changing	X_OK_CODE	Call by reference	☐	Type reference (TYPE)	SYUCOMM		Screens, function code triggered by PAI	20060925

Method ACTION_APPLICATION_LOG on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method ACTION_EDIT_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FLG_FAIL	Call by reference	☐	Type reference (TYPE)	ESP1_BOOLEAN		Error flag	20070219
2	Changing	XT_MESSAGE	Call by reference	☐	Type reference (TYPE)	BAL_T_MSG		Application Log: Table with Messages	20070219
3	Changing	X_FLG_NEED_REFRESH	Call by reference	☐	Type reference (TYPE)	ESP1_BOOLEAN		Flag indicating whether a refresh is needed	20070219
4	Changing	X_OK_CODE	Call by reference	☐	Type reference (TYPE)	SYUCOMM		Screens, function code triggered by PAI	20070219

Method ACTION_EDIT_DOCUMENTS on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method ACTION_IMPORT_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FLG_FAIL	Call by reference	☐	Type reference (TYPE)	ESP1_BOOLEAN		Error flag	20070219
2	Changing	XT_MESSAGE	Call by reference	☐	Type reference (TYPE)	BAL_T_MSG		Application Log: Table with Messages	20070219
3	Changing	X_FLG_NEED_REFRESH	Call by reference	☐	Type reference (TYPE)	ESP1_BOOLEAN		Flag indicating whether a refresh is needed	20070219
4	Changing	X_OK_CODE	Call by reference	☐	Type reference (TYPE)	SYUCOMM		Screens, function code triggered by PAI	20070219

Method ACTION_IMPORT_DOCUMENTS on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method ACTION_LONG_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FLG_FAIL	Call by reference	☐	Type reference (TYPE)	ESP1_BOOLEAN		Error flag	20060925
2	Changing	XT_MESSAGE	Call by reference	☐	Type reference (TYPE)	BAL_T_MSG		Application Log: Table with Messages	20060925
3	Changing	X_FLG_NEED_REFRESH	Call by reference	☐	Type reference (TYPE)	ESP1_BOOLEAN		Flag indicating whether a refresh is needed	20060925
4	Changing	X_OK_CODE	Call by reference	☐	Type reference (TYPE)	SYUCOMM		Screens, function code triggered by PAI	20060925

Method ACTION_LONG_TEXT on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method ACTION_NAVIGATE_ITEMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FLG_FAIL	Call by reference	☐	Type reference (TYPE)	ESP1_BOOLEAN		Error flag	20060925
2	Changing	XT_MESSAGE	Call by reference	☐	Type reference (TYPE)	BAL_T_MSG		Application Log: Table with Messages	20060925
3	Changing	X_FLG_NEED_REFRESH	Call by reference	☐	Type reference (TYPE)	ESP1_BOOLEAN		Flag indicating whether a refresh is needed	20060925
4	Changing	X_OK_CODE	Call by reference	☐	Type reference (TYPE)	SYUCOMM		Screens, function code triggered by PAI	20060925

Method ACTION_NAVIGATE_ITEMS on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method ADJUST_FIELD_CATALOG Signature

Method ADJUST_FIELD_CATALOG on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no parameter.
Method ADJUST_FIELD_CATALOG on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method CREATE_TOOLBAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FUNCS_TO_EXCL	Call by reference	☐	Type reference (TYPE)	UI_FUNCTIONS		Die auszublendenden Standard-Einträge der Werkzeugleiste	20060921
2	Exporting	ET_TOOLBAR_DEF	Call by reference	☐	Type reference (TYPE)	/TDAG/CPY_TOOLBAR		Die anwendungsspezifischen Einträge der Werkzeugleiste	20060921

Method CREATE_TOOLBAR on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method GET_DATA_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_DATA	Value transfer	☐	Object reference (TYPE REF TO)	/TDAG/CPCL_TM_DOCS_DATA		CP: Item details data handler	20060809

Method GET_DATA_OBJECT on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method ON_CONTEXT_MENU_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	E_OBJECT	Call by reference	☐	Attribute reference (LIKE)				20070220

Method ON_CONTEXT_MENU_REQUEST on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method ON_DATA_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ER_DATA_CHANGED	Call by reference	☐	Attribute reference (LIKE)				20070125
2	Importing	E_ONF4	Call by reference	☐	Attribute reference (LIKE)				20070125
3	Importing	E_ONF4_AFTER	Call by reference	☐	Attribute reference (LIKE)				20070125
4	Importing	E_ONF4_BEFORE	Call by reference	☐	Attribute reference (LIKE)				20070125

Method ON_DATA_CHANGED on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method ON_DATA_CHANGED_FINISHED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	E_MODIFIED	Call by reference	☐	Attribute reference (LIKE)				20070130

Method ON_DATA_CHANGED_FINISHED on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method ON_HEADER_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ES_TASKH	Call by reference	☐	Attribute reference (LIKE)				20070204

Method ON_HEADER_READ on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method ON_HOTSPOT_CLICK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ES_ROW_NO	Value transfer	☐	Attribute reference (LIKE)				20060823
2	Importing	E_COLUMN_ID	Value transfer	☐	Attribute reference (LIKE)				20060823
3	Importing	E_ROW_ID	Value transfer	☐	Attribute reference (LIKE)				20060823

Method ON_HOTSPOT_CLICK on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method ON_TASKS_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PT_TASKH	Value transfer	☐	Attribute reference (LIKE)				20060828

Method ON_TASKS_CHANGED on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method ON_TASK_ITEM_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PS_TASKI	Call by reference	☐	Attribute reference (LIKE)				20060826
2	Importing	P_LINES	Call by reference	☐	Attribute reference (LIKE)				20060826
3	Importing	P_NEW_TAB_ID	Call by reference	☐	Attribute reference (LIKE)				20060826
4	Importing	P_ROW_INDEX	Call by reference	☐	Attribute reference (LIKE)				20060826

Method ON_TASK_ITEM_CHANGED on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method ON_USER_COMMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	E_UCOMM	Call by reference	☐	Attribute reference (LIKE)				20070124

Method ON_USER_COMMAND on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Method SET_GRID_TITLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TITLE	Call by reference	☐	Type reference (TYPE)	LVC_S_LAYO-GRID_TITLE		ALV Control: Title bar text	20070126

Method SET_GRID_TITLE on class /TDAG/CPCL_TM_DOCS_VIEW_CTRL has no exception.

Event Signatures

Event DOCS_UPDATE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	ES_TASKD	Exporting	Value transfer	☐	Type reference (TYPE)	/TDAG/CPS_TASKD		CP: Struktur für Aufgabenköpfe	20070205

Event TASK_ITEM_NAVIG Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	P_UCOMM	Exporting	Value transfer	☐	Type reference (TYPE)	SYUCOMM		Screens, function code triggered by PAI	20060808

History

Last changed by/on	SAP	20141109
SAP Release Created in	0207B0406C