SAP ABAP Interface IF_FPM_RUIBB_BICS_GRID_CONFIG (BICS GRID Config API)
Hierarchy
☛
SAP_BW (Software Component) SAP Business Warehouse
⤷
BW-RUI-FPM (Application Component) FPM Analytical GUIBB
⤷
BW_REPORTING_FPM (Package) FPM UIBBs
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_FPM_RUIBB_BICS_GRID_CONFIG | BICS FRID Config API | 20130619 |
Properties
| Interface | IF_FPM_RUIBB_BICS_GRID_CONFIG | |
| Short Description | BICS GRID Config API |
General Data
| Package | BW_REPORTING_FPM | FPM UIBBs |
| Created | 20130619 | SAP |
| Last changed | 20140121 | SAP |
| Unicode checks active |
Forward declarations
Interface IF_FPM_RUIBB_BICS_GRID_CONFIG has no forward declaration.
Interfaces
Interface IF_FPM_RUIBB_BICS_GRID_CONFIG has no interface.
Friends
Interface IF_FPM_RUIBB_BICS_GRID_CONFIG has no friend.
Attributes
Interface IF_FPM_RUIBB_BICS_GRID_CONFIG has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Add button to button row | 20130619 | |
| 2 | Instance method | Public | Method | Add button choice to button row | 20130619 | |
| 3 | Instance method | Public | Method | Add separator to button row | 20130619 | |
| 4 | Instance method | Public | Method | Add toggle button to button row | 20130619 | |
| 5 | Instance method | Public | Method | Get bics size | 20130904 | |
| 6 | Instance method | Public | Method | Get button row button | 20130619 | |
| 7 | Instance method | Public | Method | Get button row button choice | 20130619 | |
| 8 | Instance method | Public | Method | Get button row elements | 20130619 | |
| 9 | Instance method | Public | Method | Get button row separator | 20130619 | |
| 10 | Instance method | Public | Method | Get button row toggle button | 20130619 | |
| 11 | Instance method | Public | Method | Get feeder parameter | 20130619 | |
| 12 | Instance method | Public | Method | Is personalization enabled | 20130904 | |
| 13 | Instance method | Public | Method | Is report-report-interface rendered | 20130904 | |
| 14 | Instance method | Public | Method | Set bics size | 20130904 | |
| 15 | Instance method | Public | Method | Enable or disable personalization | 20130904 | |
| 16 | Instance method | Public | Method | Enable or disable rendering of report-report interface | 20130904 |
Events
Interface IF_FPM_RUIBB_BICS_GRID_CONFIG has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_S_ACTION | Public | See coding | 20130619 | 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_BR_BUTTON | Public | See coding | 20130619 | BEGIN OF ty_s_br_button,
index TYPE fpm_index,
text TYPE fpm_text,
tooltip TYPE fpm_tooltip,
explanation_text TYPE fpm_explanation,
image_source TYPE fpmgb_image_src,
design TYPE fpm_toolbar_button_design,
hide_text TYPE fpm_hide_text,
hotkey TYPE fpmgb_hotkey,
action_type TYPE fpm_action_type,
event_id TYPE fpm_event_id,
event_params TYPE fpm_t_parameter_value,
END OF ty_s_br_button
|
||
| 3 | TY_S_BR_BUTTON_CHOICE | Public | See coding | 20130619 | BEGIN OF ty_s_br_button_choice,
index TYPE fpm_index,
text TYPE fpm_text,
tooltip TYPE fpm_tooltip,
image_src TYPE fpmgb_image_src,
repeat_selected_action TYPE fpmgb_selaction,
menu_action_items TYPE ty_t_menu_action_item,
END OF ty_s_br_button_choice
|
||
| 4 | TY_S_BR_SEPARATOR | Public | See coding | 20130619 | BEGIN OF ty_s_br_separator,
index TYPE fpm_index,
END OF ty_s_br_separator
|
||
| 5 | TY_S_BR_TOGGLE_BUTTON | Public | See coding | 20130619 | BEGIN OF ty_s_br_toggle_button,
index TYPE fpm_index,
text TYPE fpm_text,
tooltip TYPE fpm_tooltip,
explanation_text TYPE fpm_explanation,
image_source TYPE fpmgb_image_src,
image_source_checked TYPE fpmgb_image_src,
design TYPE fpm_toggle_button_design,
hide_text TYPE fpm_hide_text,
hotkey TYPE fpmgb_hotkey,
action_type TYPE fpm_action_type,
event_id TYPE fpm_event_id,
event_params TYPE fpm_t_parameter_value,
END OF ty_s_br_toggle_button
|
||
| 6 | TY_S_BUTTON_ROW_ELEMENT | Public | See coding | 20130619 | BEGIN OF ty_s_button_row_element,
element_id TYPE fpm_element_id,
index TYPE fpm_index,
display_type TYPE fpmgb_display_type,
END OF ty_s_button_row_element
|
||
| 7 | TY_S_FEEDER_PARAMETER | Public | See coding | 20130619 | BEGIN OF ty_s_feeder_parameter,
name TYPE fpmgb_parameter_name,
value TYPE fpmgb_parameter_value,
END OF ty_s_feeder_parameter
|
||
| 8 | TY_S_MENU_ACTION_ITEM | Public | See coding | 20130619 | 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 fpm_t_parameter_value,
has_separator TYPE fpm_add_separator,
END OF ty_s_menu_action_item
|
||
| 9 | TY_T_ACTION | Public | See coding | 20130619 | ty_t_action TYPE SORTED TABLE OF ty_s_action
WITH UNIQUE KEY index
|
||
| 10 | TY_T_BUTTON_ROW_ELEMENT | Public | See coding | 20130619 | ty_t_button_row_element TYPE SORTED TABLE OF ty_s_button_row_element
WITH UNIQUE KEY index
|
||
| 11 | TY_T_FEEDER_PARAMETER | Public | See coding | 20130619 | ty_t_feeder_parameter TYPE SORTED TABLE OF ty_s_feeder_parameter
WITH UNIQUE KEY name
|
||
| 12 | TY_T_MENU_ACTION_ITEM | Public | See coding | 20130619 | 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 | EV_ELEMENT_ID | Call by reference | Type reference (TYPE) | FPM_ELEMENT_ID | FPM: Element ID | 20130619 | |||
| 2 | IS_BR_BUTTON | Call by reference | Type reference (TYPE) | TY_S_BR_BUTTON | Button | 20130619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20130619 |
Method ADD_BR_BUTTON_CHOICE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_ELEMENT_ID | Call by reference | Type reference (TYPE) | FPM_ELEMENT_ID | FPM: Element ID | 20130619 | |||
| 2 | IS_BR_BUTTON_CHOICE | Call by reference | Type reference (TYPE) | TY_S_BR_BUTTON_CHOICE | Button choice | 20130619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20130619 |
Method ADD_BR_SEPARATOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_ELEMENT_ID | Call by reference | Type reference (TYPE) | FPM_ELEMENT_ID | FPM: Element ID | 20130619 | |||
| 2 | IS_BR_SEPARATOR | Call by reference | Type reference (TYPE) | TY_S_BR_SEPARATOR | Separator | 20130619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20130619 |
Method ADD_BR_TOGGLE_BUTTON Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_ELEMENT_ID | Call by reference | Type reference (TYPE) | FPM_ELEMENT_ID | FPM: Element ID | 20130619 | |||
| 2 | IS_BR_TOGGLE_BUTTON | Call by reference | Type reference (TYPE) | TY_S_BR_TOGGLE_BUTTON | Toggle button | 20130619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20130619 |
Method GET_BICS_SIZE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_HEIGHT | Call by reference | Type reference (TYPE) | FPMGB_UI_ELEMENT_HEIGHT | Height of a UI Element | 20130904 | |||
| 2 | EV_WIDTH | Call by reference | Type reference (TYPE) | FPMGB_UI_ELEMENT_WIDTH | Width of a UI Element | 20130904 |
Method GET_BICS_SIZE on Interface IF_FPM_RUIBB_BICS_GRID_CONFIG has no exception.
Method GET_BR_BUTTON Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_BR_BUTTON | Call by reference | Type reference (TYPE) | TY_S_BR_BUTTON | Button | 20130619 | |||
| 2 | IV_ELEMENT_ID | Call by reference | Type reference (TYPE) | FPM_ELEMENT_ID | FPM: Element ID | 20130619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20130619 |
Method GET_BR_BUTTON_CHOICE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_BR_BUTTON_CHOICE | Call by reference | Type reference (TYPE) | TY_S_BR_BUTTON_CHOICE | Button choice | 20130619 | |||
| 2 | IV_ELEMENT_ID | Call by reference | Type reference (TYPE) | FPM_ELEMENT_ID | FPM: Element ID | 20130619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20130619 |
Method GET_BR_ELEMENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_BUTTON_ROW_ELEMENT | Call by reference | Type reference (TYPE) | TY_T_BUTTON_ROW_ELEMENT | Button row elements | 20130619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20130619 |
Method GET_BR_SEPARATOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_BR_SEPARATOR | Call by reference | Type reference (TYPE) | TY_S_BR_SEPARATOR | Separator | 20130619 | |||
| 2 | IV_ELEMENT_ID | Call by reference | Type reference (TYPE) | FPM_ELEMENT_ID | FPM: Element ID | 20130619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20130619 |
Method GET_BR_TOGGLE_BUTTON Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_BR_TOGGLE_BUTTON | Call by reference | Type reference (TYPE) | TY_S_BR_TOGGLE_BUTTON | Toggle button | 20130619 | |||
| 2 | IV_ELEMENT_ID | Call by reference | Type reference (TYPE) | FPM_ELEMENT_ID | FPM: Element ID | 20130619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20130619 |
Method GET_FEEDER_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_FEEDER_PARAMETER | Call by reference | Type reference (TYPE) | TY_T_FEEDER_PARAMETER | Feeder parameter | 20130619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20130619 |
Method IS_PERSONALIZATION_ENABLED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_RESULT | Value transfer | Type reference (TYPE) | FPM_PERSONALIZATION_ENABLED | Personalization is Enabled | 20130904 |
Method IS_PERSONALIZATION_ENABLED on Interface IF_FPM_RUIBB_BICS_GRID_CONFIG has no exception.
Method IS_RRI_RENDERED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_RESULT | Value transfer | Type reference (TYPE) | FPM_RENDER_RRI | Render Report-Report Interface | 20130904 |
Method IS_RRI_RENDERED on Interface IF_FPM_RUIBB_BICS_GRID_CONFIG has no exception.
Method SET_BICS_SIZE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_HEIGHT | Call by reference | Type reference (TYPE) | FPMGB_UI_ELEMENT_HEIGHT | Height of a UI Element | 20130904 | |||
| 2 | IV_WIDTH | Call by reference | Type reference (TYPE) | FPMGB_UI_ELEMENT_WIDTH | Width of a UI Element | 20130904 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20130904 |
Method SET_PERSONALIZATION_ENABLED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ENABLE_PERSONALIZATION | Call by reference | Type reference (TYPE) | FPM_PERSONALIZATION_ENABLED | Personalization is Enabled | 20130904 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20130904 |
Method SET_RENDER_RRI Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_RENDER_RRI | Call by reference | Type reference (TYPE) | FPM_RENDER_RRI | Render Report-Report Interface | 20130904 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Configuration exceptions | 20130904 |
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 740 |