SAP ABAP Class CL_FDT_WD_HIERARCHY_UTILITIES (Utility class for CTable hierarchies.)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-BR (Application Component) BRFplus - ABAP-Based Business Rules
     ⤷ SFDT_WD_SERVICE (Package) BRFplus: Services for Web Dynpro UI

Properties

Class	CL_FDT_WD_HIERARCHY_UTILITIES
Short Description	Utility class for CTable hierarchies.
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SFDT_WD_SERVICE	BRFplus: Services for Web Dynpro UI
Created	20120625	SAP
Last change	20130531	SAP
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)
2	CL_WD_C_TBL_HIERARCHICAL_CELL	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_FDT_WD_HIERARCHY_UTILITIES has no interface implemented.

Friends

Class CL_FDT_WD_HIERARCHY_UTILITIES has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_DEFAULT_COLLAPSED	Constant	Public	☐	Type reference (TYPE)	WDUI_C_TABLE_HIERACHICAL_STATE	CL_WD_C_TBL_HIERARCHICAL_CELL=>E_HIERACHICAL_STATE-COLLAPSED	Default collapsed type.	20120828
2	GC_DEFAULT_EXPANDED	Constant	Public	☐	Type reference (TYPE)	WDUI_C_TABLE_HIERACHICAL_STATE	CL_WD_C_TBL_HIERARCHICAL_CELL=>E_HIERACHICAL_STATE-EXPANDED	Default expanded type.	20120828
3	GC_DEFAULT_HIERARCHICAL_STATE	Constant	Public	☐	Type reference (TYPE)	STRING	'HIERARCHICAL_STATE'	Default name for hierarchical state element.	20120828
4	GC_DEFAULT_KEY	Constant	Public	☐	Type reference (TYPE)	STRING	'KEY'	Default name for key element.	20120828
5	GC_DEFAULT_LEAF	Constant	Public	☐	Type reference (TYPE)	WDUI_C_TABLE_HIERACHICAL_STATE	CL_WD_C_TBL_HIERARCHICAL_CELL=>E_HIERACHICAL_STATE-LEAF	Leaf.	20120828
6	GC_DEFAULT_LEVEL	Constant	Public	☐	Type reference (TYPE)	STRING	'LEVEL'	Default name for level element	20120828
7	GC_DEFAULT_PARENT_KEY	Constant	Public	☐	Type reference (TYPE)	STRING	'PARENT'	Default name for parent key element.	20120828
8	MV_COLLAPSED	Instance attribute	Private	☐	Type reference (TYPE)	WDUI_C_TABLE_HIERACHICAL_STATE		Collapsed type.	20120625
9	MV_EXPANDED	Instance attribute	Private	☐	Type reference (TYPE)	WDUI_C_TABLE_HIERACHICAL_STATE		Expanded type.	20120625
10	MV_HIERARCHICAL_STATE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Name of hierarchical state element.	20120625
11	MV_KEY	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Name of key element.	20120625
12	MV_LEVEL	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Name of level element.	20120625
13	MV_PARENT_KEY	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Name of parent key element.	20120625

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	COLLAPSE_ALL	Instance method	Public	Method	Collapses all nodes.	20120625
2	COLLAPSE_NODE	Instance method	Public	Method	Collapses the specified node(s).	20120625
3	COLLAPSE_OR_EXPAND_ALL_NODES	Instance method	Private	Method	Collapses or expands all nodes.	20120625
4	COLLAPSE_OR_EXPAND_NODE	Instance method	Private	Method	Collapse or expand a node.	20120625
5	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20120625
6	CREATE_HIERARCHY_FROM_PARENT	Instance method	Public	Method	Create hierarchy from row_key / parent_key.	20120625
7	DETERMINE_DISPLAYED_NODES	Instance method	Public	Method	Determines nodes which are displayed (expanded)	20120625
8	EXPAND_ALL	Instance method	Public	Method	Expands all nodes.	20120625
9	EXPAND_NODE	Instance method	Public	Method	Expands the specified node(s).	20120625
10	GET_SORTED_CHILD_NODES	Instance method	Private	Method	Return sorted child nodes.	20120626
11	LIMIT_EXPANDED_CHILDREN	Instance method	Public	Method	Collapse all nodes which have too many children	20120904
12	SORT_NODES_BY_PARENT	Instance method	Public	Method	Sort nodes by parent.	20120626

Events

Class CL_FDT_WD_HIERARCHY_UTILITIES has no event.

Types

Class CL_FDT_WD_HIERARCHY_UTILITIES has no local type.

Method Signatures

Method COLLAPSE_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_NODE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		All nodes which are in the table.	20120726
2	Exporting	ET_DISPLAYED_NODE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Nodes which are displayed in the CTable.	20120726

Method COLLAPSE_ALL on class CL_FDT_WD_HIERARCHY_UTILITIES has no exception.

Method COLLAPSE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DISPLAYED_NODE	Call by reference	☑	Type reference (TYPE)	ANY TABLE		Nodes which are displayed in the CTable.	20120726
2	Changing	CT_NODE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		All nodes which are in the table.	20120726
3	Importing	IV_INDEX	Call by reference	☑	Type reference (TYPE)	SYTABIX		Index to determine affected node	20120625
4	Importing	IV_KEY	Call by reference	☑	Type reference (TYPE)	ANY		Key value to determine affected node	20120625
5	Importing	IV_WHERE_COND	Call by reference	☑	Type reference (TYPE)	STRING		Where Condition to determine affected nodes	20120904

Method COLLAPSE_NODE on class CL_FDT_WD_HIERARCHY_UTILITIES has no exception.

Method COLLAPSE_OR_EXPAND_ALL_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_NODE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		All nodes	20120726
2	Exporting	ET_DISPLAYED_NODE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Nodes which are displayed on the UI	20120726
3	Importing	IV_EXPAND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		True = Expand nodes.	20120625

Method COLLAPSE_OR_EXPAND_ALL_NODES on class CL_FDT_WD_HIERARCHY_UTILITIES has no exception.

Method COLLAPSE_OR_EXPAND_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DISPLAYED_NODE	Call by reference	☑	Type reference (TYPE)	ANY TABLE		Nodes which are displayed on the UI	20120726
2	Changing	CT_NODE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		All nodes	20120726
3	Importing	IV_EXPAND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120625
4	Importing	IV_INDEX	Call by reference	☑	Type reference (TYPE)	SYTABIX		Index to determine affected node	20120625
5	Importing	IV_KEY	Call by reference	☑	Type reference (TYPE)	ANY		Key value to determine affected node	20120625
6	Importing	IV_WHERE_COND	Call by reference	☑	Type reference (TYPE)	STRING		Where Condition to determine affected nodes	20120904

Method COLLAPSE_OR_EXPAND_NODE on class CL_FDT_WD_HIERARCHY_UTILITIES has no exception.

Method CONSTRUCTOR 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)	WDUI_C_TABLE_HIERACHICAL_STATE	GC_DEFAULT_COLLAPSED	Collapsed type.	20120625
2	Importing	IV_EXPANDED	Call by reference	☐	Type reference (TYPE)	WDUI_C_TABLE_HIERACHICAL_STATE	GC_DEFAULT_EXPANDED	Expanded type.	20120625
3	Importing	IV_HIERARCHICAL_STATE	Call by reference	☐	Type reference (TYPE)	STRING	GC_DEFAULT_HIERARCHICAL_STATE	Name of hierarchical state element.	20120625
4	Importing	IV_KEY	Call by reference	☐	Type reference (TYPE)	STRING	GC_DEFAULT_KEY	Name of key element.	20120625
5	Importing	IV_LEVEL	Call by reference	☐	Type reference (TYPE)	STRING	GC_DEFAULT_LEVEL	Name of level element.	20120625
6	Importing	IV_PARENT_KEY	Call by reference	☐	Type reference (TYPE)	STRING	GC_DEFAULT_PARENT_KEY	Name of parent key element.	20120625

Method CONSTRUCTOR on class CL_FDT_WD_HIERARCHY_UTILITIES has no exception.

Method CREATE_HIERARCHY_FROM_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_NODE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		All nodes which are in the table	20120726
2	Importing	IV_EXPAND_ALL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	If all nodes should be expanded at the beginning.	20120625
3	Importing	IV_LEAN_TRACE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20121214

Method CREATE_HIERARCHY_FROM_PARENT on class CL_FDT_WD_HIERARCHY_UTILITIES has no exception.

Method DETERMINE_DISPLAYED_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DISPLAYED_NODE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Nodes which are displayed in the CTable.	20120726
2	Importing	IT_NODE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		All nodes which are in the table.	20120726

Method DETERMINE_DISPLAYED_NODES on class CL_FDT_WD_HIERARCHY_UTILITIES has no exception.

Method EXPAND_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_NODE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		All nodes which are in the table.	20120726
2	Exporting	ET_DISPLAYED_NODE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Nodes which are displayed in the CTable.	20120726

Method EXPAND_ALL on class CL_FDT_WD_HIERARCHY_UTILITIES has no exception.

Method EXPAND_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DISPLAYED_NODE	Call by reference	☑	Type reference (TYPE)	INDEX TABLE		Nodes which are displayed in the CTable.	20120726
2	Changing	CT_NODE	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		All nodes which are in the table.	20120726
3	Importing	IV_INDEX	Call by reference	☑	Type reference (TYPE)	SYTABIX		Index to determine affected node	20120625
4	Importing	IV_KEY	Call by reference	☑	Type reference (TYPE)	ANY		Key value to determine affected node	20120625
5	Importing	IV_WHERE_COND	Call by reference	☑	Type reference (TYPE)	STRING		Where Condition to determine affected nodes	20120904

Method EXPAND_NODE on class CL_FDT_WD_HIERARCHY_UTILITIES has no exception.

Method GET_SORTED_CHILD_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_SORTED_CHILD_NODE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Sorted child nodes	20120726
2	Importing	IT_NODE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		All nodes	20120726
3	Importing	IV_PARENT_KEY	Call by reference	☐	Type reference (TYPE)	ANY			20120626

Method GET_SORTED_CHILD_NODES on class CL_FDT_WD_HIERARCHY_UTILITIES has no exception.

Method LIMIT_EXPANDED_CHILDREN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_NODE	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		All nodes	20120904
2	Changing	CV_INDEX	Call by reference	☐	Type reference (TYPE)	SYTABIX	1	Do not pass this Parameter!	20120904
3	Exporting	ET_DISPLAYED_NODE	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Displayed nodes	20120904
4	Importing	IV_LIMIT	Call by reference	☐	Type reference (TYPE)	NUMERIC		Collapse all nodes which have more children then IV_LIMIT	20120904

Method LIMIT_EXPANDED_CHILDREN on class CL_FDT_WD_HIERARCHY_UTILITIES has no exception.

Method SORT_NODES_BY_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SORTED_NODE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		All nodes sorted	20120726
2	Importing	IT_NODE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		All nodes	20120726

Method SORT_NODES_BY_PARENT on class CL_FDT_WD_HIERARCHY_UTILITIES has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	740