SAP ABAP Class CL_WDR_SIDE_PANEL_INTEGRATION (Side Panel Integration in WD ABAP)
Hierarchy
☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-ABA (Application Component) Web Dynpro ABAP
     ⤷ SWDP_RUNTIME_SERVICES (Package) Web Dynpro: Additional Services of Web Dynpro Runtime
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_WD_SIDE_PANEL_API WD: Side Panel API 20081113
2 Interface implementation (CLASS c. INTERFACES i_ref)  IF_WDR_PHASE_MODEL_SERVICE Interface for Phase Model Services 20090121
3 Interface implementation (CLASS c. INTERFACES i_ref)  IF_WDR_SERVICE Interface for Runtime Services 20090121
4 Interface implementation (CLASS c. INTERFACES i_ref)  IF_WDR_SIDE_PANEL_IMPL_API Side Panel: API for Side Panel Implementation 20090121
5 Interface implementation (CLASS c. INTERFACES i_ref)  IF_WD_SIDE_PANEL_API API for Using Side Panel 20081113
Properties
Class CL_WDR_SIDE_PANEL_INTEGRATION  
Short Description Side Panel Integration in WD ABAP    
Super Class CL_WD_SIDE_PANEL_API WD: Side Panel API 
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SWDP_RUNTIME_SERVICES   Web Dynpro: Additional Services of Web Dynpro Runtime 
Created 20081113   SAP 
Last change 20130531   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
# Interface Abstract Final Description Created on
1 IF_WDR_PHASE_MODEL_SERVICE Interface for Phase Model Services 20090121
2 IF_WDR_SERVICE Interface for Runtime Services 20090121
3 IF_WDR_SIDE_PANEL_IMPL_API Side Panel: API for Side Panel Implementation 20090121
4 IF_WD_SIDE_PANEL_API API for Using Side Panel 20081113
Friends
Class CL_WDR_SIDE_PANEL_INTEGRATION has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 C_APP_PROPERTY Constant Private See coding 20090127
2 C_CONFIG_ID_DEFAULT Constant Public Type reference (TYPE) WDY_CONFIG_ID '***DEFAULT***' Configuration Identification 20090119
3 C_CONFIG_ID_SETTINGS Constant Public Type reference (TYPE) WDY_CONFIG_ID '***SETTINGS***' Configuration Identification 20090119
4 C_SIDE_PANEL_COMPONENT Constant Public Type reference (TYPE) STRING 'WDR_CHIP_PAGE' 20081117
5 C_SIDE_PANEL_DEFAULT_WIDTH Constant Private Type reference (TYPE) I 300 20090327
6 C_SIDE_PANEL_IF_VIEW Constant Public Type reference (TYPE) STRING 'W_SIDE_PANEL' 20081209
7 C_SIDE_PANEL_LINK_ID Constant Public Type reference (TYPE) STRING 'WD__SIDE_PANEL_LINK' 20081113
8 C_SIDE_PANEL_RT_NAME Constant Public Type reference (TYPE) STRING 'WD__SIDE_PANEL' 20081113
9 E_SIDE_PANEL_MODE Constant Public See coding 20081218
10 M_ALLOW_SIDE_PANEL_CONFIG Instance attribute Private Type reference (TYPE) ABAP_BOOL 20090115
11 M_APPLICATION_NAME Instance attribute Private Type reference (TYPE) STRING 20081117
12 M_APPLY_CONFIGURATION Instance attribute Private Type reference (TYPE) ABAP_BOOL 20090115
13 M_APPL_PERS_HANDLER Instance attribute Private Object reference (TYPE REF TO) IF_WD_CFG_APPLICATION Application Configuration at Runtime 20090209
14 M_ASY_IS_OPEN Instance attribute Private Type reference (TYPE) ABAP_BOOL 20111123
15 M_AUTO_REFRESH Instance attribute Private Type reference (TYPE) ABAP_BOOL 20090121
16 M_CONFIG Instance attribute Private Type reference (TYPE) T_CONFIG 20081218
17 M_CONFIG_MODE Instance attribute Public Type reference (TYPE) ABAP_BOOL 20081126
18 M_CURRENT_PERS_SCOPE Instance attribute Private Type reference (TYPE) WDR_PERS_SCOPE Web Dynpro: Personalization Range 20081219
19 M_DOCKING_WINDOW Instance attribute Private Object reference (TYPE REF TO) IF_WD_WINDOW 20081120
20 M_EXT_SIDE_PANEL_CONFIG_ID Instance attribute Private Type reference (TYPE) WDY_CONFIG_ID Key Components of Configuration Tables 20090116
21 M_HAS_SIDE_PANEL Instance attribute Public Type reference (TYPE) ABAP_BOOL 20081117
22 M_INITIALIZED Instance attribute Private Type reference (TYPE) ABAP_BOOL 20090123
23 M_INSTANCE Static Attribute Public Object reference (TYPE REF TO) CL_WDR_SIDE_PANEL_INTEGRATION Side Panel Integration in WD ABAP 20090117
24 M_LINK_TEXT Instance attribute Private Type reference (TYPE) STRING 20090305
25 M_LINK_TEXT_CONFIG_MODE Instance attribute Private Type reference (TYPE) STRING 20090305
26 M_OPEN_ACTION_NAME Instance attribute Private Type reference (TYPE) STRING 20090121
27 M_PAGE_HEADER_VIEW_CONTROLLER Instance attribute Private Object reference (TYPE REF TO) IF_WD_VIEW_CONTROLLER Web Dynpro: View Controller 20090121
28 M_PHASE_MODEL Instance attribute Private Object reference (TYPE REF TO) CL_WDR_SIDE_PANEL_PHASE_MODEL WDR Side Panel Phase Model 20090902
29 M_REFRESH_TRIGGERED Instance attribute Private Type reference (TYPE) ABAP_BOOL 20090121
30 M_RESET_ENABLED Instance attribute Public Type reference (TYPE) ABAP_BOOL 20090127
31 M_RESIZABLE Instance attribute Public Attribute reference (LIKE) 20090820
32 M_ROOT_COMPONENT Instance attribute Private Object reference (TYPE REF TO) IF_WD_COMPONENT Web Dynpro: Component 20081218
33 M_SAVE_ENABLED Instance attribute Public Type reference (TYPE) ABAP_BOOL 20090401
34 M_SIDE_PANEL_STACK Instance attribute Private Type reference (TYPE) T_SIDE_PANEL_STACK 20090117
35 M_WIDTH Instance attribute Public Attribute reference (LIKE) 20090820
36 M_WIDTH_DEFINED Instance attribute Private Type reference (TYPE) ABAP_BOOL 20090327
Methods
# Method Level Visibility Method type Description Created on
1 CLOSE Instance method Public Method 20090117
2 CONSTRUCTOR Instance method Public Constructor 20090117
3 CREATE_SIDE_PANEL_LINK Instance method Private Method 20090121
4 DESTROY_SIDE_PANEL Instance method Private Method 20081113
5 FETCH_NEED_REFRESH Instance method Private Method Retrieve and reset info about whether refresh is necessary 20090902
6 GET_APPLICATION_PROPERTY Static method Public Method 20110718
7 GET_CONFIG Instance method Public Method 20081218
8 GET_CURRENT_SCOPE_TEXT Instance method Public Method 20081219
9 GET_SAVED_CONFIG_SCOPE Instance method Public Method 20081218
10 GET_SAVED_CONFIG_SCOPE_TEXT Instance method Public Method 20081219
11 GET_SETTINGS_PROMPT_TEXT Instance method Public Method 20090119
12 HANDLE_PM_NAVIGATION Instance method Private Event handling method 20090902
13 INIT_SIDE_PANEL Instance method Private Method 20090115
14 INSTANTIATE_SIDE_PANEL Instance method Private Method 20081113
15 ON_SAVE_CANCELLED Instance method Private Event handling method 20090211
16 ON_SAVE_OK Instance method Private Event handling method 20090211
17 OPEN_ASYNC Instance method Private Method Initializes the side panel for the application 20111123
18 OPEN_HELP_CENTER Static method Public Method 20090120
19 OPEN_HELP_CENTER_CALLBACK Instance method Private Event handling method 20090520
20 READ_CONFIG Instance method Private Method 20090311
21 RESET_CONFIG Instance method Public Method 20090401
22 SAVE_CONFIG Instance method Public Method 20081218
23 SET_CONFIG Instance method Public Method 20081218
24 SET_SIDE_PANEL_LINK_TEXT Instance method Private Method 20081117
25 SET_WIDTH Instance method Public Method 20090121
Events
# Event Type Visibility Description Created on
1 API_EXIT Instance Event
(0) 		Public
(2) 		20120131
2 API_INIT Instance Event
(0) 		Public
(2) 		20120131
3 API_OPEN Instance Event
(0) 		Public
(2) 		20120131
4 API_SET_AUTO_REFRESH Instance Event
(0) 		Public
(2) 		20120131
5 API_TRIGGER_REFRESH Instance Event
(0) 		Public
(2) 		20120131
6 OPEN_REQUESTED Static Event
(1) 		Public
(2) 		User has clicked on "Open" 20090117
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 T_CONFIG Private Type reference (TYPE) WDR_SIDE_PANEL_CONFIG 20090127
2 T_SIDE_PANEL_STACK Private See coding 20090117 t_side_panel_stack type standard table of wdy_config_key with default key
Method Signatures

Method CLOSE Signature

Method CLOSE on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
Method CLOSE on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
Method CONSTRUCTOR on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method CREATE_SIDE_PANEL_LINK Signature

Method CREATE_SIDE_PANEL_LINK on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
Method CREATE_SIDE_PANEL_LINK on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method DESTROY_SIDE_PANEL Signature

Method DESTROY_SIDE_PANEL on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
Method DESTROY_SIDE_PANEL on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method FETCH_NEED_REFRESH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning NEED_REFRESH Value transfer Type reference (TYPE) ABAP_BOOL 20090902

Method FETCH_NEED_REFRESH on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method GET_APPLICATION_PROPERTY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PROPERTY_NAME Call by reference Type reference (TYPE) STRING 20110718
2 Returning PROPERTY_VALUE Value transfer Type reference (TYPE) STRING 20110718

Method GET_APPLICATION_PROPERTY on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method GET_CONFIG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CONFIG Value transfer Type reference (TYPE) WDR_SIDE_PANEL_CONFIG Konfiguration des Side-Panels 20081218

Method GET_CONFIG on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method GET_CURRENT_SCOPE_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing SHORT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20081219
2 Returning TEXT Value transfer Type reference (TYPE) STRING 20081219

Method GET_CURRENT_SCOPE_TEXT on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method GET_SAVED_CONFIG_SCOPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PERS_SCOPE Value transfer Type reference (TYPE) WDR_PERS_SCOPE Web Dynpro: Personalisierungsreichweite 20081218

Method GET_SAVED_CONFIG_SCOPE on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method GET_SAVED_CONFIG_SCOPE_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning TEXT Value transfer Type reference (TYPE) STRING 20081219

Method GET_SAVED_CONFIG_SCOPE_TEXT on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method GET_SETTINGS_PROMPT_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing SHORT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20090119
2 Returning TEXT Value transfer Type reference (TYPE) STRING 20090119

Method GET_SETTINGS_PROMPT_TEXT on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method HANDLE_PM_NAVIGATION Signature

Method HANDLE_PM_NAVIGATION on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
Method HANDLE_PM_NAVIGATION on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method INIT_SIDE_PANEL Signature

Method INIT_SIDE_PANEL on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
Method INIT_SIDE_PANEL on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method INSTANTIATE_SIDE_PANEL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONFIG_KEY Call by reference Type reference (TYPE) WDY_CONFIG_KEY Konfigurations-Identifikation 20090117

Method INSTANTIATE_SIDE_PANEL on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method ON_SAVE_CANCELLED Signature

Method ON_SAVE_CANCELLED on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
Method ON_SAVE_CANCELLED on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method ON_SAVE_OK Signature

Method ON_SAVE_OK on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
Method ON_SAVE_OK on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method OPEN_ASYNC Signature

Method OPEN_ASYNC on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
Method OPEN_ASYNC on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method OPEN_HELP_CENTER Signature

Method OPEN_HELP_CENTER on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
Method OPEN_HELP_CENTER on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method OPEN_HELP_CENTER_CALLBACK Signature

Method OPEN_HELP_CENTER_CALLBACK on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
Method OPEN_HELP_CENTER_CALLBACK on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method READ_CONFIG Signature

Method READ_CONFIG on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
Method READ_CONFIG on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method RESET_CONFIG Signature

Method RESET_CONFIG on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
Method RESET_CONFIG on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method SAVE_CONFIG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NO_SAVE_TO_DATABASE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20090602

Method SAVE_CONFIG on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method SET_CONFIG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONFIG Call by reference Type reference (TYPE) WDR_SIDE_PANEL_CONFIG Konfiguration des Side-Panels 20081218

Method SET_CONFIG on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method SET_SIDE_PANEL_LINK_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing LINK Call by reference Object reference (TYPE REF TO) CL_WD_LINK_TO_ACTION 20090121

Method SET_SIDE_PANEL_LINK_TEXT on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.

Method SET_WIDTH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing WIDTH Call by reference Type reference (TYPE) I 20090121

Method SET_WIDTH on class CL_WDR_SIDE_PANEL_INTEGRATION has no exception.
Event Signatures

Event API_EXIT Signature
Event API_EXIT on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
Event API_INIT Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 ALLOW_SIDE_PANEL_CONFIG Exporting Value transfer Type reference (TYPE) ABAP_BOOL 20120131
2 APPLY_CONFIGURATION Exporting Value transfer Type reference (TYPE) ABAP_BOOL 20120131
3 AUTO_REFRESH Exporting Value transfer Type reference (TYPE) ABAP_BOOL 20120131
4 IS_OPEN Exporting Value transfer Type reference (TYPE) ABAP_BOOL 20120131
5 LINK_TEXT Exporting Value transfer Type reference (TYPE) STRING 20120131
6 LINK_TEXT_CONFIG_MODE Exporting Value transfer Type reference (TYPE) STRING 20120131
7 OPEN_ACTION_NAME Exporting Value transfer Type reference (TYPE) STRING 20120131
8 SIDE_PANEL_CONFIG_ID Exporting Value transfer Type reference (TYPE) WDY_CONFIG_ID Konfigurations-Identifikation 20120131
9 VIEW_CONTROLLER Exporting Value transfer Object reference (TYPE REF TO) IF_WD_VIEW_CONTROLLER Web Dynpro: View Controller 20120131
10 WIDTH Exporting Value transfer Type reference (TYPE) I 20120131

Event API_OPEN Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 SIDE_PANEL_CONFIG_ID Exporting Value transfer Type reference (TYPE) WDY_CONFIG_ID Konfigurations-Identifikation 20120131

Event API_SET_AUTO_REFRESH Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 AUTO_REFRESH Exporting Value transfer Type reference (TYPE) ABAP_BOOL 20120131

Event API_TRIGGER_REFRESH Signature
Event API_TRIGGER_REFRESH on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
Event OPEN_REQUESTED Signature
Event OPEN_REQUESTED on class CL_WDR_SIDE_PANEL_INTEGRATION has no parameter.
History
Last changed by/on SAP  20130531 
SAP Release Created in 720