SAP ABAP Class CL_KWUI_SEARCH_RESULT_DISPLAY (Display KW Query Result)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-KPR-DMF (Application Component) Document Management Framework
     ⤷ SKWV (Package) Knowledge Warehouse: Visual Components

Properties

Class	CL_KWUI_SEARCH_RESULT_DISPLAY
Short Description	Display KW Query Result
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SKWV	Knowledge Warehouse: Visual Components
Created	20001031	SAP
Last change	20001031	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_GUI_CFW	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	CNHT	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	SDYDO	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
5	SKWFC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_KWUI_SEARCH_RESULT_DISPLAY has no interface implemented.

Friends

Class CL_KWUI_SEARCH_RESULT_DISPLAY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_DISPLAY_BY_PATH	Constant	Public	☐	Type reference (TYPE)	I	1	Sort Mode for Display	20001206
2	C_DISPLAY_BY_RANK	Constant	Public	☐	Type reference (TYPE)	I	0	Sort Mode for Display	20001206
3	C_DONT_SORT	Constant	Public	☐	Type reference (TYPE)	I	2	Sort Mode for Display	20010109
4	C_FCODE_BACK	Constant	Public	☐	Type reference (TYPE)	UI_FUNC	'KWUIFUNC_BACK'	Function Code	20001128
5	C_FCODE_DESELECT_ALL	Constant	Public	☐	Type reference (TYPE)	UI_FUNC	'KWUIFUNC_DESELECT_ALL'	Function Code	20010108
6	C_FCODE_FORWARD	Constant	Public	☐	Type reference (TYPE)	UI_FUNC	'KWUIFUNC_FORWARD'	Function Code	20001128
7	C_FCODE_LAST_DOCUMENTS	Constant	Private	☐	Type reference (TYPE)	UI_FUNC	'KWUIFUNC_LAST_DOCUMENTS'	Function Code	20010109
8	C_FCODE_NEXT_DOCUMENTS	Constant	Private	☐	Type reference (TYPE)	UI_FUNC	'KWUIFUNC_NEXT_DOCUMENTS'	Function Code	20010109
9	C_FCODE_SEE_ALSO	Constant	Public	☐	Type reference (TYPE)	UI_FUNC	'KWUIFUNC_SEE_ALSO'	Function Code	20001130
10	C_FCODE_SELECT_ALL	Constant	Public	☐	Type reference (TYPE)	UI_FUNC	'KWUIFUNC_SELECT_ALL'	Function Code	20010108
11	C_FCODE_TOGGLE_ORDER	Constant	Public	☐	Type reference (TYPE)	UI_FUNC	'KWUIFUNC_TOGGLE_ORDER'	Function Code	20001206
12	C_SPLIT_SIGN	Constant	Private	☐	Type reference (TYPE)	C	'@'	Separator for Stack Entries	20010110
13	M_CONTROL	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_GUI_CONTROL		Surrounding Control	20001128
14	M_DOC	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_DD_DOCUMENT		Dynamic Documents: Document	20001115
15	M_DROPDOWN_MENU_BACK	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CTMENU		Context Menu for Dropdown Button 'BACK'	20010109
16	M_DROPDOWN_MENU_FORWARD	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CTMENU		Context Menu for Dropdown Button 'FORWARD'	20010109
17	M_ENABLE_FEATURE_DISPLAY	Instance attribute	Private	☐	Type reference (TYPE)	XFELD		Display Document Keyword	20001208
18	M_ENABLE_MULTI_SELECT	Instance attribute	Private	☐	Type reference (TYPE)	XFELD		Enable Multi Selection	20001201
19	M_ENABLE_SEE_ALSO_EVENT	Instance attribute	Private	☐	Type reference (TYPE)	XFELD		Connect SEE_ALSO Events to Outside	20001115
20	M_GO_BACK_PUSHED	Instance attribute	Private	☐	Type reference (TYPE)	SKWF_FLAG	' '	Shows whether Display is Called via Back Button	20010110
21	M_GO_BACK_STACK	Instance attribute	Private	☐	Type reference (TYPE)	DISPLAYED_DOCS_STRUC		Table Package ID, Description and Range	20010109
22	M_GO_FORWARD_STACK	Instance attribute	Private	☐	Type reference (TYPE)	DISPLAYED_DOCS_STRUC		Table Package ID, Description and Range	20010109
23	M_LAST_DOCS_DISPLAYED	Instance attribute	Private	☐	Type reference (TYPE)	DISPLAYED_DOC_STRUC		Package ID, Description and Range	20010110
24	M_LIST_IOS	Instance attribute	Private	☐	Type reference (TYPE)	LIST_IO_STRUC_TAB		Infor Objects Displayed in Results List	20001130
25	M_LIST_PARENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		List Parent Container	20001128
26	M_NUMBER_DISPLAYED_DOCUMENTS	Instance attribute	Private	☐	Type reference (TYPE)	I		Number of Displayed Documents	20001213
27	M_ORDER	Instance attribute	Private	☐	Type reference (TYPE)	I		Chosen Sort Mode for Display	20001206
28	M_PACKAGE_ID	Instance attribute	Private	☐	Type reference (TYPE)	SKWF_PKGID		Package ID Imported by Method Display	20001106
29	M_PACKAGE_IOS	Instance attribute	Private	☐	Type reference (TYPE)	SKWF_OBJDP_ITAB_TYPE		Table of IOs in Package	20001106
30	M_PROPERTY_LABELS	Instance attribute	Private	☐	Type reference (TYPE)	SKWV_PRPLB_T		Labels of Attributes To Be Displayed	20001207
31	M_RANGE_FROM	Instance attribute	Private	☐	Type reference (TYPE)	I	1	First Document in Displayed Range	20001213
32	M_REQUESTED_PROPS	Instance attribute	Private	☐	Type reference (TYPE)	SDOKPROPTNS		Attributes To Be Displayed	20001207
33	M_RESULT_FEATURES	Instance attribute	Private	☐	Type reference (TYPE)	RESULT_FEATURES_STRUC		Table with Features of All Documents	20010108
34	M_RESULT_PROPERTIES	Instance attribute	Private	☐	Type reference (TYPE)	SDOKPROPTLS		Table with Attributes of All Documents	20010108
35	M_SHELLSTYLE	Instance attribute	Private	☐	Type reference (TYPE)	I		Shell Style	20001128
36	M_SPLITTER_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_SPLITTER_CONTAINER		Splitter Control	20001128
37	M_TERMINOLOGY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_KWUI_TERMINOLOGY		GUI Text, Icons, Messages, Popups and so on	20001114
38	M_TOOLBAR_CTRL	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_GUI_TOOLBAR		Toolbar Control	20001128
39	M_TOOLBAR_PARENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Toolbar Parent Container	20001128

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHANGE_DROPDOWN_MENUS	Instance method	Private	Method	Changes Context Menu Entries for Drop Down Menu	20010109
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20001031
3	DISPLAY	Instance method	Public	Method	Displays the Search Result List	20001102
4	FREE	Instance method	Public	Method	Releases Objects	20001103
5	GET_SELECTED_OBJECTS	Instance method	Public	Method	Returns All Chosen Info Objects from List	20001201
6	HANDLE_DOCUMENT_CLICKED_EVENT	Instance method	Private	Event handling method	Handles the Link Clicked Event	20001107
7	HANDLE_FOLDER_CLICKED_EVENT	Instance method	Private	Event handling method	Handles the Link Clicked Event	20001107
8	HANDLE_NAVIGATE_DOCUMENTS	Instance method	Private	Event handling method	Handle the Navigation to Last or Next Document	20001213
9	HANDLE_SAPEVENT	Instance method	Private	Event handling method	SAP Event Triggered On HTML Page (e.g. Checkbox Clicked)	20001130
10	HANDLE_SEEALSO_EVENT	Instance method	Private	Event handling method	Handles the Link Clicked Event	20001107
11	HANDLE_TOOLBAR_CLICK	Instance method	Private	Event handling method	Edit Click on Toolbar	20001128
12	HANDLE_TOOLBAR_DROPDOWN	Instance method	Private	Event handling method	Edit Toolbar DropDown	20001128
13	INIT_TOOLBAR_CTRL	Instance method	Private	Method	Initialize Toolbar Control	20001128
14	SEARCH_SIMILAR_DOCS	Instance method	Private	Method	Finds Similar Documents to Phios	20001130
15	SET_VISIBLE	Instance method	Public	Method		20010104
16	SORT_IOS	Instance method	Private	Method	Sort IOs by Path or Rank	20001206

Events

#	Event	Type	Visibility	Description	Created on
1	DOCUMENT_CLICKED	Instance Event (0)	Public (2)	You clicked on a document link	20001106
2	FOLDER_CLICKED	Instance Event (0)	Public (2)	You clicked on a path link	20001107
3	SEE_ALSO_CLICKED	Instance Event (0)	Public (2)	You clicked on a 'see also' link	20001106
4	TOOLBAR_DROPDOWN_SELECT	Instance Event (0)	Public (2)	You Clicked on the Dropdown Toolbar Button	20001128
5	TOOLBAR_FUNCTION_SELECT	Instance Event (0)	Public (2)	Toolbar Function was Carried Out	20001128

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	DISPLAYED_DOCS_STRUC	Protected	See coding		DISPLAYED_DOCS_STRUC	20010109
2	DISPLAYED_DOC_STRUC	Protected	See coding			20010109
3	LIST_IO_STRUC	Protected	See coding		LIST_IO_STRUC	20001130
4	LIST_IO_STRUC_TAB	Protected	See coding		LIST_IO_STRUC_TAB	20001130
5	RESULT_FEATURES_STRUC	Protected	See coding			20010108

Method Signatures

Method CHANGE_DROPDOWN_MENUS Signature

Method CHANGE_DROPDOWN_MENUS on class CL_KWUI_SEARCH_RESULT_DISPLAY has no parameter.
Method CHANGE_DROPDOWN_MENUS on class CL_KWUI_SEARCH_RESULT_DISPLAY has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NUMBER_DISPLAYED_DOCUMENTS	Value transfer	☐	Type reference (TYPE)	I	10	Anzahl der angezeigten Dokumente	20001213
2	Importing	PARENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Parent Container	20001031
3	Importing	PROPERTIES_DISPLAYED	Value transfer	☑	Type reference (TYPE)	SDOK_PROPNS		Auszugebende Attribute, Position in Tab bestimmt Reihenfolge	20001207
4	Importing	SHELLSTYLE	Value transfer	☑	Type reference (TYPE)	I		Shellstyle	20001128
5	Importing	TERMINOLOGY	Call by reference	☑	Object reference (TYPE REF TO)	CL_KWUI_TERMINOLOGY		Gui Texte, Icons, Nachrichten, Popups usw.	20001114
6	Importing	X_ENABLE_FEATURE_DISPLAY	Call by reference	☑	Type reference (TYPE)	XFELD		'X': Schlagworte anzeigen, falls feature extraction aktivier	20001208
7	Importing	X_ENABLE_MULTI_SELECT	Call by reference	☑	Type reference (TYPE)	XFELD		'X': Checkboxen zur Auswahl mehrerer Dokumente	20001201
8	Importing	X_ENABLE_SEE_ALSO_EVENT	Call by reference	☑	Type reference (TYPE)	XFELD		'X': Durchschalten des SEE_ALSO-Events nach Außen	20001115
9	Importing	X_ENABLE_TOOLBAR	Call by reference	☑	Type reference (TYPE)	XFELD		'X': Explorer mit Toolbar	20001128

Method CONSTRUCTOR on class CL_KWUI_SEARCH_RESULT_DISPLAY has no exception.

Method DISPLAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ORDER	Value transfer	☑	Type reference (TYPE)	I		Sortiermodus: c_display_by_rank (def.), c_display_by_path	20001206
2	Importing	PACKAGE_ID	Value transfer	☐	Type reference (TYPE)	SKWF_PKGID		KW Framework: Package-Kennung	20001102
3	Importing	RANGE_FROM	Value transfer	☑	Type reference (TYPE)	I		Erstes Dokument im angezeigten Bereich	20001213
4	Importing	X_USE_M_LIST_IOS	Value transfer	☑	Type reference (TYPE)	SKWF_FLAG		internal; benutze M_LIST_IOS weiter	20010108

#	Exception	Resumable	Description	Created on
1	BAD_PROPERTY	☐	Eigenschaft nicht vorhanden	20001114
2	DISPLAY_ERROR	☐	Fehler bei der Anzeige der Seite	20001114
3	FEATURE_ERROR	☐	Fehler beim Auslesen der Features zum Dokument	20001207

Method FREE Signature

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

Method GET_SELECTED_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	PKG_OBJECTS	Call by reference	☐	Type reference (TYPE)	SKWV_PKGOB_T		Tabelle mit getypten SKWF-Objekten und ihrem jeweiligen Pake	20001201

Method GET_SELECTED_OBJECTS on class CL_KWUI_SEARCH_RESULT_DISPLAY has no exception.

Method HANDLE_DOCUMENT_CLICKED_EVENT Signature

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

Method HANDLE_DOCUMENT_CLICKED_EVENT on class CL_KWUI_SEARCH_RESULT_DISPLAY has no exception.

Method HANDLE_FOLDER_CLICKED_EVENT Signature

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

Method HANDLE_FOLDER_CLICKED_EVENT on class CL_KWUI_SEARCH_RESULT_DISPLAY has no exception.

Method HANDLE_NAVIGATE_DOCUMENTS Signature

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

Method HANDLE_NAVIGATE_DOCUMENTS on class CL_KWUI_SEARCH_RESULT_DISPLAY has no exception.

Method HANDLE_SAPEVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACTION	Call by reference	☐	Attribute reference (LIKE)				20001130
2	Importing	FRAME	Call by reference	☐	Attribute reference (LIKE)				20001130
3	Importing	GETDATA	Call by reference	☐	Attribute reference (LIKE)				20001130
4	Importing	POSTDATA	Call by reference	☐	Attribute reference (LIKE)				20001130
5	Importing	QUERY_TABLE	Call by reference	☐	Attribute reference (LIKE)				20001130

Method HANDLE_SAPEVENT on class CL_KWUI_SEARCH_RESULT_DISPLAY has no exception.

Method HANDLE_SEEALSO_EVENT Signature

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

Method HANDLE_SEEALSO_EVENT on class CL_KWUI_SEARCH_RESULT_DISPLAY has no exception.

Method HANDLE_TOOLBAR_CLICK Signature

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

Method HANDLE_TOOLBAR_CLICK on class CL_KWUI_SEARCH_RESULT_DISPLAY has no exception.

Method HANDLE_TOOLBAR_DROPDOWN Signature

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

Method HANDLE_TOOLBAR_DROPDOWN on class CL_KWUI_SEARCH_RESULT_DISPLAY has no exception.

Method INIT_TOOLBAR_CTRL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Container für das Control	20001128
2	Importing	P_LIFETIME	Call by reference	☑	Type reference (TYPE)	I		Lebensdauer	20001128
3	Importing	P_SHELLSTYLE	Call by reference	☑	Type reference (TYPE)	I		Shellstyle	20001128
4	Importing	P_X_APPL_EVENTS	Call by reference	☑	Type reference (TYPE)	XFELD		PAI bei Events auslösen	20001128

Method INIT_TOOLBAR_CTRL on class CL_KWUI_SEARCH_RESULT_DISPLAY has no exception.

Method SEARCH_SIMILAR_DOCS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INPUT_PHIOS	Call by reference	☐	Type reference (TYPE)	SKWF_IOS		IOs für die see-also Suche	20001130

Method SEARCH_SIMILAR_DOCS on class CL_KWUI_SEARCH_RESULT_DISPLAY has no exception.

Method SET_VISIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	VISIBLE	Call by reference	☐	Type reference (TYPE)	C			20010104

Method SET_VISIBLE on class CL_KWUI_SEARCH_RESULT_DISPLAY has no exception.

Method SORT_IOS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ORDER	Value transfer	☐	Type reference (TYPE)	I		Sortiermodus für Anzeige	20001206
2	Importing	X_USE_M_LIST_IOS	Value transfer	☐	Type reference (TYPE)	SKWF_FLAG		Flag, ob m_list_ios neue erstellt werden muss	20010108

#	Exception	Resumable	Description	Created on
1	NO_RANK_PROPERTY	☐	keine externe Eigenschaft für den Suchrang vorhanden	20001206

Event Signatures

Event DOCUMENT_CLICKED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	OBJECT	Exporting	Value transfer	☐	Type reference (TYPE)	SKWV_PKGOB		object that has been clicked	20001106

Event FOLDER_CLICKED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	OBJECT	Exporting	Value transfer	☐	Type reference (TYPE)	SKWV_PKGOB		folder that has been clicked	20001107

Event SEE_ALSO_CLICKED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	OBJECT	Exporting	Value transfer	☐	Type reference (TYPE)	SKWV_PKGOB		object for that see also was clicked	20001106

Event TOOLBAR_DROPDOWN_SELECT 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	20001128
2	POSX	Exporting	Value transfer	☐	Type reference (TYPE)	I		X-Position für Dropdown	20001128
3	POSY	Exporting	Value transfer	☐	Type reference (TYPE)	I		Y-Position für Dropdown	20001128

Event TOOLBAR_FUNCTION_SELECT 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	20001128

History

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