SAP ABAP Class CL_DV_VIEWER (Document Viewer)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-ARL (Application Component) ArchiveLink
     ⤷ SDV0 (Package) Document Viewing

Properties

Class	CL_DV_VIEWER
Short Description	Document Viewer
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SDV0	Document Viewing
Created	20040220	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)
2	CNTB	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	ICON	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	SDVT	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_DV_VIEWER has no interface implemented.

Friends

Class CL_DV_VIEWER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	AL_ASSIGN_REF	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_DV_AL_ASSIGN		Assign Document	20040225
2	AL_NOTE_REF	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_DV_AL_NOTE		ArchiveLink Notes	20040225
3	AL_TASK_REF	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_DV_AL_TASK		Start Workflow Task	20040225
4	BOR_OBJECT_REF	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_DV_BOR_OBJECT		Relationship to BOR Object	20040301
5	CURRENT_VIEWER	Instance attribute	Private	☐	Type reference (TYPE)	TVIEWER			20040220
6	DEFAULT_TOOLBAR_BUTTONS	Static Attribute	Private	☐	Type reference (TYPE)	TTB_BUTTON		Toolbar Buttons	20040310
7	DISABLE_GOS_TOOLBAR	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20040324
8	DOCUMENTS	Instance attribute	Private	☐	Type reference (TYPE)	SDVT_DOCUMENTS			20040220
9	DOCUMENT_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20040223
10	DOCUMENT_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	I			20040223
11	DOCUMENT_PAGE	Instance attribute	Private	☐	Type reference (TYPE)	I			20040223
12	DOCUMENT_REF	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_DV_DOCUMENT		Document	20040225
13	FUNCTION_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20040223
14	GOS_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20040301
15	GOS_CONTAINER0	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20040302
16	GOS_DUMMY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_TOOLBAR		Toolbar Control	20040302
17	GOS_TOOLBOX	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GOS_MANAGER		Publication for Generic Object Services	20040301
18	IMC_ACTIVE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20040414
19	IMC_SERVER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_DV_IMC_SERVER		Document Viewer - IMC Handling	20040308
20	IS_READY	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20040309
21	NO_GOS_TOOLBAR	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20040311
22	PARENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20040220
23	SPLITTER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_SPLITTER_CONTAINER		Splitter Control	20040223
24	SPLITTER2	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_SPLITTER_CONTAINER		Splitter Control	20040301
25	TOOLBAR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_TOOLBAR		Toolbar Control	20040223
26	TOOLBAR_BUTTONS	Instance attribute	Private	☐	Type reference (TYPE)	TTB_BUTTON		Toolbar Buttons	20040310
27	VIEWERS	Instance attribute	Private	☐	Type reference (TYPE)	TVIEWERS			20040220

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_DOCUMENT	Instance method	Public	Method		20040220
2	ADD_DOCUMENTS	Instance method	Public	Method		20040322
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20040310
4	CLOSE	Instance method	Private	Method		20040309
5	CLOSE_ALL_DOCUMENTS	Instance method	Public	Method		20040323
6	CLOSE_DOCUMENT	Instance method	Public	Method		20040225
7	CLOSE_WINDOW	Instance method	Public	Method		20040309
8	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20040220
9	CREATE_DEFAULT_TOOLBAR_BUTTONS	Static method	Private	Method		20040310
10	CREATE_DOCUMENT	Static method	Private	Method		20040225
11	CREATE_TOOLBAR	Instance method	Private	Method	Create Toolbar	20040223
12	FREE	Instance method	Public	Method		20041112
13	GET_DEFAULT_TOOLBAR_BUTTONS	Static method	Public	Method		20040310
14	GET_DOCUMENT	Instance method	Public	Method		20040309
15	GET_DOCUMENT_COUNT	Instance method	Public	Method		20040309
16	GET_SETTINGS	Static method	Public	Method		20040401
17	GET_TOOLBAR_WIDTH	Static method	Private	Method		20040310
18	IS_IMC_ACTIVE	Instance method	Public	Method		20040414
19	IS_NOT_INITIAL	Static method	Private	Method	Test Not Initial	20040225
20	ON_CLOSE_DIALOGBOX	Instance method	Private	Event handling method		20040309
21	ON_DOCUMENT_CHANGED	Instance method	Private	Event handling method		20040310
22	ON_FUNCTION_SELECTED	Instance method	Private	Event handling method	Handler for Tool Bar	20040223
23	ON_HANDLE_REQUEST	Instance method	Private	Event handling method		20040308
24	OPEN	Instance method	Private	Method		20040309
25	PROCESS_COMMAND	Instance method	Public	Method		20040308
26	SAVE_CURRENT_POSITION	Instance method	Private	Method		20040402
27	SEARCH_DOCUMENTS	Static method	Private	Method		20040225
28	SET_BUTTON_STATE	Instance method	Private	Method		20040310
29	SET_IMC_LOCK	Instance method	Public	Method		20040902
30	SET_SETTINGS	Static method	Public	Method		20040401
31	SET_VIEWER	Instance method	Private	Method		20040220
32	SHOW_DOCUMENT	Instance method	Public	Method		20040223
33	SHOW_PROGRESS	Static method	Private	Method		20040303
34	UPDATE_CONTEXT_MENU	Instance method	Private	Method		20040305

Events

#	Event	Type	Visibility	Description	Created on
1	DOCUMENT_CHANGED	Instance Event (0)	Public (2)		20040309
2	DOCUMENT_CLOSED	Instance Event (0)	Public (2)		20040323
3	FUNCTION_SELECTED	Instance Event (0)	Public (2)		20040310

Types

Class CL_DV_VIEWER has no local type.

Method Signatures

Method ADD_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_DV_DOCUMENT		Dokument	20040220
2	Importing	NO_REFRESH	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20040322
3	Returning	POS	Value transfer	☐	Type reference (TYPE)	I			20040226
4	Importing	WINDOW_ID	Call by reference	☑	Type reference (TYPE)	CSEQUENCE		Window-ID für WINDOW_CLOSE	20040309

#	Exception	Resumable	Description	Created on
1	CX_DV_EXCEPTION	☐	Basisklasse für Ausnahmen	20040316

Method ADD_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENTS	Call by reference	☐	Type reference (TYPE)	SDVT_DOCUMENTS		Dokument	20040322
2	Returning	POS	Value transfer	☐	Type reference (TYPE)	I			20040322

#	Exception	Resumable	Description	Created on
1	CX_DV_EXCEPTION	☐	Basisklasse für Ausnahmen	20040322

Method CLASS_CONSTRUCTOR Signature

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

Method CLOSE Signature

Method CLOSE on class CL_DV_VIEWER has no parameter.
Method CLOSE on class CL_DV_VIEWER has no exception.

Method CLOSE_ALL_DOCUMENTS Signature

Method CLOSE_ALL_DOCUMENTS on class CL_DV_VIEWER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_DV_EXCEPTION	☐	Basisklasse für Ausnahmen	20040323

Method CLOSE_DOCUMENT 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	0		20040309

#	Exception	Resumable	Description	Created on
1	CX_DV_EXCEPTION	☐	Basisklasse für Ausnahmen	20040316

Method CLOSE_WINDOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	WINDOW_ID	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20040309

#	Exception	Resumable	Description	Created on
1	CX_DV_EXCEPTION	☐	Basisklasse für Ausnahmen	20040316

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NO_GOS_TOOLBAR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20040311
2	Importing	NO_TOOLBAR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20040310
3	Importing	PARENT	Call by reference	☑	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstracter Container fuer GUI Controls	20040220
4	Importing	SERVE_IMC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20040308
5	Importing	TOOLBAR_BUTTONS	Call by reference	☑	Type reference (TYPE)	TTB_BUTTON		Toolbarbuttons	20040310

#	Exception	Resumable	Description	Created on
1	CX_DV_EXCEPTION	☐	Basisklasse für Ausnahmen	20040316

Method CREATE_DEFAULT_TOOLBAR_BUTTONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	BUTTONS	Value transfer	☐	Type reference (TYPE)	TTB_BUTTON		Toolbarbuttons	20040310

Method CREATE_DEFAULT_TOOLBAR_BUTTONS on class CL_DV_VIEWER has no exception.

Method CREATE_DOCUMENT Signature

Method CREATE_DOCUMENT on class CL_DV_VIEWER has no parameter.
Method CREATE_DOCUMENT on class CL_DV_VIEWER has no exception.

Method CREATE_TOOLBAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BUTTONS	Call by reference	☑	Type reference (TYPE)	TTB_BUTTON		Toolbarbuttons	20040310

Method CREATE_TOOLBAR on class CL_DV_VIEWER has no exception.

Method FREE Signature

Method FREE on class CL_DV_VIEWER has no parameter.
Method FREE on class CL_DV_VIEWER has no exception.

Method GET_DEFAULT_TOOLBAR_BUTTONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	BUTTONS	Value transfer	☐	Type reference (TYPE)	TTB_BUTTON		Toolbarbuttons	20040310

Method GET_DEFAULT_TOOLBAR_BUTTONS on class CL_DV_VIEWER has no exception.

Method GET_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_DV_DOCUMENT		Dokument	20040309
2	Importing	INDEX	Call by reference	☑	Type reference (TYPE)	I			20040309

Method GET_DOCUMENT on class CL_DV_VIEWER has no exception.

Method GET_DOCUMENT_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	COUNT	Value transfer	☐	Type reference (TYPE)	I			20040309

Method GET_DOCUMENT_COUNT on class CL_DV_VIEWER has no exception.

Method GET_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PERMANENT	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20040401
2	Returning	SETTINGS	Value transfer	☐	Type reference (TYPE)	SDVT_VIEWER_SETTINGS			20040401

Method GET_SETTINGS on class CL_DV_VIEWER has no exception.

Method GET_TOOLBAR_WIDTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BUTTONS	Call by reference	☐	Type reference (TYPE)	TTB_BUTTON			20040311
2	Returning	WIDTH	Value transfer	☐	Type reference (TYPE)	I			20040310

Method GET_TOOLBAR_WIDTH on class CL_DV_VIEWER has no exception.

Method IS_IMC_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20040414

Method IS_IMC_ACTIVE on class CL_DV_VIEWER has no exception.

Method IS_NOT_INITIAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20040225
2	Importing	VALUE	Call by reference	☐	Type reference (TYPE)	ANY			20040225

Method IS_NOT_INITIAL on class CL_DV_VIEWER has no exception.

Method ON_CLOSE_DIALOGBOX Signature

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

Method ON_CLOSE_DIALOGBOX on class CL_DV_VIEWER has no exception.

Method ON_DOCUMENT_CHANGED Signature

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

Method ON_DOCUMENT_CHANGED on class CL_DV_VIEWER has no exception.

Method ON_FUNCTION_SELECTED Signature

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

Method ON_FUNCTION_SELECTED on class CL_DV_VIEWER has no exception.

Method ON_HANDLE_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REQUEST	Value transfer	☐	Attribute reference (LIKE)				20040308
2	Importing	RESULT	Value transfer	☐	Attribute reference (LIKE)				20040308

Method ON_HANDLE_REQUEST on class CL_DV_VIEWER has no exception.

Method OPEN Signature

Method OPEN on class CL_DV_VIEWER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_DV_EXCEPTION	☐	Basisklasse für Ausnahmen	20040316

Method PROCESS_COMMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REQUEST	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20040308
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	STRING			20040308

Method PROCESS_COMMAND on class CL_DV_VIEWER has no exception.

Method SAVE_CURRENT_POSITION Signature

Method SAVE_CURRENT_POSITION on class CL_DV_VIEWER has no parameter.
Method SAVE_CURRENT_POSITION on class CL_DV_VIEWER has no exception.

Method SEARCH_DOCUMENTS Signature

Method SEARCH_DOCUMENTS on class CL_DV_VIEWER has no parameter.
Method SEARCH_DOCUMENTS on class CL_DV_VIEWER has no exception.

Method SET_BUTTON_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHECKED	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20040310
2	Importing	ENABLED	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20040310
3	Importing	FCODE	Call by reference	☐	Type reference (TYPE)	UI_FUNC		Funktionscode	20040310

Method SET_BUTTON_STATE on class CL_DV_VIEWER has no exception.

Method SET_IMC_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LOCK	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20040902

Method SET_IMC_LOCK on class CL_DV_VIEWER has no exception.

Method SET_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PERMANENT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20040401
2	Importing	SETTINGS	Call by reference	☐	Type reference (TYPE)	SDVT_VIEWER_SETTINGS			20040401

Method SET_SETTINGS on class CL_DV_VIEWER has no exception.

Method SET_VIEWER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLASS	Call by reference	☐	Type reference (TYPE)	STRING			20040220

#	Exception	Resumable	Description	Created on
1	CX_DV_EXCEPTION	☐	Basisklasse für Ausnahmen	20040316

Method SHOW_DOCUMENT 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	-1		20040223
2	Importing	PAGE	Call by reference	☐	Type reference (TYPE)	I	-1		20040223
3	Importing	SUPRESS_REFRESH	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20040304

#	Exception	Resumable	Description	Created on
1	CX_DV_EXCEPTION	☐	Basisklasse für Ausnahmen	20040316

Method SHOW_PROGRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P1	Call by reference	☑	Type reference (TYPE)	CSEQUENCE			20040303
2	Importing	P2	Call by reference	☑	Type reference (TYPE)	CSEQUENCE			20040303
3	Importing	P3	Call by reference	☑	Type reference (TYPE)	CSEQUENCE			20040303
4	Importing	P4	Call by reference	☑	Type reference (TYPE)	CSEQUENCE			20040303
5	Importing	PERCENTAGE	Call by reference	☑	Type reference (TYPE)	NUMERIC	0	MS SQL int (obsolete - do not use anymore)	20040303
6	Importing	TEXT	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20040303

Method SHOW_PROGRESS on class CL_DV_VIEWER has no exception.

Method UPDATE_CONTEXT_MENU Signature

Method UPDATE_CONTEXT_MENU on class CL_DV_VIEWER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_DV_EXCEPTION	☐	Basisklasse für Ausnahmen	20040316

Event Signatures

Event DOCUMENT_CHANGED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DOCUMENT	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	IF_DV_DOCUMENT		Dokument	20040309
2	WINDOW_ID	Exporting	Value transfer	☐	Type reference (TYPE)	STRING			20040317

Event DOCUMENT_CLOSED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DOCUMENT	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	IF_DV_DOCUMENT		Dokument	20040323
2	WINDOW_ID	Exporting	Value transfer	☐	Type reference (TYPE)	STRING			20040323

Event FUNCTION_SELECTED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	FCODE	Exporting	Value transfer	☐	Type reference (TYPE)	UI_FUNC		Funktionscode	20040310

History

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