SAP ABAP Class CL_CC_COMMON_PROPS (Control Composites: Common Property Administration)

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

Properties

Class	CL_CC_COMMON_PROPS
Short Description	Control Composites: Common Property Administration
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	20000615	SAP
Last change	00000000	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_CC_COMMON_PROPS has no forward declaration.

Interfaces

Class CL_CC_COMMON_PROPS has no interface implemented.

Friends

Class CL_CC_COMMON_PROPS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	EN_ENUM_METRIC	Constant	Private	☐	Type reference (TYPE)	COCONAME	'enum_metric'	Name of ENUM Subtype	20000616
2	PN_ALIGNMENT	Constant	Public	☐	Type reference (TYPE)	COCONAME	'Alignment'	Subtree Name of Common Property	20000616
3	PN_ALIGN_AT_BOTTOM	Constant	Public	☐	Type reference (TYPE)	COCONAME	'align_at_bottom'	Name of Common Property	20000616
4	PN_ALIGN_AT_LEFT	Constant	Public	☐	Type reference (TYPE)	COCONAME	'align_at_left'	Name of Common Property	20000616
5	PN_ALIGN_AT_RIGHT	Constant	Public	☐	Type reference (TYPE)	COCONAME	'align_at_right'	Name of Common Property	20000616
6	PN_ALIGN_AT_TOP	Constant	Public	☐	Type reference (TYPE)	COCONAME	'align_at_top'	Name of Common Property	20000616
7	PN_GEOMETRY	Constant	Public	☐	Type reference (TYPE)	COCONAME	'Geometry'	Subtree Name of Common Property	20000616
8	PN_HEIGHT	Constant	Public	☐	Type reference (TYPE)	COCONAME	'height'	Name of Common Property	20000616
9	PN_LEFT_POS	Constant	Public	☐	Type reference (TYPE)	COCONAME	'left'	Name of Common Property	20000616
10	PN_METRIC	Constant	Public	☐	Type reference (TYPE)	COCONAME	'metric'	Name of Common Property	20000616
11	PN_TOP_POS	Constant	Public	☐	Type reference (TYPE)	COCONAME	'top'	Name of Common Property	20000616
12	PN_VERSION	Constant	Public	☐	Type reference (TYPE)	COCONAME	'version'	Name of Common Property	20000616
13	PN_VISIBLE	Constant	Public	☐	Type reference (TYPE)	COCONAME	'visible'	Name of Common Property	20000616
14	PN_WIDTH	Constant	Public	☐	Type reference (TYPE)	COCONAME	'width'	Name of Common Property	20000616
15	VERSION	Constant	Private	☐	Type reference (TYPE)	COCONAME	'1.0'	Initial Value Version	20000616

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHANGE_PROPERTY	Static method	Public	Method	Change a Property	20000615
2	CREATE_AND_ADD_NODES	Static method	Public	Method	Generate a Common Property Node and Insert in Tree	20000616
3	GET_ENUM_DESCRIPTION	Static method	Public	Method	Returns Table of ENUM Constants etc for Common Property	20000616
4	HANDLE_ERROR	Static method	Private	Method	"	20000616
5	HANDLE_PROPSET_ERROR	Static method	Public	Method	Error Handling for Changes to a Property	20000616
6	SET_ALIGNMENT	Static method	Private	Method	Adjust Alignment in Container	20000615
7	SET_CONTROL_PROPS	Static method	Public	Method	Set Common Properties of a Control	20000616
8	SET_PLUG_IN_PROPS	Static method	Public	Method	Set Common Properties of a Plugin	20000621
9	SET_RECTANGLE	Static method	Public	Method	Set LEFT, TOP, WIDTH and HEIGHT in Control Tree	20000616
10	UPDATE_INT_PROP	Static method	Public	Method	"	20000619

Events

Class CL_CC_COMMON_PROPS has no event.

Types

Class CL_CC_COMMON_PROPS has no local type.

Method Signatures

Method CHANGE_PROPERTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTROL	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTROL		Control	20000615
2	Importing	CONTROL_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Control Knoten	20000615
3	Importing	PROPERTY_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Property Knoten	20000615
4	Importing	VALUE_BOOLE	Value transfer	☐	Type reference (TYPE)	BOOLEAN	' '	optional boolean value	20000615
5	Importing	VALUE_ENUM	Value transfer	☐	Type reference (TYPE)	I	0	optional enum value	20000615
6	Importing	VALUE_ICON	Value transfer	☑	Type reference (TYPE)	STRING		optional icon encoding value	20000615
7	Importing	VALUE_INT	Value transfer	☐	Type reference (TYPE)	I	0	optional Integer value	20000615
8	Importing	VALUE_STRING	Call by reference	☑	Type reference (TYPE)	STRING		optional string value	20000615
9	Importing	VALUE_TEXT	Call by reference	☑	Type reference (TYPE)	STRING		optional string value	20000615

Method CHANGE_PROPERTY on class CL_CC_COMMON_PROPS has no exception.

Method CREATE_AND_ADD_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALIGNMENT	Call by reference	☐	Type reference (TYPE)	I	0	Alignment des Controls im Container	20000616
2	Importing	CONTROL_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Control-Knoten	20000616
3	Importing	COPY_PROPS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	'X'	'X' = Geometry & Alignment Properties anlegen	20000620
4	Importing	HEIGHT	Call by reference	☐	Type reference (TYPE)	I	0	Höhe des Controls	20000616
5	Importing	LEFT	Call by reference	☐	Type reference (TYPE)	I	0	Position linke Control-Kante	20000616
6	Importing	METRIC	Call by reference	☐	Type reference (TYPE)	I	0	Metrik des Controls	20000616
7	Importing	TOP	Call by reference	☐	Type reference (TYPE)	I	0	Position obere Control-Kante	20000616
8	Importing	WIDTH	Call by reference	☐	Type reference (TYPE)	I	0	Breite des Controls	20000616

#	Exception	Resumable	Description	Created on
1	ERROR_ADDING_NODE	☐	Fehler beim Hinzufügen eines Knotens	20000616
2	ERROR_SETTING_PROP	☐	Fehler beim Setzen einer Property	20000616
3	NO_NODE	☐	Input Parameter nicht gegeben	20000621

Method GET_ENUM_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ENUM_DOCUMENTATION	Call by reference	☐	Type reference (TYPE)	STRING		Beschreibung des Typs (allgemeiner Text)	20000616
2	Importing	ENUM_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name des ENUM Typs	20000616
3	Exporting	ENUM_TABLE	Call by reference	☐	Type reference (TYPE)	COCOENTABL		Tabelle der ENUM Descriptoren	20000616

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐	ENUM dieses Namens nicht gefunden	20000616
2	NO_NAME	☐	Input Parameter ENUM_NAME nicht gegeben	20000616

Method HANDLE_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TEXT	Call by reference	☑	Type reference (TYPE)	C		"	20000616

Method HANDLE_ERROR on class CL_CC_COMMON_PROPS has no exception.

Method HANDLE_PROPSET_ERROR Signature

Method HANDLE_PROPSET_ERROR on class CL_CC_COMMON_PROPS has no parameter.
Method HANDLE_PROPSET_ERROR on class CL_CC_COMMON_PROPS has no exception.

Method SET_ALIGNMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALIGN_FLAG	Value transfer	☐	Type reference (TYPE)	AS4FLAG		"	20000615
2	Importing	CONTROL	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTROL		"	20000615
3	Importing	PROPERTY_NAME	Call by reference	☐	Type reference (TYPE)	STRING		"	20000615
4	Importing	PROPERTY_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		"	20000615

Method SET_ALIGNMENT on class CL_CC_COMMON_PROPS has no exception.

Method SET_CONTROL_PROPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALIGNMENT	Call by reference	☐	Type reference (TYPE)	I	0	Alignment im Container (Flag-Kombination)	20000616
2	Importing	CONTROL	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTROL		Control	20000616
3	Importing	CONTROL_TREE_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Control-Baumknoten	20000616
4	Importing	HEIGHT	Call by reference	☐	Type reference (TYPE)	I	0	Höhe	20000616
5	Importing	LEFT	Call by reference	☐	Type reference (TYPE)	I	0	Position linke Kante	20000616
6	Importing	METRIC	Call by reference	☐	Type reference (TYPE)	I	0	Metrik	20000616
7	Importing	TOP	Call by reference	☐	Type reference (TYPE)	I	0	Position obere Kante	20000616
8	Importing	WIDTH	Call by reference	☐	Type reference (TYPE)	I	0	Breite	20000616

#	Exception	Resumable	Description	Created on
1	ERROR_SETTING_PROP	☐	Fehler beim Setzen einer Control-Property	20000616
2	NO_CONTROL	☐	Input Parameter nicht gegeben	20000616

Method SET_PLUG_IN_PROPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALIGNMENT	Call by reference	☐	Type reference (TYPE)	I	0	Alignment im Container (Flag-Kombination)	20000621
2	Importing	CONTROL_TREE_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Control-Baumknoten	20000621
3	Importing	FOR_DESIGN	Call by reference	☐	Type reference (TYPE)	BOOLEAN		'X' = im Design-Mode	20000628
4	Importing	HEIGHT	Call by reference	☐	Type reference (TYPE)	I	0	Höhe	20000621
5	Importing	LEFT	Call by reference	☐	Type reference (TYPE)	I	0	Position linke Kante	20000621
6	Importing	METRIC	Call by reference	☐	Type reference (TYPE)	I	0	Metrik	20000621
7	Importing	PLUG_IN	Call by reference	☐	Object reference (TYPE REF TO)	IF_CONTROL_COMPOSITE_PLUG_IN		PlugIn	20000621
8	Importing	TOP	Call by reference	☐	Type reference (TYPE)	I	0	Position obere Kante	20000621
9	Importing	WIDTH	Call by reference	☐	Type reference (TYPE)	I	0	Breite	20000621

#	Exception	Resumable	Description	Created on
1	ERROR_SETTING_PROP	☐	Fehler beim Setzen einer Property	20000621
2	NO_CONTROL	☐	Top-level Control wurde nicht gefunden	20000621
3	NO_PLUG_IN	☐	Input Parameter nicht gegeben	20000621

Method SET_RECTANGLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTROL_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Structural Description of a Control Composite	20000616
2	Importing	HEIGHT	Value transfer	☐	Type reference (TYPE)	I		"	20000616
3	Importing	LEFT	Value transfer	☐	Type reference (TYPE)	I		"	20000616
4	Exporting	RECT_CHANGED	Value transfer	☐	Type reference (TYPE)	AS4FLAG		"	20000619
5	Importing	TOP	Value transfer	☐	Type reference (TYPE)	I		"	20000616
6	Importing	WIDTH	Value transfer	☐	Type reference (TYPE)	I		"	20000616

Method SET_RECTANGLE on class CL_CC_COMMON_PROPS has no exception.

Method UPDATE_INT_PROP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CHANGED	Call by reference	☐	Type reference (TYPE)	AS4FLAG		wird nicht zurückgesetzt, nur gesetzt!	20000619
2	Importing	ERROR_TEXT	Call by reference	☐	Type reference (TYPE)	C		"	20000619
3	Importing	INT_VALUE	Value transfer	☐	Type reference (TYPE)	I		"	20000619
4	Importing	NODE_NAME	Call by reference	☐	Type reference (TYPE)	C		"	20000619
5	Importing	PARENT_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		Structural Description of a Control Composite	20000619

Method UPDATE_INT_PROP on class CL_CC_COMMON_PROPS has no exception.

History

Last changed by/on	SAP	00000000
SAP Release Created in	50A