SAP ABAP Class CL_UPWB (CL_UPWB_C)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-PLA-BPS (Application Component) Business Planning and Simulation
     ⤷ UPWB (Package) Graphic Builder for Planning Applications with BSP

Properties

Class	CL_UPWB
Short Description	CL_UPWB_C
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	UPWB	Graphic Builder for Planning Applications with BSP
Created	20010716	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☐
Unicode checks active	☑

Forward declarations

Class CL_UPWB has no forward declaration.

Interfaces

Class CL_UPWB has no interface implemented.

Friends

Class CL_UPWB has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CB_FALSE	Constant	Public	☐	Type reference (TYPE)	BOOLEAN	'-'	Boolean Variable (X=True, -=False, Space=Unknown)	20020704
2	CB_TRUE	Constant	Public	☐	Type reference (TYPE)	BOOLEAN	'X'	Boolean Variable (X=True, -=False, Space=Unknown)	20020704
3	CO_JAVASCRIPT	Constant	Public	☐	Type reference (TYPE)	I	987	Parameter PRINT_STRING	20030811
4	MB_STAT_OPENED	Static Attribute	Private	☐	Type reference (TYPE)	BOOLEAN	'-'	Flag - root "WEB" Opened in Statistic	20020704
5	MR_BSP_APPL	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_UPWB_BSP_APPL		Gen. Class for WEB Interface	20040730
6	M_BW_CSS	Static Attribute	Private	☐	Type reference (TYPE)	STRING		BW CSS Path - Buffer	20040607
7	PARAM_TAB	Static Attribute	Private	☐	Type reference (TYPE)	UPWB_YT_PARAM_VALUE		Table of Global Parameters	20020111
8	TEXT_TAB	Static Attribute	Private	☐	Type reference (TYPE)	YT_TEXT_BUFFER		Table for Text Pool	20011214

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BSP_ONINITIALIZATION	Static method	Public	Method	Set Runtime for Component in Initialization	20010717
2	BSP_ONINPUTPROCESSING	Static method	Public	Method	Set Runtime for Component in Input Processing	20010717
3	CREATE_COMPONENT	Static method	Public	Method	CREATE_COMPONENT	20010716
4	ENCODE_STRING	Static method	Public	Method	Endcode String	20030811
5	GET_APPLICATION	Static method	Public	Method	Application Component	20040730
6	GET_BUFFER_CHANGED	Static method	Public	Method	Buffer Changed	20040731
7	GET_COMPONENT	Static method	Public	Method	Component by ID	20010716
8	GET_ERROR_PAGE	Static method	Public	Method	Renders HTML Error Page	20040611
9	GET_HEADER_SCRIPT	Static method	Public	Method	JavaScript for Registering Current Session in Portal	20070118
10	GET_HTML_TABLE	Static method	Public	Method	Render ABAP Internal Table	20011010
11	GET_MIME_PATH	Static method	Public	Method	Customized Theme Root, Derived from BW CSS	20040607
12	GET_MSG_COMPONENT	Static method	Public	Method	Get Message Component	20011010
13	GET_MSG_LOG	Static method	Public	Method	Obsolete	20010716
14	GET_OTR	Static method	Public	Method	OTR Text for Alias (Escaped for HTML Is Optional)	20030729
15	GET_PARAMETER	Static method	Public	Method	Global Parameters of Runtime for Everybody	20020111
16	GET_TEXT	Static method	Public	Method	Get Text from Text Pool of Current Language	20011214
17	GET_URI_PARAMETER	Static method	Public	Method	Get URI Parameters	20051208
18	GET_URL	Static method	Public	Method	Construct URL from Application and Page	20011010
19	INTEGER_TO_STRING	Static method	Public	Method	Converts Integer to String (with '-' in front')	20020213
20	RAISE_BUFFER_CHANGED	Static method	Public	Method	Raise 'buffer_changed' if Parameter 'buffer_changed' = 'X'	20020117
21	RENDER_BUTTON	Static method	Public	Method	Render button	20020725
22	RENDER_LINK	Static method	Public	Method	Render text, html, image	20020725
23	RENDER_TEXT	Static method	Public	Method	Render text, html, image	20020725
24	SET_BUFFER_CHANGED	Static method	Public	Method	Mark Buffer Changed/Saved (with Space)	20040801
25	SET_PARAMETER	Static method	Public	Method	Global Parameters of Runtime for Everybody	20020111
26	STATISTIC_CLOSE	Static method	Public	Method	Close Statistic Node	20020705
27	STATISTIC_OPEN	Static method	Public	Method	Create Statistic Node	20020705

Events

#	Event	Type	Visibility	Description	Created on
1	BUFFER_CHANGED	Static Event (1)	Public (2)	Raised after Planning Function, api_data_set, api_varvl_set	20020117

Types

Class CL_UPWB has no local type.

Method Signatures

Method BSP_ONINITIALIZATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAVIGATION	Value transfer	☐	Object reference (TYPE REF TO)	IF_BSP_NAVIGATION		Business Server Page (BSP) Navigation	20010717
2	Importing	PAGE	Value transfer	☐	Object reference (TYPE REF TO)	IF_BSP_PAGE		Business Server Page (BSP) Seite	20010717
3	Importing	REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20010717
4	Importing	RESPONSE	Value transfer	☐	Object reference (TYPE REF TO)	IF_HTTP_RESPONSE		HTTP Framework (iHTTP) HTTP Response	20010717
5	Importing	RUNTIME	Value transfer	☐	Object reference (TYPE REF TO)	IF_BSP_RUNTIME		Business Server Page (BSP) Laufzeit	20010717
6	Importing	VERSION	Value transfer	☑	Type reference (TYPE)	UPWB_Y_HTML_VERSION		Html Version	20011010

Method BSP_ONINITIALIZATION on class CL_UPWB has no exception.

Method BSP_ONINPUTPROCESSING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EVENT_ID	Value transfer	☐	Type reference (TYPE)	STRING			20010717
2	Importing	NAVIGATION	Value transfer	☐	Object reference (TYPE REF TO)	IF_BSP_NAVIGATION		Business Server Page (BSP) Navigation	20010717
3	Importing	PAGE	Value transfer	☐	Object reference (TYPE REF TO)	IF_BSP_PAGE		Business Server Page (BSP) Seite	20010717
4	Importing	REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20010717
5	Importing	RUNTIME	Value transfer	☐	Object reference (TYPE REF TO)	IF_BSP_RUNTIME		Business Server Page (BSP) Laufzeit	20010717
6	Importing	VERSION	Value transfer	☑	Type reference (TYPE)	UPWB_Y_HTML_VERSION		Html Version	20011010

Method BSP_ONINPUTPROCESSING on class CL_UPWB has no exception.

Method CREATE_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CLASS	Call by reference	☐	Type reference (TYPE)	STRING		IS_CLASS	20010716
2	Importing	IS_ID	Call by reference	☑	Type reference (TYPE)	STRING		IS_ID	20010716
3	Returning	RO_COMPONENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_UPWB_C_COMPONENT		RO_COMPONENT	20010716

#	Exception	Resumable	Description	Created on
1	CX_UPWB_EXCEPTION	☐	CX_UPWB_EXCEPTION	20010716

Method ENCODE_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENCODING	Call by reference	☐	Type reference (TYPE)	I		IF_BSP_WRITER=> CO_RAW | CO_URL | CO_HTML | CO_JAVASCRIPT	20030811
2	Importing	IN	Call by reference	☐	Type reference (TYPE)	STRING			20030811
3	Returning	OUT	Value transfer	☐	Type reference (TYPE)	STRING			20030811

Method ENCODE_STRING on class CL_UPWB has no exception.

Method GET_APPLICATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ID	Call by reference	☐	Type reference (TYPE)	STRING			20040730
2	Returning	RO_APPLICATION	Value transfer	☐	Object reference (TYPE REF TO)	IF_UPWB_C_APPLICATION			20040730

Method GET_APPLICATION on class CL_UPWB has no exception.

Method GET_BUFFER_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_CHANGED	Value transfer	☐	Type reference (TYPE)	BOOLE_D			20040731

Method GET_BUFFER_CHANGED on class CL_UPWB has no exception.

Method GET_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ID	Call by reference	☐	Type reference (TYPE)	STRING		IS_ID	20010716
2	Returning	RO_COMPONENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_UPWB_C_COMPONENT		RO_COMPONENT	20010716

Method GET_COMPONENT on class CL_UPWB has no exception.

Method GET_ERROR_PAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	OUT	Value transfer	☐	Type reference (TYPE)	STRING		HTML	20040611
2	Importing	RUNTIME	Value transfer	☑	Object reference (TYPE REF TO)	IF_BSP_RUNTIME		Business Server Page (BSP) Laufzeit	20040611

Method GET_ERROR_PAGE on class CL_UPWB has no exception.

Method GET_HEADER_SCRIPT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_RUNTIME	Value transfer	☐	Object reference (TYPE REF TO)	IF_BSP_RUNTIME		Business Server Page (BSP) Laufzeit	20070118
2	Returning	R_SCRIPT	Value transfer	☐	Type reference (TYPE)	STRING			20070118

Method GET_HEADER_SCRIPT on class CL_UPWB has no exception.

Method GET_HTML_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ABAP_TABLE	Call by reference	☐	Type reference (TYPE)	TABLE		Abap-Tabelle	20011010
2	Importing	COL_NUM	Value transfer	☑	Type reference (TYPE)	I		Anzahl Spalten	20011010
3	Importing	EMPTY_TABLE_TEXT	Call by reference	☑	Type reference (TYPE)	STRING		Text bei leerer Tabelle	20011010
4	Importing	FIELD_CATALOG	Value transfer	☑	Type reference (TYPE)	HTMLBFICAT		Feldkatalog	20011010
5	Importing	FILLUP_EMPTY_ROWS	Value transfer	☐	Type reference (TYPE)	C	'X'	Flag: leere Zeilen am Ende anlegen	20011010
6	Importing	FOOTER_VISIBLE	Value transfer	☐	Type reference (TYPE)	C	'X'	Flag: Footer sichtbar	20011010
7	Importing	FORM_ID	Call by reference	☐	Type reference (TYPE)	STRING	'bspform'	FormID	20011010
8	Importing	HEADER_CLICK	Value transfer	☑	Type reference (TYPE)	C		Mausklick auf Header	20011010
9	Importing	HEADER_VISIBLE	Value transfer	☐	Type reference (TYPE)	C	'X'	Flag: Header sichtbar	20011010
10	Importing	HEIGHT	Call by reference	☑	Type reference (TYPE)	STRING		Höhe	20011010
11	Importing	ID	Call by reference	☐	Type reference (TYPE)	STRING		ID	20011010
12	Importing	LINK_CLICK	Value transfer	☑	Type reference (TYPE)	C		Mausklick auf Links	20011010
13	Returning	OUTPUT	Value transfer	☐	Type reference (TYPE)	STRING		Das HTML	20011010
14	Importing	PAGE_EVENT	Call by reference	☑	Type reference (TYPE)	STRING		Page Event up, down, etc.	20011010
15	Importing	REQUEST	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		Request Objekt	20011010
16	Importing	SELECTION_MODE	Value transfer	☐	Type reference (TYPE)	I	0	Zeilenselektion: 0 = Keine, 1 = Single -, 2 = Multiselection	20011010
17	Importing	SHOW_NAVIGATION	Value transfer	☑	Type reference (TYPE)	C		Flag: ermögliche Blättern	20011010
18	Importing	TITLE	Call by reference	☑	Type reference (TYPE)	STRING		Titel	20011010
19	Importing	TITLE_FIELD	Call by reference	☑	Type reference (TYPE)	STRING		Field containing 'title' for row	20011122
20	Importing	VISIBLE_FIELDS	Call by reference	☑	Type reference (TYPE)	STRING		Visible fields separated by '&'	20011122
21	Importing	VISIBLE_FIRST_ROW	Value transfer	☐	Type reference (TYPE)	I	1	Erste sichtbare Zeile	20011010
22	Importing	VISIBLE_ROW_COUNT	Value transfer	☐	Type reference (TYPE)	I	-1	Anzahl sichtbarer Zeilen	20011010
23	Importing	WIDTH	Call by reference	☑	Type reference (TYPE)	STRING		Breite	20011010

Method GET_HTML_TABLE on class CL_UPWB has no exception.

Method GET_MIME_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TYPE	Call by reference	☐	Type reference (TYPE)	STRING	'THEMEROOT'	Optional: 'BWCSS' (css file)	20040607
2	Returning	R_PATH	Value transfer	☐	Type reference (TYPE)	STRING			20040607

Method GET_MIME_PATH on class CL_UPWB has no exception.

Method GET_MSG_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	IF_UPWB_C_MESSAGE		IF_UPWB_C_MESSAGE	20011010

Method GET_MSG_COMPONENT on class CL_UPWB has no exception.

Method GET_MSG_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_MSG_LOG	Value transfer	☐	Object reference (TYPE REF TO)	IF_UPWB_MSG_LOG		RO_MSG_LOG	20010716

Method GET_MSG_LOG on class CL_UPWB has no exception.

Method GET_OTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALIAS	Value transfer	☐	Type reference (TYPE)	STRING		OTR-Alias	20030729
2	Importing	ESCAPE_HTML	Value transfer	☐	Type reference (TYPE)	BOOLEAN	'X'	boolsche Variable (X=true, -=false, space=unknown)	20030729
3	Returning	TEXT	Value transfer	☐	Type reference (TYPE)	STRING		Text in aktueller Sprache oder leer	20030729

Method GET_OTR on class CL_UPWB has no exception.

Method GET_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PARAM	Call by reference	☐	Type reference (TYPE)	STRING		Parameter	20020111
2	Returning	VALUE	Value transfer	☐	Type reference (TYPE)	STRING		Value	20020111

Method GET_PARAMETER on class CL_UPWB has no exception.

Method GET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	KEY	Value transfer	☐	Type reference (TYPE)	TEXTPOOLKY		Schlüssel des Textelements (Nummer / Selektionsname)	20011214
2	Importing	PROGRAM	Value transfer	☐	Type reference (TYPE)	SYREPID	'SAPLUPWB_BUILDER'	ABAP-Programm, aktuelles Rahmenprogramm	20011214
3	Returning	TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20011214

Method GET_TEXT on class CL_UPWB has no exception.

Method GET_URI_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PARAM	Value transfer	☐	Type reference (TYPE)	STRING		URI Parameter	20051208
2	Importing	REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20051208

Method GET_URI_PARAMETER on class CL_UPWB has no exception.

Method GET_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	APPLICATION	Value transfer	☐	Type reference (TYPE)	STRING			20011010
2	Importing	PAGE	Value transfer	☑	Type reference (TYPE)	STRING			20011010
3	Returning	URL	Value transfer	☐	Type reference (TYPE)	STRING			20011010

Method GET_URL on class CL_UPWB has no exception.

Method INTEGER_TO_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INT	Value transfer	☐	Type reference (TYPE)	I			20020213
2	Returning	STR	Value transfer	☐	Type reference (TYPE)	STRING			20020213

Method INTEGER_TO_STRING on class CL_UPWB has no exception.

Method RAISE_BUFFER_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHANGED	Value transfer	☑	Type reference (TYPE)	STRING		space = 'buffer', 'selection'	20040730

Method RAISE_BUFFER_CHANGED on class CL_UPWB has no exception.

Method RENDER_BUTTON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BUTTON	Value transfer	☑	Object reference (TYPE REF TO)	IF_UPWB_C_BUTTON		IF_UPWB_C_BUTTON	20020725
2	Importing	I_ID	Value transfer	☑	Type reference (TYPE)	STRING		ID of a button component	20020725
3	Returning	R_HTML	Value transfer	☐	Type reference (TYPE)	STRING			20020725

Method RENDER_BUTTON on class CL_UPWB has no exception.

Method RENDER_LINK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ID	Value transfer	☑	Type reference (TYPE)	STRING		ID of a link component	20020725
2	Importing	I_LINK	Value transfer	☑	Object reference (TYPE REF TO)	IF_UPWB_C_LINK		IF_UPWB_C_LINK	20020725
3	Returning	R_HTML	Value transfer	☐	Type reference (TYPE)	STRING			20020725

Method RENDER_LINK on class CL_UPWB has no exception.

Method RENDER_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DESIGN	Value transfer	☑	Type reference (TYPE)	STRING		Design	20020725
2	Importing	I_ID	Value transfer	☑	Type reference (TYPE)	STRING		ID of a text component	20020725
3	Importing	I_LABEL	Value transfer	☑	Type reference (TYPE)	STRING		Label	20020725
4	Importing	I_TEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_UPWB_C_TEXT		IF_UPWB_C_TEXT	20020725
5	Returning	R_HTML	Value transfer	☐	Type reference (TYPE)	STRING			20020725

Method RENDER_TEXT on class CL_UPWB has no exception.

Method SET_BUFFER_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SAVED	Value transfer	☐	Type reference (TYPE)	BOOLE_D	'X'	Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ')	20040801

Method SET_BUFFER_CHANGED on class CL_UPWB has no exception.

Method SET_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PARAM	Call by reference	☐	Type reference (TYPE)	STRING		Parameter	20020111
2	Importing	VALUE	Call by reference	☐	Type reference (TYPE)	STRING		Value	20020111

Method SET_PARAMETER on class CL_UPWB has no exception.

Method STATISTIC_CLOSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'WEB'		20020705

Method STATISTIC_CLOSE on class CL_UPWB has no exception.

Method STATISTIC_OPEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NODE_NAME	Value transfer	☐	Type reference (TYPE)	STRING	'WEB'		20020705
2	Importing	I_PAGE	Value transfer	☑	Object reference (TYPE REF TO)	IF_BSP_PAGE		Business Server Page (BSP) Seite	20020705
3	Importing	I_REQUEST	Value transfer	☑	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20020705

Method STATISTIC_OPEN on class CL_UPWB has no exception.

Event Signatures

Event BUFFER_CHANGED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	I_SELECTION_CHANGED	Exporting	Value transfer	☐	Type reference (TYPE)	BOOLEAN	'-'	True if any selection has changed	20020306

History

Last changed by/on	SAP	20130531
SAP Release Created in	3.1A