SAP ABAP Class CL_GUI_DOCKING_CONTAINER (Docking Control Container)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-FES-GUI (Application Component) Graphical User Interface
     ⤷ SCET (Package) Control Enabling Technology / Control Framework
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_GUI_CONTAINER Abstract Container for GUI Controls 00000000
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  /ASU/CL_SSM_NAVIGATION_BOX Navigation Docking Container 20080610
2 Inheritance (c INHERITING FROM c_ref)  CL_AST_UI_DOCKING_CNTNR_FAKE Internal Only! Fake of Docking Container For Test Purposes 20071024
3 Inheritance (c INHERITING FROM c_ref)  CL_ISHMED_PDSYS_DT_NAVIGATION Navigation in the Document Category 20001128
4 Inheritance (c INHERITING FROM c_ref)  CL_ISHMED_PDTRANS_DT_NAVIGTION Navigation for Document Category Transfer 20050607
5 Inheritance (c INHERITING FROM c_ref)  CL_ISHMED_RAD_DCONT_DOC_WL IS-H*MED: RAD Docking Container with Document List 20000218
6 Inheritance (c INHERITING FROM c_ref)  CL_WRF_PBAS_DOCKING_CONTAINER Enhanced Docking Container 20040707
Properties
Class CL_GUI_DOCKING_CONTAINER  
Short Description Docking Control Container    
Super Class CL_GUI_CONTAINER Abstract Container for GUI Controls 
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status S  System Program 
Category 0   
Package SCET   Control Enabling Technology / Control Framework 
Created 19981203   SAP 
Last change 20130531   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_GUI_DOCKING_CONTAINER has no forward declaration.
Interfaces
Class CL_GUI_DOCKING_CONTAINER has no interface implemented.
Friends
Class CL_GUI_DOCKING_CONTAINER has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 DOCKING_SIDE Instance attribute Protected Type reference (TYPE) I 0 On Which Side is the Container Docked 19990204
2 DOCK_AT_BOTTOM Constant Public Type reference (TYPE) I 4 Dock Control at Bottom 19981203
3 DOCK_AT_LEFT Constant Public Type reference (TYPE) I 1 Dock Control at Left 19981203
4 DOCK_AT_RIGHT Constant Public Type reference (TYPE) I 8 Dock Control at Right 19981203
5 DOCK_AT_TOP Constant Public Type reference (TYPE) I 2 Dock Control at Top 19981203
6 METRIC_NO_NOTIFY Instance attribute Private Type reference (TYPE) SYCHAR01 INTERNAL USE! 19991220
7 PROPERTY_DOCKING Constant Public Type reference (TYPE) I 470 Docking Property 19981203
8 PROPERTY_FLOATING Constant Public Type reference (TYPE) I 480 Floating Property 19981203
Methods
# Method Level Visibility Method type Description Created on
1 CONSTRUCTOR Instance method Public Constructor Constructor 19981203
2 DOCK_AT Instance method Public Method Dock This Control on Specified Side of Main Window 19981203
3 DOCK_AT_INTERNAL Instance method Private Method Internal use! 19991220
4 FLOAT Instance method Public Method Change the State of Control Between Docking and Floating 19981203
5 GET_DOCKING_SIDE Instance method Public Method Returns Docking Side 19991110
6 GET_EXTENSION Instance method Public Method Get Current Extension 19990217
7 GET_RATIO Instance method Public Method Returns Current Percentage of Current Screen 20000112
8 SET_CAPTION Instance method Public Method Sets a New Caption 19990204
9 SET_EXTENSION Instance method Public Method Sets a New Extension 19990204
10 SET_EXTENSION_INTERNAL Instance method Private Method Internal use! 19991220
11 SET_METRIC_INTERNAL Instance method Private Method Internal use! 19991220
Events
Class CL_GUI_DOCKING_CONTAINER has no event.
Types
Class CL_GUI_DOCKING_CONTAINER has no local type.
Method Signatures

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CAPTION Value transfer Type reference (TYPE) C Caption 19981216
2 Importing DYNNR Value transfer Type reference (TYPE) SYDYNNR Dynpro to which this docking control is linked to 19981203
3 Importing EXTENSION Value transfer Type reference (TYPE) I 50 Extension of this control 19981223
4 Importing LIFETIME Value transfer Type reference (TYPE) I lifetime_default Lifetime 19981215
5 Importing METRIC Value transfer Type reference (TYPE) I 0 Metric 19990204
6 Importing NAME Value transfer Type reference (TYPE) STRING Name 20000112
7 Importing NO_AUTODEF_PROGID_DYNNR Value transfer Type reference (TYPE) C dont autodefine progid and dynnr? 19990325
8 Importing PARENT Value transfer Object reference (TYPE REF TO) CL_GUI_CONTAINER Parent container 19981203
9 Importing RATIO Value transfer Type reference (TYPE) I Prozent des Dynpros: gewinnt gegen EXTENSION 19991220
10 Importing REPID Value transfer Type reference (TYPE) SYREPID Report to which this docking control is linked to 19981203
11 Importing SIDE Value transfer Type reference (TYPE) I DOCK_AT_LEFT Side to which this control is docked to 19981203
12 Importing STYLE Value transfer Type reference (TYPE) I Windows style attributes applied to this docking container 19981203
# Exception Resumable Description Created on
1 CNTL_ERROR Invalid parent control 19981203
2 CNTL_SYSTEM_ERROR System Error 19981203
3 CREATE_ERROR Create Error 19981203
4 LIFETIME_DYNPRO_DYNPRO_LINK LIFETIME_DYNPRO_DYNPRO_LINK 19981203
5 LIFETIME_ERROR Lifetime Error 19981203

Method DOCK_AT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing SIDE Value transfer Type reference (TYPE) I Dock this control at specified side of its parent 19981203
# Exception Resumable Description Created on
1 CNTL_ERROR Invalid Control 19981203
2 CNTL_SYSTEM_ERROR System Error 19981203

Method DOCK_AT_INTERNAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NOTIFY Call by reference Type reference (TYPE) SYCHAR01 'X' Benachrichtigung CFW? 19991220
2 Importing SIDE Value transfer Type reference (TYPE) I Seite 19991220
# Exception Resumable Description Created on
1 CNTL_ERROR Fehler 19991220
2 CNTL_SYSTEM_ERROR System-Fehler 19991220

Method FLOAT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DO_FLOAT Value transfer Type reference (TYPE) I Float or dock this control 19981203
# Exception Resumable Description Created on
1 CNTL_ERROR Invalid Control 19981203
2 CNTL_SYSTEM_ERROR System Error 19981203

Method GET_DOCKING_SIDE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning DOCKING_SIDE Value transfer Type reference (TYPE) I Docking-Seite 19991110
# Exception Resumable Description Created on
1 NOT_DOCKED Container ist nicht gedockt. 19991110

Method GET_EXTENSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EXTENSION Call by reference Type reference (TYPE) I Current Extension 19990217
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990217
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990217

Method GET_RATIO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting RATIO Call by reference Type reference (TYPE) I Der Prozentsatz 20000112
# Exception Resumable Description Created on
1 NOT_AVAILABLE Steht in der aktuellen Situation nicht zur Verfügung 20000112

Method SET_CAPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CAPTION Value transfer Type reference (TYPE) C Sets a new caption 19990204
# Exception Resumable Description Created on
1 CNTL_ERROR cntl_error 19990204
2 CNTL_SYSTEM_ERROR cntl_system_error 19990204

Method SET_EXTENSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EXTENSION Call by reference Type reference (TYPE) I New Extension 19990204
# Exception Resumable Description Created on
1 CNTL_ERROR cntl_err 19990204

Method SET_EXTENSION_INTERNAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EXTENSION Call by reference Type reference (TYPE) I Extension 19991220
2 Importing NOTIFY Call by reference Type reference (TYPE) SYCHAR01 'X' Benachrichtigung von CFW 19991220
# Exception Resumable Description Created on
1 CNTL_ERROR Fehler 19991220

Method SET_METRIC_INTERNAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing METRIC Value transfer Type reference (TYPE) I Metrik 19991220
2 Importing NOTIFY Call by reference Type reference (TYPE) SYCHAR01 'X' Benachrichtigung CFW 19991220
# Exception Resumable Description Created on
1 CNTL_ERROR Fehler 19991220
2 CNTL_SYSTEM_ERROR Fehler 19991220
History
Last changed by/on SAP  20130531 
SAP Release Created in