SAP ABAP Class CL_GUI_DOCUMENT_COMPONENT (Document Component)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-ARL (Application Component) ArchiveLink
     ⤷ SAOV (Package) Document Viewer

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_ALINK_CONSTANTS	Constants	20010920

Properties

Class	CL_GUI_DOCUMENT_COMPONENT
Short Description	Document Component
Super Class	CL_ALINK_CONSTANTS	Constants
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SAOV	Document Viewer
Created	20010920	SAP
Last change	20010920	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_GUI_DOCUMENT_COMPONENT has no forward declaration.

Interfaces

Class CL_GUI_DOCUMENT_COMPONENT has no interface implemented.

Friends

Class CL_GUI_DOCUMENT_COMPONENT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	COMPONENT_URL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20010920
2	COM_COMPONENT	Instance attribute	Private	☐	Type reference (TYPE)	SCMS_COMPS		Components of Stored Documents	20010920
3	COM_CONTREP_ID	Instance attribute	Private	☐	Type reference (TYPE)	TOAAR-ARCHIV_ID		Content Repository Identification	20010920
4	COM_DOCUMENT_CLASS	Instance attribute	Private	☐	Type reference (TYPE)	TOAOM-DOC_TYPE		SAP ArchiveLink: Document Class	20010920
5	COM_DOCUMENT_ID	Instance attribute	Private	☐	Type reference (TYPE)	SAPB-SAPADOKID		SAP ArchiveLink: Document ID	20010920
6	COM_LAYER	Instance attribute	Private	☐	Type reference (TYPE)	AL_COMPONENTS		Layer	20011031
7	COM_LAYER_DOCUMENT_CLASS	Instance attribute	Private	☐	Type reference (TYPE)	TOAOM-DOC_TYPE	'CGM'	SAP ArchiveLink: Document Class	20011031
8	COM_MARKUP_OBJECT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_ECL_MARKUP		Markup (Redlining) Component	20011031
9	DISPLAY_STATUS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	ALINK_DISPLAY_STATUS		Display Status	20010921
10	ECL_CONTROL	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_ECL_2DVIEWER		Engineering Client 2D Viewer	20010921
11	HTML_CONTROL	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_HTML_VIEWER		HTML Control Proxy Class	20010921

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_LAYER	Instance method	Public	Method		20011030
2	CHECK_IF_LAYER_EXIST	Instance method	Public	Method		20011031
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20010920
4	CREATE_ECL	Instance method	Private	Method		20010921
5	CREATE_LAYER	Instance method	Private	Method		20011031
6	DELETE_LAYER	Instance method	Private	Method		20011105
7	DELETE_LAYER_IN_TABLE	Instance method	Public	Method		20011218
8	DISPLAY	Instance method	Public	Method	Display components	20010921
9	DISPLAY_ECL	Instance method	Private	Method	Display Component with ECL Control	20010920
10	DISPLAY_HTML	Instance method	Private	Method	Display Component with HTML Control	20010920
11	DISPLAY_LAYER	Instance method	Private	Method		20011031
12	GET_COMPONENT	Instance method	Public	Method	Get Component in DP	20010920
13	GET_COMPONENT_DESCRIPTION	Instance method	Public	Method		20011211
14	GET_DCL_FROM_MT	Instance method	Private	Method		20011109
15	GET_DISPLAYSTATUS	Instance method	Public	Method	Determine the Current Display Status	20010921
16	GET_HOWTODISPLAY	Instance method	Public	Method	Determine the Type of Display	20010921
17	GET_LAYER	Instance method	Public	Method		20011210
18	GET_MIMETYPE	Instance method	Public	Method		20011210
19	GET_MIMETYPE_FROM_TABLE	Instance method	Private	Method		20011012
20	GET_URL	Instance method	Private	Method	Determine the GET URL for Document Components	20011009
21	ON_DELETE_MARKUP	Instance method	Public	Event handling method		20011031
22	ON_FILE_DROPPED	Instance method	Public	Event handling method		20011031
23	ON_MARKUP_ACTIVATED	Instance method	Public	Event handling method		20011031
24	ON_SAVE_LAYER	Instance method	Public	Event handling method		20011031
25	REGISTER_ECL_EVENTS	Instance method	Private	Method		20011031
26	SLEEP	Instance method	Public	Method		20010921
27	TRANSLATE_BLANK_TO_REAL	Instance method	Public	Method		20011106
28	TRANSLATE_REAL_TO_BLANK	Instance method	Public	Method		20011106
29	UNREGISTER_ECL_EVENTS	Instance method	Public	Method		20011108
30	UPDATE_LAYER	Instance method	Public	Method		20011217
31	WAKEUP	Instance method	Public	Method		20010921

Events

#	Event	Type	Visibility	Description	Created on
1	FILE_DROPPED	Instance Event (0)	Public (2)		20011107

Types

Class CL_GUI_DOCUMENT_COMPONENT has no local type.

Method Signatures

Method ADD_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LAYER	Value transfer	☐	Type reference (TYPE)	AL_COMPONENTS		Komponenten zu abgelegten Dokumenten	20011030

Method ADD_LAYER on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method CHECK_IF_LAYER_EXIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LAYER	Value transfer	☐	Type reference (TYPE)	SCMS_COMPS		Komponenten zu abgelegten Dokumenten	20011031
2	Importing	MARKUP_NAME	Value transfer	☐	Type reference (TYPE)	CHAR40		Character 40-Stellen	20011031

Method CHECK_IF_LAYER_EXIST on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMPONENT	Call by reference	☑	Type reference (TYPE)	SCMS_COMPS		Komponenten zu abgelegten Dokumenten	20010920
2	Importing	CONTREP_ID	Value transfer	☐	Type reference (TYPE)	TOAAR-ARCHIV_ID		Content Repository Identifikation	20010920
3	Importing	DOCUMENT_CLASS	Value transfer	☐	Type reference (TYPE)	TOAOM-DOC_TYPE		SAP ArchiveLink: Dokumenttyp	20010920
4	Importing	DOCUMENT_ID	Value transfer	☐	Type reference (TYPE)	SAPB-SAPADOKID		SAP ArchiveLink: Dokument-Id	20010920

Method CONSTRUCTOR on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method CREATE_ECL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTENTCONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstracter Container fuer GUI Controls	20010921

Method CREATE_ECL on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method CREATE_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	COMPLENGTH	Call by reference	☐	Type reference (TYPE)	ALINT		Archivelinkinteger	20011106
2	Importing	FILENAME	Value transfer	☐	Type reference (TYPE)	C			20011031
3	Exporting	LAYER	Call by reference	☐	Type reference (TYPE)	SCMS_COMPS		Komponenten zu abgelegten Dokumenten	20011105
4	Importing	MARKUP_NAME	Value transfer	☐	Type reference (TYPE)	CHAR40		Character 40-Stellen	20011031

Method CREATE_LAYER on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method DELETE_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MARKUP_NAME	Call by reference	☐	Type reference (TYPE)	CHAR40		Character 40-Stellen	20011105

Method DELETE_LAYER on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method DELETE_LAYER_IN_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LAYER	Call by reference	☐	Type reference (TYPE)	SCMS_COMPS		Komponenten zu abgelegten Dokumenten	20011218

Method DELETE_LAYER_IN_TABLE on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method DISPLAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMPONENTCONTAINER	Call by reference	☑	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstracter Container fuer GUI Controls	20010921

Method DISPLAY on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method DISPLAY_ECL Signature

Method DISPLAY_ECL on class CL_GUI_DOCUMENT_COMPONENT has no parameter.
Method DISPLAY_ECL on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method DISPLAY_HTML Signature

Method DISPLAY_HTML on class CL_GUI_DOCUMENT_COMPONENT has no parameter.
Method DISPLAY_HTML on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method DISPLAY_LAYER Signature

Method DISPLAY_LAYER on class CL_GUI_DOCUMENT_COMPONENT has no parameter.
Method DISPLAY_LAYER on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method GET_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTREPTYPE	Value transfer	☐	Type reference (TYPE)	I			20010920
2	Returning	URL	Value transfer	☐	Type reference (TYPE)	STRING			20010920

Method GET_COMPONENT on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method GET_COMPONENT_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	COMPONENT_DESCRIPTION	Value transfer	☐	Type reference (TYPE)	SCMS_COMPS		Komponenten zu abgelegten Dokumenten	20011211

Method GET_COMPONENT_DESCRIPTION on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method GET_DCL_FROM_MT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DOCUMENT_CLASS	Value transfer	☐	Type reference (TYPE)	TOAOM-DOC_TYPE		SAP ArchiveLink: Dokumenttyp	20011109
2	Importing	MIMETYPE	Call by reference	☐	Type reference (TYPE)	SCMS_COMPS-MIMETYPE		SAP ArchiveLink Poolinfo/Ablagestrategie	20011109

Method GET_DCL_FROM_MT on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method GET_DISPLAYSTATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	STATUS	Value transfer	☐	Type reference (TYPE)	I			20010921

Method GET_DISPLAYSTATUS on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method GET_HOWTODISPLAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	HOWTODISPLAY	Value transfer	☐	Type reference (TYPE)	I			20010921

Method GET_HOWTODISPLAY on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method GET_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LAYER	Value transfer	☐	Type reference (TYPE)	AL_COMPONENTS		AL Components	20011210

Method GET_LAYER on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method GET_MIMETYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	MIMETYPE	Value transfer	☐	Type reference (TYPE)	SCMS_COMPS-MIMETYPE		SAP ArchiveLink Poolinfo/Ablagestrategie	20011210

Method GET_MIMETYPE on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method GET_MIMETYPE_FROM_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT_CLASS	Value transfer	☐	Type reference (TYPE)	TOADV-DOC_TYPE		SAP ArchiveLink: Dokumenttyp	20011012
2	Returning	MIMETYPE	Value transfer	☐	Type reference (TYPE)	SCMS_COMPS-MIMETYPE		Mimetype	20011012

Method GET_MIMETYPE_FROM_TABLE on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method GET_URL Signature

Method GET_URL on class CL_GUI_DOCUMENT_COMPONENT has no parameter.
Method GET_URL on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method ON_DELETE_MARKUP Signature

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

Method ON_DELETE_MARKUP on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method ON_FILE_DROPPED Signature

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

Method ON_FILE_DROPPED on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method ON_MARKUP_ACTIVATED Signature

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

Method ON_MARKUP_ACTIVATED on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method ON_SAVE_LAYER Signature

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

Method ON_SAVE_LAYER on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method REGISTER_ECL_EVENTS Signature

Method REGISTER_ECL_EVENTS on class CL_GUI_DOCUMENT_COMPONENT has no parameter.
Method REGISTER_ECL_EVENTS on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method SLEEP Signature

Method SLEEP on class CL_GUI_DOCUMENT_COMPONENT has no parameter.
Method SLEEP on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method TRANSLATE_BLANK_TO_REAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BLANK	Call by reference	☐	Type reference (TYPE)	SCMS_COMPS-COMPID		Relativer Ablageort eines physischen Dokuments	20011106
2	Returning	REAL	Value transfer	☐	Type reference (TYPE)	SCMS_COMPS-COMPID		Relativer Ablageort eines physischen Dokuments	20011106

Method TRANSLATE_BLANK_TO_REAL on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method TRANSLATE_REAL_TO_BLANK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	BLANK	Value transfer	☐	Type reference (TYPE)	SCMS_COMPS-COMPID		Relativer Ablageort eines physischen Dokuments	20011106
2	Importing	REAL	Call by reference	☐	Type reference (TYPE)	SCMS_COMPS-COMPID		Relativer Ablageort eines physischen Dokuments	20011106

Method TRANSLATE_REAL_TO_BLANK on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method UNREGISTER_ECL_EVENTS Signature

Method UNREGISTER_ECL_EVENTS on class CL_GUI_DOCUMENT_COMPONENT has no parameter.
Method UNREGISTER_ECL_EVENTS on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method UPDATE_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LAYER	Value transfer	☐	Type reference (TYPE)	SCMS_COMPS		Komponenten zu abgelegten Dokumenten	20011217

Method UPDATE_LAYER on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Method WAKEUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTENTCONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstracter Container fuer GUI Controls	20010921

Method WAKEUP on class CL_GUI_DOCUMENT_COMPONENT has no exception.

Event Signatures

Event FILE_DROPPED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	COMPONENT	Exporting	Value transfer	☐	Type reference (TYPE)	SCMS_COMPS		Komponenten zu abgelegten Dokumenten	20011108
2	FILE_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	CHAR255		char255	20011107

History

Last changed by/on	SAP	20010920
SAP Release Created in	620