SAP ABAP Class CL_ABAP_DOCU_SYNTAX_DIAGRAM (Creation and Display of ABAP Syntax Diagrams)

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_SYNTAX_DIAGRAM
Short Description	Creation and Display of ABAP Syntax Diagrams
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	20070207	SAP
Last change	20130531	SAP
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_BROWSER	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no interface implemented.

Friends

Class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ACTUAL_DIAGRAM	Static Attribute	Private	☐	Type reference (TYPE)	I	0	Index of Current Diagram	20070207
2	EXCREF	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CX_ROOT		Reference to Exception Object	20070207
3	EXT_DATA	Static Attribute	Private	☐	Type reference (TYPE)	CL_ABAP_BROWSER=>LOAD_TAB		External Data for the Browser	20070925
4	HELP_STRING	Constant	Private	☐	Type reference (TYPE)	STRING	'help_syntax_diagrams'	Event Constant	20070925
5	LAST_ACTION	Static Attribute	Private	☐	See coding			Last Event	20070925
6	MODAL	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Modal Dialog Box	20070207
7	MODE	Static Attribute	Private	☐	Type reference (TYPE)	STRING		Current mode	20070925
8	MODES	Constant	Private	☐	See coding			Event Constants	20070925
9	NAV	Constant	Private	☐	See coding			Event Constants	20070925
10	NAV_TABLE	Static Attribute	Private	☐	See coding			Navigation table	20070910
11	PICTURES	Static Attribute	Private	☐	See coding				20070926
12	UNIT_TEST	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20070925
13	XML_TEXT_SYMBOLS	Static Attribute	Private	☐	Type reference (TYPE)	STRING		Text Symbols in XML	20070925

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALL_TERMINAL	Static method	Private	Method	Displays Corresponding Documentation for a Terminal	20070207
2	CHANGE_MODUS	Static method	Private	Method	Changes the Navigation Mode	20070910
3	CHANGE_VIEW	Static method	Private	Method	Switches Between the Views Normal, Obsolete etc.	20070207
4	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20070207
5	DIAGRAM_DESCRIPTION	Static method	Private	Method	Returns the Description for Syntax Diagrams in XML	20070319
6	EXPAND	Static method	Private	Method	Expands Non-Terminals	20070207
7	FILTER_SYNTAX_STRUCTURE	Static method	Private	Method	Removes Non-Relevant Parts from the Syntax Diagram	20080326
8	GET_DESCRIPTION_TEXT	Static method	Private	Method	Get Description Texts	20070319
9	GET_PIC_TAB	Static method	Private	Method	Gets an Icon from the MIME Repository	20070207
10	GET_XML_BASIS	Static method	Private	Method	Gets the Original XML Representation	20070927
11	GET_XML_OFFLINE	Static method	Public	Method	Creates Offline Version	20070927
12	GET_XML_REPRESENTATION	Static method	Private	Method	Creates Online Representation	20070207
13	HANDLE_HTML_EVENT	Static method	Private	Event handling method	Handles Browser Results	20070207
14	LOAD_DIAGRAM	Static method	Private	Method	Loads New Diagram	20070207
15	NAVIGATE	Static method	Private	Method	Forward or Backward Navigation	20070207
16	READ_SYNTAX_STRUCTURE	Static method	Private	Method	Reads Syntax Diagram from Database	20080326
17	REDISPLAY	Static method	Private	Method	Updates the HTML Display	20070207
18	SHOW	Static method	Public	Method	Main Method of the Class for Representing a Diagram	20070207
19	TOGGLE	Static method	Private	Method	Show or Hide Elements	20070910
20	UPDATE_HTML	Static method	Private	Method	Recreates the HTML from the Altered XML Representation	20070207
21	VALIDATE_HTML	Static method	Private	Method	Validation of the Current HTML File (SAP only)	20070925

Events

#	Event	Type	Visibility	Description	Created on
1	SHOW_DOCU	Static Event (1)	Public (2)	Event to Call Docu About Selected Language Element	20070207

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	NAV_TABLE_LINE	Private	See coding			20070910	BEGIN OF nav_table_line, rule_name TYPE string, ini_xml TYPE string, curr_xml TYPE string, curr_html TYPE string, off_x TYPE string, off_y TYPE string, END OF nav_table_line
2	PICTURE	Private	See coding			20070927	BEGIN OF picture, name TYPE string, pict_tab TYPE pict_tab, END OF picture
3	PICT_LINE	Private	See coding			20070207	pict_line(1022) TYPE x
4	PICT_TAB	Private	See coding			20070207	pict_tab TYPE STANDARD TABLE OF pict_line WITH DEFAULT KEY

Method Signatures

Method CALL_TERMINAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EVENT_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20070910

Method CALL_TERMINAL on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method CHANGE_MODUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EVENT_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20070910

Method CHANGE_MODUS on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method CHANGE_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EVENT_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20070910

Method CHANGE_VIEW on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method CLASS_CONSTRUCTOR Signature

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

Method DIAGRAM_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	HELP_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20070319

Method DIAGRAM_DESCRIPTION on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method EXPAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EVENT_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20070910

Method EXPAND on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method FILTER_SYNTAX_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	RULENAME	Call by reference	☐	Type reference (TYPE)	STRING		Regel	20080326
2	Exporting	SUBRC	Call by reference	☐	Type reference (TYPE)	SY-SUBRC		Returncode	20080326
3	Changing	SYNTAX_XML	Call by reference	☐	Type reference (TYPE)	SSYNTAXSTRUCTURE-DESCRIPTION		XML-Darstellung	20080326

Method FILTER_SYNTAX_STRUCTURE on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method GET_DESCRIPTION_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION_NAME	Value transfer	☐	Type reference (TYPE)	DOKHL-OBJECT		Dokumentations-Objekt	20070319
2	Returning	DESCRIPTION_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20070319

Method GET_DESCRIPTION_TEXT on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method GET_PIC_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MIME_URL	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20070207
2	Exporting	PIC_TAB	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20070207

Method GET_PIC_TAB on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method GET_XML_BASIS Signature

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

Method GET_XML_BASIS on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method GET_XML_OFFLINE Signature

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

Method GET_XML_OFFLINE on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method GET_XML_REPRESENTATION Signature

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

Method GET_XML_REPRESENTATION on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method HANDLE_HTML_EVENT Signature

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

Method HANDLE_HTML_EVENT on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method LOAD_DIAGRAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EVENT_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20070910

Method LOAD_DIAGRAM on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method NAVIGATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EVENT_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20070910

Method NAVIGATE on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method READ_SYNTAX_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	RULENAME	Call by reference	☐	Type reference (TYPE)	STRING		Name der Regel	20080326
2	Exporting	SYNTAX_XML	Call by reference	☐	Type reference (TYPE)	SSYNTAXSTRUCTURE-DESCRIPTION			20080326

Method READ_SYNTAX_STRUCTURE on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method REDISPLAY Signature

Method REDISPLAY on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no parameter.
Method REDISPLAY on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method SHOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MODAL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Anzeige als modales Dialogfenster	20070207
2	Importing	RULEKEY	Call by reference	☐	Type reference (TYPE)	SSYNTAXSTRUCTURE-RULENAME		RULEKEY	20070207

Method SHOW on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method TOGGLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EVENT_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20070910

Method TOGGLE on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method UPDATE_HTML Signature

Method UPDATE_HTML on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no parameter.
Method UPDATE_HTML on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Method VALIDATE_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HTML	Call by reference	☐	Type reference (TYPE)	STRING		Aktuelle HTML-Datei	20070925
2	Importing	RULENAME	Call by reference	☐	Type reference (TYPE)	STRING		Name	20070925

Method VALIDATE_HTML on class CL_ABAP_DOCU_SYNTAX_DIAGRAM has no exception.

Event Signatures

Event SHOW_DOCU Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	TOKENS	Exporting	Value transfer	☐	Type reference (TYPE)	ABAPDOCU_TOKENS		Tabelle der Token der ausgewählten Anweisung	20070207

History

Last changed by/on	SAP	20130531
SAP Release Created in	710