SAP ABAP Interface /UI2/IF_START_UP_MENU (Start Up Menu)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
CA-UI2-INT-BE (Application Component) Backend Enablement
⤷
/UI2/BASIS_SERVICES_START_UP (Package) UI BE: Start-Up of Frontend Shell
SAP_UI (Software Component) User Interface Technology⤷
CA-UI2-INT-BE (Application Component) Backend Enablement⤷
/UI2/BASIS_SERVICES_START_UP (Package) UI BE: Start-Up of Frontend Shell
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /UI2/CL_START_UP_MENU | Start-Up Service | 20121008 |
Properties
| Interface | /UI2/IF_START_UP_MENU | |
| Short Description | Start Up Menu |
General Data
| Package | /UI2/BASIS_SERVICES_START_UP | UI BE: Start-Up of Frontend Shell |
| Created | 20121008 | SAP |
| Last changed | 20131127 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | /UI2/IF_START_UP_MENU | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 2 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Interface /UI2/IF_START_UP_MENU has no interface.
Friends
Interface /UI2/IF_START_UP_MENU has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BEGIN | Constant | Public | Type reference (TYPE) | C | IS INITIAL | 20130618 | ||
| 2 | CAT_PAGE_PREFIX | Constant | Public | Type reference (TYPE) | STRING | 'X-SAP-UI2-PAGECHIP?pageId=' | 20130423 | ||
| 3 | C_ASSOC_TYPE | Constant | Public | See coding | 20130221 | ||||
| 4 | C_CATALOG_PROVIDER | Constant | Public | Type reference (TYPE) | STRING | 'CAT_PROVIDER' | 20130423 | ||
| 5 | C_STATUS_CHILDREN | Constant | Public | See coding | 20121212 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CONVERT_MENU_TREE_TOP_DOWN |
Instance method | Public | Method | Convert parent relation into children relation | 20121008 |
| 2 | EXTRACT_PATH |
Instance method | Public | Method | Convert parent relation into children relation | 20121122 |
| 3 | GET_ASSOCIATION |
Instance method | Public | Method | Get associated_menu_entry | 20130222 |
| 4 | GET_INSTANCE |
Static method | Public | Method | 20130305 | |
| 5 | GET_MENU_TREE |
Instance method | Public | Method | Get Menu Tree out of PFCG and Launchpad | 20121008 |
| 6 | GET_NODES_ASSOCIATED |
Instance method | Public | Method | Get associated_menu_entry | 20130618 |
| 7 | GET_PATH |
Instance method | Public | Method | bestimmt Pfad | 20130108 |
| 8 | SERIALIZE_MENU_TREE |
Instance method | Public | Method | 20121019 | |
| 9 | SERIALIZE_PATH |
Instance method | Public | Method | 20121122 | |
| 10 | SET_DEPTH_AND_PATH_CHILD |
Instance method | Public | Method | Tiefe und Pfad der Kinder bestimmen und setzen | 20130108 |
| 11 | SET_DEPTH_CHILD |
Instance method | Public | Method | Tiefe der Kinder bestimmen | 20130107 |
Events
Interface /UI2/IF_START_UP_MENU has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | T_CHILD | Public | See coding | 20121017 | begin of t_child,
object_id type string,
unique_id type string, " unique id that is computed to be "stable"
app_id type string, " unique application identifier
parent_id type string, " parent id
report_type type string, " see e_report_type
url type string, " application URL
is_home_page type abap_bool, " homepage of the parent folder
text type string,
path type standard table of string with key table_line,
status_children type c length 1,
depth type i,
end of t_child
|
||
| 2 | T_CHILD_AGGR | Public | See coding | 20121205 | begin of t_child_aggr,
id type i,
type type string, " see e_report_type
url type string, " application URL
text type string,
end of t_child_aggr
|
||
| 3 | T_CHILD_AGGR_ELT | Public | See coding | 20121205 | begin of t_child_aggr_elt,
id type string, " unique id that is computed to be "stable"
url type string, " application URL
type type string, " see e_report_type
text type string,
end of t_child_aggr_elt
|
||
| 4 | T_CHILD_AGGR_FOLDER | Public | See coding | 20121205 | begin of t_child_aggr_folder,
id type string, " unique id that is computed to be "stable"
type type string, " see e_report_type
text type string,
end of t_child_aggr_folder
|
||
| 5 | T_MENU_ENTRY | Public | See coding | 20121008 | begin of t_menu_entry,
object_id type string, " node id
unique_id type string, " unique id that is computed to be "stable"
app_id type string, " unique application identifier
parent_id type string, " parent id
*
* agr_name TYPE agr_name, " role name
* origin_id TYPE string, " object_id of the node relative to the role (agr_name)
* menu_level TYPE string, " tree depth
report_type type string, " see e_report_type
* client_type TYPE string, " see e_client_type
* sort_order TYPE i, " sort sequence of the tree level
* target_system TYPE string, " if this application must be started on a different server
* sm59_rfc_dest_name TYPE rfcdes-rfcdest, " the related SM59 destination which contains the RFC data to that different server
url type string, " application URL
* url_base TYPE string, " only if /url#hash ==> /url
* url_hash TYPE string, " only if /url#hash ==> #hash
* is_hidden TYPE abap_bool, " not shown in tree
* force_sapgui TYPE abap_bool, " enable native SAPGUI rendering in the browser
* window_mode TYPE string, " window mode; values see constant interface
* is_report TYPE abap_bool, " special visualisation
* is_new_create TYPE abap_bool, " move into "new" menu
is_home_page type abap_bool, " homepage of the parent folder
* for_print TYPE abap_bool, " this entry is used to show "printed" documents, new icon in NWBC v1.0
* is_service_map TYPE abap_bool, " not used yet
* link_collection TYPE abap_bool, " folder is part of link collections
* single_top_level TYPE abap_bool, " display only one top level entry, rest on left panel
* menu_entry TYPE abap_bool, " these entries belong in top menu
* is_search TYPE abap_bool, " entry is a search application
* is_seldomly_used TYPE abap_bool, " not often used (will be hidden in menu)
* is_side_panel TYPE abap_bool, " entries of the folder are side panels for the parent folder
* is_force_dirty TYPE abap_bool, " Brian knows
* ref_id TYPE string, " homepage/folder reference (object id)
text type string, " display text
* description TYPE string, " tooltip text
* icon TYPE string, " icon only relevant for folder root nodes (level=1) when visualized on the shell
* icon_for_service_map TYPE string, " icon only relevant for folders when displayed in a service map (48x48)
* is_top_level TYPE abap_bool, " set if node is a top level node
* has_children type abap_bool, " set if the node has children
* is_disabled TYPE abap_bool, " entry is visible in tree, but disabled
* is_emphasized TYPE abap_bool, " entry should be visualized more prominent in tree
* inherited TYPE abap_bool, " especially at the moment for link collections, this entry is inherited from a parent node
* dont_cache TYPE abap_bool, " only set in extreme cases when entry cant be cached
* children_not_loaded TYPE abap_bool, " children of not available yet; skipped probably due to performance reasons
* application_alias TYPE string, " a string with no further meaning that applications can configure in PFCG to recognize entries again during BADI call
* nwbc_context TYPE string, " runtimee encoded string that encodes context for application to know from where it is started
* text_texts TYPE t_lang_texts,
* description_texts TYPE t_lang_texts,
end of t_menu_entry
|
||
| 6 | T_MENU_ENTRY_TOP_DOWN | Public | See coding | 20121017 | begin of t_menu_entry_top_down,
object_id type string, " node id
children type standard table of t_child
with key object_id, " table of children; identified by their object ids
end of t_menu_entry_top_down
|
||
| 7 | T_MENU_TREE | Public | See coding | 20121008 | t_menu_tree type standard table of t_menu_entry with key object_id
|
||
| 8 | T_MENU_TREE_TOP_DOWN | Public | See coding | 20121017 | t_menu_tree_top_down type hashed table of t_menu_entry_top_down with unique key object_id
|
||
| 9 | T_NODE_ASSOCIATED | Public | See coding | 20130618 | t_node_associated type standard table of ref to /ui2/if_node_association with DEFAULT KEY
|
||
| 10 | T_PATH | Public | See coding | 20130108 | t_path type table of t_path_element
|
||
| 11 | T_PATH_ELEMENT | Public | See coding | 20130108 | begin of t_path_element,
object_id type string,
depth type i,
end of t_path_element
|
Method Signatures
Method CONVERT_MENU_TREE_TOP_DOWN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IT_MENU_TREE | Call by reference | Object reference (TYPE REF TO) | T_MENU_TREE | 20121008 | |||
| 2 | Importing |
I_DEPTH | Call by reference | Type reference (TYPE) | I | -1 | # Levels to be read -1 means all | 20121120 | |
| 3 | Importing |
I_UNIQUE_ID | Call by reference | Type reference (TYPE) | STRING | initial is root | 20121120 | ||
| 4 |  Returning |
RT_MENU_TREE_TOP_DOWN | Value transfer | Object reference (TYPE REF TO) | T_MENU_TREE_TOP_DOWN | 20121008 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  /UI2/CX_RUNTIME |
UI2 Exception for data provider | 20130117 |
Method EXTRACT_PATH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_MENU_TREE | Call by reference | Object reference (TYPE REF TO) | T_MENU_TREE | 20121122 | |||
| 2 | Importing |
I_DEPTH | Call by reference | Type reference (TYPE) | I | -1 | # Levels to be read -1 means all | 20121122 | |
| 3 | Importing |
I_UNIQUE_ID | Call by reference | Type reference (TYPE) | STRING | initial is root | 20121122 | ||
| 4 | Returning |
RT_MENU_TREE_TOP_DOWN | Value transfer | Object reference (TYPE REF TO) | /UI2/IF_START_UP_MENU=>T_MENU_TREE_TOP_DOWN | 20121122 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /UI2/CX_RUNTIME |
UI2 Exception for data provider | 20130118 |
Method GET_ASSOCIATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_ASSOC_TYPE | Call by reference | Type reference (TYPE) | STRING | C_ASSOC_TYPE-CATALOG | Association_type | 20130222 | |
| 2 | Returning |
R_ASSOC_TAB | Value transfer | Type reference (TYPE) | STRING_TABLE | Table of Strings | 20130222 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /UI2/CX_RUNTIME |
UI2 Exception for data provider | 20130222 |
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_INSTANCE_TYPE | Call by reference | Type reference (TYPE) | SEOCLSNAME | Object Type Name | 20130305 | ||
| 2 | Returning |
RO_INSTANCE | Value transfer | Object reference (TYPE REF TO) | /UI2/IF_START_UP_MENU | Start Up Menu | 20130305 |
Method GET_INSTANCE on Interface /UI2/IF_START_UP_MENU has no exception.
Method GET_MENU_TREE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_INCLUDE_HIDDEN_ENTRIES | Call by reference | Type reference (TYPE) | BOOLEAN | Include hidden entries | 20130315 | ||
| 2 | Importing |
I_LEVEL | Value transfer | Type reference (TYPE) | I | -1 | # Levels to be read -1 means all | 20121119 | |
| 3 | Importing |
I_UNIQUE_ID | Call by reference | Type reference (TYPE) | STRING | initial is root | 20121119 | ||
| 4 | Returning |
RT_MENU_TREE | Value transfer | Object reference (TYPE REF TO) | T_MENU_TREE | 20121008 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /UI2/CX_RUNTIME |
UI2 Exception for data provider | 20130626 |
Method GET_NODES_ASSOCIATED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_ASSOC_TYPE | Call by reference | Type reference (TYPE) | STRING | C_ASSOC_TYPE-CATALOG | Association_type | 20130618 | |
| 2 | Returning |
R_ASSOC_TAB | Value transfer | Type reference (TYPE) | T_NODE_ASSOCIATED | Table of Strings | 20130618 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /UI2/CX_RUNTIME |
UI2 Exception for data provider | 20130618 |
Method GET_PATH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_PATH | Call by reference | Type reference (TYPE) | T_PATH | 20130108 | |||
| 2 | Importing |
IT_MENU_TREE | Call by reference | Object reference (TYPE REF TO) | T_MENU_TREE | 20130108 | |||
| 3 | Importing |
I_UNIQUE_ID | Call by reference | Type reference (TYPE) | STRING | initial is root | 20130108 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /UI2/CX_RUNTIME |
UI2 Exception for data provider | 20130118 |
Method SERIALIZE_MENU_TREE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_DEPTH | Call by reference | Type reference (TYPE) | I | -1 | # Generations to be read -1 means all | 20121120 | |
| 2 | Importing |
I_UNIQUE_ID | Call by reference | Type reference (TYPE) | STRING | initial is root | 20121119 | ||
| 3 | Returning |
R_MENU_TREE_SERIALIZED | Value transfer | Type reference (TYPE) | STRING | 20121019 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /UI2/CX_RUNTIME |
UI2 Exception for data provider | 20130117 |
Method SERIALIZE_PATH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_CAMEL_CASE | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20121204 | |||
| 2 | Importing |
I_DEPTH | Call by reference | Type reference (TYPE) | I | -1 | # Generations to be read -1 means all | 20121122 | |
| 3 | Importing |
I_UNIQUE_ID | Call by reference | Type reference (TYPE) | STRING | initial is root | 20121122 | ||
| 4 | Returning |
R_MENU_TREE_SERIALIZED | Value transfer | Type reference (TYPE) | STRING | 20121122 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /UI2/CX_RUNTIME |
UI2 Exception for data provider | 20130118 |
Method SET_DEPTH_AND_PATH_CHILD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_DEPTH | Call by reference | Type reference (TYPE) | I | -1 | 20130108 | ||
| 2 | Importing |
I_DEPTH_ENTRY | Call by reference | Type reference (TYPE) | I | -1 | 20130108 | ||
| 3 | Importing |
I_PATH | Call by reference | Type reference (TYPE) | T_PATH | 20130108 | |||
| 4 | Importing |
OBJECT_ID | Call by reference | Type reference (TYPE) | STRING | 20130108 | |||
| 5 |  Changing |
T_MENU_TREE_TOP_DOWN | Call by reference | Type reference (TYPE) | /UI2/IF_START_UP_MENU=>T_MENU_TREE_TOP_DOWN | 20130108 |
Method SET_DEPTH_AND_PATH_CHILD on Interface /UI2/IF_START_UP_MENU has no exception.
Method SET_DEPTH_CHILD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_DEPTH | Call by reference | Type reference (TYPE) | I | -1 | 20130108 | ||
| 2 | Importing |
I_DEPTH_ENTRY | Call by reference | Type reference (TYPE) | I | -1 | 20130108 | ||
| 3 | Importing |
OBJECT_ID | Call by reference | Type reference (TYPE) | STRING | 20130107 | |||
| 4 | Changing |
T_MENU_TREE_TOP_DOWN | Call by reference | Type reference (TYPE) | /UI2/IF_START_UP_MENU=>T_MENU_TREE_TOP_DOWN | 20130107 |
Method SET_DEPTH_CHILD on Interface /UI2/IF_START_UP_MENU has no exception.
History
| Last changed by/on | SAP | 20131127 |
| SAP Release Created in | 100 |
