SAP ABAP Class CL_ABAP_DOCU_HTML (Web Version of ABAP Keyword Documentation)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
     ⤷ SABAPDOCU (Package) ABAP Documentation Objects in ABAP Workbench

Properties

Class	CL_ABAP_DOCU_HTML
Short Description	Web Version of ABAP Keyword Documentation
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SABAPDOCU	ABAP Documentation Objects in ABAP Workbench
Created	20121029	SAP
Last change	20141121
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	CL_ABAP_DOCU	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_ABAP_DOCU_HTML has no interface implemented.

Friends

Class CL_ABAP_DOCU_HTML has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	G_CLIENT	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20131113
2	G_ECLIPSE	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20121029
3	G_LANGUAGE	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20121029
4	G_PATH	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20121029
5	G_TITLE1	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20121029
6	G_TITLE2	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20121029

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADJUST_HTML_FOR_ECLIPSE	Static method	Private	Method		20121029
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20121029
3	GET_DOCUMENT	Static method	Private	Method		20121029
4	GET_FIGURE	Static method	Private	Method		20121029
5	GET_HTML	Static method	Public	Method	Provides HTML File	20121029
6	HANDLE_SEARCH_RESULT	Static method	Private	Method		20121119
7	MARKUP_SEARCH_RESULT	Static method	Private	Method		20121029
8	SEARCH_DOCU_BY_INDEX	Static method	Private	Method		20121029
9	SEARCH_DOCU_BY_KEYWORD	Static method	Private	Method		20121029
10	SEARCH_DOCU_BY_TEXT	Static method	Private	Method		20121029
11	SEARCH_DOCU_BY_TOKENS	Static method	Private	Method		20121119
12	TRANSFORM_SEARCH_RESULTS	Static method	Private	Method		20121119

Events

Class CL_ABAP_DOCU_HTML has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	RESULTS	Private	See coding			20121119	results TYPE STANDARD TABLE OF results_wa with EMPTY KEY
2	RESULTS_WA	Private	See coding			20121119	BEGIN OF results_wa, text TYPE string, object TYPE dokil-object, END OF results_wa

Method Signatures

Method ADJUST_HTML_FOR_ECLIPSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	HTML	Call by reference	☐	Type reference (TYPE)	STRING			20121029

Method ADJUST_HTML_FOR_ECLIPSE on class CL_ABAP_DOCU_HTML has no exception.

Method CLASS_CONSTRUCTOR Signature

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

Method GET_DOCUMENT Signature

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

Method GET_DOCUMENT on class CL_ABAP_DOCU_HTML has no exception.

Method GET_FIGURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OBJECT	Value transfer	☐	Type reference (TYPE)	STRING			20121029
2	Returning	XHTML	Value transfer	☐	Type reference (TYPE)	XSTRING			20121029

Method GET_FIGURE on class CL_ABAP_DOCU_HTML has no exception.

Method GET_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Value transfer	☑	Type reference (TYPE)	STRING		Mandant	20131113
2	Importing	FORMAT	Value transfer	☐	Type reference (TYPE)	STRING	``		20121029
3	Exporting	HTML	Call by reference	☐	Type reference (TYPE)	STRING		HTML-Datei	20121029
4	Importing	LANGUAGE	Value transfer	☑	Type reference (TYPE)	STRING		Sprache (EN, DE)	20121029
5	Importing	OBJECT	Value transfer	☑	Type reference (TYPE)	STRING		ABAP-Doku-Objekt	20121029
6	Importing	PATH	Value transfer	☑	Type reference (TYPE)	STRING		Pfad der Web-Adresse	20121029
7	Importing	QUERY	Value transfer	☑	Type reference (TYPE)	STRING		Suchbegriff	20121029
8	Importing	TOKENS	Call by reference	☑	Type reference (TYPE)	ABAPDOCU_TOKENS		Tabelle der Token der ausgewählten Anweisung	20121119
9	Exporting	XHTML	Call by reference	☐	Type reference (TYPE)	XSTRING		Binärdatei	20121029

Method GET_HTML on class CL_ABAP_DOCU_HTML has no exception.

Method HANDLE_SEARCH_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	HTML	Call by reference	☐	Type reference (TYPE)	STRING			20121119

Method HANDLE_SEARCH_RESULT on class CL_ABAP_DOCU_HTML has no exception.

Method MARKUP_SEARCH_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	HTML	Call by reference	☐	Type reference (TYPE)	STRING			20121029

Method MARKUP_SEARCH_RESULT on class CL_ABAP_DOCU_HTML has no exception.

Method SEARCH_DOCU_BY_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	HTML	Value transfer	☐	Type reference (TYPE)	STRING			20121029
2	Importing	QUERY	Value transfer	☐	Type reference (TYPE)	STRING			20121029

Method SEARCH_DOCU_BY_INDEX on class CL_ABAP_DOCU_HTML has no exception.

Method SEARCH_DOCU_BY_KEYWORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	HTML	Value transfer	☐	Type reference (TYPE)	STRING			20121029
2	Importing	KEYWORD	Value transfer	☐	Type reference (TYPE)	STRING			20121029

Method SEARCH_DOCU_BY_KEYWORD on class CL_ABAP_DOCU_HTML has no exception.

Method SEARCH_DOCU_BY_TEXT Signature

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

Method SEARCH_DOCU_BY_TEXT on class CL_ABAP_DOCU_HTML has no exception.

Method SEARCH_DOCU_BY_TOKENS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	HTML	Value transfer	☐	Type reference (TYPE)	STRING			20121119
2	Importing	TOKENS	Call by reference	☐	Type reference (TYPE)	ABAPDOCU_TOKENS		Tabelle der Token der ausgewählten Anweisung	20121119

Method SEARCH_DOCU_BY_TOKENS on class CL_ABAP_DOCU_HTML has no exception.

Method TRANSFORM_SEARCH_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	HTML	Value transfer	☐	Type reference (TYPE)	STRING			20121119
2	Importing	RESULT_TAB	Call by reference	☐	Type reference (TYPE)	CL_ABAP_DOCU=>SEARCH_RESULTS			20121119

Method TRANSFORM_SEARCH_RESULTS on class CL_ABAP_DOCU_HTML has no exception.

History

Last changed by/on	SAP	20141121
SAP Release Created in	740