SAP CL_BSP_WD_VIEW_CONTROLLER OO Class - Basis Class for WD View Controller
CL_BSP_WD_VIEW_CONTROLLER is a standard SAP object class available within R/3 SAP systems depending on your version and release level. You can view/maintain the class details by entering its name into the relevant SAP transactions such as SE24, SE80 or even SE84. Below is the documentation available for class CL_BSP_WD_VIEW_CONTROLLER including details of:
- Interface class implementations
- Inheritance details
- Methods defined within class ( including link to full details )
- Attributes ( including initial values )
- Class Events
Inheritance
This OO class has a superclass assigned to it, which means it will inherit its objects and methods. The superclass for CL_BSP_WD_VIEW_CONTROLLER is CL_BSP_WD_CONTROLLERInterface Implementation
This OO class is an Interface Implementation, which means it will implement its own version of the methods from implementation class IF_BSP_WD_HISTORY_STATE_DESCRInterface Implementation
This OO class is an Interface Implementation, which means it will implement its own version of the methods from implementation class IF_BSP_WD_STATE_CONTEXTInterface Implementation
This OO class is an Interface Implementation, which means it will implement its own version of the methods from implementation class IF_BSP_WD_CONFIG_STYLEMethod list of CL_BSP_WD_VIEW_CONTROLLER SAP class
A method is a coding block that performs a certain procedure (i.e. ABAP functionality) on an object within the overall SAP class. In simple terms if the object is an SAP database table a method could be the procedure to add a record or to delete a record. If you are new to OO in many respects, the implementation of a method is similar to a function module and can be called in a very similar way using CALL METHOD.
Instead of "CALL FUNCTION", Methods are referenced using the following syntax: CALL METHOD =>methodname EXPORTING/IMPORTING...
| Method Name | Description | Visability |
| ADAPT_UI | Call Config Popup for Create Group & Add/Remove Cust Fields | Private |
| CALL METHOD cl_bsp_wd_view_controller=>ADAPT_UI...more details | ||
| BIND_VIEW | Binds a View to a View Area | Public |
| CALL METHOD cl_bsp_wd_view_controller=>BIND_VIEW...more details | ||
| CALCULATE_CONTROLLER_ID | Generates New Controller ID | Public |
| CALL METHOD cl_bsp_wd_view_controller=>CALCULATE_CONTROLLER_ID...more details | ||
| CFG_BUTTONS_IS_ACTIVE | Redefinition of this method allows to disable button config. | Public |
| CALL METHOD cl_bsp_wd_view_controller=>CFG_BUTTONS_IS_ACTIVE...more details | ||
| CFG_BUTTONS_MODIFY | Modify list of configured buttons | Public |
| CALL METHOD cl_bsp_wd_view_controller=>CFG_BUTTONS_MODIFY...more details | ||
| CFG_NUM_VISIBLE_BUTTONS_MODIFY | Override the configured max button number | Public |
| CALL METHOD cl_bsp_wd_view_controller=>CFG_NUM_VISIBLE_BUTTONS_MODIFY...more details | ||
|
| ||
| CHECK_CNTR_INST_ARE_UNIQUE | Check for ASSERT | Private |
| CALL METHOD cl_bsp_wd_view_controller=>CHECK_CNTR_INST_ARE_UNIQUE...more details | ||
| CLEAR_OLD_AJAX_AREA_CONTENT | Protected | |
| CALL METHOD cl_bsp_wd_view_controller=>CLEAR_OLD_AJAX_AREA_CONTENT...more details | ||
| COPY_CONFIG_KEYS_FROM_PARENT | Copy Configuration Key of Higher-Level View If Set | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>COPY_CONFIG_KEYS_FROM_PARENT...more details | ||
| DISABLE_VIEW_GROUP_CONTEXT | Sets State of View Group Context on Controller Deactivation | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>DISABLE_VIEW_GROUP_CONTEXT...more details | ||
| DO_BEFORE_CONTENT_CHANGE | Protected | |
| CALL METHOD cl_bsp_wd_view_controller=>DO_BEFORE_CONTENT_CHANGE...more details | ||
| DO_BEFORE_VA_REOCCUPATION | Protected | |
| CALL METHOD cl_bsp_wd_view_controller=>DO_BEFORE_VA_REOCCUPATION...more details | ||
| DO_CONFIG_DETERMINATION | Redefine Optional: Set Configuration Key | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>DO_CONFIG_DETERMINATION...more details | ||
| DO_PREPARE_OUTPUT | Optional Redefinition: Output Preparation | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>DO_PREPARE_OUTPUT...more details | ||
| DO_REPLACE_INITIAL_VIEW | Redefine Optional: Replace Initial View of View Area | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>DO_REPLACE_INITIAL_VIEW...more details | ||
| DO_SERVICE_REQUEST | Public | |
| CALL METHOD cl_bsp_wd_view_controller=>DO_SERVICE_REQUEST...more details | ||
| DO_VALIDATE_INPUT | Optional Redefinition: Input Data Check | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>DO_VALIDATE_INPUT...more details | ||
| DO_VIEW_INIT_ON_ACTIVATION | Redefine Optional: Prepare Controller After (Re)activation | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>DO_VIEW_INIT_ON_ACTIVATION...more details | ||
| DO_VIEW_INIT_ON_RESTORE | Redefine Optional: Prepare Controller After Restore f. Hist. | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>DO_VIEW_INIT_ON_RESTORE...more details | ||
| GET_CHILDREN | Returns All View Areas with Current Values | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>GET_CHILDREN...more details | ||
| GET_DELTA_HANDLING_BEHAVIOUR | Protected | |
| CALL METHOD cl_bsp_wd_view_controller=>GET_DELTA_HANDLING_BEHAVIOUR...more details | ||
| GET_EMPTY_MANDATORY_FIELDS | Protected | |
| CALL METHOD cl_bsp_wd_view_controller=>GET_EMPTY_MANDATORY_FIELDS...more details | ||
| GET_ERROR_STATE | Returns the Error State of the Controller | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>GET_ERROR_STATE...more details | ||
| GET_FLP_INTENT | Get FLP Intent | Public |
| CALL METHOD cl_bsp_wd_view_controller=>GET_FLP_INTENT...more details | ||
| GET_HELP_ID | Returns ID for Help (ABAP Class Name) | Public |
| CALL METHOD cl_bsp_wd_view_controller=>GET_HELP_ID...more details | ||
| GET_MODELS_RECURSIVELY | Get models for the current (sub)controller | Private |
| CALL METHOD cl_bsp_wd_view_controller=>GET_MODELS_RECURSIVELY...more details | ||
| GET_OLD_SCROLL_HEIGHT | Returns the Previous Scroll Height of View Area | Public |
| CALL METHOD cl_bsp_wd_view_controller=>GET_OLD_SCROLL_HEIGHT...more details | ||
| GET_PERS_SAVED | Get Personalization saved flag. Clears out pers saved. | Public |
| CALL METHOD cl_bsp_wd_view_controller=>GET_PERS_SAVED...more details | ||
| GET_REPOSITORY_VIEW | Protected | |
| CALL METHOD cl_bsp_wd_view_controller=>GET_REPOSITORY_VIEW...more details | ||
| GET_SCROLL_POSITION_X | Returns the Horizontal Scroll Position | Public |
| CALL METHOD cl_bsp_wd_view_controller=>GET_SCROLL_POSITION_X...more details | ||
| GET_SCROLL_POSITION_Y | Returns the Vertical Scroll Position | Public |
| CALL METHOD cl_bsp_wd_view_controller=>GET_SCROLL_POSITION_Y...more details | ||
| GET_SUBCONTROLLER_BY_VIEWNAME | Uses View Name To Determine Current Given Sub-Controller | Public |
| CALL METHOD cl_bsp_wd_view_controller=>GET_SUBCONTROLLER_BY_VIEWNAME...more details | ||
| GET_VIEWAREA_CONTENT | Returns Name of the Current View for a View Area | Public |
| CALL METHOD cl_bsp_wd_view_controller=>GET_VIEWAREA_CONTENT...more details | ||
| GET_VIEWAREA_CONTENT_ID | Returns the Current Assigned View Controller for View Area | Public |
| CALL METHOD cl_bsp_wd_view_controller=>GET_VIEWAREA_CONTENT_ID...more details | ||
| GET_VIEWAREA_CONTENT_URL | Returns URL of Current Assigned View Controllr for View Area | Public |
| CALL METHOD cl_bsp_wd_view_controller=>GET_VIEWAREA_CONTENT_URL...more details | ||
| GET_VIEW_ID | Returns the current assigned 'view_id' | Public |
| CALL METHOD cl_bsp_wd_view_controller=>GET_VIEW_ID...more details | ||
| HANDLE_ASCBO_EVENT | Handle association BO event | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>HANDLE_ASCBO_EVENT...more details | ||
| HANDLE_ASCBO_EVENT_WRAPPER | Protected | |
| CALL METHOD cl_bsp_wd_view_controller=>HANDLE_ASCBO_EVENT_WRAPPER...more details | ||
| HANDLE_EVENT_ASSERT | Assertion for Handle Event | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>HANDLE_EVENT_ASSERT...more details | ||
| HANDLE_EXT_EVENT | Handle extensibility event | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>HANDLE_EXT_EVENT...more details | ||
| HANDLE_TABLE_VIEW_SWITCH_EVENT | Handle Table View Switch event | Private |
| CALL METHOD cl_bsp_wd_view_controller=>HANDLE_TABLE_VIEW_SWITCH_EVENT...more details | ||
| INSTANT_GET | Public | |
| CALL METHOD cl_bsp_wd_view_controller=>INSTANT_GET...more details | ||
| IP_ERROR_NAVIGATION | Special Inbound Plug for Error Navigation | Public |
| CALL METHOD cl_bsp_wd_view_controller=>IP_ERROR_NAVIGATION...more details | ||
| IS_DELTA_HANDLING_ENABLED | Does the View Permit Automatic Delta Handling? | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>IS_DELTA_HANDLING_ENABLED...more details | ||
| IS_FIRST_RENDERING | Returns the FIRST_RENDERING_AFTER_ACTIVATE flag | Public |
| CALL METHOD cl_bsp_wd_view_controller=>IS_FIRST_RENDERING...more details | ||
| IS_ON_OVERVIEW_PAGE | Public | |
| CALL METHOD cl_bsp_wd_view_controller=>IS_ON_OVERVIEW_PAGE...more details | ||
| IS_RESTORE_POSSIBLE | Checks, whether a BreadCrumb Restore is possible or not | Public |
| CALL METHOD cl_bsp_wd_view_controller=>IS_RESTORE_POSSIBLE...more details | ||
| LOAD_VIEW_4_VIEWAREA | Protected | |
| CALL METHOD cl_bsp_wd_view_controller=>LOAD_VIEW_4_VIEWAREA...more details | ||
| ON_VIEW_RENDERED | Private | |
| CALL METHOD cl_bsp_wd_view_controller=>ON_VIEW_RENDERED...more details | ||
| OPEN_MASS_TAGS_POPUP | Opens a mass tag popup from a search result list | Public |
| CALL METHOD cl_bsp_wd_view_controller=>OPEN_MASS_TAGS_POPUP...more details | ||
| OPEN_MASS_TAGS_POPUP_MIXED | Opens a mass tag popup from a mixed list | Public |
| CALL METHOD cl_bsp_wd_view_controller=>OPEN_MASS_TAGS_POPUP_MIXED...more details | ||
| OPEN_PERSONALIZATION_POPUP | Public | |
| CALL METHOD cl_bsp_wd_view_controller=>OPEN_PERSONALIZATION_POPUP...more details | ||
| OP_DEFAULT_BACK | Framework-Controlled BACK Navigation | Public |
| CALL METHOD cl_bsp_wd_view_controller=>OP_DEFAULT_BACK...more details | ||
| POST_MANDATORY_FIELD | Tag library may post mandatory fields to controller | Public |
| CALL METHOD cl_bsp_wd_view_controller=>POST_MANDATORY_FIELD...more details | ||
| PROCESS_VIEW | Private | |
| CALL METHOD cl_bsp_wd_view_controller=>PROCESS_VIEW...more details | ||
| RETRIEVE_AJAX_AREA_CONTENT | Public | |
| CALL METHOD cl_bsp_wd_view_controller=>RETRIEVE_AJAX_AREA_CONTENT...more details | ||
| SAVE_AJAX_AREA_CONTENT | Public | |
| CALL METHOD cl_bsp_wd_view_controller=>SAVE_AJAX_AREA_CONTENT...more details | ||
| SET_CONFIG_KEYS | Sets Changeable Configuration Keys | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>SET_CONFIG_KEYS...more details | ||
| SET_CONFIG_KEYS_4_CHILDREN | Sets Changeable Configuration Keys of Dependent View | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>SET_CONFIG_KEYS_4_CHILDREN...more details | ||
| SET_ERROR_STATE | Shifts Controller in Error State | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>SET_ERROR_STATE...more details | ||
| SET_MODELS | Sets Context Nodes as Page Attributes on Layout | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>SET_MODELS...more details | ||
| SET_OLD_SCROLL_HEIGHT | Set the Previous Scroll Height of View Area | Public |
| CALL METHOD cl_bsp_wd_view_controller=>SET_OLD_SCROLL_HEIGHT...more details | ||
| SET_PERS_SAVED | Set the personalization saved flag. | Public |
| CALL METHOD cl_bsp_wd_view_controller=>SET_PERS_SAVED...more details | ||
| SET_SCROLL_POSITION | Sets the Vertical and Horizontal Scroll Position | Public |
| CALL METHOD cl_bsp_wd_view_controller=>SET_SCROLL_POSITION...more details | ||
| SET_VIEW_GROUP_CONTEXT | Protected | |
| CALL METHOD cl_bsp_wd_view_controller=>SET_VIEW_GROUP_CONTEXT...more details | ||
| SET_ZERO_INITIAL_DATA_TYPES | Sets the data types which zero is considered as initial. | Protected |
| CALL METHOD cl_bsp_wd_view_controller=>SET_ZERO_INITIAL_DATA_TYPES...more details | ||
| UNBIND_VIEW | Removes a bound View from a View Area | Public |
| CALL METHOD cl_bsp_wd_view_controller=>UNBIND_VIEW...more details | ||
| WD_VIEW_INITIALIZE | Initializes BSP WD View | Public |
| CALL METHOD cl_bsp_wd_view_controller=>WD_VIEW_INITIALIZE...more details | ||
CL_BSP_WD_VIEW_CONTROLLER attributes
List of attributes within class CL_ABAP_CHAR_UTILITIES. These can be referenced using the following syntax CL_ABAP_CHAR_UTILITIES=>. Although depending on where you are inserting the ABAP code you do need to check if the attribute is public or private.
| Name | Level | Description | Initial Value | Type | Visability |
| ADH_FRAME_MODE_CHECKED | Static Attribute | Checked for ADH test frame mode | LIKE ABAP_BOOL | Protected | |
| ADH_FRAME_MODE_ENABLED | Static Attribute | ADH test frame mode is enabled | LIKE ABAP_BOOL | Protected | |
| AJAX_AREA_CONTENT_TAB | Instance Attribute | LIKE GTYPE_AJAX_AREA_CONTENT_TAB | Private | ||
| AJAX_AUTO_ENABLED | Instance Attribute | ABAP_TRUE | LIKE ABAP_BOOL | Private | |
| AJAX_CASCADE_MODE | Instance Attribute | LIKE STRING | Private | ||
| CONFIGURATION_DESCR | Instance Attribute | LIKE IF_BSP_DLC_CONFIGURATION | Public | ||
| CONFIG_KEYS_4_CHILDREN | Instance Attribute | LIKE LTYPE_CONFIG_KEYS | Private | ||
| CO_ADH_DISABLED | Constant | Automatic Delta Handling Not Permitted | SPACE | LIKE BSPWD_ADH_DH_TYPE | Public |
| CO_ADH_ENABLED | Constant | Automatic Delta Handling Permitted | 'E' | LIKE BSPWD_ADH_DH_TYPE | Public |
| CO_ADH_UNDEFINED | Constant | '/' | LIKE BSPWD_ADH_DH_TYPE | Private | |
| CO_CANCEL_EVENT_PREFIX | Constant | Prefix for Termination Events | '#Exit#_' | LIKE STRING | Public |
| CO_EMBEDDED_VIEW_DELETED | Instance Attribute | 'DELETED_BY_UNBIND' | LIKE STRING | Protected | |
| CO_LAST_FOCUSED_AB | Static Attribute | Last focused assignment block ID | 'lastFocusedAB' | LIKE STRING | Public |
| CO_MANDATORY_FIELD_EMPTY | Constant | Indicator: Entry Missing in Required Entry Field | '#empty_mand_field' | LIKE STRING | Public |
| CO_OLD_SCROLL_HEIGHT | Constant | Name of Form Field Containing the Old Scroll Height | 'crmFrwOldScrollHeight' | LIKE STRING | Public |
| CO_PAGE_TYPE_TBUI | Constant | Page Type: Task-Based UI | 'T' | LIKE BSP_WD_PAGE_TYPE | Public |
| CO_PAGE_TYPE_UNKNOWN | Constant | Page Type: Unknown | ' ' | LIKE BSP_WD_PAGE_TYPE | Public |
| CO_SCROLL_X | Constant | Name of Form Field Containing the X Scroll Position | 'crmFrwScrollXPos' | LIKE STRING | Public |
| CO_SCROLL_Y | Constant | Name of Form Field Containing the Y Scroll Position | 'crmFrwScrollYPos' | LIKE STRING | Public |
| DH_TYPE | Instance Attribute | CO_ADH_UNDEFINED | LIKE BSPWD_ADH_DH_TYPE | Private | |
| ERROR_STATE | Instance Attribute | Controller State Contains Errors | ABAP_FALSE | LIKE ABAP_BOOL | Private |
| EVENT_ADD_FIELD | Constant | 'ADDFIELD' | LIKE STRING | Public | |
| EVENT_ADD_SECTION | Constant | 'ADDSECTION' | LIKE STRING | Public | |
| EVENT_COLLAPSE_SECTION | Constant | 'COLLAPSESECTION' | LIKE STRING | Public | |
| EVENT_CREATE_GROUP | Constant | 'CREATEGROUP' | LIKE STRING | Public | |
| EVENT_EXPAND_SECTION | Constant | 'EXPANDSECTION' | LIKE STRING | Public | |
| EVENT_HIGHL_CUSTOM_FLDS_OFF | Constant | Highlight Custom Fields Event Off | 'FWhighlightCustomFieldsOff' | LIKE STRING | Public |
| EVENT_HIGHL_CUSTOM_FLDS_ON | Constant | Highlight Custom Fields Event On | 'FWhighlightCustomFieldsOn' | LIKE STRING | Public |
| EVENT_MASS_TAGS | Constant | '#MASS_TAGS#' | LIKE STRING | Public | |
| EVENT_MASS_TAGS_MIXED | Constant | '#MASS_TAGS_MIXED#' | LIKE STRING | Public | |
| EVENT_MULTICELL_UPDATE_OFF | Constant | Event Multi Cell Update for Spreadsheet Off | 'SpreadSheetMultiCellUpdateOff' | LIKE STRING | Public |
| EVENT_MULTICELL_UPDATE_ON | Constant | Event Multi Cell Update for Spreadsheet On | 'SpreadSheetMultiCellUpdateOn' | LIKE STRING | Public |
| EVENT_PERSONALIZATION | Constant | '#PERSONALIZATION#' | LIKE STRING | Public | |
| EVENT_REMOVE_GROUP | Constant | 'REMOVEGROUP' | LIKE STRING | Public | |
| EVENT_REMOVE_SECTION | Constant | 'REMOVESECTION' | LIKE STRING | Public | |
| EVENT_RENAME_GROUP | Constant | 'RENAMEGROUP' | LIKE STRING | Public | |
| EVENT_TABLE_VIEW_SWITCH | Constant | TABLE VIEW SWITCH ddlb SELECT EVENT | '#TVS_DDLB_SELECT#' | LIKE STRING | Public |
| FIRST_RENDERING_AFTER_ACTIVATE | Instance Attribute | ABAP_FALSE | LIKE ABAP_BOOL | Private | |
| HIGHLIGHTED_AREA_ID | Static Attribute | ID of the Custom Field Area | LIKE STRING | Public | |
| HIGHLIGHT_CUSTOM_FIELDS | Static Attribute | LIKE ABAP_BOOL | Public | ||
| IS_OVERVIEW_PAGE | Instance Attribute | Is View Within an Overview Page? | ABAP_FALSE | LIKE ABAP_BOOL | Protected |
| MANDATORY_FIELDS | Instance Attribute | List of binding strings for mandatory fields | LIKE TIHTTPNVP | Private | |
| MULTIPLE_ROLES | Static Attribute | User has multiple roles, TRUE or FALSE. | '' | LIKE STRING | Public |
| MY_RENDERING_GROUP | Instance Attribute | ABAP_FALSE | LIKE STRING | Private | |
| OLD_SCROLL_HEIGHT | Instance Attribute | Previous Scroll Height of the View Area | '0' | LIKE STRING | Protected |
| PAGE_TYPE | Instance Attribute | Page Type | CO_PAGE_TYPE_UNKNOWN | LIKE BSP_WD_PAGE_TYPE | Public |
| PERS_SAVED | Instance Attribute | Personalization has been saved. | ABAP_FALSE | LIKE ABAP_BOOL | Private |
| PRINT_MODE_ACTIVE | Static Attribute | ABAP_FALSE | LIKE ABAP_BOOL | Public | |
| REP_VIEW | Instance Attribute | Repository View | LIKE CL_BSP_WD_REP_VIEW | Protected | |
| SCROLL_POSITION | Instance Attribute | Scroll Position of View | LIKE LTYPE_SCROLL_POS | Protected | |
| SELECTED_CONFIG_AREA | Static Attribute | Selected Config Area | LIKE STRING | Public | |
| SELECTED_PANEL | Static Attribute | Selected Panel number | LIKE STRING | Public | |
| SPDSHEET_MULTI_CELL_UPDATE_ON | Static Attribute | Spreadsheet multicell update on | LIKE ABAP_BOOL | Public | |
| VIEWAREA_CONT | Instance Attribute | View Area Content | LIKE LTYPE_VA_CONTENT_TAB | Protected | |
| VIEW_GROUP_CONTEXT | Instance Attribute | Interface for the Data Context of a View Group | LIKE IF_BSP_WD_VIEW_GROUP_CONTEXT | Public | |
| VIEW_ID | Instance Attribute | Own View ID | LIKE STRING | Protected | |
| VIEW_NAME | Instance Attribute | View Name | LIKE STRING | Protected | |
| ZERO_INITIAL_DATA_TYPES | Instance Attribute | ABAP Data Types where zero value is considered as initial | 'DTIPFNbs' | LIKE STRING | Private |
Events of Class CL_BSP_WD_VIEW_CONTROLLER
Events are created within your class using special event handler methods. These must be registered at runtime for the event and can then be triggered using the ABAP syntax: RAISE EVENT EXPOTING... BEFORE_OUTPUT - Controller is about to render a LayoutCONTROLLER_DISABLED - Controller Was Deactivated
DATA_LOSS_TRIGGER - Data Loss Trigger
HISTORY_TRIGGER - History Trigger
OUTPUT_RENDERED - Controller Has Rendered a Layout
CL_BSP_WD_VIEW_CONTROLLER types
GTYPE_AJAX_AREA_CONTENT_TAB -LTYPE_SCROLL_POS -
LTYPE_VA_CONTENT -
LTYPE_VA_CONTENT_TAB -
Links to Related Class(s)
CL_BSP_W...Full list of available SAP object classes
Search for further information about these or an SAP related objects