SAP CL_GUI_ECL_PRIMARYVIEWER OO Class - Basis Class for ECL Viewers (2D und 3D)









CL_GUI_ECL_PRIMARYVIEWER is a standard SAP object class available within R/3 SAP systems depending on your version and release level. You can view/maintain the class details by entering its name into the relevant SAP transactions such as SE24, SE80 or even SE84. Below is the documentation available for class CL_GUI_ECL_PRIMARYVIEWER including details of:

  • Interface class implementations
  • Inheritance details
  • Methods defined within class ( including link to full details )
  • Attributes ( including initial values )
  • Class Events

Inheritance

This OO class has a superclass assigned to it, which means it will inherit its objects and methods. The superclass for CL_GUI_ECL_PRIMARYVIEWER is CL_GUI_CONTROL

Interface Implementation

This OO class is an Interface Implementation, which means it will implement its own version of the methods from implementation class IF_ECL_LAYER

Method list of CL_GUI_ECL_PRIMARYVIEWER SAP class


A method is a coding block that performs a certain procedure (i.e. ABAP functionality) on an object within the overall SAP class. In simple terms if the object is an SAP database table a method could be the procedure to add a record or to delete a record. If you are new to OO in many respects, the implementation of a method is similar to a function module and can be called in a very similar way using CALL METHOD. Instead of "CALL FUNCTION", Methods are referenced using the following syntax: CALL METHOD =>methodname EXPORTING/IMPORTING...


Method NameDescriptionVisability
ADD_AVAILABLE_REDLINE_LAYERPrivate
CALL METHOD cl_gui_ecl_primaryviewer=>ADD_AVAILABLE_REDLINE_LAYER...more details

CLEAN_TEMP_BUFFERDeletes Documents Stored TemporarilyPublic
CALL METHOD cl_gui_ecl_primaryviewer=>CLEAN_TEMP_BUFFER...more details

CONSTRUCTORConstructorPublic
CALL METHOD cl_gui_ecl_primaryviewer=>CONSTRUCTOR...more details

DISPLAY_COPYRIGHTDisplays a Copyright Window of the EAIPublic
CALL METHOD cl_gui_ecl_primaryviewer=>DISPLAY_COPYRIGHT...more details

DRAWRefreshes the Viewer ContentPublic
CALL METHOD cl_gui_ecl_primaryviewer=>DRAW...more details

FLUSH_ACTION_LOGFinishes an Interrupted ActionPublic
CALL METHOD cl_gui_ecl_primaryviewer=>FLUSH_ACTION_LOG...more details

GET_AVAILABLE_SECONDARIESReturns the Available SecondariesPublic
CALL METHOD cl_gui_ecl_primaryviewer=>GET_AVAILABLE_SECONDARIES...more details

GET_MARKUP_SECONDARYReturns a Markup ObjectPublic
CALL METHOD cl_gui_ecl_primaryviewer=>GET_MARKUP_SECONDARY...more details

GET_SUBTYPEReturns the Viewer Subtype (2D or 3D, see Constants)Private
CALL METHOD cl_gui_ecl_primaryviewer=>GET_SUBTYPE...more details

GET_TEMP_DIRECTORYDetermines Temporary Directory for Storing DataPublic
CALL METHOD cl_gui_ecl_primaryviewer=>GET_TEMP_DIRECTORY...more details

IMPORT_DOCUMENTImports a File in Addition to Files Already LoadedPublic
CALL METHOD cl_gui_ecl_primaryviewer=>IMPORT_DOCUMENT...more details

IMPORT_MARKUPPrivate
CALL METHOD cl_gui_ecl_primaryviewer=>IMPORT_MARKUP...more details

OPEN_DOCUMENTLoads a Single File into the ViewerPublic
CALL METHOD cl_gui_ecl_primaryviewer=>OPEN_DOCUMENT...more details

PRINTPrints the Visible Area to the Windows Default PrinterPublic
CALL METHOD cl_gui_ecl_primaryviewer=>PRINT...more details

SAVE_CURRENT_VIEWSaves the Currently Loaded View in 2D FormatPublic
CALL METHOD cl_gui_ecl_primaryviewer=>SAVE_CURRENT_VIEW...more details

SEARCH_VIEWER_COLORSearches BGR Color for Viewer (in Decimal Number Display)Public
CALL METHOD cl_gui_ecl_primaryviewer=>SEARCH_VIEWER_COLOR...more details

SET_AMBIENT_BACKGROUNDAdjusts the Background Color to the ContainerPublic
CALL METHOD cl_gui_ecl_primaryviewer=>SET_AMBIENT_BACKGROUND...more details

SET_BACKGROUNDCOLORSets the Background Color for the ViewerPublic
CALL METHOD cl_gui_ecl_primaryviewer=>SET_BACKGROUNDCOLOR...more details

SET_EDIT_MODEPrivate
CALL METHOD cl_gui_ecl_primaryviewer=>SET_EDIT_MODE...more details

SET_INTERACTION_MODESets the Interaction Mode for the ViewerPublic
CALL METHOD cl_gui_ecl_primaryviewer=>SET_INTERACTION_MODE...more details

SET_PRINT_WATERMARKCreates a Watermark Which Is Included in the PrintoutPublic
CALL METHOD cl_gui_ecl_primaryviewer=>SET_PRINT_WATERMARK...more details

SHOW_HELP_DOCUDisplays the Help Documentation in a Dialog Box ContainerPublic
CALL METHOD cl_gui_ecl_primaryviewer=>SHOW_HELP_DOCU...more details

SYNC_LOCAL_CACHESynchronizes the Data at the Frontend with the KPRO DataPublic
CALL METHOD cl_gui_ecl_primaryviewer=>SYNC_LOCAL_CACHE...more details

UNLOAD_ALLCloses all Open FilesPublic
CALL METHOD cl_gui_ecl_primaryviewer=>UNLOAD_ALL...more details



CL_GUI_ECL_PRIMARYVIEWER attributes

List of attributes within class CL_ABAP_CHAR_UTILITIES. These can be referenced using the following syntax CL_ABAP_CHAR_UTILITIES=>. Although depending on where you are inserting the ABAP code you do need to check if the attribute is public or private.

NameLevelDescriptionInitial ValueTypeVisability
ACTION_LOGInstance AttributeACTION_LOGLIKE
ACTION_LOG_TYPE
Protected
ALL_AVAILABLE_LAYERSInstance AttributeTable of all Available LayersLIKE
Protected
ALL_BUFFERED_FILESInstance AttributeALL_BUFFERED_FILESLIKE
Protected
ALL_DIRTY_LAYERSInstance AttributeALL_DIRTY_LAYERSLIKE
Protected
ASK_FOR_LAYER_NAMEInstance AttributeDialog Box for New Layer: 'X' = Yes'X'LIKE
CHAR01
Public
ASK_FOR_UNSAVED_LAYERSInstance AttributeCreate Dialog Box for Unsaved Layers When Exiting'X'LIKE
CHAR01
Public
CTMENUInstance AttributeIndividual Context Menu of Viewer ObjectLIKE
CL_CTMENU
Protected
FOR_DVSInstance AttributeDVS ModeLIKE
CHAR01
Public
MARKUP_FORBIDDENInstance AttributeEnable/Disable Markup AuthorizationLIKE
CHAR01
Public
MY_TOOLBARInstance AttributeToolbarLIKE
CL_GUI_TOOLBAR
Public
NEW_LAYER_NAMEInstance AttributeName of Next New LayerLIKE
CHAR40
Public
NO_ACTION_MODEConstantInteraction Mode: No Action0LIKE
I
Public
NUMBER_OF_AVAILABLE_LAYERSInstance AttributeNumber of All Available Layers0LIKE
I
Public
PAN_MODEConstantInteraction Mode for Panning1LIKE
I
Public
PRINT_WITH_META_DATAInstance Attribute'X' = Always Print with Meta DataLIKE
CHAR01
Public
SEEK_MODEConstantConstant for Search Interaction Mode4LIKE
I
Public
STAMPING_FORBIDDENInstance Attribute'X' = Stamping the Reserved Layer Not PermittedLIKE
CHAR01
Public
VIEWERTYPEInstance AttributeLIKE
Private
VIEWER_2D_SUBTYPEConstantConstant for 2D Viewer - Subtype2LIKE
I
Private
VIEWER_3D_SUBTYPEConstantConstant for 3D Viewer - Subtype3LIKE
I
Private
VIEW_ALL_MODEConstantConstant for Total View Interaction Mode5LIKE
I
Public
WATERMARK_COLOR_BLACKConstantBlack16LIKE
I
Public
WATERMARK_COLOR_BLUEConstantBlue7LIKE
I
Public
WATERMARK_COLOR_GRAYConstantGrey14LIKE
I
Public
WATERMARK_COLOR_GREENConstantGreen4LIKE
I
Public
WATERMARK_COLOR_REDConstantRed11LIKE
I
Public
WATERMARK_COLOR_WHITEConstantWhite1LIKE
I
Public
WATERMARK_COLOR_YELLOWConstantYellow2LIKE
I
Public
ZOOM_AREA_MODEConstantConstant for Zoom Area Interaction Mode3LIKE
I
Public
ZOOM_MODEConstantInteraction Mode for Zooming2LIKE
I
Public


Events of Class CL_GUI_ECL_PRIMARYVIEWER

Events are created within your class using special event handler methods. These must be registered at runtime for the event and can then be triggered using the ABAP syntax: RAISE EVENT EXPOTING... ANNOTATION_TEXT_REQUESTED - Control Is Expecting Text
CLOSE_DIRTY_DOCUMENT - There are Unsaved Documents When the Control is Closed
CONTEXT_MENU_REQUEST - CONTEXT_MENU_REQUEST
CONTEXT_MENU_SELECTED - CONTEXT_MENU_SELECTED
FILE_DROPPED - A File was Dropped Into the Viewer
IMPORT_LAYER_REQUEST -
INITIALISE_OPTIONS - Informs Event Listener of Control Initialization
LAYER_NAME_REQUEST -
VIEWER_FREE - Destructor of Viewer was Called
VIEWING_FINISHED - 'Exit' Button was Clicked



CL_GUI_ECL_PRIMARYVIEWER types

ACTION_LOG_TYPE - ACTION_LOG_TYPE
BUFFERED_FILE - BUFFERED_FILE
MARKUP_LAYER - MARKUP_LAYER
VIEWER_COLOR - BGR Mode as Decimal Number

Links to Related Class(s)

CL_GUI_E...
Full list of available SAP object classes

Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!