SAP ABAP Class CL_ALINK_DOCAREA_TREE (Displays the Document Areas)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-ARL (Application Component) ArchiveLink
     ⤷ SAOP (Package) ArchiveLink general

Properties

Class	CL_ALINK_DOCAREA_TREE
Short Description	Displays the Document Areas
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SAOP	ArchiveLink general
Created	20010925	SAP
Last change	20090618	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	SEOR	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_ALINK_DOCAREA_TREE has no interface implemented.

Friends

Class CL_ALINK_DOCAREA_TREE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ACTUAL_COUNTER	Instance attribute	Private	☐	Type reference (TYPE)	I			20010925
2	ATTRIBUTES	Instance attribute	Private	☐	Type reference (TYPE)	LS_TOAATTR_T		ArchiveLink: Table for Transferring External Attributes	20010925
3	CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20010925
4	CO_ACTIVE	Instance attribute	Private	☐	Type reference (TYPE)	TV_IMAGE		Tree Control: Icon / Image	20010925
5	CO_ATTRIBUTE_IMAGE	Instance attribute	Private	☐	Type reference (TYPE)	TV_IMAGE		Tree Control: Icon / Image	20010925
6	CO_DESCR_NAME	Constant	Private	☐	Type reference (TYPE)	TV_ITMNAME	'DESCR'	Tree Control: Column Name / Item Name	20010926
7	CO_ERROR	Instance attribute	Private	☐	Type reference (TYPE)	TV_IMAGE		Tree Control: Icon / Image	20010925
8	CO_HIERARCHY_NAME	Constant	Private	☐	Type reference (TYPE)	TV_ITMNAME	'DOCAREA'	Tree Control: Column Name / Item Name	20010925
9	CO_INACTIVE	Instance attribute	Private	☐	Type reference (TYPE)	TV_IMAGE		Tree Control: Icon / Image	20010925
10	CO_TYPE_NAME	Constant	Private	☐	Type reference (TYPE)	TV_ITMNAME	'TYPE'	Tree Control: Column Name / Item Name	20010925
11	DND_BEHAVIOUR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_DRAGDROP		Behavior for Drag and Drop	20010927
12	DOCUMENT_AREAS	Instance attribute	Private	☐	Type reference (TYPE)	LS_TOADOCSP_T		Table for ArchiveLink: Document Areas (Structure)	20010925
13	FEDAREA_TREE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ALINK_FEDAREA_TREE		Displays the Document Areas	20010926
14	TREE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_COLUMN_TREE		Proxy Class for Control in GUI	20010925
15	TR_REQUEST	Instance attribute	Private	☐	Type reference (TYPE)	E070-TRKORR		Request/Task	20011022

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE_DOCAREA	Instance method	Public	Method	Activate a Document Area	20011004
2	ACTIVATE_FTS_QUERY	Instance method	Public	Method	Activate Full Text Search	20011004
3	APPEND_COLUMNS	Instance method	Private	Method	Attach all Required Columns	20010925
4	BUILD_ATTRIBUTES	Instance method	Private	Method	Structure the Attribute	20010925
5	BUILD_DOCAREA	Instance method	Private	Method	Structure the Tables for the Document Area	20010925
6	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20010925
7	DEACTIVATE_DOCAREA	Instance method	Public	Method	Activate a Document Area	20011004
8	DEACTIVATE_FTS_QUERY	Instance method	Public	Method	Activate Full Text Search	20011004
9	DELETE_DOCAREA_FROM_FRONTEND	Instance method	Private	Method	Delete Document Area from Front End	20010926
10	DELETE_DOCUMENT_AREA	Instance method	Public	Method	Delete a Document Area	20010926
11	DISPLAY	Instance method	Public	Method	Display the Document Area Tree	20010925
12	DISPLAY_ATTRIBUTE	Instance method	Public	Method	Display Properties of the Attribute	20011007
13	DISPLAY_DOCUMENT_AREA	Instance method	Public	Method	Display the Document Area	20011007
14	GET_ATTRIBUTES	Instance method	Public	Method	Return the Attributes	20010927
15	GET_SELECTED_ATTRIBUTES	Instance method	Public	Method	Return all Selected Attributes	20011011
16	GET_SELECTED_DOCAREAS	Instance method	Public	Method	Return all Selected Document Areas	20011005
17	INSERT_DOCUMENT_AREA	Instance method	Public	Method	Add New Document Area	20010925
18	ON_DRAG_EVENT	Instance method	Private	Event handling method	Drag Event	20010927
19	ON_DRAG_EVENT_MULTIPLE	Instance method	Private	Event handling method	Drag Event Multiple	20011009
20	ON_HEADER_CT_MENU_REQUEST	Instance method	Private	Event handling method	Header Menu Request	20010925
21	ON_HEADER_CT_MENU_SELECT	Instance method	Private	Event handling method	Header Menu Select	20010925
22	ON_NODE_CONTEXT_MENU_REQUEST	Instance method	Private	Event handling method	Node Menu Request	20010926
23	ON_NODE_CONTEXT_MENU_SELECT	Instance method	Private	Event handling method	Node Menu Select	20010926
24	ON_NODE_DOUBLE_CLICK	Instance method	Private	Event handling method	Node Double Click Event	20011009
25	REBUILD	Instance method	Public	Method	New Structure of Tree	20011007
26	REGISTER_EVENTS	Instance method	Private	Method	Register Events	20010925
27	SET_FEDAREA_TREE	Instance method	Public	Method	Set Aggregated Search Area Reference	20010926
28	UPDATE_DOCUMENT_AREA	Instance method	Public	Method	Change Document Area Data	20011004

Events

Class CL_ALINK_DOCAREA_TREE has no event.

Types

Class CL_ALINK_DOCAREA_TREE has no local type.

Method Signatures

Method ACTIVATE_DOCAREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOCAREA	Call by reference	☐	Type reference (TYPE)	TOADOCSP_S		ArchiveLink: Dokumentenbereiche (Struktur)	20011004

Method ACTIVATE_DOCAREA on class CL_ALINK_DOCAREA_TREE has no exception.

Method ACTIVATE_FTS_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOCAREA	Call by reference	☐	Type reference (TYPE)	TOADOCSP_S		ArchiveLink: Dokumentenbereiche (Struktur)	20011004

Method ACTIVATE_FTS_QUERY on class CL_ALINK_DOCAREA_TREE has no exception.

Method APPEND_COLUMNS Signature

Method APPEND_COLUMNS on class CL_ALINK_DOCAREA_TREE has no parameter.

#	Exception	Resumable	Description	Created on
1	CONTROL_ERROR	☐	Control Error	20010925

Method BUILD_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_ITEM_TAB	Call by reference	☐	Type reference (TYPE)	TOATITEM_T		Tabellentyp zu TOATITEM_S	20010926
2	Changing	CH_NODE_TAB	Call by reference	☐	Type reference (TYPE)	TREEV_NTAB		Tree Control: Knotentabelle	20010926
3	Importing	IM_DOCUMENT_AREA	Call by reference	☐	Type reference (TYPE)	LS_TOADOCSP_S		Document Space Reference to Names	20010925

#	Exception	Resumable	Description	Created on
1	CONTROL_ERROR	☐	Control Error	20010926
2	INITIALIZATION_ERROR	☐	Initialisierungserror	20010925

Method BUILD_DOCAREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOCUSPACE	Call by reference	☐	Type reference (TYPE)	TOADOCSP_S		ArchiveLink: Dokumentenbereiche (Struktur)	20010925

#	Exception	Resumable	Description	Created on
1	CONTROL_ERROR	☐	Control Error	20010925

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstracter Container fuer GUI Controls	20010925

#	Exception	Resumable	Description	Created on
1	CONTROL_ERROR	☐	Control Error	20010925

Method DEACTIVATE_DOCAREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOCAREA	Call by reference	☐	Type reference (TYPE)	TOADOCSP_S		ArchiveLink: Dokumentenbereiche (Struktur)	20011004

Method DEACTIVATE_DOCAREA on class CL_ALINK_DOCAREA_TREE has no exception.

Method DEACTIVATE_FTS_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOCAREA	Call by reference	☐	Type reference (TYPE)	TOADOCSP_S		ArchiveLink: Dokumentenbereiche (Struktur)	20011004

Method DEACTIVATE_FTS_QUERY on class CL_ALINK_DOCAREA_TREE has no exception.

Method DELETE_DOCAREA_FROM_FRONTEND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOCAREA	Call by reference	☐	Type reference (TYPE)	LS_TOADOCSP_S		Document Space Reference to Names	20010926

#	Exception	Resumable	Description	Created on
1	CONTROL_ERROR	☐	Control Error	20010926

Method DELETE_DOCUMENT_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOCAREA	Call by reference	☐	Type reference (TYPE)	TOADOCSP_S		Document Space Reference to Names	20011007

#	Exception	Resumable	Description	Created on
1	CANCELLED	☐	Abgesagt	20010926

Method DISPLAY Signature

Method DISPLAY on class CL_ALINK_DOCAREA_TREE has no parameter.

#	Exception	Resumable	Description	Created on
1	CONTROL_ERROR	☐	Control Error	20010925

Method DISPLAY_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	TOAATTR_S		ArchiveLink: Struktur zur Übergabe von externen Attributen	20011007

Method DISPLAY_ATTRIBUTE on class CL_ALINK_DOCAREA_TREE has no exception.

Method DISPLAY_DOCUMENT_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOCAREA	Call by reference	☐	Type reference (TYPE)	TOADOCSP_S		ArchiveLink: Dokumentenbereiche (Struktur)	20011007

Method DISPLAY_DOCUMENT_AREA on class CL_ALINK_DOCAREA_TREE has no exception.

Method GET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_ATTRIBUTES	Value transfer	☐	Type reference (TYPE)	TOAATTR_T		ArchiveLink: Tabelle zur Übergabe von externen Attributen	20010927

Method GET_ATTRIBUTES on class CL_ALINK_DOCAREA_TREE has no exception.

Method GET_SELECTED_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_ATTRIBUTES	Value transfer	☐	Type reference (TYPE)	TOAATTR_T		ArchiveLink: Tabelle zur Übergabe von externen Attributen	20011011

#	Exception	Resumable	Description	Created on
1	CONTROL_ERROR	☐	Control Error	20011011
2	NO_ATTRIBUTE_SELECTED	☐	Keine Attribute selektiert	20011011

Method GET_SELECTED_DOCAREAS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_DOCAREAS	Value transfer	☐	Type reference (TYPE)	TOADOCSP_T		Tabelle zu ArchiveLink: Dokumentenbereiche (Struktur)	20011005

#	Exception	Resumable	Description	Created on
1	CONTROL_ERROR	☐	Control Error	20011005
2	NO_DOCAREA_SELECTED	☐	Keine Selektion erfolgt	20011005

Method INSERT_DOCUMENT_AREA Signature

Method INSERT_DOCUMENT_AREA on class CL_ALINK_DOCAREA_TREE has no parameter.

#	Exception	Resumable	Description	Created on
1	CANCELLED	☐	Nicht hinzugefügt	20010925
2	CONTROL_ERROR	☐	Control Error	20010925

Method ON_DRAG_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DRAG_DROP_OBJECT	Call by reference	☐	Attribute reference (LIKE)				20010927
2	Importing	ITEM_NAME	Call by reference	☐	Attribute reference (LIKE)				20010927
3	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20010927

Method ON_DRAG_EVENT on class CL_ALINK_DOCAREA_TREE has no exception.

Method ON_DRAG_EVENT_MULTIPLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DRAG_DROP_OBJECT	Call by reference	☐	Attribute reference (LIKE)				20011009
2	Importing	ITEM_NAME	Call by reference	☐	Attribute reference (LIKE)				20011009
3	Importing	NODE_KEY_TABLE	Call by reference	☐	Attribute reference (LIKE)				20011009

Method ON_DRAG_EVENT_MULTIPLE on class CL_ALINK_DOCAREA_TREE has no exception.

Method ON_HEADER_CT_MENU_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HEADER_NAME	Call by reference	☐	Attribute reference (LIKE)				20010925
2	Importing	MENU	Call by reference	☐	Attribute reference (LIKE)				20010925

Method ON_HEADER_CT_MENU_REQUEST on class CL_ALINK_DOCAREA_TREE has no exception.

Method ON_HEADER_CT_MENU_SELECT Signature

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

Method ON_HEADER_CT_MENU_SELECT on class CL_ALINK_DOCAREA_TREE has no exception.

Method ON_NODE_CONTEXT_MENU_REQUEST Signature

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

Method ON_NODE_CONTEXT_MENU_REQUEST on class CL_ALINK_DOCAREA_TREE has no exception.

Method ON_NODE_CONTEXT_MENU_SELECT 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	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20010926

Method ON_NODE_CONTEXT_MENU_SELECT on class CL_ALINK_DOCAREA_TREE has no exception.

Method ON_NODE_DOUBLE_CLICK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20011009

Method ON_NODE_DOUBLE_CLICK on class CL_ALINK_DOCAREA_TREE has no exception.

Method REBUILD Signature

Method REBUILD on class CL_ALINK_DOCAREA_TREE has no parameter.

#	Exception	Resumable	Description	Created on
1	CONTROL_ERROR	☐	Control Error	20011007

Method REGISTER_EVENTS Signature

Method REGISTER_EVENTS on class CL_ALINK_DOCAREA_TREE has no parameter.

#	Exception	Resumable	Description	Created on
1	CONTROL_ERROR	☐	Control Error	20010925

Method SET_FEDAREA_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_REF	Call by reference	☐	Object reference (TYPE REF TO)	CL_ALINK_FEDAREA_TREE		Zeigt die Dokumentbereiche an	20010926

Method SET_FEDAREA_TREE on class CL_ALINK_DOCAREA_TREE has no exception.

Method UPDATE_DOCUMENT_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOCAREA	Call by reference	☐	Type reference (TYPE)	TOADOCSP_S		ArchiveLink: Dokumentenbereiche (Struktur)	20011004

#	Exception	Resumable	Description	Created on
1	CANCELLED	☐	Abgebrochen	20011004

History

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