SAP ABAP Class CL_DOCUMENT_CLIENT_SERVICES (Document Component Functions)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_ALINK_CONSTANTS	Constants	20010926

Properties

Class	CL_DOCUMENT_CLIENT_SERVICES
Short Description	Document Component Functions
Super Class	CL_ALINK_CONSTANTS	Constants
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SAOV	Document Viewer
Created	20010926	SAP
Last change	00000000	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_DOCUMENT_CLIENT_SERVICES has no forward declaration.

Interfaces

Class CL_DOCUMENT_CLIENT_SERVICES has no interface implemented.

Friends

Class CL_DOCUMENT_CLIENT_SERVICES has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	DOC_ACTUAL_DOCUMENT	Instance attribute	Private	☐	Type reference (TYPE)	I			20010926
2	DOC_CL_SERVICES_CONTAINER	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20010926
3	DOC_CL_SERVICES_CONTEXTMENU	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CTMENU		Context Menu	20010926
4	DOC_CL_SERVICES_TOOLBAR	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_GUI_TOOLBAR		Toolbar Control	20010926
5	DOC_DESCRIPTION	Instance attribute	Private	☐	Type reference (TYPE)	ALINK_TEXT_TABLE		Text Table Type	20010926
6	DOC_MARK_ACTIVE	Instance attribute	Private	☐	Type reference (TYPE)	OAX		Selection Activated	20011002
7	DOC_NOTE_EXIST_ACTIVE	Instance attribute	Private	☐	Type reference (TYPE)	OAX		Note Exists Activated	20011107
8	DOC_NOTE_FUNCTION_ACTIVE	Instance attribute	Private	☐	Type reference (TYPE)	OAX		Notes Function Activated	20011002
9	DOC_NUMBER_OF_DOCUMENTS	Instance attribute	Private	☐	Type reference (TYPE)	I			20010926
10	DOC_VIEWER_MODE	Instance attribute	Private	☐	Type reference (TYPE)	I			20011011

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLOSE_DOCUMENT	Instance method	Private	Method	Close document	20010927
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20010926
3	FREE	Instance method	Public	Method		20011002
4	MARK_DOCUMENT	Instance method	Public	Method	Select Document	20010927
5	ON_DROPDOWN_CLICKED	Instance method	Private	Event handling method		20010926
6	ON_FUNCTION_SELECTED	Instance method	Private	Event handling method		20010926
7	PAGETO	Instance method	Public	Method	Page to a New Component	20010926
8	REGISTER_EVENTS	Instance method	Private	Method		20010926
9	SET_DESCRIPTION	Instance method	Public	Method		20011009
10	SET_NOTE_FUNCTION	Instance method	Public	Method		20011107
11	SET_NUMBEROFDOCUMENTS	Instance method	Public	Method		20011005
12	UMARK_DOCUMENT	Instance method	Public	Method		20010927

Events

#	Event	Type	Visibility	Description	Created on
1	EVENT_ASSIGN_DOCUMENT	Instance Event (0)	Public (2)	Assign Document	20010927
2	EVENT_DOCUMENT_CLOSED	Instance Event (0)	Public (2)	Document Closed	20010927
3	EVENT_DOCUMENT_MARKED	Instance Event (0)	Public (2)	Document Selected	20010927
4	EVENT_DOCUMENT_UNMARKED	Instance Event (0)	Public (2)	Document Selection Removed	20010927
5	EVENT_NEW_DOCUMENT	Instance Event (0)	Public (2)	Create New Document	20010927
6	EVENT_PAGE	Instance Event (0)	Public (2)	Paging Activated	20010927
7	EVENT_PROCESS_NOTE	Instance Event (0)	Public (2)	Edit Note	20010927
8	EVENT_SEARCH	Instance Event (0)	Public (2)	Find Documents	20010927
9	EVENT_START_WORKFLOW	Instance Event (0)	Public (2)	Use Current Document to Start Workflow	20010927

Types

Class CL_DOCUMENT_CLIENT_SERVICES has no local type.

Method Signatures

Method CLOSE_DOCUMENT Signature

Method CLOSE_DOCUMENT on class CL_DOCUMENT_CLIENT_SERVICES has no parameter.
Method CLOSE_DOCUMENT on class CL_DOCUMENT_CLIENT_SERVICES has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstracter Container fuer GUI Controls	20010926
2	Importing	MARK_ACTIVE	Value transfer	☑	Type reference (TYPE)	OAX		Dokument markiert	20010926
3	Importing	NOTE_EXIST	Value transfer	☐	Type reference (TYPE)	OAX		Existiert eine Notiz	20010926
4	Importing	NOTE_FUNCTION_ACTIVE	Value transfer	☐	Type reference (TYPE)	OAX		Notizbearbeitung aktiv	20010926
5	Importing	NUMBER_OF_DOCUMENTS	Value transfer	☐	Type reference (TYPE)	I			20010926
6	Importing	VIEWERMODE	Call by reference	☐	Type reference (TYPE)	I			20011011

Method CONSTRUCTOR on class CL_DOCUMENT_CLIENT_SERVICES has no exception.

Method FREE Signature

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

Method MARK_DOCUMENT Signature

Method MARK_DOCUMENT on class CL_DOCUMENT_CLIENT_SERVICES has no parameter.
Method MARK_DOCUMENT on class CL_DOCUMENT_CLIENT_SERVICES has no exception.

Method ON_DROPDOWN_CLICKED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Attribute reference (LIKE)				20010926
2	Importing	POSX	Call by reference	☐	Attribute reference (LIKE)				20010926
3	Importing	POSY	Call by reference	☐	Attribute reference (LIKE)				20010926

Method ON_DROPDOWN_CLICKED on class CL_DOCUMENT_CLIENT_SERVICES 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	Call by reference	☐	Attribute reference (LIKE)				20010926

Method ON_FUNCTION_SELECTED on class CL_DOCUMENT_CLIENT_SERVICES has no exception.

Method PAGETO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NEXTDOCUMENT	Value transfer	☐	Type reference (TYPE)	I			20010927

Method PAGETO on class CL_DOCUMENT_CLIENT_SERVICES has no exception.

Method REGISTER_EVENTS Signature

Method REGISTER_EVENTS on class CL_DOCUMENT_CLIENT_SERVICES has no parameter.
Method REGISTER_EVENTS on class CL_DOCUMENT_CLIENT_SERVICES has no exception.

Method SET_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION	Call by reference	☐	Type reference (TYPE)	ALINK_TEXT_TABLE		Texttabellentyp	20011009

Method SET_DESCRIPTION on class CL_DOCUMENT_CLIENT_SERVICES has no exception.

Method SET_NOTE_FUNCTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NOTE_EXIST	Value transfer	☐	Type reference (TYPE)	OAX		Kennzeichen Ja/Nein (X/ )	20011107

Method SET_NOTE_FUNCTION on class CL_DOCUMENT_CLIENT_SERVICES has no exception.

Method SET_NUMBEROFDOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NUMBEROFDOCUMENTS	Value transfer	☐	Type reference (TYPE)	I			20011005

Method SET_NUMBEROFDOCUMENTS on class CL_DOCUMENT_CLIENT_SERVICES has no exception.

Method UMARK_DOCUMENT Signature

Method UMARK_DOCUMENT on class CL_DOCUMENT_CLIENT_SERVICES has no parameter.
Method UMARK_DOCUMENT on class CL_DOCUMENT_CLIENT_SERVICES has no exception.

Event Signatures

Event EVENT_ASSIGN_DOCUMENT Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DOC_ACTUAL_DOCUMENT	Exporting	Value transfer	☐	Type reference (TYPE)	I			20010927

Event EVENT_DOCUMENT_CLOSED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DOCUMENT	Exporting	Value transfer	☐	Type reference (TYPE)	I			20010927

Event EVENT_DOCUMENT_MARKED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DOCUMENT	Exporting	Value transfer	☐	Type reference (TYPE)	I			20010927

Event EVENT_DOCUMENT_UNMARKED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DOCUMENT	Exporting	Value transfer	☐	Type reference (TYPE)	I			20010927

Event EVENT_NEW_DOCUMENT Signature
Event EVENT_NEW_DOCUMENT on class CL_DOCUMENT_CLIENT_SERVICES has no parameter.
Event EVENT_PAGE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	NEXTPAGE	Exporting	Value transfer	☐	Type reference (TYPE)	I		Ausgewählte Seite	20010927

Event EVENT_PROCESS_NOTE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DOC_ACTUAL_DOCUMENT	Exporting	Value transfer	☐	Type reference (TYPE)	I			20010927

Event EVENT_SEARCH Signature
Event EVENT_SEARCH on class CL_DOCUMENT_CLIENT_SERVICES has no parameter.
Event EVENT_START_WORKFLOW Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DOC_ACTUAL_DOCUMENT	Exporting	Value transfer	☐	Type reference (TYPE)	I			20010927

History

Last changed by/on	SAP	00000000
SAP Release Created in	620