SAP ABAP Class CL_SA_DOC (Document in SAP Solution Manager)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ SV-SMG-IMP (Application Component) Solution Manager Implementation
     ⤷ SOLAR_DOC (Package) Document Management in Solution Manager
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  IF_SA_DOC Documents in SAP Solution Manager 20010214
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_SA_DOC_BROWSER Create URL Dialog Box 20010323
2 Inheritance (c INHERITING FROM c_ref)  CL_SA_DOC_GEN Generic Docment in SAP Solution Architect 20010228
3 Inheritance (c INHERITING FROM c_ref)  CL_SA_DOC_OI Office Integration Document in SAP Solution Architect 20010214
4 Inheritance (c INHERITING FROM c_ref)  CL_SA_DOC_TXT Text Document in SAP Solution Architect 20010220
5 Inheritance (c INHERITING FROM c_ref)  CL_SA_DOC_VIEW Display Document in SAP Solution Architect 20010220
Properties
Class CL_SA_DOC  
Short Description Document in SAP Solution Manager    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SOLAR_DOC   Document Management in Solution Manager 
Created 20010213   SAP 
Last change 20130531   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 CL_ICON Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
2 CL_SA_DOC_ATTR_DLG Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
3 ICON Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
# Interface Abstract Final Description Created on
1 IF_SA_DOC Documents in SAP Solution Manager 20010214
Friends
# Friend Modeled only Created on Description
1 CL_SA_DOC_FACTORY 20010314 SAP Solution Manager: Document Management
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 AT_PROP_BUTTONS Instance attribute Private Type reference (TYPE) TTB_BUTTON Buttons for Property Toolbar 20010319
2 AT_PROP_MENU_BUTTONS Instance attribute Private Type reference (TYPE) TTB_BTNMNU Assignment of Toolbar Button to Context Menu 20010319
3 AT_STATE_VALUES Instance attribute Private Type reference (TYPE) SADOCVAL_T Possible Status Values 20010319
4 A_ATTR_DIA_OPEN Instance attribute Public Type reference (TYPE) CHAR1 Attribute Dialog Opened 20120427
5 A_DOCUMENT_CHANGED Instance attribute Protected Type reference (TYPE) CHAR1 Save the document 20010215
6 A_DOC_STATUS Instance attribute Protected Attribute reference (LIKE) 20010215
7 A_DOKU_CONTENT_CHANGED Instance attribute Protected Type reference (TYPE) CHAR1 Single-Character Flag 20040420
8 A_EDITOR_ON Instance attribute Private Type reference (TYPE) CHAR1 Show/Hide Editor Details Indicator (for Expand/Collapse) 20010319
9 A_EXPANDER_COLUMN Instance attribute Private Type reference (TYPE) I Column in Upper Splitter for Expand Button 20010319
10 A_FUNCTION_ACTIVE Static Attribute Protected Type reference (TYPE) FLAG Function Active 20060626
11 A_FUNCTION_CHECKED Static Attribute Protected Type reference (TYPE) FLAG Function Checked 20060626
12 A_INPLACE Instance attribute Protected Type reference (TYPE) FLAG Open Document in Window 20031127
13 A_PROP_COLUMN Instance attribute Private Type reference (TYPE) I Column in Upper Splitter for Property Toolbar 20010319
14 A_RC Instance attribute Protected Type reference (TYPE) I Result for Control Methods 20010318
15 A_REFRESH_STATUS_DROPDOWN Instance attribute Protected Type reference (TYPE) FLAG Refresh Status Selection List 20050830
16 A_SHOW_TOOLBARS Instance attribute Protected Type reference (TYPE) CHAR1 Display Toolbars in Editor 20010314
17 A_SPLITTER_HEIGHT Instance attribute Private Type reference (TYPE) I Current Height of Collapse Splitter 20010319
18 A_TITLE_COLUMN Instance attribute Private Type reference (TYPE) I Column in Upper Splitter for Text Edit Title 20010319
19 A_WRITE_PROTECTION_SET Instance attribute Protected Type reference (TYPE) FLAG Write-Protect External Documents 20031201
20 C_DOC_STATUS_CLOSED Instance attribute Protected Attribute reference (LIKE) 20010215
21 C_DOC_STATUS_INITIAL Instance attribute Protected Attribute reference (LIKE) 20010215
22 C_DOC_STATUS_OPEN Instance attribute Protected Attribute reference (LIKE) 20010215
23 C_EXPANDER_COLUMN_WIDTH Constant Private Type reference (TYPE) I 28 Width of Expand Toolbar 20010319
24 C_FCODE_CLOSE_SCREEN Constant Private Type reference (TYPE) SYUCOMM 'SA_SCREEN_CLOSE' Close an Amodal Window 20050729
25 C_FCODE_EXPAND Constant Private Type reference (TYPE) SYUCOMM 'EXPAND' OKCODE for Expand Button on Toolbar 20010319
26 C_FCODE_PRINT Constant Private Type reference (TYPE) SYUCOMM 'PRINT' Function Code for Print 20060713
27 C_FCODE_PROP Constant Private Type reference (TYPE) SYUCOMM 'PROP' OKCODE for Expand Button on Toolbar 20010319
28 C_FCODE_SHOW_HIDE Constant Private Type reference (TYPE) SYUCOMM 'SHOW' OKCODE for Expand Button on Toolbar 20010319
29 C_FCODE_SHOW_SIGNATURES Constant Private Type reference (TYPE) SYUCOMM 'SA_DOC_SHOW_SIGNATURES' Signature Display Function Code 20061114
30 C_FCODE_SIGN Constant Private Type reference (TYPE) SYUCOMM 'SA_DOC_SIGN' Function Code for Digital Signature 20050316
31 C_FCODE_STATUS Constant Private Type reference (TYPE) SYUCOMM 'STATE' OKCODE for Expand Button on Toolbar 20010319
32 C_PROP_COLUMN_WIDTH Constant Private Type reference (TYPE) I 300 Width of Property Toolbar 20010319
33 C_TOP_CONTAINER_HEIGH Instance attribute Private Type reference (TYPE) I 25 Height in Pixel of Upper Container 20010318
34 R_CALLING_OBJECT Instance attribute Protected Object reference (TYPE REF TO) OBJECT Link to Calling Object 20011127
35 R_DOC_ATTR Instance attribute Protected Object reference (TYPE REF TO) IF_SA_IO Attributes for Document in SAP Solution Manager 20010214
36 R_EDITOR_CONTAINER Instance attribute Protected Object reference (TYPE REF TO) CL_GUI_CONTAINER Container for Editor 20010318
37 R_EXPAND_CONTAINER Instance attribute Private Object reference (TYPE REF TO) CL_GUI_CONTAINER Abstract Container for GUI Controls 20010319
38 R_EXPAND_TOOLBAR Instance attribute Private Object reference (TYPE REF TO) CL_GUI_TOOLBAR Toolbar for Expand Buttons 20010319
39 R_GLOBAL_CONTAINER Instance attribute Private Object reference (TYPE REF TO) CL_GUI_CONTAINER Container for Total Control 20010318
40 R_MAIN_SPLITTER Instance attribute Private Object reference (TYPE REF TO) CL_GUI_SPLITTER_CONTAINER Splitter Control for Whole Document 20010319
41 R_PROP_CONTAINER Instance attribute Private Object reference (TYPE REF TO) CL_GUI_CONTAINER Abstract Container for GUI Controls 20010319
42 R_PROP_TOOLBAR Instance attribute Private Object reference (TYPE REF TO) CL_GUI_TOOLBAR Toolbar for Edit Functions 20010319
43 R_TITLE Instance attribute Private Object reference (TYPE REF TO) CL_GUI_TEXTEDIT Text Edit for Title 20010318
44 R_TITLE_CONTAINER Instance attribute Private Object reference (TYPE REF TO) CL_GUI_CONTAINER Abstract Container for GUI Controls 20010319
45 R_TOOL_SPLITTER Instance attribute Private Object reference (TYPE REF TO) CL_GUI_SPLITTER_CONTAINER Splitter Control for Tool Area 20010319
Methods
# Method Level Visibility Method type Description Created on
1 BUILD_STATUS_DROPDOWN Instance method Private Method Creates the Status Key Selection List 20050830
2 CHECK_FOR_SIGNATURES Instance method Public Method Checks whether the Document has been Signed 20061208
3 CHECK_MANDATORY_ATTRIBUTES Instance method Public Method Checks whether Required Attributes have Values 20061207
4 COLLAPSE Instance method Private Method Hide Editor 20010319
5 CONSTRUCTOR Instance method Public Constructor Constructor 20010214
6 EXPAND Instance method Private Method Show Editor 20010319
7 FREE_SIGNATURE_POPUP Instance method Protected Method Dismantle Popup 20060626
8 GET_DOC_FROM_EDITOR Instance method Protected Method Fetches Document from Front End 20010220
9 GET_FILE_EXTENSION_FROM_NAME Static method Public Method Gets the File Extension from the File Name 20061115
10 GET_R_DOC_ATTR Instance method Public Method Returns Attribute Object R_DOC_ATTR 20100914
11 GET_TITLE_FROM_CONTROL Instance method Protected Method Fetches Title from Front End 20010318
12 INIT_EXPAND_TOOLBAR Instance method Private Method Create Expand Toolbar 20010319
13 INIT_HEADER_SPLITTER Instance method Private Method Splitting of Header Area 20010320
14 INIT_MAIN_SPLITTER Instance method Private Method Create Horizontal Split of Editor and Header 20010320
15 INIT_PROP_TOOLBAR Instance method Private Method Create Expand Toolbar 20010319
16 ON_FUNCTION_SELECTED Instance method Private Event handling method Event Handler for Toolbar 20010319
17 OPEN_DOCUMENT Instance method Protected Method Uploads Current Document into Editor 20010313
18 REFRESH_STATUS_DROPDOWN Instance method Protected Method Refresh Status Value Selection List in Editor 20050830
19 SET_TITLE_TO_CONTROL Instance method Private Method Puts Title in the Control 20010318
20 SHOW_SIGNATURES_OF_DOCUMENT Instance method Protected Method Show Document Signature 20060626
Events
Class CL_SA_DOC has no event.
Types
Class CL_SA_DOC has no local type.
Method Signatures

Method BUILD_STATUS_DROPDOWN Signature

Method BUILD_STATUS_DROPDOWN on class CL_SA_DOC has no parameter.
# Exception Resumable Description Created on
1 ERROR 20050830

Method CHECK_FOR_SIGNATURES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning SIGNATURES_AVAILABLE Value transfer Type reference (TYPE) FLAG allgemeines flag 20061208

Method CHECK_FOR_SIGNATURES on class CL_SA_DOC has no exception.

Method CHECK_MANDATORY_ATTRIBUTES Signature

Method CHECK_MANDATORY_ATTRIBUTES on class CL_SA_DOC has no parameter.
# Exception Resumable Description Created on
1 VALUE_MISSING 20061207

Method COLLAPSE Signature

Method COLLAPSE on class CL_SA_DOC has no parameter.
Method COLLAPSE on class CL_SA_DOC has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_TOOLBAR_BUTTONS Call by reference Type reference (TYPE) TTB_BUTTON Customer Buttons für Toolbar 20010319
2 Importing IT_TOOLBAR_MENUES Call by reference Type reference (TYPE) TTB_BTNMNU Customer Menüs für Toolbar 20010319
3 Importing I_CALLING_OBJECT Call by reference Object reference (TYPE REF TO) OBJECT Rufendes Objekt 20011127
4 Importing I_DOC_ATTR Call by reference Object reference (TYPE REF TO) IF_SA_IO Attribute zum Dokument im SA 20010214
5 Importing I_PARENT_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER GUI Container für Editor 20010314
6 Importing I_READ_ONLY Call by reference Type reference (TYPE) CHAR1 SPACE Starten im Anzeigemodus 20010215
7 Importing I_SHOW_TOOLBARS Call by reference Type reference (TYPE) CHAR1 SPACE Toolbars im Editor anzeigen 20010314
8 Importing I_WITH_EXPANDER Call by reference Type reference (TYPE) CHAR1 SPACE Mit Expander Funktion 20010320
9 Importing I_WITH_HEADER Call by reference Type reference (TYPE) CHAR1 'X' Aufteilung in Editor und Header 20010320
# Exception Resumable Description Created on
1 CANCELLED User Abbruch 20010214
2 ERROR allg. Fehler 20010214

Method EXPAND Signature

Method EXPAND on class CL_SA_DOC has no parameter.
Method EXPAND on class CL_SA_DOC has no exception.

Method FREE_SIGNATURE_POPUP Signature

Method FREE_SIGNATURE_POPUP on class CL_SA_DOC has no parameter.
Method FREE_SIGNATURE_POPUP on class CL_SA_DOC has no exception.

Method GET_DOC_FROM_EDITOR Signature

Method GET_DOC_FROM_EDITOR on class CL_SA_DOC has no parameter.
# Exception Resumable Description Created on
1 CANCELLED User Abbruch 20010220
2 ERROR allg. Fehler 20010220

Method GET_FILE_EXTENSION_FROM_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning E_FILE_EXTENSION Value transfer Type reference (TYPE) CHAR10 Characterfeld der Länge 10 20061115
2 Importing I_FILE_NAME Call by reference Type reference (TYPE) STRING 20061115

Method GET_FILE_EXTENSION_FROM_NAME on class CL_SA_DOC has no exception.

Method GET_R_DOC_ATTR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning E_R_DOC_ATTR Value transfer Object reference (TYPE REF TO) IF_SA_IO Schnittstelle zu KW Infoobjekt Attributen 20100914

Method GET_R_DOC_ATTR on class CL_SA_DOC has no exception.

Method GET_TITLE_FROM_CONTROL Signature

Method GET_TITLE_FROM_CONTROL on class CL_SA_DOC has no parameter.
Method GET_TITLE_FROM_CONTROL on class CL_SA_DOC has no exception.

Method INIT_EXPAND_TOOLBAR Signature

Method INIT_EXPAND_TOOLBAR on class CL_SA_DOC has no parameter.
# Exception Resumable Description Created on
1 ERROR allg. Fehler 20010319

Method INIT_HEADER_SPLITTER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_PARENT_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER Abstracter Container fuer GUI Controls 20010320
2 Importing I_WITH_EXPANDER Call by reference Type reference (TYPE) CHAR1 Expander Funktion im Header 20010320
# Exception Resumable Description Created on
1 ERROR allg. Fehler 20010320

Method INIT_MAIN_SPLITTER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_EDITOR_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER Container für Editor 20010320
2 Exporting E_HEADER_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER Container für Headerbereich 20010320
3 Importing I_PARENT_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER Abstracter Container fuer GUI Controls 20010320
# Exception Resumable Description Created on
1 ERROR allg. Fehler 20010320

Method INIT_PROP_TOOLBAR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FCODE Call by reference Type reference (TYPE) SYUCOMM Funktionscode 20130225
# Exception Resumable Description Created on
1 ERROR allg. Fehler 20010319

Method ON_FUNCTION_SELECTED Signature

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

Method ON_FUNCTION_SELECTED on class CL_SA_DOC has no exception.

Method OPEN_DOCUMENT Signature

Method OPEN_DOCUMENT on class CL_SA_DOC has no parameter.
# Exception Resumable Description Created on
1 ERROR allg. Fehler 20010313

Method REFRESH_STATUS_DROPDOWN Signature

Method REFRESH_STATUS_DROPDOWN on class CL_SA_DOC has no parameter.
Method REFRESH_STATUS_DROPDOWN on class CL_SA_DOC has no exception.

Method SET_TITLE_TO_CONTROL Signature

Method SET_TITLE_TO_CONTROL on class CL_SA_DOC has no parameter.
Method SET_TITLE_TO_CONTROL on class CL_SA_DOC has no exception.

Method SHOW_SIGNATURES_OF_DOCUMENT Signature

Method SHOW_SIGNATURES_OF_DOCUMENT on class CL_SA_DOC has no parameter.
Method SHOW_SIGNATURES_OF_DOCUMENT on class CL_SA_DOC has no exception.
History
Last changed by/on SAP  20130531 
SAP Release Created in 610