SAP ABAP Class /ASU/CL_SSM_NAVIGATION_BOX (Navigation Docking Container)

Hierarchy

☛ ST-PI (Software Component) SAP Solution Tools Plug-In
   ⤷ SV-SMG-ASU (Application Component) Application-Specific Upgrade
     ⤷ /ASU/MAIN (Package) Application-Specific Upgrade

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_GUI_DOCKING_CONTAINER	Docking Control Container	20080610

Properties

Class	/ASU/CL_SSM_NAVIGATION_BOX
Short Description	Navigation Docking Container
Super Class	CL_GUI_DOCKING_CONTAINER	Docking Control Container
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/ASU/MAIN	Application-Specific Upgrade
Created	20080610	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_GUI_CFW	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	ICON	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class /ASU/CL_SSM_NAVIGATION_BOX has no interface implemented.

Friends

Class /ASU/CL_SSM_NAVIGATION_BOX has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_FCODE_CLOSE	Constant	Protected	☐	Type reference (TYPE)	SYUCOMM	'CLOSE'	Fcode Show	20080618
2	GC_FCODE_DISPLAY	Constant	Protected	☐	Type reference (TYPE)	SYUCOMM	'DISPLAY'	Fcode Show	20080617
3	GC_FCODE_DISPLAY_SOURCE	Constant	Protected	☐	Type reference (TYPE)	SYUCOMM	'DISPLAYSO'	Fcode Show	20080618
4	GD_DOCKING_CONTAINER_HIDDEN	Instance attribute	Private	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20080808
5	GD_SOURCE_STEP	Instance attribute	Private	☐	Type reference (TYPE)	/ASU/SSMTREE_CO		ASU: Content Object & ALV Tree Entry	20080618
6	GD_SSM_ALV_TREE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	/ASU/CL_SSM_ALV_TREE		Classical ALV Tree ASU Smple Schedule Manager	20080617
7	GT_FIELDCATALOG	Instance attribute	Private	☐	Type reference (TYPE)	LVC_T_FCAT		Field catalog for ListViewer control	20080612
8	GT_OUTTAB	Instance attribute	Protected	☐	Type reference (TYPE)	TY_NAVIBOX_TAB		ALV Grid Output Table	20080612
9	GT_TB_EXCLUDE	Instance attribute	Private	☐	Type reference (TYPE)	UI_FUNCTIONS		Toolbar Exclude Function Code Table	20080613
10	G_ALV_GRID	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GUI_ALV_GRID		ALV List Viewer	20080610

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20080610
2	FILL_FIELDCATALOG_TREE	Instance method	Private	Method	Fill fieldcatalog for ALV grid	20080612
3	GET_USER_STATUS_ICON	Instance method	Protected	Method	Determine User Status	20080808
4	HANDLE_CONTEXT_MENU_REQUEST	Instance method	Protected	Event handling method	Context Menu Requesed Event ALV Grid	20080617
5	HANDLE_DOUBLE_CLICK	Instance method	Protected	Event handling method	Tolbar Double Click Event ALV Grid	20080617
6	HANDLE_FUNCTION_SELECTED	Instance method	Public	Event handling method	Function Selected	20080610
7	HANDLE_TOOLBAR	Instance method	Protected	Event handling method	Toolbar Event ALV Grid	20080617
8	HANDLE_USER_COMMAND	Instance method	Protected	Event handling method	User Command Event ALV Grid	20080617
9	HIDE	Instance method	Public	Method	Hide Docking Control	20080612
10	INIT	Instance method	Public	Method	Initialize docking control	20080610
11	IS_HIDDEN	Instance method	Public	Method	Is Docking Container hidden or visible?	20080808
12	REFRESH	Instance method	Public	Method	Refresh Naviagtion Box (f.g. user status)	20080808
13	SHOW_STEPS	Instance method	Public	Method	Show steps in navigation box	20080612
14	UNHIDE	Instance method	Public	Method	Unhide Docking Control	20080612

Events

Class /ASU/CL_SSM_NAVIGATION_BOX has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_NAVIBOX_TAB	Protected	See coding			20080613

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CLOSE_BUTTON	Call by reference	☐	Type reference (TYPE)	CHAR1	'X'	'X'	20080610
2	Importing	IM_DISPLAY_STATE	Call by reference	☐	Type reference (TYPE)	CHAR1	'H'	Hidden = 'H' Unhidden = 'U'	20080610
3	Importing	IM_DYNNR	Call by reference	☐	Type reference (TYPE)	SYDYNNR		Dynpro	20080610
4	Importing	IM_EXTENSION	Call by reference	☐	Type reference (TYPE)	I	265	Extension in pixel (default 300)	20080610
5	Importing	IM_LIFETIME	Call by reference	☐	Type reference (TYPE)	I	LIFETIME_DEFAULT	Lifetime	20080610
6	Importing	IM_REPID	Call by reference	☐	Type reference (TYPE)	SYREPID		Report	20080610
7	Importing	IM_SIDE	Call by reference	☐	Type reference (TYPE)	I	DOCK_AT_LEFT	Docking side	20080610
8	Importing	IM_SSM_ALV_TREE	Call by reference	☐	Object reference (TYPE REF TO)	/ASU/CL_SSM_ALV_TREE		Classical ALV Tree ASU Smple Schedule Manager	20080617

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control Error	20080610
2	CNTL_SYSTEM_ERROR	☐	Control System Error	20080610
3	CREATE_ERROR	☐	Error when creating the docking control	20080610
4	LIFETIME_DYNPRO_DYNPRO_LINK	☐	lifetime_dynpro_dynpro_link	20080610
5	LIFETIME_ERROR	☐	Lifetime error	20080610

Method FILL_FIELDCATALOG_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_STRUCTURE	Call by reference	☐	Type reference (TYPE)	TABNAME		Table name	20080612

Method FILL_FIELDCATALOG_TREE on class /ASU/CL_SSM_NAVIGATION_BOX has no exception.

Method GET_USER_STATUS_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_USER_STATUS_ICON	Call by reference	☐	Type reference (TYPE)	/ASU/USER_STATUS_ICON		ASU: The status as icon that the user has defined	20080808
2	Importing	IM_ID	Call by reference	☐	Type reference (TYPE)	/ASU/ID		ASU - General ID f.g. sequence number	20080808
3	Importing	IM_TASKLIST	Call by reference	☐	Type reference (TYPE)	PEPPROFILE		Schedule Manager: Task list	20080808

Method GET_USER_STATUS_ICON on class /ASU/CL_SSM_NAVIGATION_BOX has no exception.

Method HANDLE_CONTEXT_MENU_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	E_OBJECT	Call by reference	☐	Attribute reference (LIKE)				20080617

Method HANDLE_CONTEXT_MENU_REQUEST on class /ASU/CL_SSM_NAVIGATION_BOX has no exception.

Method HANDLE_DOUBLE_CLICK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ES_ROW_NO	Call by reference	☐	Attribute reference (LIKE)				20080617
2	Importing	E_COLUMN	Call by reference	☐	Attribute reference (LIKE)				20080617
3	Importing	E_ROW	Call by reference	☐	Attribute reference (LIKE)				20080617

Method HANDLE_DOUBLE_CLICK on class /ASU/CL_SSM_NAVIGATION_BOX has no exception.

Method HANDLE_FUNCTION_SELECTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Attribute reference (LIKE)				20080617

Method HANDLE_FUNCTION_SELECTED on class /ASU/CL_SSM_NAVIGATION_BOX has no exception.

Method HANDLE_TOOLBAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	E_INTERACTIVE	Call by reference	☐	Attribute reference (LIKE)				20080617
2	Importing	E_OBJECT	Call by reference	☐	Attribute reference (LIKE)				20080617

Method HANDLE_TOOLBAR on class /ASU/CL_SSM_NAVIGATION_BOX has no exception.

Method HANDLE_USER_COMMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	E_UCOMM	Call by reference	☐	Attribute reference (LIKE)				20080617

Method HANDLE_USER_COMMAND on class /ASU/CL_SSM_NAVIGATION_BOX has no exception.

Method HIDE Signature

Method HIDE on class /ASU/CL_SSM_NAVIGATION_BOX has no parameter.
Method HIDE on class /ASU/CL_SSM_NAVIGATION_BOX has no exception.

Method INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CLOSE_BUTTON	Call by reference	☐	Type reference (TYPE)	CHAR1	'X'	Inserts a close button	20080610
2	Importing	IM_DISPLAY_STATE	Call by reference	☐	Type reference (TYPE)	CHAR1	'U'	Hidden = 'H' Unhidden = 'U'	20080610
3	Importing	IM_DYNNR	Call by reference	☐	Type reference (TYPE)	SYDYNNR		ABAP program, number of current screen	20080610
4	Importing	IM_EXTENSION	Call by reference	☐	Type reference (TYPE)	I	300	Extension in pixel (default 300)	20080610
5	Importing	IM_REPID	Call by reference	☐	Type reference (TYPE)	SYREPID		ABAP program, current main program	20080610
6	Importing	IM_SIDE	Call by reference	☐	Type reference (TYPE)	CHAR1	'L'	Docked 'L' , 'R', 'T' or 'B'	20080610

Method INIT on class /ASU/CL_SSM_NAVIGATION_BOX has no exception.

Method IS_HIDDEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_FLAG	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20080808

Method IS_HIDDEN on class /ASU/CL_SSM_NAVIGATION_BOX has no exception.

Method REFRESH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_SSMTREES_CO	Call by reference	☐	Type reference (TYPE)	/ASU/SSMTREE_CO		ASU: Content Object & ALV Tree Entry	20080808
2	Importing	IM_TASKLIST	Call by reference	☐	Type reference (TYPE)	PEPPROFILE		Schedule Manager: Task list	20080808

Method REFRESH on class /ASU/CL_SSM_NAVIGATION_BOX has no exception.

Method SHOW_STEPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DEP_STEPS	Call by reference	☐	Type reference (TYPE)	/ASU/SSMTREE_CO_T		Table Type ASU: SSM Tree Entry & Content Object	20080617
2	Importing	IM_STEP	Call by reference	☐	Type reference (TYPE)	/ASU/SSMTREE_CO		ASU: Content Object & ALV Tree Entry	20080617

Method SHOW_STEPS on class /ASU/CL_SSM_NAVIGATION_BOX has no exception.

Method UNHIDE Signature

Method UNHIDE on class /ASU/CL_SSM_NAVIGATION_BOX has no parameter.
Method UNHIDE on class /ASU/CL_SSM_NAVIGATION_BOX has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	2005_1_46C