SAP ABAP Class CL_PT_GUI_OBJECT_LAYOUT (GUI Layout)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_PT_GUI_LAYOUT	GUI layout	20000311

Properties

Class	CL_PT_GUI_OBJECT_LAYOUT
Short Description	GUI Layout
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

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

Forward declarations

Class CL_PT_GUI_OBJECT_LAYOUT has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_PT_GUI_LAYOUT	☐	☐	GUI layout	20000311

Friends

Class CL_PT_GUI_OBJECT_LAYOUT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	APP_ID	Instance attribute	Protected	☐	Type reference (TYPE)	PTAPPID		Usage Indicator	20000314
2	CHILDREN	Instance attribute	Private	☐	See coding			Sublayouts	20000311
3	FACTORY	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_PT_GUI_FACTORY		GUI_Factory	20000311
4	FALSE	Constant	Protected	☐	Type reference (TYPE)	BOOLE_D	' '	False	20000311
5	LAYOUT_BUFFER	Static Attribute	Private	☐	Type reference (TYPE)	TY_TAB_LAYOUT_BUFFER		LAYOUT_BUFFER	20010112
6	NODES	Instance attribute	Protected	☐	Type reference (TYPE)	TY_TAB_NODE_OBJECT_MAP		Nodes	20000311
7	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 Definition	20010125
2	CONSTRUCTOR	Instance method	Public	Constructor	Create	20000311
3	CREATE_FACTORY	Instance method	Protected	Method	Generate Factory	20000311
4	CREATE_OBJECT	Instance method	Private	Method	Generate Objects	20000311
5	GET_LAYOUT_DESCRIPTION	Static method	Public	Method	Descriptive Text for Specified Layout ID	20000314
6	GET_LAYOUT_IDS_FOR_OBJECT_ID	Static method	Public	Method	Layout IDs for Object ID	20000311
7	GET_LAYOUT_IDS_FOR_USAGE_TYPE	Static method	Public	Method	Layout IDs for Usage Type	20000311
8	MAP_GUI_TO_UIA_LAYOUT_ID	Static method	Public	Method	Map GUI According to UIA	20000314
9	READ_LAYOUT	Static method	Private	Method	Read Layout from Database	20010110

Events

Class CL_PT_GUI_OBJECT_LAYOUT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_REC_DESCR_BUFFER	Private	See coding		TY_REC_DESCR_BUFFER	20010110
2	TY_REC_LAYOUT	Private	See coding		TY_REC_LAYOUT	20010112
3	TY_REC_LAYOUT_BUFFER	Private	See coding		TY_REC_LAYOUT_BUFFER	20010110
4	TY_REC_NODE_OBJECT_MAP	Protected	See coding		TY_REC_NODE_OBJECT_MAP	20000314
5	TY_TAB_DESCR_BUFFER	Private	See coding		TY_TAB_DESCR_BUFFER	20010110
6	TY_TAB_LAYOUT	Private	See coding		TY_TAB_LAYOUT	20010112
7	TY_TAB_LAYOUT_BUFFER	Private	See coding		TY_TAB_LAYOUT_BUFFER	20010112
8	TY_TAB_NODE_OBJECT_MAP	Protected	See coding		TY_TAB_NODE_OBJECT_MAP	20000314

Method Signatures

Method CHECK 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		Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ')	20010125
2	Exporting	EX_SAP_DEFINED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ')	20010125
3	Exporting	EX_UNDEFINED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ')	20010125
4	Importing	IM_APP_ID	Value transfer	☐	Type reference (TYPE)	PTAPPID		Anwendungskennzeichen für UI Framework	20010125
5	Importing	IM_LAYOUT_ID	Value transfer	☐	Type reference (TYPE)	PTLYTID		Layout ID	20010125

Method CHECK on class CL_PT_GUI_OBJECT_LAYOUT has no exception.

Method CONSTRUCTOR 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	20000314
2	Importing	IM_LAYOUT_ID	Value transfer	☐	Type reference (TYPE)	PTLYTID		Layout ID	20000311
3	Importing	IM_UIA_LAYOUT	Value transfer	☐	Object reference (TYPE REF TO)	IF_PT_UIA_LAYOUT		UIA Layout	20000311

#	Exception	Resumable	Description	Created on
1	FAILED	☐		20000311

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_GUI_FACTORY			20000311

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Factory konnte nicht erzeugt werden	20000311

Method CREATE_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_ID	Value transfer	☐	Type reference (TYPE)	PTOBJID		Objekt ID	20000311
3	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_PT_GUI_OBJECT		GUI Objekt	20000311

Method CREATE_OBJECT on class CL_PT_GUI_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	20000314
2	Importing	IM_LANGUAGE	Value transfer	☐	Type reference (TYPE)	LANGU	SY-LANGU	Sprachenschlüssel	20010112
3	Importing	IM_LAYOUT_ID	Value transfer	☐	Type reference (TYPE)	PTLYTID		Layout ID	20000314
4	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	PTOBJDSCR		Beschreibung	20000314

Method GET_LAYOUT_DESCRIPTION on class CL_PT_GUI_OBJECT_LAYOUT has no exception.

Method GET_LAYOUT_IDS_FOR_OBJECT_ID 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	20000314
2	Importing	IM_LANGUAGE	Value transfer	☐	Type reference (TYPE)	LANGU	SY-LANGU	Sprachenschlüssel	20000311
3	Importing	IM_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	PTOBJID		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_OBJECT_ID on class CL_PT_GUI_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	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_GUI_OBJECT_LAYOUT has no exception.

Method MAP_GUI_TO_UIA_LAYOUT_ID 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	20000314
2	Importing	IM_GUI_LAYOUT_ID	Value transfer	☐	Type reference (TYPE)	PTLYTID		GUI Laoyut ID	20000314
3	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	PTLYTID		UIA Laoyut ID	20000314

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐	Keine Zuordnung gefunden	20000314

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		Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ')	20010110
2	Exporting	EX_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	PTOBJDSCR		Kurzbeschreibung eines Objekts	20010110
3	Exporting	EX_LAYOUT_DB	Call by reference	☐	Type reference (TYPE)	TY_TAB_LAYOUT		Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ')	20010110
4	Exporting	EX_SAP_DEFINED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ')	20010110
5	Exporting	EX_UIA_LAYOUT_ID	Call by reference	☐	Type reference (TYPE)	PTLYTID		Layout ID	20010112
6	Exporting	EX_UNDEFINED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ')	20010110
7	Exporting	EX_USAGETYPE	Call by reference	☐	Type reference (TYPE)	PTLYTUSGTY		Verwendungsart eines Layouts	20010110
8	Importing	IM_APP_ID	Value transfer	☐	Type reference (TYPE)	PTAPPID		Anwendungskennzeichen für UI Framework	20010110
9	Importing	IM_LANGUAGE	Value transfer	☑	Type reference (TYPE)	LANGU	SY-LANGU	Sprachenschlüssel	20010110
10	Importing	IM_LAYOUT_ID	Value transfer	☐	Type reference (TYPE)	PTLYTID		Layout ID	20010110

Method READ_LAYOUT on class CL_PT_GUI_OBJECT_LAYOUT has no exception.

History

Last changed by/on	SAP	20000503
SAP Release Created in