SAP ABAP Interface IF_FPM_CNR_OIF (Interface for CNR in OIF)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
BC-WD-CMP-FPM (Application Component) Floorplan Manager Web Dynpro ABAP
⤷
APB_FPM_CORE (Package) Floorplan Manager (Framework)
SAP_UI (Software Component) User Interface Technology⤷
BC-WD-CMP-FPM (Application Component) Floorplan Manager Web Dynpro ABAP⤷
APB_FPM_CORE (Package) Floorplan Manager (Framework)
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_FPM_CNR_OIF | API to overwrite properties of CNR_OIF | 20070504 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_FPM_TEST_DOUBLE | Test double for IF_FPM | 20111004 |
Properties
| Interface | IF_FPM_CNR_OIF | |
| Short Description | Interface for CNR in OIF |
General Data
| Package | APB_FPM_CORE | Floorplan Manager (Framework) |
| Created | 20070504 | SAP |
| Last changed | 20130531 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | CL_FPM_CNR_OIF | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 2 | IF_FPM_CNR_OIF | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Interface IF_FPM_CNR_OIF has no interface.
Friends
Interface IF_FPM_CNR_OIF has no friend.
Attributes
Interface IF_FPM_CNR_OIF has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CREATE_SEPARATOR |
Instance method | Public | Method | Creates a separator for 'Other Functions' | 20070606 |
| 2 | DEFINE_BUTTON |
Instance method | Public | Method | Creates/Changes a button with the given attributes | 20070606 |
| 3 | DEFINE_BUTTON_CHOICE |
Instance method | Public | Method | Creates/Changes a button choice with the given attributes | 20070606 |
| 4 | DEFINE_RELATED_LINKS |
Instance method | Public | Method | Defines the configuration of the RELATED LINKS menubar | 20070701 |
| 5 | DEFINE_YOU_CAN_ALSO |
Instance method | Public | Method | Defines the configuration of the YOU CAN ALSO menubar | 20070701 |
| 6 | GET_BUTTONS |
Instance method | Public | Method | Deliveres all buttons of the toolbar with their attributes | 20070919 |
| 7 | GET_BUTTON_CHOICES |
Instance method | Public | Method | Deliveres all button-choices of the toolbar | 20070919 |
| 8 | GET_RELATED_LINKS |
Instance method | Public | Method | Deliveres the content of the RELATED LINKS menubar | 20070919 |
| 9 | GET_SEPARATORS |
Instance method | Public | Method | Deliveres the separator positions inside 'Other Functions' | 20071011 |
| 10 | GET_YOU_CAN_ALSO |
Instance method | Public | Method | Deliveres the content of the YOU CAN ALSO menubar | 20070919 |
| 11 | REMOVE_SEPARATOR |
Instance method | Public | Method | Removes a separator for 'Other Functions' | 20071011 |
| 12 | SET_DUPLICATE_TOOLBAR |
Instance method | Public | Method | Defines if toolbar is duplicated at the end of the screen | 20070504 |
| 13 | SET_VIEW_SWITCH_ACTION_TYPE |
Instance method | Public | Method | Defines the action type of a view switch (standard/val.ind.) | 20090805 |
| 14 | SET_VIEW_SWITCH_ENABLED |
Instance method | Public | Method | Enables/Disables a certain view of the current variant | 20080129 |
Events
Interface IF_FPM_CNR_OIF has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | S_BUTTON | Public | See coding | 20070919 | BEGIN OF s_button,
variant_id TYPE string,
function TYPE string,
screen TYPE fpm_floorplan_state,
element_id TYPE string,
other_function_index TYPE string,
design TYPE wdui_button_design,
enabled TYPE boole_d,
explanation TYPE string,
on_action TYPE string,
text TYPE string,
tooltip TYPE string,
visibility TYPE wdui_visibility,
default_button TYPE boole_d,
hotkey type fpm_hotkey,
action_type TYPE fpm_action_type,
image type fpm_image,
END OF s_button
|
||
| 2 | S_BUTTON_CHOICE | Public | See coding | 20070919 | BEGIN OF s_button_choice,
variant_id TYPE string,
function TYPE string,
element_id TYPE string,
other_function_index TYPE string,
enabled TYPE boole_d,
text TYPE string,
tooltip TYPE string,
visibility TYPE wdui_visibility,
menu_action_items TYPE t_menu_action_items,
screen TYPE fpm_floorplan_state,
repeat_selected_action TYPE boole_d,
image type fpm_image,
END OF s_button_choice
|
||
| 3 | S_MENUBAR | Public | See coding | 20070919 | BEGIN OF s_menubar,
variant_id TYPE string,
role TYPE fpm_s_navigation_key-key1,
instance TYPE fpm_s_navigation_key-key2,
label TYPE string,
visibility TYPE wdui_visibility,
END OF s_menubar
|
||
| 4 | S_MENU_ACTION_ITEMS | Public | See coding | 20070606 | BEGIN OF s_menu_action_items,
text TYPE string,
on_action TYPE string,
enabled TYPE wdy_boolean,
visible TYPE wdui_visibility,
action_type TYPE fpm_action_type,
element_id TYPE fpm_element_id,
hotkey type fpm_hotkey,
END OF s_menu_action_items
|
||
| 5 | S_SEPARATOR | Public | See coding | 20071016 | BEGIN OF s_separator,
variant_id TYPE string,
sequence_id TYPE i,
screen TYPE fpm_floorplan_state,
END OF s_separator
|
||
| 6 | T_BUTTON | Public | See coding | 20070919 | t_button TYPE STANDARD TABLE OF s_button WITH DEFAULT KEY
|
||
| 7 | T_BUTTON_CHOICE | Public | See coding | 20070919 | t_button_choice TYPE STANDARD TABLE OF s_button_choice WITH DEFAULT KEY
|
||
| 8 | T_MENUBAR | Public | See coding | 20070920 | t_menubar TYPE STANDARD TABLE OF s_menubar WITH DEFAULT KEY
|
||
| 9 | T_MENU_ACTION_ITEMS | Public | See coding | 20070606 | t_menu_action_items TYPE STANDARD TABLE OF s_menu_action_items WITH DEFAULT KEY
|
||
| 10 | T_SEPARATOR | Public | See coding | 20071016 | t_separator TYPE STANDARD TABLE OF s_separator WITH DEFAULT KEY
|
Method Signatures
Method CREATE_SEPARATOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_SCREEN | Call by reference | Type reference (TYPE) | FPM_FLOORPLAN_STATE | The screen where the UI-Element has to be added (INIT, MAIN) | 20080701 | ||
| 2 | Importing |
IV_SEQUENCE_ID | Call by reference | Type reference (TYPE) | I | sequence-index in which the separator has to be defined | 20070606 | ||
| 3 | Importing |
IV_VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | Variant ID (current variant if skipped) | 20070624 |
Method CREATE_SEPARATOR on Interface IF_FPM_CNR_OIF has no exception.
Method DEFINE_BUTTON Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ACTION_TYPE | Call by reference | Type reference (TYPE) | FPM_ACTION_TYPE | FPM: Defines the FPM Event Action Type | 20090616 | ||
| 2 | Importing |
IV_DEFAULT_BUTTON | Call by reference | Type reference (TYPE) | BOOLE_D | only relevant for Start, Check and Refresh Button | 20080430 | ||
| 3 | Importing |
IV_DESIGN | Call by reference | Type reference (TYPE) | WDUI_BUTTON_DESIGN | WebDynpro:ButtonDesign | 20070606 | ||
| 4 | Importing |
IV_ELEMENT_ID | Call by reference | Type reference (TYPE) | STRING | ID only for app-specific buttons, for later change | 20070606 | ||
| 5 | Importing |
IV_ENABLED | Call by reference | Type reference (TYPE) | BOOLE_D | Supplement for True Boolean Type: 'X' == True '' == False | 20070606 | ||
| 6 | Importing |
IV_EXPLANATION | Call by reference | Type reference (TYPE) | STRING | An explanation provides a more detailed description | 20070606 | ||
| 7 | Importing |
IV_FUNCTION | Call by reference | Type reference (TYPE) | STRING | see Interface IF_FPM_CONSTANTS and attribute GC_BUTTON | 20070606 | ||
| 8 | Importing |
IV_HOTKEY | Call by reference | Type reference (TYPE) | FPM_HOTKEY | Hotkey of a UI-Element | 20080819 | ||
| 9 | Importing |
IV_IMAGE | Call by reference | Type reference (TYPE) | FPM_IMAGE | Image | 20101130 | ||
| 10 | Importing |
IV_ON_ACTION | Call by reference | Type reference (TYPE) | STRING | EventID of the button | 20070606 | ||
| 11 | Importing |
IV_SCREEN | Call by reference | Type reference (TYPE) | FPM_FLOORPLAN_STATE | The screen where the UI-Element has to be added (INIT, MAIN) | 20080701 | ||
| 12 | Importing |
IV_SEQUENCE_ID | Call by reference | Type reference (TYPE) | STRING | only relevant for non-standard buttons ('Other Functions'... | 20070606 | ||
| 13 | Importing |
IV_TEXT | Call by reference | Type reference (TYPE) | STRING | Text/Label of the button | 20070606 | ||
| 14 | Importing |
IV_TOOLTIP | Call by reference | Type reference (TYPE) | STRING | Tooltip of the button | 20070606 | ||
| 15 | Importing |
IV_VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | Variant ID (current variant if skipped) | 20070624 | ||
| 16 | Importing |
IV_VISIBILITY | Call by reference | Type reference (TYPE) | WDUI_VISIBILITY | Web Dynpro: Visibility | 20070606 |
Method DEFINE_BUTTON on Interface IF_FPM_CNR_OIF has no exception.
Method DEFINE_BUTTON_CHOICE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_MENU_ACTION_ITEMS | Call by reference | Type reference (TYPE) | T_MENU_ACTION_ITEMS | menu elements of a Button-Choice | 20070606 | ||
| 2 | Importing |
IV_ELEMENT_ID | Call by reference | Type reference (TYPE) | STRING | ID only for app-specific buttons, for later change | 20070606 | ||
| 3 | Importing |
IV_ENABLED | Call by reference | Type reference (TYPE) | BOOLE_D | Supplement for True Boolean Type: 'X' == True '' == False | 20070606 | ||
| 4 | Importing |
IV_FUNCTION | Call by reference | Type reference (TYPE) | STRING | see Interface IF_FPM_CONSTANTS -> attribute GC_BUTTON_CHOICE | 20070606 | ||
| 5 | Importing |
IV_IMAGE | Call by reference | Type reference (TYPE) | FPM_IMAGE | Image | 20101130 | ||
| 6 | Importing |
IV_REPEAT_SELECTED_ACTION | Call by reference | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20080805 | ||
| 7 | Importing |
IV_SCREEN | Call by reference | Type reference (TYPE) | FPM_FLOORPLAN_STATE | The screen where the UI-Element has to be added (INIT, MAIN) | 20080701 | ||
| 8 | Importing |
IV_SEQUENCE_ID | Call by reference | Type reference (TYPE) | STRING | only relevant for non-standard buttons (Other Functions,...) | 20070606 | ||
| 9 | Importing |
IV_TEXT | Call by reference | Type reference (TYPE) | STRING | only relevant for certain buttons (see Spec of OIF Toolbar) | 20070606 | ||
| 10 | Importing |
IV_TOOLTIP | Call by reference | Type reference (TYPE) | STRING | only relevant for certain buttons (see Spec of OIF Toolbar) | 20070606 | ||
| 11 | Importing |
IV_VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | Variant ID (current variant if skipped) | 20070624 | ||
| 12 | Importing |
IV_VISIBILITY | Call by reference | Type reference (TYPE) | WDUI_VISIBILITY | Web Dynpro: Visibility | 20070606 |
Method DEFINE_BUTTON_CHOICE on Interface IF_FPM_CNR_OIF has no exception.
Method DEFINE_RELATED_LINKS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_INSTANCE | Call by reference | Type reference (TYPE) | FPM_S_NAVIGATION_KEY-KEY2 | Launchpad Instance | 20070701 | ||
| 2 | Importing |
IV_LABEL | Call by reference | Type reference (TYPE) | STRING | Label of the menubar | 20070701 | ||
| 3 | Importing |
IV_ROLE | Call by reference | Type reference (TYPE) | FPM_S_NAVIGATION_KEY-KEY1 | Launchpad Role | 20070701 | ||
| 4 | Importing |
IV_VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | Variant ID (current variant if skipped) | 20070701 | ||
| 5 | Importing |
IV_VISIBILITY | Call by reference | Type reference (TYPE) | WDUI_VISIBILITY | Web Dynpro: Visibility | 20070701 |
Method DEFINE_RELATED_LINKS on Interface IF_FPM_CNR_OIF has no exception.
Method DEFINE_YOU_CAN_ALSO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_INSTANCE | Call by reference | Type reference (TYPE) | FPM_S_NAVIGATION_KEY-KEY2 | Launchpad Instance | 20070701 | ||
| 2 | Importing |
IV_LABEL | Call by reference | Type reference (TYPE) | STRING | Label of the menubar | 20070701 | ||
| 3 | Importing |
IV_ROLE | Call by reference | Type reference (TYPE) | FPM_S_NAVIGATION_KEY-KEY1 | Launchpad Role | 20070701 | ||
| 4 | Importing |
IV_VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | Variant ID (current variant if skipped) | 20070701 | ||
| 5 | Importing |
IV_VISIBILITY | Call by reference | Type reference (TYPE) | WDUI_VISIBILITY | Web Dynpro: Visibility | 20070701 |
Method DEFINE_YOU_CAN_ALSO on Interface IF_FPM_CNR_OIF has no exception.
Method GET_BUTTONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_BUTTONS | Call by reference | Type reference (TYPE) | T_BUTTON | List of current buttons in the CNR toolbar | 20070919 | ||
| 2 | Importing |
IV_EVENT_ID | Call by reference | Type reference (TYPE) | STRING | 20110809 | |||
| 3 | Importing |
IV_SCREEN | Call by reference | Type reference (TYPE) | FPM_FLOORPLAN_STATE | The screen where the UI-Element has to be added (INIT, MAIN) | 20080808 | ||
| 4 | Importing |
IV_VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | Variant ID (current variant if skipped) | 20070919 |
Method GET_BUTTONS on Interface IF_FPM_CNR_OIF has no exception.
Method GET_BUTTON_CHOICES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_BUTTON_CHOICES | Call by reference | Type reference (TYPE) | T_BUTTON_CHOICE | List of all current button-choices in the CNR toolbar | 20070919 | ||
| 2 | Importing |
IV_EVENT_ID | Call by reference | Type reference (TYPE) | STRING | 20110809 | |||
| 3 | Importing |
IV_SCREEN | Call by reference | Type reference (TYPE) | FPM_FLOORPLAN_STATE | The screen where the UI-Element has to be added (INIT, MAIN) | 20080808 | ||
| 4 | Importing |
IV_VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | Variant ID (current variant if skipped) | 20070919 |
Method GET_BUTTON_CHOICES on Interface IF_FPM_CNR_OIF has no exception.
Method GET_RELATED_LINKS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_RELATED_LINKS | Call by reference | Type reference (TYPE) | S_MENUBAR | List of the properties of RELATED LINKS | 20071017 | ||
| 2 | Importing |
IV_VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | Variant ID (current variant if skipped) | 20070919 |
Method GET_RELATED_LINKS on Interface IF_FPM_CNR_OIF has no exception.
Method GET_SEPARATORS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_SEPARATORS | Call by reference | Type reference (TYPE) | T_SEPARATOR | Deliveres a table with all separator sequence-indexes | 20071011 | ||
| 2 | Importing |
IV_SCREEN | Call by reference | Type reference (TYPE) | FPM_FLOORPLAN_STATE | The screen where the UI-Element has to be added (INIT, MAIN) | 20080808 | ||
| 3 | Importing |
IV_VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | Variant ID (current variant if skipped) | 20071011 |
Method GET_SEPARATORS on Interface IF_FPM_CNR_OIF has no exception.
Method GET_YOU_CAN_ALSO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_YOU_CAN_ALSO | Call by reference | Type reference (TYPE) | S_MENUBAR | List of the properties of YOU CAN ALSO | 20071017 | ||
| 2 | Importing |
IV_VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | Variant ID (current variant if skipped) | 20070919 |
Method GET_YOU_CAN_ALSO on Interface IF_FPM_CNR_OIF has no exception.
Method REMOVE_SEPARATOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_SCREEN | Call by reference | Type reference (TYPE) | FPM_FLOORPLAN_STATE | The screen where the UI-Element has to be added (INIT, MAIN) | 20080701 | ||
| 2 | Importing |
IV_SEQUENCE_ID | Call by reference | Type reference (TYPE) | I | sequence-index where the separator has to be deleted | 20071011 | ||
| 3 | Importing |
IV_VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | Variant ID (current variant if skipped) | 20071011 |
Method REMOVE_SEPARATOR on Interface IF_FPM_CNR_OIF has no exception.
Method SET_DUPLICATE_TOOLBAR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ACTIVATE_BOTTOM_TOOLBAR | Call by reference | Type reference (TYPE) | BOOLE_D | 'X' | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20070504 | |
| 2 | Importing |
IV_VARIANT_ID | Call by reference | Type reference (TYPE) | STRING | Variant ID (current variant if skipped) | 20070624 |
Method SET_DUPLICATE_TOOLBAR on Interface IF_FPM_CNR_OIF has no exception.
Method SET_VIEW_SWITCH_ACTION_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ACTION_TYPE | Call by reference | Type reference (TYPE) | FPM_VIEW_SWITCH_ACTION_TYPE | Action Type of OIF View Switch Event | 20090805 | ||
| 2 | Importing |
IV_VARIANT | Call by reference | Type reference (TYPE) | FPM_VARIANT_ID | FPM: ID of the variant | 20090805 |
Method SET_VIEW_SWITCH_ACTION_TYPE on Interface IF_FPM_CNR_OIF has no exception.
Method SET_VIEW_SWITCH_ENABLED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ENABLED | Call by reference | Type reference (TYPE) | BOOLE_D | 'X' | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20080129 | |
| 2 | Importing |
IV_MAINVIEW_ID | Call by reference | Type reference (TYPE) | STRING | 20080316 | |||
| 3 | Importing |
IV_SUBVIEW_ID | Call by reference | Type reference (TYPE) | STRING | 20080316 |
Method SET_VIEW_SWITCH_ENABLED on Interface IF_FPM_CNR_OIF has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in |
