SAP ABAP Class CL_BTP_WD_ASSIST_CTRL (BTP Web Dynpro Assistance Controller)

Hierarchy

☛ DMIS (Software Component) DMIS 2011_1
   ⤷ CA-EUR (Application Component) European Monetary Union: Euro
     ⤷ BTP_WD (Package) BTP Web Dynpro Layer

Properties

Class	CL_BTP_WD_ASSIST_CTRL
Short Description	BTP Web Dynpro Assistance Controller
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	BTP_WD	BTP Web Dynpro Layer
Created	20091229	SAP
Last change	20141030
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_BTP_WD_ASSIST_CTRL has no interface implemented.

Friends

Class CL_BTP_WD_ASSIST_CTRL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GV_LAST_PLUG_NAME	Static Attribute	Public	☐	Type reference (TYPE)	STRING			20100309
2	NC_UI_INVISIBLE	Constant	Public	☐	Type reference (TYPE)	WDUI_VISIBILITY	'01'	Web Dynpro: Visibility	20091229
3	NC_UI_VISIBLE	Constant	Public	☐	Type reference (TYPE)	WDUI_VISIBILITY	'02'	Web Dynpro: Visibility	20091229
4	PC_NAVPANEL_MAXSIZE	Constant	Private	☐	Type reference (TYPE)	INT4	320		20100107
5	PC_NAVPANEL_MINSIZE	Constant	Private	☐	Type reference (TYPE)	INT4	200		20100107
6	PC_NAVPANEL_STEPSIZE	Constant	Private	☐	Type reference (TYPE)	INT4	20		20100107
7	PR_WC_CONTENT_VIEW	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_WDR_VIEW		Web Dynpro: API of a View	20100104
8	PV_EDIT_MODE	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20100819
9	PV_IS_TREE_HIDDEN	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100503
10	PV_NAVPANEL_COLLAPSED	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20100107
11	PV_NAVPANEL_SIZE	Static Attribute	Private	☐	Type reference (TYPE)	INT4	220		20100107
12	PV_PF_SELECTED_ITAPPROACH	Static Attribute	Private	☐	Type reference (TYPE)	BTP_DL_GUID		BTP GUID	20100310
13	PV_PF_SELECTED_USECASE	Static Attribute	Private	☐	Type reference (TYPE)	BTP_DL_GUID		Selected use case in portfolio navigation	20091229
14	PV_READY_FOR_UPDATE	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Tree update status	20100122
15	PV_TDMS_PORTFOLIO_ACTIVE	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20100610

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20091229
2	DEC_NAVPANEL_SIZE	Static method	Public	Method	Decreases the navigation panel size by one step	20100107
3	GET_CONCATENATED_SYS_TEXT	Static method	Public	Method	Get concatination of a text and text from wording class	20100223
4	GET_DOCU_DISPLAY_TEXT	Static method	Public	Method	Get the concatenated text of docu object and version	20100129
5	GET_EDITMODE	Static method	Public	Method	Get Edit mode	20100819
6	GET_NAVPANEL_SIZE	Static method	Public	Method	Gets current size of the navigation panel in pixel	20100107
7	GET_PF_SELECTED_ITAPPROACH	Static method	Public	Method	Gets GUID of the selected use case in portfolio naviagtion	20100310
8	GET_PF_SELECTED_USECASE	Static method	Public	Method	Gets GUID of the selected use case in portfolio naviagtion	20091229
9	GET_URL	Static method	Public	Method	Build URL for SAPGUI	20100225
10	GET_WC_CONTENT_VIEW	Static method	Public	Method	Gets the reference to the workcenter content view	20100104
11	INC_NAVPANEL_SIZE	Static method	Public	Method	Increases the navigation panel size by one step	20100107
12	IS_DOCU_TREE_HIDDEN	Static method	Public	Method	Returns abap_true if tree is hidden	20100503
13	IS_NAVPANEL_COLLAPSED	Static method	Public	Method	Returns if naviation panel is collapsed	20100107
14	IS_TDMS_PORTFOLIO_ACTIVE	Static method	Public	Method	Check if TDMS Portfolio view is active	20100610
15	IS_TREE_READY_FOR_UPDATE	Static method	Public	Method	Returns true if tree must be updated	20100122
16	SET_DOCU_TREE_HIDDEN	Static method	Public	Method	If set the tree will be hidden in the help documentation	20100503
17	SET_EDITMODE	Static method	Public	Method	Set Edit mode	20100819
18	SET_NAVPANEL_COLLAPSED	Static method	Public	Method	Sets collapsed state of navigation panel	20100107
19	SET_PF_SELECTED_ITAPPROACH	Static method	Public	Method	Sets GUID of the selected use case in portfolio navigation	20100310
20	SET_PF_SELECTED_USECASE	Static method	Public	Method	Sets GUID of the selected use case in portfolio navigation	20091229
21	SET_TDMS_PORTFOLIO_ACTIVE	Static method	Public	Method	Set the TDMS portfolio as active	20100610
22	SET_TREE_READY_FOR_UPDATE	Static method	Public	Method	Sets to true if tree needs to be updated	20100122
23	SET_WC_CONTENT_VIEW	Static method	Public	Method	Sets the reference to the workcenter content view	20100104

Events

Class CL_BTP_WD_ASSIST_CTRL has no event.

Types

Class CL_BTP_WD_ASSIST_CTRL has no local type.

Method Signatures

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_BTP_WD_ASSIST_CTRL has no parameter.
Method CLASS_CONSTRUCTOR on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method DEC_NAVPANEL_SIZE Signature

Method DEC_NAVPANEL_SIZE on class CL_BTP_WD_ASSIST_CTRL has no parameter.
Method DEC_NAVPANEL_SIZE on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method GET_CONCATENATED_SYS_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	I		ID in cl_btp_dl_uiw	20100223
2	Importing	IV_REVERSE_ORDER	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		Put iv_text last in sentence.	20100223
3	Importing	IV_TEXT	Call by reference	☑	Type reference (TYPE)	STRING			20100223
4	Returning	RV_CONCATENATED_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20100223

Method GET_CONCATENATED_SYS_TEXT on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method GET_DOCU_DISPLAY_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DOCU_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20100129
2	Returning	RV_DISPLAY_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_DOCU_DISPLAY_TEXT on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method GET_EDITMODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_EDIT_MODE	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20100819

Method GET_EDITMODE on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method GET_NAVPANEL_SIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SIZE	Value transfer	☐	Type reference (TYPE)	INT4		Natural Number	20100107

Method GET_NAVPANEL_SIZE on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method GET_PF_SELECTED_ITAPPROACH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_GUID	Value transfer	☐	Type reference (TYPE)	BTP_DL_GUID		GUID of the selected use case in portfolio navigation	20100310

Method GET_PF_SELECTED_ITAPPROACH on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method GET_PF_SELECTED_USECASE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_GUID	Value transfer	☐	Type reference (TYPE)	BTP_DL_GUID		GUID of the selected use case in portfolio navigation	20091229

Method GET_PF_SELECTED_USECASE on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method GET_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTENT	Call by reference	☐	Type reference (TYPE)	STRING			20100225
2	Returning	RV_URL	Value transfer	☐	Type reference (TYPE)	STRING			20100225

Method GET_URL on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method GET_WC_CONTENT_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_VIEW	Value transfer	☐	Object reference (TYPE REF TO)	CL_WDR_VIEW		Web Dynpro: API of a View	20100104

Method GET_WC_CONTENT_VIEW on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method INC_NAVPANEL_SIZE Signature

Method INC_NAVPANEL_SIZE on class CL_BTP_WD_ASSIST_CTRL has no parameter.
Method INC_NAVPANEL_SIZE on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method IS_DOCU_TREE_HIDDEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_STATE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100503

Method IS_DOCU_TREE_HIDDEN on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method IS_NAVPANEL_COLLAPSED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_COLLAPSED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Navigation panel collapsed or not	20100107

Method IS_NAVPANEL_COLLAPSED on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method IS_TDMS_PORTFOLIO_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TDMS_PORTFOLIO_ACTIVE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100610

Method IS_TDMS_PORTFOLIO_ACTIVE on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method IS_TREE_READY_FOR_UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_READY_FOR_UPDATE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100122

Method IS_TREE_READY_FOR_UPDATE on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method SET_DOCU_TREE_HIDDEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STATE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20100503

Method SET_DOCU_TREE_HIDDEN on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method SET_EDITMODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EDIT_MODE	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20100819

Method SET_EDITMODE on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method SET_NAVPANEL_COLLAPSED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COLLAPSED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Navigation panel collapsed or not	20100107

Method SET_NAVPANEL_COLLAPSED on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method SET_PF_SELECTED_ITAPPROACH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	BTP_DL_GUID		GUID of selected use case	20100310

Method SET_PF_SELECTED_ITAPPROACH on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method SET_PF_SELECTED_USECASE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	BTP_DL_GUID		GUID of selected use case	20091229

Method SET_PF_SELECTED_USECASE on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method SET_TDMS_PORTFOLIO_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TDMS_PORTFOLIO_ACTIVE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100610

Method SET_TDMS_PORTFOLIO_ACTIVE on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method SET_TREE_READY_FOR_UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_READY_FOR_UPDATE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100122

Method SET_TREE_READY_FOR_UPDATE on class CL_BTP_WD_ASSIST_CTRL has no exception.

Method SET_WC_CONTENT_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	CL_WDR_VIEW		Web Dynpro: API of a View	20100104

Method SET_WC_CONTENT_VIEW on class CL_BTP_WD_ASSIST_CTRL has no exception.

History

Last changed by/on	SAP	20141030
SAP Release Created in	2006_1_700