SAP ABAP Class CL_PT_UIA_OBJECT_LAYOUT (UIA Layout)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-UIF (Application Component) User Interface Framework
     ⤷ SPTV (Package) UIF Interfaces Abstraction (Implementation)

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_PT_UIA_LAYOUT	UIA Layout	20000311

Properties

Class	CL_PT_UIA_OBJECT_LAYOUT
Short Description	UIA Layout
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SPTV	UIF Interfaces Abstraction (Implementation)
Created	20000311	SAP
Last change	20000503	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☐
Unicode checks active	☑

Forward declarations

Class CL_PT_UIA_OBJECT_LAYOUT has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_PT_UIA_LAYOUT	☐	☐	UIA Layout	20000311

Friends

Class CL_PT_UIA_OBJECT_LAYOUT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	APPID	Instance attribute	Protected	☐	Type reference (TYPE)	PTAPPID		Usage Indicator for UI Framework	20000313
2	CHILDREN	Instance attribute	Protected	☐	Type reference (TYPE)	TY_TAB_CHILD_LAYOUT		Sublayouts	20000311
3	CO_LAYOUT_DYNAMIC	Constant	Protected	☐	Type reference (TYPE)	PTNODETY	'?'	Node Type: Dynamic Layout	20000311
4	CO_LAYOUT_MULTIPLE	Constant	Protected	☐	Type reference (TYPE)	PTNODETY	'M'	Node Type: Dynamic Number of Layouts	20000311
5	CO_LAYOUT_STATIC	Constant	Protected	☐	Type reference (TYPE)	PTNODETY	'L'	Node Type: Individual Layout	20000311
6	CO_OBJECT_MULTIPLE	Constant	Protected	☐	Type reference (TYPE)	PTNODETY	'N'	Node Type: Dynamic Number of Objects	20000311
7	CO_OBJECT_SINGLE	Constant	Protected	☐	Type reference (TYPE)	PTNODETY	'1'	Node Type: Individual Object	20000311
8	DESCRIPTION	Instance attribute	Protected	☐	Attribute reference (LIKE)				20000311
9	FACTORY	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_PT_UIA_FACTORY		Factory	20000311
10	FALSE	Constant	Protected	☐	Type reference (TYPE)	BOOLE_D	' '	False	20000311
11	LAYOUT_BUFFER	Static Attribute	Private	☐	Type reference (TYPE)	TY_TAB_LAYOUT_BUFFER		LAYOUT_BUFFER	20000311
12	LAYOUT_DB	Instance attribute	Protected	☐	Type reference (TYPE)	TY_TAB_DB_LAYOUT_HASHED		Layout	20000311
13	LAYOUT_DB_SORTED	Instance attribute	Protected	☐	Type reference (TYPE)	TY_TAB_DB_LAYOUT_SORTED		Layout	20000311
14	LAYOUT_ID	Instance attribute	Protected	☐	Attribute reference (LIKE)				20000311
15	NODE_ID	Instance attribute	Protected	☐	Attribute reference (LIKE)				20000311
16	OBJECTS	Instance attribute	Protected	☐	Type reference (TYPE)	TY_TAB_LAYOUT_OBJECT		Objects	20000311
17	PARENT_OBJECT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_PT_UIA_OBJECT		Superior Object Root	20000311
18	TRUE	Constant	Protected	☐	Type reference (TYPE)	BOOLE_D	'X'	True	20000311

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK	Static method	Public	Method	Check Layout	20001201
2	CREATE_FACTORY	Instance method	Protected	Method	Factory	20000311
3	CREATE_LAYOUT_INTERN	Instance method	Protected	Method	New Layout	20000311
4	CREATE_OBJECT	Instance method	Protected	Method		20000311
5	CREATE_OBJECT_INTERN	Instance method	Protected	Method	Create Object	20000311
6	FREE	Instance method	Protected	Method		20000311
7	GET_CHILD	Instance method	Protected	Method	Sublayout	20000311
8	GET_CHILD_OBJECTS	Instance method	Protected	Method		20000311
9	GET_LAYOUT_DESCRIPTION	Static method	Public	Method	Descriptive Text for Specified Layout_id	20010125
10	GET_LAYOUT_IDS_FOR_USAGE_TYPE	Static method	Public	Method	Layout IDs for Usage Type	20000311
11	GET_NODE	Instance method	Protected	Method		20000311
12	GET_OBJECT	Instance method	Protected	Method		20000311
13	GET_PARENT_OBJECT	Instance method	Protected	Method		20000311
14	INITIALIZE	Instance method	Public	Method	Initialization	20000311
15	MAP_NODE_TO_OBJECT_ID	Instance method	Protected	Method	Mapping	20000311
16	MODIFY_LAYOUT	Instance method	Protected	Method	Select Sublayout	20000311
17	MODIFY_OBJECT	Instance method	Protected	Method	Select Generated Object	20000311
18	READ_LAYOUT	Static method	Private	Method	Read Layout from Database	20001130
19	REFRESH	Instance method	Protected	Method		20000311

Events

Class CL_PT_UIA_OBJECT_LAYOUT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_REC_CHILD_LAYOUT	Protected	See coding		TY_REC_CHILD_LAYOUT	20000311
2	TY_REC_DB_LAYOUT	Protected	See coding		TY_REC_DB_LAYOUT	20000311
3	TY_REC_DESCR_BUFFER	Private	See coding		TY_REC_DESCR_BUFFER	20001213
4	TY_REC_LAYOUT_BUFFER	Private	See coding		TY_REC_LAYOUT_BUFFER	20001213
5	TY_REC_LAYOUT_OBJECT	Protected	See coding		TY_REC_LAYOUT_OBJECT	20000311
6	TY_TAB_CHILD_LAYOUT	Protected	See coding		TY_TAB_CHILD_LAYOUT	20000311
7	TY_TAB_DB_LAYOUT_HASHED	Protected	See coding		TY_TAB_DB_LAYOUT_HASHED	20000311
8	TY_TAB_DB_LAYOUT_SORTED	Protected	See coding		TY_TAB_DB_LAYOUT_SORTED	20000311
9	TY_TAB_DESCR_BUFFER	Private	See coding		TY_TAB_DESCR_BUFFER	20001213
10	TY_TAB_LAYOUT_BUFFER	Private	See coding		TY_TAB_LAYOUT_BUFFER	20000311
11	TY_TAB_LAYOUT_OBJECT	Protected	See coding		TY_TAB_LAYOUT_OBJECT	20000311

Method Signatures

Method CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_CUSTOMER_DEFINED	Value transfer	☐	Type reference (TYPE)	BOOLE_D		kundendefiniert	20001201
2	Exporting	EX_SAP_DEFINED	Value transfer	☐	Type reference (TYPE)	BOOLE_D		SAP definiert	20001201
3	Exporting	EX_STRUCTURE_ERROR	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Fehler in Struktur	20001201
4	Exporting	EX_UNDEFINED	Value transfer	☐	Type reference (TYPE)	BOOLE_D		nicht definiert	20001201
5	Importing	IM_APP_ID	Value transfer	☐	Type reference (TYPE)	PTAPPID		Anwendungskennzeichen für UI Framework	20001201
6	Importing	IM_LAYOUT_ID	Value transfer	☐	Type reference (TYPE)	PTLYTID		Layout ID	20001201

Method CHECK on class CL_PT_UIA_OBJECT_LAYOUT has no exception.

Method CREATE_FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_PT_UIA_FACTORY		Factory	20000311

Method CREATE_FACTORY on class CL_PT_UIA_OBJECT_LAYOUT has no exception.

Method CREATE_LAYOUT_INTERN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_LAYOUT_ID	Value transfer	☐	Type reference (TYPE)	PTLYTID		ID	20000311
2	Importing	IM_NODE_ID	Value transfer	☐	Type reference (TYPE)	PTNODEID		Knoten ID	20000311
3	Importing	IM_NODE_TYPE	Value transfer	☐	Type reference (TYPE)	PTNODETY		Knoten Typ	20000311
4	Importing	IM_PARENT_OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	IF_PT_UIA_OBJECT		Anknüpfungsobjekt	20000311
5	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_PT_UIA_LAYOUT		Neues Layout	20000311

Method CREATE_LAYOUT_INTERN on class CL_PT_UIA_OBJECT_LAYOUT has no exception.

Method CREATE_OBJECT Signature

Method CREATE_OBJECT on class CL_PT_UIA_OBJECT_LAYOUT has no parameter.
Method CREATE_OBJECT on class CL_PT_UIA_OBJECT_LAYOUT has no exception.

Method CREATE_OBJECT_INTERN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NODE_ID	Value transfer	☐	Type reference (TYPE)	PTNODEID		Knoten ID	20000311
2	Importing	IM_NODE_TYPE	Value transfer	☐	Type reference (TYPE)	PTNODETY		Knoten Typ	20000311
3	Importing	IM_OBJECT_ID	Value transfer	☑	Type reference (TYPE)	PTOBJID		Objekt ID	20000311
4	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_PT_UIA_OBJECT		Objekt Referenz	20000311

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Fehler bei Erzeugung	20000311

Method FREE Signature

Method FREE on class CL_PT_UIA_OBJECT_LAYOUT has no parameter.
Method FREE on class CL_PT_UIA_OBJECT_LAYOUT has no exception.

Method GET_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NODE_ID	Value transfer	☐	Type reference (TYPE)	PTNODEID		Knoten ID	20000311
2	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_PT_UIA_LAYOUT		Layout Referenz	20000311

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐	Nix da	20000311

Method GET_CHILD_OBJECTS Signature

Method GET_CHILD_OBJECTS on class CL_PT_UIA_OBJECT_LAYOUT has no parameter.
Method GET_CHILD_OBJECTS on class CL_PT_UIA_OBJECT_LAYOUT has no exception.

Method GET_LAYOUT_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_APP_ID	Value transfer	☐	Type reference (TYPE)	PTAPPID		Anwendungskennzeichen für UI Framework	20010125
2	Importing	IM_LANGUAGE	Value transfer	☐	Type reference (TYPE)	LANGU	SY-LANGU	Sprachenschlüssel	20010125
3	Importing	IM_LAYOUT_ID	Call by reference	☐	Type reference (TYPE)	PTLYTID		Layout_id	20010125
4	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	PTOBJDSCR		Beschreibung	20010125

Method GET_LAYOUT_DESCRIPTION on class CL_PT_UIA_OBJECT_LAYOUT has no exception.

Method GET_LAYOUT_IDS_FOR_USAGE_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_APP_ID	Value transfer	☐	Type reference (TYPE)	PTAPPID		Anwendungskennzeichen für UI Framework	20000313
2	Importing	IM_LANGUAGE	Value transfer	☐	Type reference (TYPE)	LANGU	SY-LANGU	Sprachenschlüssel	20000311
3	Importing	IM_USAGE_TYPE	Value transfer	☐	Type reference (TYPE)	PTLYTUSGTY		Verwendungsart eines Layouts	20000311
4	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	PTTLYTTXT		Tabelle von Layout IDs mit Texten	20000311

Method GET_LAYOUT_IDS_FOR_USAGE_TYPE on class CL_PT_UIA_OBJECT_LAYOUT has no exception.

Method GET_NODE Signature

Method GET_NODE on class CL_PT_UIA_OBJECT_LAYOUT has no parameter.
Method GET_NODE on class CL_PT_UIA_OBJECT_LAYOUT has no exception.

Method GET_OBJECT Signature

Method GET_OBJECT on class CL_PT_UIA_OBJECT_LAYOUT has no parameter.
Method GET_OBJECT on class CL_PT_UIA_OBJECT_LAYOUT has no exception.

Method GET_PARENT_OBJECT Signature

Method GET_PARENT_OBJECT on class CL_PT_UIA_OBJECT_LAYOUT has no parameter.
Method GET_PARENT_OBJECT on class CL_PT_UIA_OBJECT_LAYOUT has no exception.

Method INITIALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_APP_ID	Value transfer	☐	Type reference (TYPE)	PTAPPID		Anwendungskennzeichen für UI Framework	20000313
2	Importing	IM_LAYOUT_ID	Value transfer	☐	Type reference (TYPE)	PTLYTID		Layout ID	20000311
3	Importing	IM_NODE_ID	Value transfer	☐	Type reference (TYPE)	PTNODEID		Knoten ID in übergeordenetem Layout	20000311
4	Importing	IM_PARENT_OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	IF_PT_UIA_OBJECT		Vater Objekt der Wurzel	20000311

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Fehler bei Erzeugung	20000311

Method MAP_NODE_TO_OBJECT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NODE_ID	Value transfer	☐	Type reference (TYPE)	PTNODEID		Knoten ID	20000311
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	PTOBJID		Object ID	20000311

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Fehler	20000311

Method MODIFY_LAYOUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_LAYOUT	Value transfer	☐	Object reference (TYPE REF TO)	IF_PT_UIA_LAYOUT		Layout Referenz	20000311
2	Importing	IM_NODE_ID	Value transfer	☑	Type reference (TYPE)	PTNODEID		Knoten ID	20000311

Method MODIFY_LAYOUT on class CL_PT_UIA_OBJECT_LAYOUT has no exception.

Method MODIFY_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NODE_ID	Value transfer	☐	Type reference (TYPE)	PTNODEID		Knoten ID	20000311
2	Importing	IM_OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	IF_PT_UIA_OBJECT		Objekt Referenz	20000311
3	Importing	IM_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	PTOBJID		Objekt ID	20000311

Method MODIFY_OBJECT on class CL_PT_UIA_OBJECT_LAYOUT has no exception.

Method READ_LAYOUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_CUSTOMER_DEFINED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		kundendefiniert	20001201
2	Exporting	EX_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	PTOBJDSCR		Kurzbeschreibung eines Objekts	20001130
3	Exporting	EX_LAYOUT_DB	Call by reference	☐	Attribute reference (LIKE)	LAYOUT_DB			20001130
4	Exporting	EX_SAP_DEFINED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		SAP-definiert	20001201
5	Exporting	EX_STRUCTURE_ERROR	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Fehler in Struktur	20001201
6	Exporting	EX_UNDEFINED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		nicht definiert	20001201
7	Exporting	EX_USAGETYPE	Call by reference	☐	Type reference (TYPE)	PTLYTUSGTY		Verwendungsart eines Layouts	20001130
8	Importing	IM_APP_ID	Value transfer	☐	Type reference (TYPE)	PTAPPID		Anwendungskennzeichen für UI Framework	20001130
9	Importing	IM_LANGUAGE	Value transfer	☑	Type reference (TYPE)	LANGU	SY-LANGU	Sprachenschlüssel	20001201
10	Importing	IM_LAYOUT_ID	Value transfer	☐	Type reference (TYPE)	PTLYTID		Layout ID	20001130

Method READ_LAYOUT on class CL_PT_UIA_OBJECT_LAYOUT has no exception.

Method REFRESH Signature

Method REFRESH on class CL_PT_UIA_OBJECT_LAYOUT has no parameter.
Method REFRESH on class CL_PT_UIA_OBJECT_LAYOUT has no exception.

History

Last changed by/on	SAP	20000503
SAP Release Created in