SAP ABAP Class CL_ABAP_DOCU (Methods 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
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-ABA-LA (Application Component) Syntax, Compiler, Runtime⤷
SABAPDOCU (Package) ABAP Documentation Objects in ABAP WorkbenchProperties
| Class | CL_ABAP_DOCU | |
| Short Description | Methods of ABAP Keyword Documentation | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SABAPDOCU | ABAP Documentation Objects in ABAP Workbench |
| Created | 20061117 | 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_ABAP_DOCU |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 2 | CL_ABAP_DOCU_TABLES |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_ABAP_DOCU has no interface implemented.
Friends
Class CL_ABAP_DOCU has no friend class.
Attributes
Class CL_ABAP_DOCU has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CONVERT_ITF_TO_HTML |
Static method | Public | Method | Converts Documents of the ABAP Keyword Docu to HTML | 20071127 |
| 2 | GET_ABAP_ELEMENTS |
Static method | Public | Method | Provides a List of ABAP Language Elements of ABAP Index | 20071121 |
| 3 | GET_ABAP_INDEX |
Static method | Public | Method | Provides a Reference to a Table with the ABAP Index | 20071121 |
| 4 | GET_TITLE |
Static method | Public | Method | Gets the Title of a Document | 20120321 |
| 5 | SHOW |
Static method | Public | Method | ABAP Keyword Documentation Display | 20071121 |
| 6 | SHOW_SYNTAX_DIAGRAM |
Static method | Public | Method | Displays a Syntax Diagram | 20080329 |
| 7 | START |
Static method | Public | Method | Call ABAP Keyword Documentation | 20061117 |
Events
Class CL_ABAP_DOCU has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | ABAP_INDEX | Public | See coding | 20121107 | BEGIN OF abap_index,
key1 TYPE xbnfname,
docu_objects TYPE STANDARD TABLE OF abap_index_document
WITH NON-UNIQUE KEY key2,
END OF abap_index
|
||
| 2 | ABAP_INDEX_DOCUMENT | Public | See coding | 20121107 | BEGIN OF abap_index_document,
key2 TYPE xbnfname,
docu_name TYPE dokil-object,
docu_section TYPE string,
END OF abap_index_document
|
||
| 3 | ABAP_INDEX_TAB | Public | See coding | 20121107 | abap_index_tab TYPE HASHED TABLE OF abap_index
WITH UNIQUE KEY key1
|
||
| 4 | AREA | Public | Type reference (TYPE) | THEAD-TDNAME | Document Area: ABEN, ABAP, or DYNP | 20080903 | |
| 5 | NAME | Public | Type reference (TYPE) | THEAD-TDNAME | Name of Document | 20080903 | |
| 6 | SEARCH_RESULT | Public | See coding | 20121107 | BEGIN OF search_result,
object TYPE dokil-object,
text TYPE string,
anchor TYPE string,
END OF search_result
|
||
| 7 | SEARCH_RESULTS | Public | See coding | 20080903 | search_results TYPE TABLE OF search_result WITH NON-UNIQUE DEFAULT KEY
|
Method Signatures
Method CONVERT_ITF_TO_HTML Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
AREA | Call by reference | Type reference (TYPE) | CL_ABAP_DOCU=>AREA | Dokumentbereich (ABEN, ABAP oder DYNP) | 20071127 | ||
| 2 | Importing |
EXAS | Call by reference | Type reference (TYPE) | ABAP_BOOL | Beispiele beim Download berücksichtigen | 20071127 | ||
| 3 | Importing |
FILE_FLAG | Call by reference | Type reference (TYPE) | CHAR1 | Flag für Konvertierung in .HTM-File | 20071127 | ||
| 4 |  Exporting |
HTML | Call by reference | Type reference (TYPE) | ABAPDOCU_HTML_TAB | HTML-Datei | 20071127 | ||
| 5 | Importing |
ID | Call by reference | Type reference (TYPE) | DOKIL-ID | 'SD' | Dokumentklasse, unterstützt wird nur 'SD' | 20071127 | |
| 6 | Importing |
INCLUDE_CSS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | CSS einfügen | 20071128 | |
| 7 | Importing |
LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | SY-LANGU | Sprache | 20071127 | |
| 8 | Importing |
NAME | Call by reference | Type reference (TYPE) | CL_ABAP_DOCU=>NAME | Dokumentname | 20071127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ABAP_DOCU_CONVERSION |
Ausnahme bei der Konvertierung | 20071127 |
Method GET_ABAP_ELEMENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ELEMENT_TAB | Call by reference | Type reference (TYPE) | STANDARD TABLE | Liste der Sprachelemente | 20071121 | ||
| 2 | Importing |
LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | Sprache | 20071121 | ||
| 3 | Importing |
WITH_BUILTINS | Call by reference | Type reference (TYPE) | ABAP_BOOL | 'X' | Eingebaute Typen und Funktionen berücksichtigen | 20071121 |
Method GET_ABAP_ELEMENTS on class CL_ABAP_DOCU has no exception.
Method GET_ABAP_INDEX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
INDEX_TAB | Value transfer | Object reference (TYPE REF TO) | CL_ABAP_DOCU=>ABAP_INDEX_TAB | Referenz auf Indextabelle | 20071121 | ||
| 2 | Importing |
LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | Sprache | 20071121 |
Method GET_ABAP_INDEX on class CL_ABAP_DOCU has no exception.
Method GET_TITLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | SY-LANGU | Sprache | 20120321 | |
| 2 | Importing |
OBJECT | Call by reference | Type reference (TYPE) | CSEQUENCE | Dokument | 20120321 | ||
| 3 | Returning |
TITLE | Value transfer | Type reference (TYPE) | STRING | Titel | 20120321 |
Method GET_TITLE on class CL_ABAP_DOCU has no exception.
Method SHOW Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ANCHOR | Call by reference | Type reference (TYPE) | C | Interne Textmarke für Direktansteuerung | 20071121 | ||
| 2 | Importing |
AREA | Call by reference | Type reference (TYPE) | C | 'ABEN' | Dokubereich | 20071121 | |
| 3 | Exporting |
DOCU_CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTROL | Referenz auf Control | 20071121 | ||
| 4 | Importing |
LANGU | Call by reference | Type reference (TYPE) | SYST-LANGU | SY-LANGU | Sprache | 20071121 | |
| 5 | Importing |
NAME | Call by reference | Type reference (TYPE) | C | 'ABAP' | Dokuname | 20071121 | |
| 6 | Importing |
SEARCHED | Call by reference | Type reference (TYPE) | STANDARD TABLE | Suchwörter der Volltextsuche | 20071121 | ||
| 7 | Importing |
SEARCH_MODE | Call by reference | Type reference (TYPE) | C | I, F for Index, Fulltext | 20071121 | ||
| 8 | Importing |
SEARCH_WORD | Call by reference | Type reference (TYPE) | CSEQUENCE | Suchausdruck | 20071121 |
Method SHOW on class CL_ABAP_DOCU has no exception.
Method SHOW_SYNTAX_DIAGRAM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
RULENAME | Call by reference | Type reference (TYPE) | SSYNTAXSTRUCTURE-RULENAME | 20080329 |
Method SHOW_SYNTAX_DIAGRAM on class CL_ABAP_DOCU has no exception.
Method START Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DEBUG_FLAG | Value transfer | Type reference (TYPE) | ABAP_BOOL | ' ' | Spezialanzeigemodus für Aufruf aus ABAP Debugger | 20061117 | |
| 2 | Exporting |
DOCU_CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTROL | Referenz auf Doku- oder Hitlist-Container | 20061117 | ||
| 3 | Importing |
EXAMPLES_FLAG | Value transfer | Type reference (TYPE) | ABAP_BOOL | 'X' | Beispiele werden durchsucht | 20061117 | |
| 4 | Importing |
FIRST_WORD | Value transfer | Type reference (TYPE) | CSEQUENCE | '' | Erstes Wort der Anweisung | 20061117 | |
| 5 | Importing |
FULL_TEXT_FLAG | Value transfer | Type reference (TYPE) | ABAP_BOOL | Volltextsuche | 20061117 | ||
| 6 | Importing |
GLOSSARY_FLAG | Value transfer | Type reference (TYPE) | ABAP_BOOL | 'X' | Glossar wird durchsucht | 20061117 | |
| 7 | Importing |
INDEX_FLAG | Value transfer | Type reference (TYPE) | ABAP_BOOL | 'X' | Index wird durchsucht | 20061117 | |
| 8 | Importing |
LANGU | Value transfer | Type reference (TYPE) | SY-LANGU | SY-LANGU | Sprache für Volltextsuche | 20061117 | |
| 9 | Importing |
MODE | Value transfer | Type reference (TYPE) | CSEQUENCE | ' ' | 'ABAP' oder 'DYNP' | 20061117 | |
| 10 | Importing |
NO_DIALOG | Value transfer | Type reference (TYPE) | ABAP_BOOL | ' ' | Rückgabe der Ergebnisse ohne Anzeige | 20061117 | |
| 11 | Importing |
NO_SIMILARS | Value transfer | Type reference (TYPE) | ABAP_BOOL | ' ' | Keine Ähnlichkeitssuche | 20080130 | |
| 12 | Exporting |
SEARCH_RESULTS | Call by reference | Type reference (TYPE) | CL_ABAP_DOCU=>SEARCH_RESULTS | Suchergebnis, falls NO_DIALOG = 'X' | 20061117 | ||
| 13 | Exporting |
STRUCTURED_SEARCH_RESULTS | Call by reference | Type reference (TYPE) | CL_ABAP_DOCU=>SEARCH_RESULTS | 20100802 | |||
| 14 | Importing |
SUBJECTS_FLAG | Value transfer | Type reference (TYPE) | ABAP_BOOL | 'X' | Schlagworte werden durchsucht | 20061117 | |
| 15 | Importing |
TOKENS | Call by reference | Type reference (TYPE) | ABAPDOCU_TOKENS | Alle Tokens der Anweisung | 20061117 | ||
| 16 | Importing |
WORD | Value transfer | Type reference (TYPE) | CSEQUENCE | '' | ABAP-Begriff (ggf. generisch) | 20061117 |
Method START on class CL_ABAP_DOCU has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 710 |
