SAP ABAP Class CL_RSR_WWW_ITEM_DOC (Item for Single Document)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-BEX-ET (Application Component) End User Technology
     ⤷ RS_WEB_RUNTIME_3X (Package) Web Runtime to BW Release 3.x (Outside CORE)

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_RSR_WWW_ITEM	Module for a Page in Web Reporting	20010306
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_RSOD_DOC_MAINT_CALLER	Called Up By in Docu Maintenance in Web	20030203

Properties

Class	CL_RSR_WWW_ITEM_DOC
Short Description	Item for Single Document
Super Class	CL_RSR_WWW_ITEM	Module for a Page in Web Reporting
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	RS_WEB_RUNTIME_3X	Web Runtime to BW Release 3.x (Outside CORE)
Created	20010306	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_RSOD_UTILITIES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	IF_RSOD_CONST	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	RRXW3	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
5	RSD	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_RSOD_DOC_MAINT_CALLER	☐	☐	Called Up By in Docu Maintenance in Web	20030203

Friends

Class CL_RSR_WWW_ITEM_DOC has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_DEFAULT_FONT_WIDTH	Constant	Public	☐	Type reference (TYPE)	FLOAT	'5.2'	Default Font Width	20020507
2	C_DEFAULT_MAX_LINES_TEXTAREA	Constant	Private	☐	Type reference (TYPE)	I	25	Maximum Number of Rows in Text Area	20020507
3	C_FRAME_NEW_WINDOW	Constant	Private	☐	Type reference (TYPE)	STRING	'ITEM_DOC_NEW_WINDOW_NAME'	Frame to Fix New Window	20020516
4	C_PARAMETER_CHAVL	Constant	Public	☐	Type reference (TYPE)	RRXW3_PARAMETER_ID	'CHAVL'	Parameter Characteristic Value	20010306
5	C_PARAMETER_DEFAULT_URL	Constant	Public	☐	Type reference (TYPE)	RRXW3_PARAMETER_ID	'DEFAULT_PICTURE_URL'	URL for Error Screen	20020211
6	C_PARAMETER_DOC_CLASS	Constant	Public	☐	Type reference (TYPE)	RRXW3_PARAMETER_ID	'DOCUMENT_CLASS'	Parameter Document Class	20020510
7	C_PARAMETER_FONT_WIDTH	Constant	Public	☐	Type reference (TYPE)	RRXW3_PARAMETER_ID	'FONT_WIDTH'	Average Character Width in Font	20020507
8	C_PARAMETER_IOBJNM	Constant	Public	☐	Type reference (TYPE)	RRXW3_PARAMETER_ID	'IOBJNM'	Characteristic	20010306
9	C_PARAMETER_IS_INPLACE	Constant	Public	☐	Type reference (TYPE)	RRXW3_PARAMETER_ID	'IS_INPLACE'	ID if Inplace	20010306
10	C_PARAMETER_LINK_TO_BROWSER	Constant	Public	☐	Type reference (TYPE)	RRXW3_PARAMETER_ID	'LINK_TO_BOWSER'	Indicator of Whether Links to Document Browser Generated	20020211
11	C_PARAMETER_MAX_TEXT_LINES	Constant	Public	☐	Type reference (TYPE)	RRXW3_PARAMETER_ID	'MAX_TEXT_LINES'	Maximum Number of Text Lines	20020507
12	C_PARAMETER_PICTURE	Instance attribute	Private	☐	Type reference (TYPE)	RRXW3_PARAMETER_ID	'PICTURE'	Mime Name Screen	20010510
13	C_PARAMETER_TARGET_FRAME	Constant	Public	☐	Type reference (TYPE)	RRXW3_PARAMETER_ID	'TARGET_FRAME'	Frame Parameter (for Frameset or IFRAME)	20020515
14	C_PARAMETER_TARGET_FRAME_LEVEL	Constant	Public	☐	Type reference (TYPE)	RRXW3_PARAMETER_ID	'TARGET_FRAME_LEVEL'	Parameter Frame Level (As in Frame Hier. - Upwards)	20020910
15	C_PARAMETER_WWW_DOC_TYPE	Constant	Public	☐	Type reference (TYPE)	RRXW3_PARAMETER_ID	'WWW_DOC_TYPE'	Document Type	20010306
16	N_R_CONTEXT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_RSOD_CONTEXT		Context for BW Documents	20020510
17	O_DUMMY_MSG	Instance attribute	Protected	☐	Type reference (TYPE)	C		Dummy for Messages	20020211
18	O_T_MIME_CATALOG	Instance attribute	Protected	☐	Type reference (TYPE)	RSZW_T_MIME_INFO		Table for Structure RSZW_S_MIME_INFO	20010509
19	P_CHABASNM	Instance attribute	Private	☐	Type reference (TYPE)	RSCHABASNM		Reference Characteristic (for Document Class Master Data)	20010911
20	P_DOC_CLASS	Instance attribute	Private	☐	Type reference (TYPE)	RSOD_DOC_CLASS		BW Document Class	20020510
21	P_IOBJNM	Instance attribute	Private	☐	Type reference (TYPE)	RSIOBJNM		InfoObject (for Document Class Master Data)	20010306
22	P_MESSAGE_150_SENDED	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		Message 150 has been sent	20010905
23	P_NO_SNIPPET_POSSIBLE	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		= 'X': No Snippets Allowed (for Textarea)	20030204
24	P_R_DOC	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_RSOD_DOC		Current Document	20030203
25	P_R_ITEM_DOC_BADI	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_EX_RSOD_ITEM_DOC		BAdI Interface IF_EX_RSOD_ITEM_DOC	20030131
26	P_TH_MIME_BUFFER	Instance attribute	Private	☐	Type reference (TYPE)	RSZW_TH_MIME_INFO		Hashed Table for Structure RSZW_S_MIME_INFO	20030303

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_URL_APPEND	Instance method	Private	Method	Gets Attachment to URL (on_close_url, style_sheet)	20030120
2	CREATE_CONTEXT_FROM_DATA_PROV	Instance method	Private	Method	Creates the context from the view	20021106
3	EXTRACT_TAG	Static method	Private	Method	Remove Tag in HTML Source	20020522
4	GET_ACTION	Instance method	Private	Method	Builds Prefix of Action URL	20010306
5	GET_CHAVL_FROM_VIEW	Instance method	Private	Method	Gets Characteristic Value of Current Navigation	20010307
6	GET_F4	Static method	Public	Method	F4 Help for IOBJNM, WWW_Doc Type, and Document Class	20010322
7	GET_IOBJ_TEXT	Instance method	Private	Method	Delivers InfoObject Text	20020211
8	GET_URL_FROM_CHAVLS	Instance method	Private	Method	Gets URL for Document Browser for Several Char. Values	20010912
9	GET_URL_FROM_CONTEXT	Instance method	Private	Method	Gets URL for Document Browser for InforProvider Documents	20020513
10	ON_DATA_PROVIDER_CHANGED	Instance method	Private	Event handling method	DataProvider Event Handler Changed	20021106
11	PUT_TEXT_INTO_HTML	Instance method	Protected	Method	Write Text in HTML	20010718
12	REMOVE_TAG	Static method	Private	Method	Remove Tag in HTML Source	20020516
13	RENDER_HTML_INPLACE	Instance method	Private	Method	Displays Text in a Text Area	20020516
14	RENDER_LINK_TO_FRAME	Instance method	Private	Method	Send Document Automatically (Using JS) into a Frame	20020515
15	RENDER_PICTURE_INPLACE	Instance method	Private	Method	Render Picture	20020515
16	RENDER_TEXTLINK_TO_DOC_BROWSER	Instance method	Private	Method	Render Link to Document Browser	20020515
17	RENDER_TEXT_INPLACE	Instance method	Private	Method	Displays Text in a Text Area	20010911
18	RENDER_URL_IN_FRAME	Instance method	Private	Method	Send Document Automatically (Using JS) into a Frame	20020515

Events

Class CL_RSR_WWW_ITEM_DOC has no event.

Types

Class CL_RSR_WWW_ITEM_DOC has no local type.

Method Signatures

Method ADD_URL_APPEND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_URL	Call by reference	☐	Type reference (TYPE)	STRING		Zu Erweiternde URL	20030120
2	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	STRING		Erweiterte URL	20030120

Method ADD_URL_APPEND on class CL_RSR_WWW_ITEM_DOC has no exception.

Method CREATE_CONTEXT_FROM_DATA_PROV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_R_VIEW	Value transfer	☐	Object reference (TYPE REF TO)	CL_RSR_WWW_VIEW		Web Reporting Data Provider Query View	20021209

Method CREATE_CONTEXT_FROM_DATA_PROV on class CL_RSR_WWW_ITEM_DOC has no exception.

Method EXTRACT_TAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_SOURCE	Call by reference	☐	Type reference (TYPE)	STRING		HTML Source	20020522
2	Importing	I_TAG	Call by reference	☐	Type reference (TYPE)	STRING		Tag ohne <,/ und > Zeichen	20020522

#	Exception	Resumable	Description	Created on
1	CX_RS_NOT_FOUND	☐	Objekt nicht gefunden	20020522

Method GET_ACTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_ACTION	Value transfer	☐	Type reference (TYPE)	STRING		Baut den Präfix der Action URL auf	20010306

Method GET_ACTION on class CL_RSR_WWW_ITEM_DOC has no exception.

Method GET_CHAVL_FROM_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSR_WWW_VIEW		Web Reporting Data Provider Query View	20010510
2	Returning	R_TH_CHAVL	Value transfer	☐	Type reference (TYPE)	RSD_TH_CHAVL		Merkmalswerte	20010912

Method GET_CHAVL_FROM_VIEW on class CL_RSR_WWW_ITEM_DOC has no exception.

Method GET_F4 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20010322
2	Exporting	E_T_CHAVT	Call by reference	☐	Type reference (TYPE)	RSDM_T_CHAVT			20010322
3	Importing	I_R_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSR_PARAMETER		Parameter	20010322

#	Exception	Resumable	Description	Created on
1	X_MESSAGE	☐	Abbruch	20010322

Method GET_IOBJ_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_TEXT	Value transfer	☐	Type reference (TYPE)	RSTXTSH		Beschreibung kurz	20020211

Method GET_IOBJ_TEXT on class CL_RSR_WWW_ITEM_DOC has no exception.

Method GET_URL_FROM_CHAVLS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TH_CHAVL	Call by reference	☐	Type reference (TYPE)	RSD_TH_CHAVL		Hashed Tabelle von Chavls	20010912
2	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	STRING		Url zum Document Browser	20010912

Method GET_URL_FROM_CHAVLS on class CL_RSR_WWW_ITEM_DOC has no exception.

Method GET_URL_FROM_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	STRING		Url zum Document Browser	20020513

Method GET_URL_FROM_CONTEXT on class CL_RSR_WWW_ITEM_DOC has no exception.

Method ON_DATA_PROVIDER_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_DATA_PROVIDER	Call by reference	☐	Attribute reference (LIKE)				20021106
2	Importing	SENDER	Call by reference	☐	Attribute reference (LIKE)				20021106

Method ON_DATA_PROVIDER_CHANGED on class CL_RSR_WWW_ITEM_DOC has no exception.

Method PUT_TEXT_INTO_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TEXT	Call by reference	☐	Type reference (TYPE)	ANY			20010718

Method PUT_TEXT_INTO_HTML on class CL_RSR_WWW_ITEM_DOC has no exception.

Method REMOVE_TAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_SOURCE	Call by reference	☐	Type reference (TYPE)	STRING		HTML Source	20020516
2	Exporting	E_SUBRC	Call by reference	☐	Type reference (TYPE)	SYSUBRC		= 0: Tag gefunden	20020522
3	Importing	I_TAG	Call by reference	☐	Type reference (TYPE)	STRING		Tag ohne <,/ und > Zeichen	20020516
4	Importing	I_WITH_CONTENT	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	= 'X' auch den Inhalt des Tags entfernen	20020516

Method REMOVE_TAG on class CL_RSR_WWW_ITEM_DOC has no exception.

Method RENDER_HTML_INPLACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_S_PHIO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		Phio	20020516
2	Returning	R_ERROR	Value transfer	☐	Type reference (TYPE)	RS_BOOL		Boolean	20020516

Method RENDER_HTML_INPLACE on class CL_RSR_WWW_ITEM_DOC has no exception.

Method RENDER_LINK_TO_FRAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FRAME	Call by reference	☐	Type reference (TYPE)	STRING		Frame	20020515
2	Importing	I_R_DOC	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSOD_DOC		Dokument	20020515

Method RENDER_LINK_TO_FRAME on class CL_RSR_WWW_ITEM_DOC has no exception.

Method RENDER_PICTURE_INPLACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_DOC	Call by reference	☑	Object reference (TYPE REF TO)	CL_RSOD_DOC		BW Dokument	20020516
2	Importing	I_S_COMPONENT	Call by reference	☑	Type reference (TYPE)	SKWF_CPPRP		KW Framework: Komponenteninformation	20020515
3	Importing	I_S_PHIO	Call by reference	☑	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20020515
4	Importing	I_URL	Value transfer	☐	Type reference (TYPE)	STRING		URL	20020515
5	Importing	I_URL_DOC_BROWSER	Call by reference	☑	Type reference (TYPE)	STRING		URL zum document browser	20020515
6	Returning	R_ERROR	Value transfer	☐	Type reference (TYPE)	RS_BOOL		Boolean	20020515

Method RENDER_PICTURE_INPLACE on class CL_RSR_WWW_ITEM_DOC has no exception.

Method RENDER_TEXTLINK_TO_DOC_BROWSER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20020515
2	Importing	I_URL	Call by reference	☐	Type reference (TYPE)	STRING		URL	20020515

Method RENDER_TEXTLINK_TO_DOC_BROWSER on class CL_RSR_WWW_ITEM_DOC has no exception.

Method RENDER_TEXT_INPLACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_S_PHIO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		Phio	20020516
2	Returning	R_ERROR	Value transfer	☐	Type reference (TYPE)	RS_BOOL		Boolean	20020516

Method RENDER_TEXT_INPLACE on class CL_RSR_WWW_ITEM_DOC has no exception.

Method RENDER_URL_IN_FRAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FRAME	Call by reference	☐	Type reference (TYPE)	STRING		Frame	20020515
2	Importing	I_LEVEL	Value transfer	☐	Type reference (TYPE)	I	0	Level - wie oft muß man in der Frame Hierachie nach oben um	20020910
3	Importing	I_URL	Call by reference	☐	Type reference (TYPE)	STRING		URL zum Dokument	20020515

Method RENDER_URL_IN_FRAME on class CL_RSR_WWW_ITEM_DOC has no exception.

History

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