SAP ABAP Class CL_LAYOUT_POC (POC: Layout Definition)

Hierarchy

☛ EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
   ⤷ PP-PI-PMA-PMC (Application Component) Browser-Based PI Sheet / Cockpit
     ⤷ CMX_POC (Package) Manufacturing Execution: Browser-Based PI Sheet

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SY_MESS_POC	POC: System Message Processing	20000412

Properties

Class	CL_LAYOUT_POC
Short Description	POC: Layout Definition
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	CMX_POC	Manufacturing Execution: Browser-Based PI Sheet
Created	19991129	SAP
Last change	20100310	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_IXML	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	CL_TRANSACTION_POC	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IXML	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	OSCON	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
5	POCCO	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
6	POCXT	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SY_MESS_POC	☐	☐	POC: System Message Processing	20000412

Friends

Class CL_LAYOUT_POC has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CM_INSTANCES	Static Attribute	Protected	☐	Type reference (TYPE)	TY_OBJ_TAB		Instance List	20000329
2	CM_IXML	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	IF_IXML		IXML Instance	20000404
3	CM_IXML_STREAMFC	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	IF_IXML_STREAM_FACTORY		IXML Stream Factory	20000404
4	CO_ARCHIVE_STYLE	Constant	Public	☐	Type reference (TYPE)	STRING	'ARCHIVE/STYLE'	Constant: Settings Parameter	20000619
5	CO_DIALOG_STYLE	Constant	Public	☐	Type reference (TYPE)	STRING	'DIALOG/STYLE'	Constant: Settings Parameter	20001120
6	CO_DOCUMENT_LABEL	Constant	Public	☐	Type reference (TYPE)	STRING	'DOCUMENT/LABEL'	Constant: Settings Parameter	20000627
7	CO_EMPTY_DOCUMENT	Static Attribute	Protected	☐	Type reference (TYPE)	STRING		Constant	20000620
8	CO_FRAMESET	Constant	Public	☐	Type reference (TYPE)	STRING	'FRAMESET'	Constant: Settings Parameter	20000619
9	CO_HEADER_INCLUDE_PHASECOUNT	Constant	Public	☐	Type reference (TYPE)	STRING	'HEADER/INCLUDE/PHASECOUNT'	Constant: Settings Parameter	20001212
10	CO_HEADER_META	Constant	Public	☐	Type reference (TYPE)	STRING	'HEADER/META'	Constant: Settings Parameter	20001212
11	CO_HEADER_PHASES	Constant	Protected	☐	Type reference (TYPE)	STRING	'HEADER/PHASES'	Constant	20001212
12	CO_INSTRUCTIONS_GROUP	Constant	Public	☐	Type reference (TYPE)	STRING	'INSTRUCTIONS/GROUP'	Constant: Settings Parameter	20000928
13	CO_INSTRUCTIONS_META	Constant	Public	☐	Type reference (TYPE)	STRING	'INSTRUCTIONS/META'	Constant: Settings Parameter	20001212
14	CO_INSTR_GROUP_ALL	Constant	Public	☐	Type reference (TYPE)	INT1	1	Constant: Group Mode	20000928
15	CO_INSTR_GROUP_LIST	Constant	Public	☐	Type reference (TYPE)	INT1	2	Constant: Group Mode	20000928
16	CO_INSTR_GROUP_NONE	Constant	Public	☐	Type reference (TYPE)	INT1	3	Constant: Group Mode	20000928
17	CO_MAINTAIN_STYLE	Constant	Public	☐	Type reference (TYPE)	STRING	'MAINTAIN/STYLE'	Constant: Settings Parameter	20001120
18	CO_PHASES_META	Constant	Public	☐	Type reference (TYPE)	STRING	'PHASES/META'	Constant: Settings Parameter	20001212
19	CO_STEPS_META	Constant	Public	☐	Type reference (TYPE)	STRING	'STEPS/META'	Constant: Settings Parameter	20020613
20	CO_STYLE	Constant	Protected	☐	Type reference (TYPE)	STRING	'STYLE'	Constant	20001212
21	CO_URL_PREFIX	Constant	Private	☐	Type reference (TYPE)	CHAR50	'SAPR3-BDS-POC_PIDOC-OT-'	Constant	20000329
22	CO_URL_SUFFIX	Constant	Private	☐	Type reference (TYPE)	CHAR50	'-layout.xml'	Constant	20000329
23	M_ARCHIVE_STYLE	Instance attribute	Public	☑	Type reference (TYPE)	POC_NAME_TAB		Archiving Stylesheet	20000329
24	M_DIALOG_STYLE	Instance attribute	Public	☑	Type reference (TYPE)	POC_NAME_TAB		Dialog Style Sheet	20001120
25	M_DOC_ID	Instance attribute	Protected	☐	Type reference (TYPE)	POC_DOCID		Document ID	20000329
26	M_ERRORS	Instance attribute	Public	☑	Type reference (TYPE)	POC_RETURN_TAB		Error Message Table	20000329
27	M_FRAMESET	Instance attribute	Public	☑	Type reference (TYPE)	STRING		Processing Frameset	20000329
28	M_HEADER_INCLUDE_PHASECOUNT	Instance attribute	Public	☑	Type reference (TYPE)	I		Number of Header Phases	20001212
29	M_HEADER_META	Instance attribute	Public	☑	Type reference (TYPE)	POC_NAME_TAB		Additional Metadata in Header	20001212
30	M_INSTRS_META	Instance attribute	Public	☑	Type reference (TYPE)	POC_NAME_TAB		Additional Metadata in Process Instructions	20001212
31	M_INSTR_GROUP_LIST	Instance attribute	Public	☑	Type reference (TYPE)	POC_NAME_TAB		List of Process Instruction Categories to be Grouped	20000928
32	M_INSTR_GROUP_MODE	Instance attribute	Public	☑	Type reference (TYPE)	I		Group Mode for Process Instructions	20000928
33	M_MAINTAIN_STYLE	Instance attribute	Public	☑	Type reference (TYPE)	POC_NAME_TAB		Processing Stylesheet	20001120
34	M_OS_TRANS	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_OS_TRANSACTION		OS Transaction	20000411
35	M_PHASES_META	Instance attribute	Public	☑	Type reference (TYPE)	POC_NAME_TAB		Additional Metadata in Phases	20001212
36	M_RESOURCE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_BFW_WEBRESOURCE_POC		Own Resource	20000329
37	M_STEPS_META	Instance attribute	Public	☑	Type reference (TYPE)	POC_NAME_TAB		Additional Metadata in Steps	20020108

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_FRAMESET_DEFINITION	Instance method	Private	Method	Check Definition of a Frameset	20000620
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20000329
3	CLEAR	Static method	Protected	Method	Clear Instance	20000330
4	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20000329
5	CREATE	Static method	Public	Method	Create Instance with Source Resources	20000329
6	FREE	Instance method	Protected	Method	Release Instance	20000330
7	GET	Static method	Public	Method	Create Instance	20000329
8	GET_ABSOLUTE_PATH	Instance method	Private	Method	Determine Absolute Path for Element	20000404
9	GET_FRAMESET_DEFINITION	Instance method	Private	Method	Get Frameset Definition	20000404
10	GET_INSTR_GROUP_MODE	Instance method	Private	Method	Get Group Mode for Process Instruction Categories	20000928
11	GET_LIST_FROM_CONTENT	Instance method	Private	Method	Get List of Values with Relative Path from Tag Content	20000929
12	GET_NUMBER_FROM_CONTENT	Instance method	Private	Method	Get Number from Day Content	20000404
13	GET_STYLE_FROM_CONTENT	Instance method	Private	Method	Get Stylesheet from Day Content	20000404
14	INIT	Instance method	Protected	Method	Initialize Instance	20000330
15	ON_SAVE_PREPARED	Instance method	Private	Event handling method	TOP Transaction: Save Prepared	20000412
16	ON_TRANSACTION_FINISHED	Instance method	Private	Event handling method	OS Transaction: Transaction was Closed	20000411
17	OPEN_XML_DOCUMENT	Instance method	Private	Method	Import Layout Definition	20000404
18	PARSE_FRAMESET_DEFINITION	Instance method	Private	Method	Parse Definition of a Frameset	20000620
19	REGISTER_TRANSACTION	Instance method	Private	Method	Register Transaction	20000411
20	REMOVE	Static method	Public	Method	Delete Resource and Clear Instance	20000329
21	RENDER_FRAMESET_DEFINITION	Instance method	Private	Method	Render Definition of a Frameset	20000620
22	SAVE_XML_DOCUMENT	Instance method	Private	Method	Write Layout Definition	20000619
23	UNREGISTER_TRANSACTION	Instance method	Private	Method	Deregister Transaction	20000411

Events

Class CL_LAYOUT_POC has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_OBJ_TAB	Protected	See coding		TY_OBJ_TAB	20000329

Method Signatures

Method CHECK_FRAMESET_DEFINITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		Element	20000620
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Gültig ?	20000620

Method CHECK_FRAMESET_DEFINITION on class CL_LAYOUT_POC has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_LAYOUT_POC has no parameter.
Method CLASS_CONSTRUCTOR on class CL_LAYOUT_POC has no exception.

Method CLEAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_ID	Call by reference	☐	Type reference (TYPE)	POC_DOCID		Dokument-ID	20000405

Method CLEAR on class CL_LAYOUT_POC has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_ID	Call by reference	☐	Type reference (TYPE)	POC_DOCID		Dokument-ID	20000407
2	Importing	RESOURCE	Call by reference	☐	Object reference (TYPE REF TO)	CL_BFW_WEBRESOURCE_POC		Ressource	20000407

Method CONSTRUCTOR on class CL_LAYOUT_POC has no exception.

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_ID	Call by reference	☐	Type reference (TYPE)	POC_DOCID		Dokument-ID	20000329
2	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_LAYOUT_POC		Referenz auf Instanz	20000329
3	Importing	SETTINGS	Call by reference	☐	Type reference (TYPE)	POC_SETTINGS_VALUE_TAB		Einstellungen aus Umgebung	20000619
4	Importing	SOURCE	Call by reference	☐	Type reference (TYPE)	POC_URL		URL für Quelle	20000329

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Fehlgeschlagen	20000329

Method FREE Signature

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

Method GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_ID	Call by reference	☐	Type reference (TYPE)	POC_DOCID		Dokument-ID	20000329
2	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_LAYOUT_POC		Referenz auf Instanz	20000329

Method GET on class CL_LAYOUT_POC has no exception.

Method GET_ABSOLUTE_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		Element	20000404
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	STRING		Pfad	20000404

Method GET_ABSOLUTE_PATH on class CL_LAYOUT_POC has no exception.

Method GET_FRAMESET_DEFINITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DEFAULT	Call by reference	☐	Type reference (TYPE)	STRING		Standardwert	20000620
2	Importing	ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		Element	20000404
3	Importing	PATH	Call by reference	☐	Type reference (TYPE)	STRING		Pfad	20000404
4	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	STRING		Wert	20000620
5	Importing	SETTINGS	Call by reference	☐	Type reference (TYPE)	POC_SETTINGS_VALUE_TAB		Einstellungen aus Umgebung	20000620

Method GET_FRAMESET_DEFINITION on class CL_LAYOUT_POC has no exception.

Method GET_INSTR_GROUP_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DEFAULT	Call by reference	☐	Type reference (TYPE)	I		Standardwert	20000928
2	Importing	ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		Element	20000928
3	Importing	PATH	Call by reference	☐	Type reference (TYPE)	STRING		Pfad	20000928
4	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	I		Wert	20000928
5	Importing	SETTINGS	Call by reference	☐	Type reference (TYPE)	POC_SETTINGS_VALUE_TAB		Einstellungen aus Umgebung	20000928
6	Importing	TAGNAME	Call by reference	☐	Type reference (TYPE)	STRING		Tag-Name	20000929

Method GET_INSTR_GROUP_MODE on class CL_LAYOUT_POC has no exception.

Method GET_LIST_FROM_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		Element	20000929
2	Importing	NOCONCAT	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Settings nicht automatisch anhängen	20001212
3	Importing	NOCONDENSE	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Leere Einträge nicht löschen	20001212
4	Importing	PATH	Call by reference	☐	Type reference (TYPE)	STRING		Pfad	20000929
5	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	POC_NAME_TAB		Liste der Werte	20000929
6	Importing	SETTINGS	Call by reference	☐	Type reference (TYPE)	POC_SETTINGS_VALUE_TAB		Einstellungen aus der Umgebnung	20000929
7	Importing	TAGNAME	Call by reference	☐	Type reference (TYPE)	STRING		Tag-Name	20000929

Method GET_LIST_FROM_CONTENT on class CL_LAYOUT_POC has no exception.

Method GET_NUMBER_FROM_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DEFAULT	Call by reference	☐	Type reference (TYPE)	I		Standardwert	20000620
2	Importing	ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		Element	20000404
3	Importing	PATH	Call by reference	☐	Type reference (TYPE)	STRING		Pfad	20000404
4	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	I		Wert	20000620
5	Importing	SETTINGS	Call by reference	☐	Type reference (TYPE)	POC_SETTINGS_VALUE_TAB		Einstellungen aus Umgebung	20000620

Method GET_NUMBER_FROM_CONTENT on class CL_LAYOUT_POC has no exception.

Method GET_STYLE_FROM_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DEFAULT	Call by reference	☐	Type reference (TYPE)	STRING		Standardwert	20000620
2	Importing	ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		Element	20000404
3	Importing	PATH	Call by reference	☐	Type reference (TYPE)	STRING		Pfad	20000404
4	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	STRING		Wert	20000620
5	Importing	SETTINGS	Call by reference	☐	Type reference (TYPE)	POC_SETTINGS_VALUE_TAB		Einstellungen aus Umgebung	20000620

Method GET_STYLE_FROM_CONTENT on class CL_LAYOUT_POC has no exception.

Method INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SETTINGS	Call by reference	☐	Type reference (TYPE)	POC_SETTINGS_VALUE_TAB		Einstellungen aus Umgebung	20000619

Method INIT on class CL_LAYOUT_POC has no exception.

Method ON_SAVE_PREPARED Signature

Method ON_SAVE_PREPARED on class CL_LAYOUT_POC has no parameter.
Method ON_SAVE_PREPARED on class CL_LAYOUT_POC has no exception.

Method ON_TRANSACTION_FINISHED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STATUS	Value transfer	☐	Attribute reference (LIKE)				20000411

Method ON_TRANSACTION_FINISHED on class CL_LAYOUT_POC has no exception.

Method OPEN_XML_DOCUMENT 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_IXML_DOCUMENT		XML-Dokument	20000404

Method OPEN_XML_DOCUMENT on class CL_LAYOUT_POC has no exception.

Method PARSE_FRAMESET_DEFINITION 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_IXML_ELEMENT		Element	20000620
2	Importing	SOURCE	Call by reference	☐	Type reference (TYPE)	STRING		Quelle	20000620

Method PARSE_FRAMESET_DEFINITION on class CL_LAYOUT_POC has no exception.

Method REGISTER_TRANSACTION Signature

Method REGISTER_TRANSACTION on class CL_LAYOUT_POC has no parameter.
Method REGISTER_TRANSACTION on class CL_LAYOUT_POC has no exception.

Method REMOVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_ID	Call by reference	☐	Type reference (TYPE)	POC_DOCID		Dokument-ID	20000329

Method REMOVE on class CL_LAYOUT_POC has no exception.

Method RENDER_FRAMESET_DEFINITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		Element	20000620
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	STRING		Ergebnis	20000620

Method RENDER_FRAMESET_DEFINITION on class CL_LAYOUT_POC has no exception.

Method SAVE_XML_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Erfolgreich ?	20000619

Method SAVE_XML_DOCUMENT on class CL_LAYOUT_POC has no exception.

Method UNREGISTER_TRANSACTION Signature

Method UNREGISTER_TRANSACTION on class CL_LAYOUT_POC has no parameter.
Method UNREGISTER_TRANSACTION on class CL_LAYOUT_POC has no exception.

History

Last changed by/on	SAP	20100310
SAP Release Created in	46C