SAP ABAP Class CL_WDR_IO_THEMES (Importing and Exporting Web Dynpro ABAP Themes)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-ABA (Application Component) Web Dynpro ABAP
     ⤷ SWDP_UTILITY (Package) Web Dynpro Utilities

Properties

Class	CL_WDR_IO_THEMES
Short Description	Importing and Exporting Web Dynpro ABAP Themes
Super Class
Instantiability of a Class	0	Private
Final	☐

General Data

Message Class
Program status
Category	0
Package	SWDP_UTILITY	Web Dynpro Utilities
Created	20070330	SAP
Last change	20110908	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)

Interfaces

Class CL_WDR_IO_THEMES has no interface implemented.

Friends

Class CL_WDR_IO_THEMES has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	DISPLAY_PROGRESS	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Progress indicator is displayed if apab_true	20070531
2	IMPORT_ERROR_MESSAGE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Error Message in Import Processes	20070531
3	IMPORT_FILE_COUNTER	Instance attribute	Private	☐	Type reference (TYPE)	I		Number of Imported Files	20070531
4	IMPORT_LOG_OBJECT	Constant	Private	☐	Type reference (TYPE)	BALOBJ_D	'WEBDYNPRO'	Object for the logs from Import_Themes_From_ZIP	20070531
5	IMPORT_LOG_SUBOBJECT	Constant	Private	☐	Type reference (TYPE)	BALSUBOBJ	'IMPORT_THEME'	Subobject for the logs from Import_Themes_From_ZIP	20070531
6	IMPORT_NO_OF_TASKS	Instance attribute	Private	☐	Type reference (TYPE)	I		Number of Current Import Work Processes	20070531
7	METADATA70SUFFIX1	Constant	Private	☐	Type reference (TYPE)	STRING	'.design'	Suffix of a Theme Metadata File in 7.0	20070531
8	METADATA70SUFFIX2	Constant	Private	☐	Type reference (TYPE)	STRING	'.designinfo'	Suffix of a Theme Metadata File in 7.0	20070531
9	MR_CUSTOM_SUB_DIR	Constant	Public	☐	Type reference (TYPE)	STRING	'CUSTOM/'	Sub-Directory in MR_XXX_PATH with the Customer Themes	20070405
10	MR_DATA_PATH	Constant	Public	☐	Type reference (TYPE)	STRING	'/SAP/PUBLIC/BC/UR/nw5/data/'	Path with the metadata of the themes in the MR repository	20070405
11	MR_THEMES_UR_PATH	Constant	Public	☐	Type reference (TYPE)	STRING	'/SAP/PUBLIC/BC/UR/nw5/themes/'	Path with data generated by the themes in the MR repository	20070413
12	MR_WAR_PATH	Constant	Public	☐	Type reference (TYPE)	STRING	'/SAP/PUBLIC/BC/UR/nw5/war/'	Path with WAR data with the UR version in the MR repository	20070405
13	R_MR_API	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_MR_API		Maintenance of Access to the MR Repository	20070330
14	R_ONLY_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_WDR_IO_THEMES		Indicator to the only instance	20070531
15	SAP_KEYWORD	Constant	Private	☐	Type reference (TYPE)	STRING	'ISSAPDESIGN'	Keyword for isSAPDesign	20070411
16	SAP_KEYWORD_70	Constant	Private	☐	Type reference (TYPE)	STRING	'ISSAPTHEME'		20091008
17	TRADESHOW	Constant	Private	☐	Type reference (TYPE)	STRING	'sap_tradeshow'	File Name in SAP Tradeshow	20070411
18	VERSION_FILENAME	Constant	Private	☐	Type reference (TYPE)	STRING	'/themeInfo.properties'	themeInfo File Name	20070411
19	VERSION_KEYWORD	Constant	Private	☐	Type reference (TYPE)	STRING	'VERSION'	Keyword for the version in the themeInfo file	20070411
20	ZIP_DATA_PATH	Constant	Private	☐	Type reference (TYPE)	STRING	'project/data/'	Corresponding Path in the ZIP File	20070402
21	ZIP_THEMES_PATH	Constant	Private	☐	Type reference (TYPE)	STRING	'project/themes/ur/'	Corresponding Path in the ZIP File	20070402
22	ZIP_WAR_PATH	Constant	Private	☐	Type reference (TYPE)	STRING	'project/war/'	Corresponding Path in the ZIP File	20070402

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ANALYZE_THEMEINFO	Static method	Private	Method	Analyzes the data in the themeInfo properties file	20070531
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20070615
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20070330
4	DELETE_PROGRESS_INDICATOR	Static method	Private	Method	Progress indicator displayed during import	20070531
5	DELETE_THEME	Instance method	Public	Method	Deletes a theme from the MIME repository	20070412
6	EXPORT_FOLDER_TO_ZIP	Instance method	Private	Method	EXPORT_THEME: Exports a whole directory	20070531
7	EXPORT_GEN_METADAT_TO_ZIP	Instance method	Private	Method	EXPORT_THEME: Exports non theme-specific metadata	20070531
8	EXPORT_PROGRESS_INDICATOR	Static method	Private	Method	Progress indicator displayed during import	20070531
9	EXPORT_THEMES_TO_ZIP	Instance method	Public	Method	Exports all themes from the MIME repository to a ZIP file	20070531
10	EXPORT_THEME_METADAT_70_TO_ZIP	Instance method	Private	Method	EXPORT_THEME: Exports metadata for a 7.0 theme	20070531
11	FACTORY	Static method	Public	Method	Generates the only instance in the class	20070531
12	GET_IMPORT_LOGS	Static method	Public	Method	Transfers the logs from Import_Themes_from_ZIP	20070531
13	GET_MAX_PROC	Instance method	Public	Method	Returns the number of free work processes	20070531
14	GET_THEME_INFO	Static method	Public	Method	Returns version of a theme and whether it is an SAP theme	20070615
15	GET_UR_VERSION	Static method	Public	Method	Returns the version of the themes in the MIME repository	20070412
16	IMPORT_PROGRESS_INDICATOR	Static method	Public	Method	Progress indicator displayed during import	20070531
17	IMPORT_THEMES_FROM_ZIP	Instance method	Public	Method	Imports themes from a ZIP file to the MIME repository	20070531
18	IMPORT_THEMES_RETURN	Instance method	Public	Method	Method	20070531
19	IS_REQUIRED_THEME_DATA	Static method	Public	Method	Shows whether 't_path' contains theme data needed by WD ABAP	20070622
20	IS_THEME_FRESH	Static method	Public	Method		20090715
21	LIST_FOLDERS_IN_MR	Static method	Private	Method	Attaches list of all sub-directories in the MIME repository	20070531
22	LIST_THEMES_IN_MR	Static method	Public	Method	Lists all themes in the MIME repository	20070531
23	LIST_THEMES_IN_ZIP	Instance method	Private	Method	Lists all themes in a ZIP and checks versions	20070531
24	PROGRESS_INDICATOR	Static method	Private	Method	Display the SAP GUI progress indicator	20070531

Events

#	Event	Type	Visibility	Description	Created on
1	IMPORT_INFO	Instance Event (0)	Public (2)	Sends information about the themes in the ZIP file	20070412

Types

Class CL_WDR_IO_THEMES has no local type.

Method Signatures

Method ANALYZE_THEMEINFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_IS_SAP	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Ist Theme ein SAP-Theme?	20070531
2	Exporting	E_THEME_IS_FRESH	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN		Ersatz für echten boolschen Typ: 'X' == wahr '' == falsch	20090713
3	Exporting	E_VERSION	Call by reference	☐	Type reference (TYPE)	STRING		Version des Themes	20070531
4	Importing	I_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		Der Inhalt der themeInfo.properties Datei eines Themes	20070531

#	Exception	Resumable	Description	Created on
1	CX_WDR_IO_THEMES	☐	Ausnahmeklasse zu CL_WDR_IO_THEMES	20070531

Method CLASS_CONSTRUCTOR Signature

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

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DISPLAY_PROGRESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Soll Progress_Indicator angezeigt werden?	20070531

#	Exception	Resumable	Description	Created on
1	CX_WDR_IO_THEMES	☐	Ausnahmeklasse zu CL_WDR_IO_THEMES	20070330

Method DELETE_PROGRESS_INDICATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PERC	Call by reference	☐	Type reference (TYPE)	I		Prozent	20070531
2	Importing	I_VARIABLE	Call by reference	☐	Type reference (TYPE)	STRING			20070531

Method DELETE_PROGRESS_INDICATOR on class CL_WDR_IO_THEMES has no exception.

Method DELETE_THEME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	DURATION	Call by reference	☑	Type reference (TYPE)	T		Dauer der Löschung	20070417
2	Importing	I_THEME_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name des zu löschenden Kunden-Themes (ohne Pfad)	20070412

#	Exception	Resumable	Description	Created on
1	CX_WDR_IO_THEMES	☐	Ausnahmeklasse zu CL_WDR_IO_THEMES	20070412

Method EXPORT_FOLDER_TO_ZIP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	FILE_COUNTER	Call by reference	☐	Type reference (TYPE)	I		Anzahl der gezippten Dateien	20070531
2	Importing	I_CHECK_THEME_DATA	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Soll is_required_meta_data ausgeführt werden?	20070622
3	Importing	I_MR_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Pfad im MIME-Repository	20070531
4	Importing	I_PROGRESS_START	Call by reference	☐	Type reference (TYPE)	I		für event export_progress	20070531
5	Importing	I_PROGRESS_STEP	Call by reference	☐	Type reference (TYPE)	I		für event export_progress	20070531
6	Importing	I_PROGRESS_VAR	Call by reference	☐	Type reference (TYPE)	STRING			20070531
7	Importing	I_ZIP	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_ZIP		Zip-Utility	20070531
8	Importing	I_ZIP_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Pfad in der ZIP-Datei	20070531

#	Exception	Resumable	Description	Created on
1	CX_WDR_IO_THEMES	☐	Ausnahmeklasse zu CL_WDR_IO_THEMES	20070531

Method EXPORT_GEN_METADAT_TO_ZIP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	FILE_COUNTER	Call by reference	☐	Type reference (TYPE)	I		Anzahl der gezippten Dateien	20070531
2	Importing	I_MR_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Pfad im MIME-Repository	20070531
3	Importing	I_PROGRESS_START	Call by reference	☐	Type reference (TYPE)	I		für event export_progress	20070531
4	Importing	I_PROGRESS_STEP	Call by reference	☐	Type reference (TYPE)	I		für event export_progress	20070531
5	Importing	I_PROGRESS_VAR	Call by reference	☐	Type reference (TYPE)	STRING			20070531
6	Importing	I_THEME_LIST	Call by reference	☐	Type reference (TYPE)	WDR_THEMES_INFO		Informationen zu Themes	20070531
7	Importing	I_ZIP	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_ZIP		Zip-Utility	20070531
8	Importing	I_ZIP_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Pfad in der ZIP-Datei	20070531

#	Exception	Resumable	Description	Created on
1	CX_WDR_IO_THEMES	☐	Ausnahmeklasse zu CL_WDR_IO_THEMES	20070531

Method EXPORT_PROGRESS_INDICATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PERC	Call by reference	☐	Type reference (TYPE)	I		Prozent	20070531
2	Importing	I_VARIABLE	Call by reference	☐	Type reference (TYPE)	STRING			20070531

Method EXPORT_PROGRESS_INDICATOR on class CL_WDR_IO_THEMES has no exception.

Method EXPORT_THEMES_TO_ZIP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	DURATION	Call by reference	☐	Type reference (TYPE)	T		Dauer der Übertragung	20070531
2	Importing	EXPORTED_THEMES	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Namen der Themes, die exportiert werden sollen	20070531
3	Changing	FILE_COUNTER	Call by reference	☐	Type reference (TYPE)	I		Anzahl der übertragenen Dateien	20070531
4	Importing	ZIPFILENAME	Call by reference	☐	Type reference (TYPE)	STRING		Name der ZIP-Datei	20070531

#	Exception	Resumable	Description	Created on
1	CX_WDR_IO_THEMES	☐	Ausnahmeklasse zu CL_WDR_IO_THEMES	20070531

Method EXPORT_THEME_METADAT_70_TO_ZIP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	FILE_COUNTER	Call by reference	☐	Type reference (TYPE)	I		Anzahl der gezippten Dateien	20070531
2	Importing	I_MR_PREFIX	Call by reference	☐	Type reference (TYPE)	STRING		Pfad im MIME-Repository	20070531
3	Importing	I_ZIP	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_ZIP		Zip-Utility	20070531
4	Importing	I_ZIP_PREFIX	Call by reference	☐	Type reference (TYPE)	STRING		Pfad in der ZIP-Datei	20070531

#	Exception	Resumable	Description	Created on
1	CX_WDR_IO_THEMES	☐	Ausnahmeklasse zu CL_WDR_IO_THEMES	20070531

Method FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DISPLAY_PROGRESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Soll Progress_Indicator angezeigt werden?	20070531
2	Returning	R_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_WDR_IO_THEMES		Zeiger auf die Instanz	20070531

#	Exception	Resumable	Description	Created on
1	CX_WDR_IO_THEMES	☐	Ausnahmeklasse zu CL_WDR_IO_THEMES	20070531

Method GET_IMPORT_LOGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_HEADER	Value transfer	☐	Type reference (TYPE)	BALHDR_T		Anwendungs-Log: Tabelle mit Protokollkopfdaten	20070531

Method GET_IMPORT_LOGS on class CL_WDR_IO_THEMES has no exception.

Method GET_MAX_PROC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_RESULT	Value transfer	☐	Type reference (TYPE)	I		Anzahl der freien Arbeitsprozesse	20070531

Method GET_MAX_PROC on class CL_WDR_IO_THEMES has no exception.

Method GET_THEME_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_IS_SAP	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Ist es ein SAP-Theme?	20070615
2	Exporting	E_OK	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Existiert das Theme?	20070615
3	Exporting	E_VERSION	Call by reference	☐	Type reference (TYPE)	STRING		Version des Themes	20070615
4	Importing	I_THEME_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name des Themes	20070615

Method GET_THEME_INFO on class CL_WDR_IO_THEMES has no exception.

Method GET_UR_VERSION Signature

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

#	Exception	Resumable	Description	Created on
1	CX_WDR_IO_THEMES	☐	Ausnahmeklasse zu CL_WDR_IO_THEMES	20070412

Method IMPORT_PROGRESS_INDICATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PERC	Call by reference	☐	Type reference (TYPE)	I		Prozent	20070531
2	Importing	I_VARIABLE	Call by reference	☐	Type reference (TYPE)	STRING			20070531

Method IMPORT_PROGRESS_INDICATOR on class CL_WDR_IO_THEMES has no exception.

Method IMPORT_THEMES_FROM_ZIP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	DURATION	Call by reference	☐	Type reference (TYPE)	T		Dauer der Übertragung	20070531
2	Changing	FILE_COUNTER	Value transfer	☐	Type reference (TYPE)	I		Anzahl der übertragenen Daten	20070531
3	Importing	ZIPFILENAME	Value transfer	☐	Type reference (TYPE)	STRING		Name der ZIP-Datei mit den Theme-Daten	20070531

#	Exception	Resumable	Description	Created on
1	CX_WDR_IO_THEMES	☐	Ausnahmeklasse zu CL_WDR_IO_THEMES	20070531

Method IMPORT_THEMES_RETURN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_TASK	Value transfer	☐	Type reference (TYPE)	CLIKE			20070531

Method IMPORT_THEMES_RETURN on class CL_WDR_IO_THEMES has no exception.

Method IS_REQUIRED_THEME_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING			20070622
2	Returning	R_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20070622

Method IS_REQUIRED_THEME_DATA on class CL_WDR_IO_THEMES has no exception.

Method IS_THEME_FRESH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	IS_FRESH	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090715
2	Importing	THEME_VERSION	Call by reference	☐	Type reference (TYPE)	STRING			20090715

#	Exception	Resumable	Description	Created on
1	CX_WDR_IO_THEMES	☐	Ausnahmeklasse zu CL_WDR_IO_THEMES	20090715

Method LIST_FOLDERS_IN_MR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_LIST	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Tabelle von Strings	20070531
2	Importing	I_URL	Call by reference	☐	Type reference (TYPE)	STRING			20070531

#	Exception	Resumable	Description	Created on
1	CX_WDR_IO_THEMES	☐	Ausnahmeklasse zu CL_WDR_IO_THEMES	20070531

Method LIST_THEMES_IN_MR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_THEMES_LIST	Call by reference	☐	Type reference (TYPE)	WDR_THEMES_INFO		Informationen zu Themes	20070531

#	Exception	Resumable	Description	Created on
1	CX_WDR_IO_THEMES	☐	Ausnahmeklasse zu CL_WDR_IO_THEMES	20070531

Method LIST_THEMES_IN_ZIP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_THEMES_LIST	Call by reference	☐	Type reference (TYPE)	WDR_THEMES_INFO		Liste der gefundenen Themes	20070531
2	Importing	I_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		Dateiname der ZIP-Datei	20070531
3	Importing	I_ZIP	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_ZIP		Zip-Utility	20070531

#	Exception	Resumable	Description	Created on
1	CX_WDR_IO_THEMES	☐	Ausnahmeklasse zu CL_WDR_IO_THEMES	20070531

Method PROGRESS_INDICATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PERC	Call by reference	☐	Type reference (TYPE)	I		Prozent	20070531
2	Importing	I_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Text	20070531
3	Importing	I_VARIABLE	Call by reference	☑	Type reference (TYPE)	STRING			20070531

Method PROGRESS_INDICATOR on class CL_WDR_IO_THEMES has no exception.

Event Signatures

Event IMPORT_INFO Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	ER_THEME_LIST	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	WDR_THEMES_INFO			20070425

History

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