SAP ABAP Class CL_CONTROL_TREE_NODE (Control Tree Node)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-TOO (Application Component) Workbench Tools: Editors, Painters, Modelers
     ⤷ SEU_CONTROL_COMPOSITE (Package) Tools and Utilities for Controls: Composite and Loader

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CONTROL_TREE_NODE	Structural Description of a Control Composite	19990909
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CONTROL_TREE_NODE_DIAG	Diagnostic Supplements	19990910

Properties

Class	CL_CONTROL_TREE_NODE
Short Description	Control Tree Node
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SEU_CONTROL_COMPOSITE	Tools and Utilities for Controls: Composite and Loader
Created	19990909	SAP
Last change	20000411	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_CONTROL_TREE_NODE has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_CONTROL_TREE_NODE	☐	☐	Structural Description of a Control Composite	19990909
2	IF_CONTROL_TREE_NODE_DIAG	☐	☐	Diagnostic Supplements	19990910

Friends

Class CL_CONTROL_TREE_NODE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CONTROL_COMPOSITE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CONTROL_COMPOSITE		Handle of Relevant Control Composite	20000218
2	CONTROL_PROXY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTROL		Handle of GUI Control Proxy	19990921
3	DOM_NODE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		Handle of Node in iXML DOM	19990913
4	FIRST_CHILD	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		First Subnode	19991111
5	LAST_CHILD	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Last Subnode	19991111
6	NEXT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Successor Same-Level Node	19991111
7	PARENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Superior Node	19991111
8	PREVIOUS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Previous Same-Level Node	19991111
9	XML_NAME_CLASS_NAME	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'Class'	Literal Constant	20000328
10	XML_NAME_COMMENT	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'Comment'	Literal Constant	19991020
11	XML_NAME_DOCU_TEXT_NAME	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'DocuTextName'	Literal Constant	20000605
12	XML_NAME_FACTORY_CLASS_NAME	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'FactoryClass'	Literal Constant	20000328
13	XML_NAME_HANDLER	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'Handler'	Literal Constant	19991022
14	XML_NAME_NAME	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'Name'	Literal Constant	19990929
15	XML_NAME_OBJECT_NAME	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'ObjectName'	Literal Constant	20000405
16	XML_NAME_OBJECT_TYPE	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'ObjectType'	Literal Constant	20000405
17	XML_NAME_READ_ONLY	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'ReadOnly'	Literal Constant	19991111
18	XML_NAME_SUBTYPE	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'Subtype'	Literal Constant	19991020
19	XML_NAME_TYPE	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'Type'	Literal Constant	19990929
20	XML_NAME_VALUE	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'Value'	Literal Constant	19990929
21	XML_NODE_TYPE_CONTAINER	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'Container'	Literal Constant	19990930
22	XML_NODE_TYPE_CONTROL	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'Control'	Literal Constant	19990929
23	XML_NODE_TYPE_CONTROL_COMP	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'ControlComposite'	Literal Constant	19990929
24	XML_NODE_TYPE_CONTROL_EVENTS	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'ControlEvents'	Literal Constant	19990929
25	XML_NODE_TYPE_CONTROL_PROPS	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'ControlProps'	Literal Constant	19990929
26	XML_NODE_TYPE_EVENT	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'Event'	Literal Constant	19990929
27	XML_NODE_TYPE_PLUG_IN	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'PlugIn'	Literal Constant	20000405
28	XML_NODE_TYPE_PROP	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'Prop'	Literal Constant	19990929
29	XML_NODE_TYPE_PROP_LIST	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'PropList'	Literal Constant	19991118
30	XML_NODE_TYPE_PROP_TREE	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'PropTree'	Literal Constant	19990929
31	XML_TYPE_BOOLE	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'BOOLE'	Literal Constant	19990929
32	XML_TYPE_ENUM	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'ENUM'	Literal Constant	19991020
33	XML_TYPE_ICON	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'ICON'	Literal Constant	19991020
34	XML_TYPE_INT	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'INT'	Literal Constant	19990929
35	XML_TYPE_STRING	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'STRING'	Literal Constant	19991020
36	XML_TYPE_TEXT	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'TEXT'	Literal Constant	19991020
37	XML_VALUE_FALSE	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'FALSE'	Literal Constant	19990929
38	XML_VALUE_TRUE	Static Attribute	Private	☐	Type reference (TYPE)	COCONAME	'TRUE'	Literal Constant	19990929

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_NODE	Instance method	Private	Method	Creates a New Node and Inserts it as a Subnode	19991103
2	COLLECT_TEXT_IDS_FROM_DOM_TREE	Static method	Private	Method	Returns Table of All Text IDs in DOM Subtree Given	20000223
3	CREATE_AND_INSERT_NODE	Static method	Public	Method	Creates a New Node and Inserts it in Tree	19991105
4	CREATE_NODE	Static method	Public	Method	Creates New Node	19991110
5	DELETE_NODE	Static method	Private	Method	Deletes Node	19991110
6	DELETE_TEXTS_OF_SUBTREE	Static method	Private	Method	Deletes the Texts of All Text Property Nodes in Subtree	20000224
7	GET_CONTROL_COMPOSITE	Instance method	Public	Method	Returns Handle of Relevant Control Composite	20000218
8	GET_CONTROL_PROXY	Instance method	Public	Method	Returns Instance Handle of Associated Control Proxy Object	20000411
9	GET_LAST_CHILD	Instance method	Private	Method	Returns Last Subnode (Can Be NULL)	19991111
10	GET_PREVIOUS	Instance method	Private	Method	Returns Previous Node (Can Be NULL)	19991111
11	HANDLE_ERROR	Static method	Private	Method	Internal Error Handling	19990929
12	INSERT_CHILD	Instance method	Private	Method	Inserts Subnode Before Reference Node Given	19991110
13	NODE_TYPE_TO_XML_NAME	Static method	Private	Method	Converts Node Type to XML Name String	19991014
14	REMOVE_CHILD	Instance method	Private	Method	Removes Subnode from Tree	19991110
15	SET_DOM_NODE	Instance method	Public	Method	Saves Handle of DOM_NODE Instance	19991110
16	SET_FIRST_CHILD	Instance method	Private	Method	Saves First Subnode (Can Be NULL)	19991111
17	SET_LAST_CHILD	Instance method	Private	Method	Saves Last Subnode (Can Be NULL)	19991111
18	SET_NEXT	Instance method	Private	Method	Saves Next Same-Level Node (Can Be NULL)	19991111
19	SET_PREVIOUS	Instance method	Private	Method	Saves Previous Same-Level Node (Can Be NULL)	19991111
20	SUPPORTS_ATTRIBUTE	Instance method	Private	Method	Returns TRUE if Node Supports Attribute Given	19991022
21	XML_NAME_TO_NODE_TYPE	Static method	Private	Method	Converts XML Name String to Node Type	19991014

Events

Class CL_CONTROL_TREE_NODE has no event.

Types

Class CL_CONTROL_TREE_NODE 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	Returning	NEW_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Handle der neuen Knoten-Instanz	19991105
2	Importing	NODE_TYPE	Call by reference	☐	Type reference (TYPE)	I		Knotentyp des neuen Knotens	19991103
3	Importing	SUCCESSOR_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Optionaler Geschwisterknoten, vor den eingefügt werden soll	19991103

#	Exception	Resumable	Description	Created on
1	ERROR_CREATING	☐	Fehler beim Erzeugen des DOM-Knotens	19991103
2	ERROR_INSERTING	☐	Fehler beim Einfügen des DOM-Knotens in den Baum	19991103
3	NO_NODE_TYPE	☐	Input Parameter NODE_TYPE nicht gegeben	19991103

Method COLLECT_TEXT_IDS_FROM_DOM_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOM_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		Handle des DOM-Knotens	20000223
2	Changing	TEXT_ID_TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Tabelle der Text-Ids	20000223

#	Exception	Resumable	Description	Created on
1	NO_DOM_NODE	☐	Input Parameter DOM_NODE nicht gegeben	20000223

Method CREATE_AND_INSERT_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NEW_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Handle der neuen Knoteninstanz	19991105
2	Importing	NODE_TYPE	Call by reference	☐	Type reference (TYPE)	I		Knotentyp des neuen Knotens	19991105
3	Importing	PARENT_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Elternknoten, zu dem Knoten hinzugefügt wird	19991105
4	Importing	SUCCESSOR_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Optional: Geschwisterknoten, vor dem Knoten eingefügt wird	19991105

#	Exception	Resumable	Description	Created on
1	ERROR_CREATING	☐	Fehler beim Erzeugen des DOM-Knotens	19991105
2	ERROR_INSERTING	☐	Fehler beim Einfügen des DOM-Knotens in Baum	19991105
3	NO_NODE_TYPE	☐	Input Parameter NODE_TYPE nicht gegeben	19991105
4	NO_PARENT_NODE	☐	Input Parameter PARENT_NODE nicht gegeben	19991105

Method CREATE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTROL_COMPOSITE	Call by reference	☑	Object reference (TYPE REF TO)	CL_CONTROL_COMPOSITE		Handle des enthaltenden Control Composites	20000218
2	Importing	DOM_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		zugehöriger DOM Knoten	19991110
3	Returning	NEW_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Handle der neuen Instanz	19991110
4	Importing	PARENT	Call by reference	☑	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Elternknoten	19991111

#	Exception	Resumable	Description	Created on
1	ERROR_CREATING	☐	Fehler beim Erzeugen des Knotens	19991110
2	NO_DOM_NODE	☐	Input Parameter PARENT_NODE nicht gegeben	19991110

Method DELETE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		node instance to delete	19991110

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐	node not found in node table	19991110
2	NO_DOM_NODE	☐	node has no associated DOM node	19991110
3	NO_NODE	☐	input parameter NODE not supplied	19991110
4	TABLE_ERROR	☐	could not locate Control Tree node in node table	19991110

Method DELETE_TEXTS_OF_SUBTREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTROL_TREE_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Wurzelknoten des Teilbaums	20000224

#	Exception	Resumable	Description	Created on
1	NO_NODE	☐	Input Parameter CONTROL_TREE_NODE nicht gegeben	20000224

Method GET_CONTROL_COMPOSITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CONTROL_COMPOSITE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CONTROL_COMPOSITE		Handle des Control Composites	20000218

Method GET_CONTROL_COMPOSITE on class CL_CONTROL_TREE_NODE has no exception.

Method GET_CONTROL_PROXY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CONTROL_PROXY	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTROL		Instanz-Handle des Control Proxy-Objekts	20000411

Method GET_CONTROL_PROXY on class CL_CONTROL_TREE_NODE has no exception.

Method GET_LAST_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LAST_CHILD	Value transfer	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		last child node, or NULL	19991111

Method GET_LAST_CHILD on class CL_CONTROL_TREE_NODE has no exception.

Method GET_PREVIOUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PREVIOUS	Value transfer	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		previous sibling node, or NULL	19991111

Method GET_PREVIOUS on class CL_CONTROL_TREE_NODE has no exception.

Method HANDLE_ERROR Signature

Method HANDLE_ERROR on class CL_CONTROL_TREE_NODE has no parameter.
Method HANDLE_ERROR on class CL_CONTROL_TREE_NODE has no exception.

Method INSERT_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NEW_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		child node to insert	19991110
2	Importing	SUCCESSOR_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		reference node to insert node before	19991110

#	Exception	Resumable	Description	Created on
1	ERROR_INSERTING	☐	could not insert node into tree	19991112
2	NOT_CHILD	☐	child node is not a child of this instance	19991110
3	NO_DOM_NODE	☐	node has no DOM node	19991110
4	NO_NEW_NODE	☐	input parameter NEW_NODE not supplied	19991110

Method NODE_TYPE_TO_XML_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_TYPE	Call by reference	☐	Type reference (TYPE)	I		enumerated node type	19991014
2	Returning	XML_NAME	Value transfer	☐	Type reference (TYPE)	STRING		XML name string	19991014

Method NODE_TYPE_TO_XML_NAME on class CL_CONTROL_TREE_NODE has no exception.

Method REMOVE_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		child node to remove	19991110

#	Exception	Resumable	Description	Created on
1	NOT_CHILD	☐	child node is not a child of this instance	19991110
2	NO_DOM_NODE	☐	given node has no DOM node	19991110
3	NO_NODE	☐	input parameter NODE not supplied	19991110

Method SET_DOM_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOM_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		pointer to DOM node	19991110

Method SET_DOM_NODE on class CL_CONTROL_TREE_NODE has no exception.

Method SET_FIRST_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIRST_CHILD	Value transfer	☑	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		first child node, or NULL	19991111

Method SET_FIRST_CHILD on class CL_CONTROL_TREE_NODE has no exception.

Method SET_LAST_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LAST_CHILD	Value transfer	☑	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		last child node, or NULL	19991111

Method SET_LAST_CHILD on class CL_CONTROL_TREE_NODE has no exception.

Method SET_NEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		next sibling node, or NULL	19991111

Method SET_NEXT on class CL_CONTROL_TREE_NODE has no exception.

Method SET_PREVIOUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PREVIOUS	Value transfer	☑	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		previous sibling node, or NULL	19991111

Method SET_PREVIOUS on class CL_CONTROL_TREE_NODE has no exception.

Method SUPPORTS_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ATTRIBUTE_NAME	Call by reference	☐	Type reference (TYPE)	COCONAME		attribute name	19991022
2	Returning	RVAL	Value transfer	☐	Type reference (TYPE)	BOOLEAN		'X' = true, ' ' = false	19991022

#	Exception	Resumable	Description	Created on
1	NO_NAME	☐	input parameter ATTRIBUTE_NAME not supplied	19991022

Method XML_NAME_TO_NODE_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NODE_TYPE	Value transfer	☐	Type reference (TYPE)	I		enumerated node type	19991014
2	Importing	XML_NAME	Call by reference	☐	Type reference (TYPE)	STRING		XML name string	19991014

Method XML_NAME_TO_NODE_TYPE on class CL_CONTROL_TREE_NODE has no exception.

History

Last changed by/on	SAP	20000411
SAP Release Created in	46D