SAP ABAP Class CL_DOCUMENT (CL_DOCUMENT)
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 20010921
Properties
Class CL_DOCUMENT  
Short Description    
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 20010921   SAP 
Last change 20010921   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_DOCUMENT has no forward declaration.
Interfaces
Class CL_DOCUMENT has no interface implemented.
Friends
Class CL_DOCUMENT has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 ACTUAL_PAGE Instance attribute Private Type reference (TYPE) I Current Page (Component) 20010921
2 COMPONENTOBJECT Instance attribute Private Object reference (TYPE REF TO) CL_GUI_DOCUMENT_COMPONENT Document Component 20011107
3 COMPONENT_OBJECTS Instance attribute Private Type reference (TYPE) DOC_COMPS Document Components 20010921
4 DOC_COMMUNICATION_TYPE Instance attribute Private Type reference (TYPE) I Display type 20010921
5 DOC_COMPONENTS Instance attribute Private Type reference (TYPE) AL_COMPONENTS AL Components 20011030
6 DOC_COMPONENT_COUNT Instance attribute Private Type reference (TYPE) I -1 No. of Components 20010927
7 DOC_COMPONENT_PAGER Instance attribute Private Object reference (TYPE REF TO) CL_COMPONENT_PAGER Document Component Functions 20010924
8 DOC_COMPPAGER_STATUS Instance attribute Private Object reference (TYPE REF TO) ALINK_DISPLAY_STATUS Status Class for Document Display 20011010
9 DOC_CONTENTCONTAINER Instance attribute Public Object reference (TYPE REF TO) CL_GUI_CONTAINER Abstract Container for GUI Controls 20010924
10 DOC_CONTREP_ID Instance attribute Private Type reference (TYPE) SAEARCHIVI Content Repository Identification 20010921
11 DOC_CONTREP_TYPE Instance attribute Private Type reference (TYPE) I 20010924
12 DOC_DOCUMENT_CLASS Instance attribute Private Type reference (TYPE) SAEDOKTYP SAP ArchiveLink: Document Class 20010921
13 DOC_DOCUMENT_ID Instance attribute Private Type reference (TYPE) SAEARDOID SAP ArchiveLink: Document ID 20010921
14 DOC_NOTE_EXIST Instance attribute Private Type reference (TYPE) OAX UNKNOWNC Note Exists 20010927
15 DOC_NOTE_FUNCTION_ACTIVE Instance attribute Private Type reference (TYPE) OAX 'U' Note Can be Edited 20010927
16 DOC_PAGECONTAINER Instance attribute Private Object reference (TYPE REF TO) CL_GUI_CONTAINER Abstract Container for GUI Controls 20010924
Methods
# Method Level Visibility Method type Description Created on
1 CHECK_IF_EAI_SHOULD_BE_CALLED Instance method Private Method 20010924
2 CHECK_KIND_OF_BROWSER Instance method Private Method 20010924
3 CONSTRUCTOR Instance method Public Constructor Constructor 20010921
4 CREATE_COMPONENTOBJECTS Instance method Private Method 20011012
5 DELETE_CONTROL Instance method Public Method Close Current Display Control 20011002
6 DISPLAY Instance method Public Method Display document 20010921
7 DISPLAY_ME_AGAIN Instance method Private Method 20011109
8 DOCUMENT_IMPLACE Static method Public Method Can the Document be Display Inplace 20011011
9 DO_I_NEED_PAGER Instance method Public Method Do I need the Option to Page Between Compnents 20010927
10 FIND_CONTREPTYPE Instance method Private Method Determine Type of Content Repository (RFC or HTTP) 20010924
11 FIND_STANDARD_DISPLAY_COMMTYPE Instance method Private Method 20010924
12 GET_COMPONENT_COUNT Instance method Public Method How Many Components Does the Document Have? 20011206
13 GET_COMPONENT_OBJECT Instance method Public Method 20011210
14 GET_COMPPAGERSTATUS Instance method Public Method 20011010
15 GET_CONTREP_ID Instance method Public Method Return Cont. Rep. ID 20011107
16 GET_CONTREP_TYPE Instance method Public Method 20011210
17 GET_DISPLAY_COMMUNICATION_TYPE Instance method Private Method 20010921
18 GET_DOCUMENT_CLASS Instance method Public Method Return Document Class 20011107
19 GET_DOCUMENT_ID Instance method Public Method Return Document ID 20011107
20 GET_LAYER Instance method Private Method 20011030
21 GET_MIMETYPE_FROM_FILE Instance method Public Method 20011109
22 GET_NOTE_FUNCTIONS Instance method Public Method Determine Note Function 20010927
23 GET_PAGER_STATUS Instance method Public Method 20011010
24 GET_PAGE_COMPONENTS Instance method Private Method 20010924
25 GIVE_ME_NEW_COMPID Instance method Public Method 20011108
26 ON_FILE_DROPPED Instance method Private Event handling method 20011107
27 ON_PAGECHANGE Instance method Private Event handling method 20010925
28 ORDER Instance method Private Method 20011107
29 PAGECOMPONENT Instance method Private Method Page Between Components 20010921
30 PROCESS_COMPONENTPAGER Instance method Private Method 20011010
31 REGISTER_EVENTS Instance method Private Method 20010925
32 SET_COMPONENT_COUNT Instance method Public Method Set Number of Components 20011211
33 SET_NOTE_FUNCTIONS Instance method Public Method Set Note Function 20020117
34 SLEEP Instance method Public Method 20011010
35 STORE_NEW_COMPONENT Instance method Public Method 20011108
36 UNREGISTER_DND Instance method Public Method 20011107
Events
# Event Type Visibility Description Created on
1 DISPLAY_AGAIN Instance Event
(0) 		Public
(2) 		20011109
Types
Class CL_DOCUMENT has no local type.
Method Signatures

Method CHECK_IF_EAI_SHOULD_BE_CALLED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DOCUMENT_CLASS Value transfer Type reference (TYPE) SAEDOKTYP SAP ArchiveLink: Dokumenttyp 20010924
2 Returning EAI_STATUS Value transfer Type reference (TYPE) I 20010924

Method CHECK_IF_EAI_SHOULD_BE_CALLED on class CL_DOCUMENT has no exception.

Method CHECK_KIND_OF_BROWSER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning BROWSER_STATUS Value transfer Type reference (TYPE) I 20010924
2 Importing DOCUMENT_CLASS Value transfer Type reference (TYPE) SAEDOKTYP SAP ArchiveLink: Dokumenttyp 20010924

Method CHECK_KIND_OF_BROWSER on class CL_DOCUMENT has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTREP_ID Value transfer Type reference (TYPE) SAEARCHIVI Content Repository Identifikation 20010921
2 Importing DOCUMENT_CLASS Value transfer Type reference (TYPE) SAEDOKTYP SAP ArchiveLink: Dokumenttyp 20010921
3 Importing DOCUMENT_ID Value transfer Type reference (TYPE) SAEARDOID SAP ArchiveLink: Dokument-Id 20010921

Method CONSTRUCTOR on class CL_DOCUMENT has no exception.

Method CREATE_COMPONENTOBJECTS Signature

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

Method CREATE_COMPONENTOBJECTS on class CL_DOCUMENT has no exception.

Method DELETE_CONTROL Signature

Method DELETE_CONTROL on class CL_DOCUMENT has no parameter.
Method DELETE_CONTROL on class CL_DOCUMENT has no exception.

Method DISPLAY Signature

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

Method DISPLAY on class CL_DOCUMENT has no exception.

Method DISPLAY_ME_AGAIN Signature

Method DISPLAY_ME_AGAIN on class CL_DOCUMENT has no parameter.
Method DISPLAY_ME_AGAIN on class CL_DOCUMENT has no exception.

Method DOCUMENT_IMPLACE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DOCUMENT Call by reference Type reference (TYPE) TOADI Struktur für die Anzeige von Dokumenten 20011011
2 Returning IMPLACE_ACTIVE Value transfer Type reference (TYPE) I 20011011

Method DOCUMENT_IMPLACE on class CL_DOCUMENT has no exception.

Method DO_I_NEED_PAGER Signature

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

Method DO_I_NEED_PAGER on class CL_DOCUMENT has no exception.

Method FIND_CONTREPTYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTREP_ID Value transfer Type reference (TYPE) SAEARCHIVI Content Repository Identifikation 20010924

Method FIND_CONTREPTYPE on class CL_DOCUMENT has no exception.

Method FIND_STANDARD_DISPLAY_COMMTYPE Signature

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

Method FIND_STANDARD_DISPLAY_COMMTYPE on class CL_DOCUMENT has no exception.

Method GET_COMPONENT_COUNT Signature

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

Method GET_COMPONENT_COUNT on class CL_DOCUMENT has no exception.

Method GET_COMPONENT_OBJECT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning COMPONENT_OBJECT Value transfer Object reference (TYPE REF TO) CL_GUI_DOCUMENT_COMPONENT Dokumentenkomponente 20011210
2 Importing NUMBER Call by reference Type reference (TYPE) I 20011210

Method GET_COMPONENT_OBJECT on class CL_DOCUMENT has no exception.

Method GET_COMPPAGERSTATUS Signature

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

Method GET_COMPPAGERSTATUS on class CL_DOCUMENT has no exception.

Method GET_CONTREP_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CONTREP_ID Value transfer Type reference (TYPE) TOADI-AID Content Repository Identifikation 20011107

Method GET_CONTREP_ID on class CL_DOCUMENT has no exception.

Method GET_CONTREP_TYPE Signature

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

Method GET_CONTREP_TYPE on class CL_DOCUMENT has no exception.

Method GET_DISPLAY_COMMUNICATION_TYPE Signature

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

Method GET_DISPLAY_COMMUNICATION_TYPE on class CL_DOCUMENT has no exception.

Method GET_DOCUMENT_CLASS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning DOCUMENT_CLASS Value transfer Type reference (TYPE) TOADI-DCL SAP ArchiveLink: technischer Dokumenttyp 20011107

Method GET_DOCUMENT_CLASS on class CL_DOCUMENT has no exception.

Method GET_DOCUMENT_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning DOCUMENT_ID Value transfer Type reference (TYPE) TOADI-ADID SAP ArchiveLink: Dokument-Id 20011107

Method GET_DOCUMENT_ID on class CL_DOCUMENT has no exception.

Method GET_LAYER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing COMPONENTOBJECT Value transfer Object reference (TYPE REF TO) CL_GUI_DOCUMENT_COMPONENT Komponenten zu abgelegten Dokumenten 20011211
2 Returning LAYER Value transfer Type reference (TYPE) AL_COMPONENTS AL Components 20011030

Method GET_LAYER on class CL_DOCUMENT has no exception.

Method GET_MIMETYPE_FROM_FILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FILENAME Call by reference Type reference (TYPE) CHAR255 char255 20011109
2 Returning MIMETYPE Value transfer Type reference (TYPE) W3CONTTYPE HTML-Content-Type 20011109

Method GET_MIMETYPE_FROM_FILE on class CL_DOCUMENT has no exception.

Method GET_NOTE_FUNCTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting NOTE_EXIST Call by reference Type reference (TYPE) OAX Kennzeichen Ja/Nein (X/ ) 20010927
2 Exporting NOTE_FUNCTION_ACTIVE Call by reference Type reference (TYPE) OAX Kennzeichen Ja/Nein (X/ ) 20010927

Method GET_NOTE_FUNCTIONS on class CL_DOCUMENT has no exception.

Method GET_PAGER_STATUS Signature

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

Method GET_PAGER_STATUS on class CL_DOCUMENT has no exception.

Method GET_PAGE_COMPONENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTREP_ID Value transfer Type reference (TYPE) SAEARCHIVI Content Repository Identifikation 20010924
2 Importing DOCUMENT_ID Value transfer Type reference (TYPE) SAEARDOID SAP ArchiveLink: Dokument-Id 20010924
3 Exporting PAGES Call by reference Type reference (TYPE) AL_COMPONENTS AL Components 20010924

Method GET_PAGE_COMPONENTS on class CL_DOCUMENT has no exception.

Method GIVE_ME_NEW_COMPID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning NEW_COMPID Value transfer Type reference (TYPE) SCMS_COMPS-COMPID Relativer Ablageort eines physischen Dokuments 20011108

Method GIVE_ME_NEW_COMPID on class CL_DOCUMENT has no exception.

Method ON_FILE_DROPPED Signature

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

Method ON_FILE_DROPPED on class CL_DOCUMENT has no exception.

Method ON_PAGECHANGE Signature

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

Method ON_PAGECHANGE on class CL_DOCUMENT has no exception.

Method ORDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DISPLAYABLE_COMPONENTS Call by reference Type reference (TYPE) AL_COMPONENTS AL Components 20011107
2 Returning ORDERED_COMPONENTS Value transfer Type reference (TYPE) AL_COMPONENTS AL Components 20011107

Method ORDER on class CL_DOCUMENT has no exception.

Method PAGECOMPONENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NEXTPAGE Value transfer Type reference (TYPE) I 20010924

Method PAGECOMPONENT on class CL_DOCUMENT has no exception.

Method PROCESS_COMPONENTPAGER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NUMBER_OF_PAGES Value transfer Type reference (TYPE) I 20011010

Method PROCESS_COMPONENTPAGER on class CL_DOCUMENT has no exception.

Method REGISTER_EVENTS Signature

Method REGISTER_EVENTS on class CL_DOCUMENT has no parameter.
Method REGISTER_EVENTS on class CL_DOCUMENT has no exception.

Method SET_COMPONENT_COUNT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing COUNT Value transfer Type reference (TYPE) I 20011211

Method SET_COMPONENT_COUNT on class CL_DOCUMENT has no exception.

Method SET_NOTE_FUNCTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NOTE_EXIST Value transfer Type reference (TYPE) OAX Kennzeichen Ja/Nein (X/ ) 20020117

Method SET_NOTE_FUNCTIONS on class CL_DOCUMENT has no exception.

Method SLEEP Signature

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

Method STORE_NEW_COMPONENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FILE_NAME Call by reference Type reference (TYPE) CHAR255 char255 20011108
2 Importing NEW_COMPID Call by reference Type reference (TYPE) SCMS_COMPS-COMPID Relativer Ablageort eines physischen Dokuments 20011108

Method STORE_NEW_COMPONENT on class CL_DOCUMENT has no exception.

Method UNREGISTER_DND Signature

Method UNREGISTER_DND on class CL_DOCUMENT has no parameter.
Method UNREGISTER_DND on class CL_DOCUMENT has no exception.
Event Signatures

Event DISPLAY_AGAIN Signature
Event DISPLAY_AGAIN on class CL_DOCUMENT has no parameter.
History
Last changed by/on SAP  20010921 
SAP Release Created in 620