SAP ABAP Interface IF_ECL_LAYER (Layer Interface for ECL Viewer)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CI (Application Component) Component Integration / Installation Windows Components
     ⤷ SECLVIEWER (Package) Engineering Client Viewer for 2D/3D objects

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_GUI_ECL_PRIMARYVIEWER	Basis Class for ECL Viewers (2D und 3D)	20000502

Properties

Interface	IF_ECL_LAYER
Short Description	Layer Interface for ECL Viewer

General Data

Package	SECLVIEWER	Engineering Client Viewer for 2D/3D objects
Created	20000502	SAP
Last changed	00000000	SAP
Unicode checks active	☑

Forward declarations

Interface IF_ECL_LAYER has no forward declaration.

Interfaces

Interface IF_ECL_LAYER has no interface.

Friends

Interface IF_ECL_LAYER has no friend.

Attributes

Interface IF_ECL_LAYER has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_AVAILABLE_REDLINE_LAYER	Instance method	Public	Method	Declares Available Layer for an Original	20000505
2	CHECK_IF_LAYER_IS_DIRTY	Instance method	Public	Method	Checks Whether a Layer is Unsaved	20000508
3	CREATE_NEW_LAYER	Instance method	Public	Method	Creates a New Layer	20000502
4	GET_ACTIVE_LAYER	Instance method	Public	Method	Returns Name, Index, etc. of Active Layer	20000503
5	GET_AVAILABLE_LAYER	Instance method	Public	Method	Provides Information on an Available Markup File	20000508
6	GET_DIRTY_LAYERS	Instance method	Public	Method	Passes a List of Unsaved Layers to the Event Handler	20000508
7	GET_LAYER_INDEX	Instance method	Public	Method	Returns the Index of a Particular Layer	20000503
8	GET_LAYER_NAME	Instance method	Public	Method	Returns the Name of a Layer	20000503
9	GET_LAYER_VISIBLE	Instance method	Public	Method	Determine Visibility of Layer	20000502
10	GET_NUMBER_OF_LAYERS	Instance method	Public	Method	Returns the Number of Layers	20000502
11	LOAD_LAYER	Instance method	Public	Method	Loads a Redlining Layer	20000508
12	REMOVE_LAYER	Instance method	Public	Method	Deletes a Particular Layer	20000503
13	SAVE_ACTIVE_LAYER	Instance method	Public	Method	Saves the Active Layer in a Local File	20000505
14	SAVE_DIRTY_LAYERS	Instance method	Public	Method	Informs About Unsaved Layers and Saves Them if Required	20000508
15	SAVE_LAYER	Instance method	Public	Method	Saves a Layer to a File	20000505
16	SET_ACTIVE_LAYER	Instance method	Public	Method	Sets the Active Layer	20000503
17	SET_LAYER_NAME	Instance method	Public	Method	Sets the Name of a Layer	20000505
18	SET_LAYER_VISIBLE	Instance method	Public	Method	Set Layer to Visible / Invisible	20000503

Events

#	Event	Type	Visibility	Description	Created on
1	ALL_LAYERS_REMOVED	Instance Event (0)	Public (2)	All Existing Layers Removed from Viewer	20000614
2	IMPORT_LAYER_REQUEST	Instance Event (0)	Public (2)	Request to Import a Markup Layer	20000505
3	LAYERS_DETECTED	Instance Event (0)	Public (2)	Triggered if More Than the Basis Layer Is Loaded	20000505
4	LAYER_DELETED	Instance Event (0)	Public (2)	User Deleted Single Layer	20000614
5	LAYER_NAME_REQUEST	Instance Event (0)	Public (2)	Name Needs to Be Assigned to a New Layer	20000505
6	SAVED_DIRTY_LAYER	Instance Event (0)	Public (2)	Unsaved Layer Was Saved	20000508

Types

Interface IF_ECL_LAYER has no local type.

Method Signatures

Method ADD_AVAILABLE_REDLINE_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LAYER_NAME	Call by reference	☐	Type reference (TYPE)	C		Name des Layers	20000505
2	Importing	MARKUP_CATEGORY	Call by reference	☑	Type reference (TYPE)	C		Layer ist einer Kategorie zugeordnet	20000505
3	Importing	MARKUP_FORBIDDEN	Call by reference	☑	Type reference (TYPE)	CHAR01		Ändern des Layers verboten = 'X'	20000505
4	Importing	REMOVAL_FORBIDDEN	Call by reference	☑	Type reference (TYPE)	CHAR01		Löschen des Layers verboten = 'X'	20000505

Method ADD_AVAILABLE_REDLINE_LAYER on Interface IF_ECL_LAYER has no exception.

Method CHECK_IF_LAYER_IS_DIRTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INDEX	Call by reference	☐	Type reference (TYPE)	I		Layerindex	20000508
2	Exporting	IS_DIRTY	Call by reference	☐	Type reference (TYPE)	I		1=dirty, 0=clean	20000508

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000508
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000508

Method CREATE_NEW_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LAYER_INDEX	Call by reference	☐	Type reference (TYPE)	I		Layer Index	20000502
2	Importing	LAYER_NAME	Call by reference	☑	Type reference (TYPE)	C		Layer Name	20000502

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000502
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000502
3	POP_UP_CANCELED	☐	POP_UP_CANCELED	20000502

Method GET_ACTIVE_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CONTROL_INDEX	Call by reference	☐	Type reference (TYPE)	I		Index im Control-internen Stapel	20000928
2	Exporting	INDEX	Call by reference	☐	Type reference (TYPE)	I		Index des aktiven Layers	20000503
3	Exporting	LAYER_NAME	Call by reference	☐	Type reference (TYPE)	CHAR40		Name des aktiven Layers	20000503
4	Exporting	MARKUP_CATEGORY	Call by reference	☐	Type reference (TYPE)	C		Markup-Kategorie	20000503
5	Exporting	MARKUP_FORBIDDEN	Call by reference	☐	Type reference (TYPE)	CHAR01		Schreibrecht für aktiven Layer	20000503
6	Exporting	REMOVAL_FORBIDDEN	Call by reference	☐	Type reference (TYPE)	CHAR01		Berechtigung zum Löschen des Layers oder von Objekten darauf	20000503

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000503
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000503

Method GET_AVAILABLE_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ALREADY_LOADED	Call by reference	☐	Type reference (TYPE)	CHAR01		Ist schon geladen = 'X'	20000508
2	Exporting	CONTROL_INDEX	Call by reference	☐	Type reference (TYPE)	I		Control-interner Layerindex	20000928
3	Exporting	IS_VISIBLE	Call by reference	☐	Type reference (TYPE)	CHAR01		Ist sichtbar = 'X'	20000508
4	Exporting	LAYERINDEX	Call by reference	☐	Type reference (TYPE)	I		Index des Layers	20000508
5	Importing	LAYERNAME	Call by reference	☑	Type reference (TYPE)	CHAR40		Suchkriterium 2: Layer Name	20000508
6	Importing	LAYER_INDEX	Call by reference	☑	Type reference (TYPE)	I		Suchkriterium 1: Index des Layers	20000508
7	Exporting	LAYER_NAME	Call by reference	☐	Type reference (TYPE)	CHAR40		Layer Name	20000508
8	Exporting	MARKUP_FORBIDDEN	Call by reference	☐	Type reference (TYPE)	CHAR01		Redlinen verboten = 'X'	20000508
9	Exporting	REMOVAL_FORBIDDEN	Call by reference	☐	Type reference (TYPE)	CHAR01		Layer löschen verboten = 'X'	20000508

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000508
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000508
3	NO_SUCH_LAYER	☐	NO_SUCH_LAYER	20000508

Method GET_DIRTY_LAYERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DIRTY_LAYERS	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Liste aller ungesicherten Layer, Referenz wird aktualisiert	20000508

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000508
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000508

Method GET_LAYER_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	LAYERINDEX	Call by reference	☐	Type reference (TYPE)	I		Index des Layers	20000503
2	Importing	LAYERNAME	Call by reference	☐	Type reference (TYPE)	C		Name des Layers	20000503

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000503
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000503

Method GET_LAYER_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LAYERINDEX	Call by reference	☐	Type reference (TYPE)	I	1	Layer Index	20000503
2	Exporting	LAYERNAME	Call by reference	☐	Type reference (TYPE)	CHAR40		Layer Name	20000503

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000503
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000503

Method GET_LAYER_VISIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LAYERINDEX	Call by reference	☑	Type reference (TYPE)	I		Layer Index	20000502
2	Exporting	VISIBLE	Call by reference	☐	Type reference (TYPE)	I		Layer Visible Flag	20000502

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000502
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000502

Method GET_NUMBER_OF_LAYERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	NUMBEROFLAYERS	Call by reference	☐	Type reference (TYPE)	I		Anzahl der Layer	20000502

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000502
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000502

Method LOAD_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR_CODE	Call by reference	☐	Type reference (TYPE)	I		Error Code	20000508
2	Importing	LAYER_NAME	Call by reference	☐	Type reference (TYPE)	CHAR40		Layer-Name	20000508
3	Importing	MARKUP_CATEGORY	Call by reference	☑	Type reference (TYPE)	CHAR50		Markup-Kategorie	20000508
4	Importing	MARKUP_FORBIDDEN	Call by reference	☑	Type reference (TYPE)	C		Schreibrecht auf dem Layer	20000508
5	Importing	REMOVAL_FORBIDDEN	Call by reference	☑	Type reference (TYPE)	C		Löschen des Layers nicht erlaubt	20000508
6	Importing	URL	Call by reference	☐	Type reference (TYPE)	C		Dateipfad oder URL	20000508

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000508
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000508

Method REMOVE_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LAYER_NAME	Call by reference	☐	Type reference (TYPE)	CHAR40		Layer Name; 'ALL' = alle Layer	20000503

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000503
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000503

Method SAVE_ACTIVE_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILE_PATH	Call by reference	☐	Type reference (TYPE)	C		Dateipfad	20000505
2	Importing	LAYER_NAME	Call by reference	☑	Type reference (TYPE)	CHAR40		Layer Name	20000505

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000505
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000505

Method SAVE_DIRTY_LAYERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACTION_LOG	Call by reference	☑	Type reference (TYPE)	CHAR10		Beschreibt, welche Aktion durch Dialogbox unterbrochen wurde	20000508
2	Importing	LAYER_NAME	Call by reference	☑	Type reference (TYPE)	CHAR40		Falls nicht alle, sondern ein bestimmter Layer gesichert	20000508
3	Exporting	NO_DIRTY_LAYERS	Call by reference	☐	Type reference (TYPE)	CHAR01		'X', falls keine ungesicherten Layer vorhanden	20000508

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000508
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000508
3	NO_TEMP_DIR_FOUND	☐	NO_TEMP_DIR_FOUND	20000508

Method SAVE_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	FILE_FORMAT	Call by reference	☐	Type reference (TYPE)	I	0	Dateiformat.	20000505
2	Changing	FILE_NAME	Call by reference	☐	Type reference (TYPE)	C		Name der zu speichernden Datei	20000505
3	Changing	FILE_PATH	Call by reference	☐	Type reference (TYPE)	CHAR255		Pfad, unter dem die Datei gespeichert wird	20000505
4	Importing	INDEX	Call by reference	☐	Type reference (TYPE)	I		Index des zu speichernden Layers	20000505

#	Exception	Resumable	Description	Created on
1	CAN_NOT_SAVE_FILE	☐	CAN_NOT_SAVE_FILE	20000505
2	CNTL_ERROR	☐	CNTL_ERROR	20000505
3	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000505
4	INDEX_DOES_NOT_EXIST	☐	INDEX_DOES_NOT_EXIST	20000505
5	NO_TEMP_DIR_FOUND	☐	NO_TEMP_DIR_FOUND	20000505

Method SET_ACTIVE_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AUTO	Call by reference	☑	Type reference (TYPE)	C		Automatisches Definieren des aktiven Layers	20000503
2	Importing	INDEX	Call by reference	☑	Type reference (TYPE)	I		Layerindex	20000503

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000503
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000503

Method SET_LAYER_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LAYERINDEX	Call by reference	☐	Type reference (TYPE)	I		Layer Index	20000505
2	Importing	LAYERNAME	Call by reference	☐	Type reference (TYPE)	C		Name des Layers	20000505

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000505
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000505

Method SET_LAYER_VISIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LAYERINDEX	Call by reference	☐	Type reference (TYPE)	I	1	Layer Index	20000503
2	Importing	LAYERVISIBLE	Call by reference	☐	Type reference (TYPE)	I	1	1 = sichtbar, 0 = unsichtbar	20000503

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	CNTL_ERROR	20000503
2	CNTL_SYSTEM_ERROR	☐	CNTL_SYSTEM_ERROR	20000503

Event Signatures

Event ALL_LAYERS_REMOVED Signature
Event ALL_LAYERS_REMOVED on Interface IF_ECL_LAYER has no parameter.
Event IMPORT_LAYER_REQUEST Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	LAYER_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	CHAR40		Layer Name	20000505

Event LAYERS_DETECTED Signature
Event LAYERS_DETECTED on Interface IF_ECL_LAYER has no parameter.
Event LAYER_DELETED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	LAYERNAME	Exporting	Value transfer	☑	Type reference (TYPE)	CHAR40		Name des zu löschenden Layers	20000614

Event LAYER_NAME_REQUEST Signature
Event LAYER_NAME_REQUEST on Interface IF_ECL_LAYER has no parameter.
Event SAVED_DIRTY_LAYER Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	FILE_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	CHAR255		Dateipfad	20000508
2	LAYER_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	CHAR40		Layername	20000508

History

Last changed by/on	SAP	00000000
SAP Release Created in	50A