SAP ABAP Interface IF_WD_COMPONENT (Web Dynpro: Component)
Hierarchy
☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-ABA-RUN (Application Component) Web Dynpro ABAP Runtime
     ⤷ SWDP_RUNTIME_CORE (Package) Web Dynpro Runtime: Core Functions
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_WDR_COMPONENT Base Class of All Web Dynpro Components 20021015
Properties
Interface IF_WD_COMPONENT  
Short Description Web Dynpro: Component    
General Data
Package SWDP_RUNTIME_CORE   Web Dynpro Runtime: Core Functions 
Created 20021015   SAP 
Last changed 20130531   SAP 
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)
2 IF_WD_CONFIG_CONSTANTS Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
3 IF_WD_CONFIG_RUNTIME Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
# Interface Abstract Final Description Created on
1 IF_WD_CONTROLLER Web Dynpro: Controller Interface 20030915
Friends
Interface IF_WD_COMPONENT has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 ASSISTANCE_CLASS Instance attribute Public Object reference (TYPE REF TO) OBJECT Basis for a Web Dynpro assistance class 20060817
2 CO_APP_EXIT_BROWSER_UNLOAD Constant Public Type reference (TYPE) WDR_APPL_EXIT_REASON 'U' Web Dynpro: Reason for Termination of Application 20050119
3 CO_APP_EXIT_SESSION_TIMEOUT Constant Public Type reference (TYPE) WDR_APPL_EXIT_REASON 'T' Web Dynpro: Reason for Termination of Application 20050119
4 CO_APP_EXIT_USER_ABORT Constant Public Type reference (TYPE) WDR_APPL_EXIT_REASON 'A' Web Dynpro: Reason for Termination of Application 20050203
5 ID Instance attribute Public Type reference (TYPE) STRING Unique ID of Component 20030908
6 NAME Instance attribute Public Attribute reference (LIKE) 20030915
Methods
# Method Level Visibility Method type Description Created on
1 ADD_EVENT_HANDLER Instance method Public Method Registers an Event Handler for an Event 20041210
2 CANCEL_NAVIGATION Instance method Public Method Prevents Navigation in Entire Application 20050113
3 CREATE_CMP_USAGE_GROUP Instance method Public Method Creates a Component Usage Group 20041217
4 DELETE_CONFIGURATION Instance method Public Method Obsolete: Use Method from IF_WD_PERSONALIZATION 20050111
5 GET_ACTION Instance method Public Method 20030915
6 GET_APPLICATION Instance method Public Method Returns Reference to Application Object 20050527
7 GET_CMP_USAGE_GROUP Instance method Public Method Returns a Reference to Component Usage Group 20041210
8 GET_COMPONENT Instance method Public Method 20030915
9 GET_COMPONENT_INFO Instance method Public Method Returns Metadata Description of Component 20030823
10 GET_COMPONENT_USAGE Instance method Public Method Returns one component usage of this component 20080725
11 GET_COMPONENT_USAGES Instance method Public Method Returns all component usages of this component 20080725
12 GET_CONFIGURATION_KEY Instance method Public Method Returns Current Configuration Key or Initial 20041209
13 GET_CONTEXT Instance method Public Method 20030915
14 GET_CONTROLLER_INFO Instance method Public Method 20030915
15 GET_ID Instance method Public Method Returns Unique ID of Component 20021015
16 GET_MESSAGE Instance method Public Method 20030915
17 GET_MESSAGE_MANAGER Instance method Public Method 20030915
18 GET_PERSONALIZATION_MANAGER Instance method Public Method Returns Reference to Personalization Manager 20050224
19 GET_PORTAL_MANAGER Instance method Public Method Returns Reference to Portal Manager 20040716
20 GET_SAPGUI_MANAGER Instance method Public Method Returns a reference to the SAPGUI Manager 20050921
21 GET_WINDOW_MANAGER Instance method Public Method Returns a reference to the Window Manager 20030611
22 HAS_CMP_USAGE_GROUP Instance method Public Method Does Component Usage Group Exist? 20050117
23 LOAD_CONFIGURATION_BY_KEY Instance method Public Method Obsolete: Use Method from IF_WD_PERSONALIZATION 20041209
24 REMOVE_CMP_USAGE_GROUP Instance method Public Method Removes a component usage group 20060329
25 REMOVE_EVENT_HANDLER Instance method Public Method Deregisters Event Handler from Event 20041210
26 REMOVE_PENDING_INPUT Instance method Public Method Deletes User Input that Was Not Transferred 20031014
27 SAVE_CONFIGURATION Instance method Public Method Obsolete: Use Method from IF_WD_PERSONALIZATION 20041215
Events
Interface IF_WD_COMPONENT has no event.
Types
Interface IF_WD_COMPONENT has no local type.
Method Signatures

Method ADD_EVENT_HANDLER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTROLLER_NAME Call by reference Type reference (TYPE) STRING Name des Controllers, der das Ereignis auslöst 20041210
2 Importing EVENT_NAME Call by reference Type reference (TYPE) STRING Name des Events 20041210
3 Importing HANDLER_NAME Call by reference Type reference (TYPE) STRING Name des Ereignisbehandlers 20041210
4 Importing LISTENER_NAME Call by reference Type reference (TYPE) STRING Controller des Ereignisbehandlers 20041210

Method ADD_EVENT_HANDLER on Interface IF_WD_COMPONENT has no exception.

Method CANCEL_NAVIGATION Signature

Method CANCEL_NAVIGATION on Interface IF_WD_COMPONENT has no parameter.
Method CANCEL_NAVIGATION on Interface IF_WD_COMPONENT has no exception.

Method CREATE_CMP_USAGE_GROUP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME Value transfer Type reference (TYPE) STRING 20041217
2 Returning RESULT Value transfer Object reference (TYPE REF TO) IF_WD_COMPONENT_USAGE_GROUP Web Dynpro: Gruppe von Component-Verwendungen 20041217
3 Importing USED_COMPONENT Value transfer Type reference (TYPE) STRING 20041217

Method CREATE_CMP_USAGE_GROUP on Interface IF_WD_COMPONENT has no exception.

Method DELETE_CONFIGURATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONFIG_VIEW Call by reference Type reference (TYPE) CSEQUENCE 20050202
2 Importing USER_ROLE Call by reference Type reference (TYPE) WDY_CONF_USER_TYPE IF_WD_CONFIG_CONSTANTS=>C_CONFIG_USER_USER Art der Benutzer-Identifikation 20050111

Method DELETE_CONFIGURATION on Interface IF_WD_COMPONENT has no exception.

Method GET_ACTION Signature

Method GET_ACTION on Interface IF_WD_COMPONENT has no parameter.
Method GET_ACTION on Interface IF_WD_COMPONENT has no exception.

Method GET_APPLICATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Object reference (TYPE REF TO) IF_WD_APPLICATION 20050527

Method GET_APPLICATION on Interface IF_WD_COMPONENT has no exception.

Method GET_CMP_USAGE_GROUP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME Call by reference Type reference (TYPE) STRING 20041210
2 Returning RESULT Value transfer Object reference (TYPE REF TO) IF_WD_COMPONENT_USAGE_GROUP Web Dynpro: Gruppe von Component-Verwendungen 20041210

Method GET_CMP_USAGE_GROUP on Interface IF_WD_COMPONENT has no exception.

Method GET_COMPONENT Signature

Method GET_COMPONENT on Interface IF_WD_COMPONENT has no parameter.
Method GET_COMPONENT on Interface IF_WD_COMPONENT has no exception.

Method GET_COMPONENT_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning COMPONENT_INFO Value transfer Object reference (TYPE REF TO) IF_WD_RR_COMPONENT Metadaten zu dieser Komponente 20030823

Method GET_COMPONENT_INFO on Interface IF_WD_COMPONENT has no exception.

Method GET_COMPONENT_USAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME Call by reference Type reference (TYPE) STRING 20080725
2 Returning RESULT Value transfer Type reference (TYPE) WDAPI_COMPONENT_USAGE Web Dynpro: Component-Verwendung 20080725

Method GET_COMPONENT_USAGE on Interface IF_WD_COMPONENT has no exception.

Method GET_COMPONENT_USAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) WDAPI_COMPONENT_USAGES Web Dynpro: Component-Verwendungen 20080725

Method GET_COMPONENT_USAGES on Interface IF_WD_COMPONENT has no exception.

Method GET_CONFIGURATION_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CONFIG_KEY Value transfer Type reference (TYPE) WDY_CONFIG_KEY Key-Komponenten der Konfigurationstabellen 20041209

Method GET_CONFIGURATION_KEY on Interface IF_WD_COMPONENT has no exception.

Method GET_CONTEXT Signature

Method GET_CONTEXT on Interface IF_WD_COMPONENT has no parameter.
Method GET_CONTEXT on Interface IF_WD_COMPONENT has no exception.

Method GET_CONTROLLER_INFO Signature

Method GET_CONTROLLER_INFO on Interface IF_WD_COMPONENT has no parameter.
Method GET_CONTROLLER_INFO on Interface IF_WD_COMPONENT has no exception.

Method GET_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RET Value transfer Type reference (TYPE) STRING Eindeutige ID der Komponente 20021015

Method GET_ID on Interface IF_WD_COMPONENT has no exception.

Method GET_MESSAGE Signature

Method GET_MESSAGE on Interface IF_WD_COMPONENT has no parameter.
Method GET_MESSAGE on Interface IF_WD_COMPONENT has no exception.

Method GET_MESSAGE_MANAGER Signature

Method GET_MESSAGE_MANAGER on Interface IF_WD_COMPONENT has no parameter.
Method GET_MESSAGE_MANAGER on Interface IF_WD_COMPONENT has no exception.

Method GET_PERSONALIZATION_MANAGER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PERS_MANAGER Value transfer Object reference (TYPE REF TO) IF_WD_PERSONALIZATION Web Dynpro Personalisierungs-Interface 20050224

Method GET_PERSONALIZATION_MANAGER on Interface IF_WD_COMPONENT has no exception.

Method GET_PORTAL_MANAGER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Object reference (TYPE REF TO) IF_WD_PORTAL_INTEGRATION WebDynpro: Portal Integration 20040716

Method GET_PORTAL_MANAGER on Interface IF_WD_COMPONENT has no exception.

Method GET_SAPGUI_MANAGER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Object reference (TYPE REF TO) CL_WDR_SAPGUI_INTEGRATION2 WebDynpro Runtime: SAPGUI Integration 20050921

Method GET_SAPGUI_MANAGER on Interface IF_WD_COMPONENT has no exception.

Method GET_WINDOW_MANAGER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning WINDOW_MANAGER Value transfer Object reference (TYPE REF TO) IF_WD_WINDOW_MANAGER Referenz auf Window-Manager 20030611

Method GET_WINDOW_MANAGER on Interface IF_WD_COMPONENT has no exception.

Method HAS_CMP_USAGE_GROUP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME Call by reference Type reference (TYPE) STRING 20050117
2 Returning RESULT Value transfer Type reference (TYPE) ABAP_BOOL 20050117

Method HAS_CMP_USAGE_GROUP on Interface IF_WD_COMPONENT has no exception.

Method LOAD_CONFIGURATION_BY_KEY 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 Key-Komponenten der Konfigurationstabellen 20041209
2 Importing CONFIG_VIEW Call by reference Type reference (TYPE) CSEQUENCE 20050201

Method LOAD_CONFIGURATION_BY_KEY on Interface IF_WD_COMPONENT has no exception.

Method REMOVE_CMP_USAGE_GROUP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME Call by reference Type reference (TYPE) STRING 20060329

Method REMOVE_CMP_USAGE_GROUP on Interface IF_WD_COMPONENT has no exception.

Method REMOVE_EVENT_HANDLER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTROLLER_NAME Call by reference Type reference (TYPE) STRING Name des Controllers, der das Ereignis auslöst 20041210
2 Importing EVENT_NAME Call by reference Type reference (TYPE) STRING Name des Ereignisses 20041210
3 Importing HANDLER_NAME Call by reference Type reference (TYPE) STRING Name des Ereignisbehandlers 20041210
4 Importing LISTENER_NAME Call by reference Type reference (TYPE) STRING Controller des Ereignisbehandlers 20041210

Method REMOVE_EVENT_HANDLER on Interface IF_WD_COMPONENT has no exception.

Method REMOVE_PENDING_INPUT Signature

Method REMOVE_PENDING_INPUT on Interface IF_WD_COMPONENT has no parameter.
Method REMOVE_PENDING_INPUT on Interface IF_WD_COMPONENT has no exception.

Method SAVE_CONFIGURATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONFIG_VIEW Call by reference Type reference (TYPE) CSEQUENCE View-Name 20050202
2 Importing USER_ROLE Call by reference Type reference (TYPE) WDY_CONF_USER_TYPE IF_WD_CONFIG_CONSTANTS=>C_CONFIG_USER_USER Art der Benutzer-Identifikation 20041215

Method SAVE_CONFIGURATION on Interface IF_WD_COMPONENT has no exception.
History
Last changed by/on SAP  20130531 
SAP Release Created in 640