SAP ABAP Class CL_FPM_VISBIZ_CONFIG_WRITER (Configuration Writer for Visbiz UIBB)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
BC-WD-CMP-FPM (Application Component) Floorplan Manager Web Dynpro ABAP
⤷
APB_FPM_GUIBB (Package) Generic UI building blocks
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_FPM_CONFIG_WRITER | Configuration Rerader for OIF | 20130830 |
Properties
| Class | CL_FPM_VISBIZ_CONFIG_WRITER | |
| Short Description | Configuration Writer for Visbiz UIBB | |
| Super Class | CL_FPM_CONFIG_WRITER | Configuration Rerader for OIF |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | APB_FPM_GUIBB | Generic UI building blocks |
| Created | 20130830 | SAP |
| Last change | 20141120 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 2 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 3 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Class CL_FPM_VISBIZ_CONFIG_WRITER has no interface implemented.
Friends
Class CL_FPM_VISBIZ_CONFIG_WRITER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_FPM_GUIBB_VISBIZ | Feeder Interface for VisBiz UIBB | 20131119 | |||
| 2 | Instance attribute | Private | Type reference (TYPE) | CL_FPM_VISBIZ_UIBB_ASSIST=>YS_VISBIZ | 20131119 | ||||
| 3 | Instance attribute | Private | Type reference (TYPE) | FPMGB_T_ACTIONDEF | Action Definition | 20131119 | |||
| 4 | Instance attribute | Private | Type reference (TYPE) | STRING | 20130830 |
Methods
Events
Class CL_FPM_VISBIZ_CONFIG_WRITER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_S_ACTION | Public | See coding | 20131030 | BEGIN OF ty_s_action,
fpm_primary_attribute TYPE fpm_element_id,
index TYPE fpm_index,
text TYPE fpm_text,
action_type TYPE fpm_action_type,
event_id TYPE fpm_event_id,
event_parameters TYPE string,
has_separator TYPE fpm_add_separator,
END OF ty_s_action
|
||
| 2 | TY_S_MENU_ACTION_ITEM | Public | See coding | 20131030 | BEGIN OF ty_s_menu_action_item,
index TYPE fpm_index,
text TYPE fpm_text,
action_type TYPE fpm_action_type,
event_id TYPE fpm_event_id,
event_params TYPE string,
has_separator TYPE fpm_add_separator,
END OF ty_s_menu_action_item
|
||
| 3 | TY_T_ACTION | Public | See coding | 20131030 | ty_t_action TYPE SORTED TABLE OF ty_s_action
WITH UNIQUE KEY index
|
||
| 4 | TY_T_MENU_ACTION_ITEM | Public | See coding | 20131030 | ty_t_menu_action_item TYPE SORTED TABLE OF ty_s_menu_action_item
WITH UNIQUE KEY index
|
Method Signatures
Method ADD_BR_BUTTON Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_BR_BUTTON | Call by reference | Type reference (TYPE) | IF_FPM_GUIBB_VISBIZ_CONFIG=>TY_S_BR_BUTTON | Button | 20131030 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20131030 |
Method ADD_BR_BUTTON_CHOICE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_BR_BUTTON_CHOICE | Call by reference | Type reference (TYPE) | IF_FPM_GUIBB_VISBIZ_CONFIG=>TY_S_BR_BUTTON_CHOICE | Button choice | 20131030 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20131030 |
Method ADD_BR_DROP_DOWN_LIST_BOX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_BR_DROP_DOWN_LIST_BOX | Call by reference | Type reference (TYPE) | IF_FPM_GUIBB_VISBIZ_CONFIG=>TY_S_BR_DROP_DOWN_LIST_BOX | Drop-down list box | 20131030 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20131030 |
Method ADD_BR_INPUT_FIELD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_BR_INPUT_FIELD | Call by reference | Type reference (TYPE) | IF_FPM_GUIBB_VISBIZ_CONFIG=>TY_S_BR_INPUT_FIELD | Input field | 20131030 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20131030 |
Method ADD_BR_LINK_TO_ACTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_BR_LINK_TO_ACTION | Call by reference | Type reference (TYPE) | IF_FPM_GUIBB_VISBIZ_CONFIG=>TY_S_BR_LINK_TO_ACTION | Link to action | 20131030 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20131030 |
Method ADD_BR_SEPARATOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_BR_SEPARATOR | Call by reference | Type reference (TYPE) | IF_FPM_GUIBB_VISBIZ_CONFIG=>TY_S_BR_SEPARATOR | Separator | 20131030 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20131030 |
Method ADD_BR_TOGGLE_BUTTON Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_BR_TOGGLE_BUTTON | Call by reference | Type reference (TYPE) | IF_FPM_GUIBB_VISBIZ_CONFIG=>TY_S_BR_TOGGLE_BUTTON | Toggle button | 20131030 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20131030 |
Method ADD_SIMPLE_BR_ELEMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_DATA | Call by reference | Type reference (TYPE) | DATA | 20131030 | ||||
| 2 | IT_EVENT_PARAMS | Call by reference | Type reference (TYPE) | FPM_T_PARAMETER_VALUE | Parameter values | 20131120 | |||
| 3 | IV_DISPLAY_TYPE | Call by reference | Type reference (TYPE) | FPMGB_DISPLAY_TYPE | Display Type | 20131030 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20131030 |
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_APPL_READER | Call by reference | Object reference (TYPE REF TO) | IF_WD_CONFIG_APPL_READER | Read Interface for Application Configuration | 20130830 | |||
| 2 | IR_APPL_WRITER | Call by reference | Object reference (TYPE REF TO) | IF_WD_CONFIG_APPL_MODIFIER | Write Interface for Application Configuration | 20130830 | |||
| 3 | IR_COMP_READER | Call by reference | Object reference (TYPE REF TO) | IF_WD_CONFIG_COMP_READER | Read Interface for the Component Configuration | 20130830 | |||
| 4 | IR_COMP_WRITER | Call by reference | Object reference (TYPE REF TO) | IF_WD_CONFIG_COMP_MODIFIER | Write Interface for the Component Configuration | 20130830 | |||
| 5 | IR_CONFIG_TOOL_COMP | Call by reference | Object reference (TYPE REF TO) | IF_WD_CONFIG_TOOL_COMP | API Configuration Component | 20130830 | |||
| 6 | IV_CONFIGURATION_ID | Call by reference | Type reference (TYPE) | WDY_CONFIG_ID | Configuration Identification | 20130830 | |||
| 7 | IV_CONFIG_TYPE | Call by reference | Type reference (TYPE) | WDY_CONFIG_TYPE | Type of Web Dynpro Configuration | 20130830 | |||
| 8 | IV_CREATE | Call by reference | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20130830 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Floorplan exceptions | 20130830 |
Method CREATE_BR_ELEMENT Signature
Method CREATE_BR_ELEMENT on class CL_FPM_VISBIZ_CONFIG_WRITER has no parameter.
Method CREATE_BR_ELEMENT on class CL_FPM_VISBIZ_CONFIG_WRITER has no exception.
Method INIT_FEEDER Signature
Method INIT_FEEDER on class CL_FPM_VISBIZ_CONFIG_WRITER has no parameter.
Method INIT_FEEDER on class CL_FPM_VISBIZ_CONFIG_WRITER has no exception.
Method SAVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_ERROR | Value transfer | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20130830 |
Method SAVE on class CL_FPM_VISBIZ_CONFIG_WRITER has no exception.
Method SET_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_APPLICATION | Call by reference | Type reference (TYPE) | VBI_APP_ID | Visual Business Application Identifier | 20130830 | |||
| 2 | IV_ARIA_LANDMARK | Call by reference | Type reference (TYPE) | FPM_ARIA_LANDMARK | Aria Landmark | 20131016 | |||
| 3 | IV_DEFAULT_MAP_STACK | Call by reference | Type reference (TYPE) | VBI_DEFAULT_MAP_STACK | Default Map Stack | 20130830 | |||
| 4 | IV_FEEDER | Call by reference | Type reference (TYPE) | FPMGB_FEEDER_CLASS | Feeder Class | 20130830 | |||
| 5 | IV_HAS_MAX_MIN_BUTTON | Call by reference | Type reference (TYPE) | FPM_HAS_MAX_MIN_BUTTON | FPM GUIBB has Maximize/ Minimize Button in its Toolbar | 20140219 | |||
| 6 | IV_MIME_REP_PATH | Call by reference | Type reference (TYPE) | VBI_MIME_REP_PATH | MIME Repository Path | 20130830 | |||
| 7 | IV_PERS_ENABLED | Call by reference | Type reference (TYPE) | FPM_PERSONALIZATION_ENABLED | Personalization is Enabled | 20130830 |
Method SET_ATTRIBUTES on class CL_FPM_VISBIZ_CONFIG_WRITER has no exception.
Method SET_EVENT_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_PARAM | Value transfer | Type reference (TYPE) | FPM_T_PARAMETER_VALUE | Parameter values | 20131119 | |||
| 2 | IV_EVENT_ID | Call by reference | Type reference (TYPE) | FPM_EVENT_ID | ID of the FPM Event | 20131119 | |||
| 3 | RV_ENCODED_PARAMETER | Value transfer | Type reference (TYPE) | STRING | 20131119 |
Method SET_EVENT_PARAMETER on class CL_FPM_VISBIZ_CONFIG_WRITER has no exception.
Method SET_PARAMETERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_PARAMETER | Call by reference | Type reference (TYPE) | CL_FPM_CONFIG_WRITER=>TY_T_PARAMETER | 20130903 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Personalization Error | 20130903 |
Method SET_SETTINGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_SETTINGS | Call by reference | Type reference (TYPE) | CL_FPM_VISBIZ_UIBB_ASSIST=>YS_VISBIZ-SETTINGS | 20130830 |
Method SET_SETTINGS on class CL_FPM_VISBIZ_CONFIG_WRITER has no exception.
Method SET_START_POSITION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_START_POSITION | Call by reference | Type reference (TYPE) | CL_FPM_VISBIZ_UIBB_ASSIST=>YS_VISBIZ-START_POSITION | 20130830 |
Method SET_START_POSITION on class CL_FPM_VISBIZ_CONFIG_WRITER has no exception.
Method SET_VISBIZ_CLASSES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_VISBIZ_CLASSES | Call by reference | Type reference (TYPE) | CL_FPM_VISBIZ_UIBB_ASSIST=>YS_VISBIZ-VISBIZ_CLASSES | 20130830 |
Method SET_VISBIZ_CLASSES on class CL_FPM_VISBIZ_CONFIG_WRITER has no exception.
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in | 740 |