SAP ABAP Class CL_CFX_TREE_UI (Collaboration Folders: Navigation Tree)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PLM-CFO (Application Component) Collaboration Folders
     ⤷ CFX_UI (Package) Collaboration Folders: User Interface

Properties

Class	CL_CFX_TREE_UI
Short Description	Collaboration Folders: Navigation Tree
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CFX_UI	Collaboration Folders: User Interface
Created	20001221	SAP
Last change	20141109
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_CFX_TREE_UI has no interface implemented.

Friends

Class CL_CFX_TREE_UI has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_NODES	Instance attribute	Private	☐	Type reference (TYPE)	CFX_TT_NODES		Node Data	20001221
2	M_NODE_NUMBER	Instance attribute	Private	☐	Type reference (TYPE)	I		Number of Rows	20001221
3	M_TREE	Instance attribute	Private	☐	Type reference (TYPE)	CFX_TS_TREE		Global Tree Data	20001221

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_NODE	Instance method	Public	Method	Add Node	20001222
2	CALCULATE_IDS_FROM_EVENT	Static method	Private	Method	Determine IDs for Expand All, Collapse All, Move Up/Down	20020626
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructing the Navigation Tree	20001221
4	GET_NODE	Instance method	Public	Method	Get Node Data	20001221
5	GET_NODE_NUMBER	Instance method	Public	Method	Get Number of Nodes	20001222
6	GET_TREE	Instance method	Public	Method	Get Global Tree Data	20001221
7	HANDLE_EVENTS	Static method	Public	Method	Handles Tree Events	20010116
8	SET_NODE	Instance method	Public	Method	Set Node Data	20001221
9	TOGGLE_NODE	Static method	Public	Method	Toggles the Node Status (Expanded/Collapsed)	20010823

Events

Class CL_CFX_TREE_UI has no event.

Types

Class CL_CFX_TREE_UI has no local type.

Method Signatures

Method ADD_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLOSE_WITH_CHILD	Call by reference	☑	Type reference (TYPE)	STRING		Flag. If set, there are children and node is closed	20001227
2	Importing	I_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	STRING		Description	20001227
3	Importing	I_HREF	Call by reference	☑	Type reference (TYPE)	STRING		Link	20001227
4	Importing	I_INDENTATION	Call by reference	☑	Type reference (TYPE)	STRING		Indentation in pixels	20001227
5	Importing	I_MARKED	Call by reference	☑	Type reference (TYPE)	STRING		Node has focus	20010111
6	Importing	I_NODELEVEL	Call by reference	☑	Type reference (TYPE)	STRING		Nodelevel	20020416
7	Importing	I_NODETYPE	Call by reference	☑	Type reference (TYPE)	STRING		Nodetype	20050408
8	Importing	I_NO_CHILD	Call by reference	☑	Type reference (TYPE)	STRING		Flag. If set, no child exists.	20001227
9	Importing	I_OBJECT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Id of the represented object	20010111
10	Importing	I_OPEN_WITH_CHILD	Call by reference	☑	Type reference (TYPE)	STRING		Flag. If set; there are children and node is expanded	20001227
11	Importing	I_TEXT	Call by reference	☑	Type reference (TYPE)	STRING		Text of node	20001222
12	Returning	R_NEW_NODE_INDEX	Value transfer	☐	Type reference (TYPE)	I		Index of new node	20001222

Method ADD_NODE on class CL_CFX_TREE_UI has no exception.

Method CALCULATE_IDS_FROM_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_COL_ID	Call by reference	☐	Type reference (TYPE)	STRING			20020626
2	Changing	C_TOPIC_ID	Call by reference	☐	Type reference (TYPE)	STRING			20020626
3	Importing	I_FOLDER_ID	Call by reference	☐	Type reference (TYPE)	STRING			20020626

Method CALCULATE_IDS_FROM_EVENT on class CL_CFX_TREE_UI has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COLLABORATION_ID	Call by reference	☐	Type reference (TYPE)	STRING		Collaboration Id	20010115
2	Importing	I_DOC_ID	Call by reference	☑	Type reference (TYPE)	STRING		Doc Id	20050413
3	Importing	I_TOPIC_ID	Call by reference	☑	Type reference (TYPE)	STRING		Topic Id	20010126

Method CONSTRUCTOR on class CL_CFX_TREE_UI has no exception.

Method GET_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CLOSE_WITH_CHILD	Call by reference	☐	Type reference (TYPE)	STRING		Flag. If set, there are children and node is closed	20001227
2	Exporting	E_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	STRING		Description	20001227
3	Exporting	E_HREF	Call by reference	☐	Type reference (TYPE)	STRING		Link	20001227
4	Exporting	E_INDENTATION	Call by reference	☐	Type reference (TYPE)	STRING		Indentation in pixels	20001227
5	Exporting	E_MARKED	Call by reference	☐	Type reference (TYPE)	STRING		Node has focus	20010111
6	Exporting	E_NODELEVEL	Call by reference	☐	Type reference (TYPE)	STRING		Nodelevel	20020416
7	Exporting	E_NODETYPE	Call by reference	☐	Type reference (TYPE)	STRING		Nodetype	20050408
8	Exporting	E_NO_CHILD	Call by reference	☐	Type reference (TYPE)	STRING		Flag. If set ,no child exists	20001227
9	Exporting	E_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	STRING		Id of the represented object	20010111
10	Exporting	E_OPEN_WITH_CHILD	Call by reference	☐	Type reference (TYPE)	STRING		Flag. If set, there are children and node is expanded	20001227
11	Exporting	E_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Text of node	20001221
12	Exporting	E_TOOLTIP	Call by reference	☐	Type reference (TYPE)	STRING		Tooltip	20011015
13	Importing	I_NODE_INDEX	Value transfer	☐	Type reference (TYPE)	I		Index of node	20001221

Method GET_NODE on class CL_CFX_TREE_UI has no exception.

Method GET_NODE_NUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_NODE_NUMBER	Value transfer	☐	Type reference (TYPE)	I		Number of nodes	20001222

Method GET_NODE_NUMBER on class CL_CFX_TREE_UI has no exception.

Method GET_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_COL_ID	Call by reference	☐	Type reference (TYPE)	STRING		Collaboration id	20010131
2	Exporting	E_COL_URL	Call by reference	☐	Type reference (TYPE)	STRING		URL of collaboration	20010201
3	Exporting	E_ERROR_MSG	Call by reference	☐	Type reference (TYPE)	STRING		Error message	20010131
4	Exporting	E_OTR_EMPTY	Call by reference	☐	Type reference (TYPE)	STRING		OTR:cfx/no_entries	20010212
5	Exporting	E_READ_AUTHORITY	Call by reference	☐	Type reference (TYPE)	STRING		Read authority	20011206
6	Exporting	E_TITLE	Call by reference	☐	Type reference (TYPE)	STRING		Title of tree	20010131
7	Exporting	E_TOOLTIP	Call by reference	☐	Type reference (TYPE)	STRING		Tooltip	20011015
8	Exporting	E_TOPIC_ID	Call by reference	☐	Type reference (TYPE)	STRING		Topic id	20010131

Method GET_TREE on class CL_CFX_TREE_UI has no exception.

Method HANDLE_EVENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_NAVIGATION	Call by reference	☑	Object reference (TYPE REF TO)	IF_BSP_NAVIGATION		BSP Navigation	20010116
2	Importing	IP_REQUEST	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		BSP navigation object	20010116
3	Importing	IT_PARAMS	Call by reference	☑	Type reference (TYPE)	CFX_TT_NAV_PARAMS		CFX: Navigation parameters	20011012
4	Importing	I_AREA_ID	Call by reference	☑	Type reference (TYPE)	STRING		Parameter "Area id"	20010924
5	Importing	I_COL_ID	Call by reference	☑	Type reference (TYPE)	STRING		Parameter "Collaboration id"	20010924
6	Importing	I_EVENT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Event id	20010924
7	Importing	I_TOPIC_ID	Call by reference	☑	Type reference (TYPE)	STRING		Parameter "Topic id"	20010924
8	Returning	R_EVENT_HANDLED	Value transfer	☐	Type reference (TYPE)	STRING		Is set when handler handled the event	20010117

Method HANDLE_EVENTS on class CL_CFX_TREE_UI has no exception.

Method SET_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLOSE_WITH_CHILD	Call by reference	☑	Type reference (TYPE)	STRING		Flag. When set: There are children and node is closed	20001227
2	Importing	I_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	STRING		Description	20001227
3	Importing	I_HREF	Call by reference	☑	Type reference (TYPE)	STRING		Link	20001227
4	Importing	I_INDENTATION	Call by reference	☑	Type reference (TYPE)	STRING		Indentation (in pixels)	20001227
5	Importing	I_MARKED	Call by reference	☑	Type reference (TYPE)	STRING		Node has focus	20010111
6	Importing	I_NODELEVEL	Call by reference	☑	Type reference (TYPE)	STRING		Nodelevel	20020416
7	Importing	I_NODETYPE	Call by reference	☑	Type reference (TYPE)	STRING		Nodetype	20050408
8	Importing	I_NODE_INDEX	Value transfer	☐	Type reference (TYPE)	I		Index of node	20001221
9	Importing	I_NO_CHILD	Call by reference	☑	Type reference (TYPE)	STRING		Flag. When set: No child exists.	20001227
10	Importing	I_OBJECT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Id of the represented object	20010111
11	Importing	I_OPEN_WITH_CHILD	Call by reference	☑	Type reference (TYPE)	STRING		Flag. When set: There are children and node is expanded	20001227
12	Importing	I_TEXT	Call by reference	☑	Type reference (TYPE)	STRING		Text	20001221

Method SET_NODE on class CL_CFX_TREE_UI has no exception.

Method TOGGLE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_TOPIC_ID	Call by reference	☑	Type reference (TYPE)	STRING		Topic id	20010911
2	Importing	IP_NAVIGATION	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_NAVIGATION		Business Server Page (BSP) Navigation	20011113
3	Importing	IP_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20010911
4	Importing	I_AREA_ID	Call by reference	☐	Type reference (TYPE)	STRING		Area Id	20011113
5	Importing	I_COL_ID	Call by reference	☐	Type reference (TYPE)	STRING		Collaboration id	20010911
6	Importing	I_DOC_ID	Call by reference	☑	Type reference (TYPE)	STRING		Doc id	20050412

Method TOGGLE_NODE on class CL_CFX_TREE_UI has no exception.

History

Last changed by/on	SAP	20141109
SAP Release Created in	20A