SAP ABAP Class CL_BUS_LOCATOR (Locator)

Hierarchy

☛

SAP_ABA (Software Component) Cross-Application Component
⤷

AP-MD-BP-UI (Application Component) Dialog SAP-GUI
⤷

BUS_TOOLS (Package) Locator

Properties

Class	CL_BUS_LOCATOR
Short Description	Locator
Super Class
Instantiability of a Class	2	Public
Final

General Data

Message Class
Program status
Category	0
Package	BUS_TOOLS	Locator
Created	20000114	SAP
Last change	20040930	SAP
Shared Memory-enabled
Fixed point arithmetic
Unicode checks active

Forward declarations

Class CL_BUS_LOCATOR has no forward declaration.

Interfaces

Class CL_BUS_LOCATOR has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_BUS_LOCATOR_DIALOG		20001121	Locator: Dialog

Attributes

#	Attribute	Level	Visibility	Typing	Associated Type	Initial Value	Description	Created on
1	GC_MAXIMUM_WIDTH	Instance attribute	Protected	Type reference (TYPE)	I	999	Maximum Width of Locator	20010612
2	GC_MINIMUM_WIDTH	Constant	Protected	Type reference (TYPE)	I	35	Minimum Width of the Locator in Characters	20000119
3	GC_PROGRAM_NAME	Constant	Protected	Type reference (TYPE)	BUS_SCREEN-PROGRAM_NAME	'SAPLBUS_LOCATOR'	Name of Main Function Group	20000320
4	GC_SEARCH_TAB	Constant	Protected	Type reference (TYPE)	BUS_LOCATOR-TAB	'B'	Key for the Search Tab	20000628
5	GC_TODO_TAB	Constant	Protected	Type reference (TYPE)	BUS_LOCATOR-TAB	'A'	Key for the Worklist Tab	20000628
6	GC_X	Constant	Protected	Type reference (TYPE)	BUS_LOCATOR-BOOLEAN	'X'	Boolean for TRUE	20000119
7	GV_ACTIVE_TAB	Instance attribute	Public	Object reference (TYPE REF TO)	CL_BUS_TABSTRIP_TAB		Active Title Element	20000711
8	GV_MAXIMUM_WIDTH_REACHED	Instance attribute	Protected	Type reference (TYPE)	BUS_LOCATOR-BOOLEAN		Maximum Width of Locator Reached	20010612
9	GV_SEARCH_TAB	Instance attribute	Public	Object reference (TYPE REF TO)	CL_BUS_TABSTRIP_TAB		Search Tab	20000125
10	GV_STARTED_FULLSCREEN	Instance attribute	Public	Type reference (TYPE)	BUS_LOCATOR-BOOLEAN		Locator is starting in full screen mode	20010621
11	GV_STEP_WIDTH	Instance attribute	Protected	Type reference (TYPE)	I	15	Increment for Makimg Narrower/Wider	20000720
12	GV_TODO_TAB	Instance attribute	Public	Object reference (TYPE REF TO)	CL_BUS_TABSTRIP_TAB		Worklist Tab	20000125
13	GV_USER_LANGUAGE	Instance attribute	Protected	Type reference (TYPE)	SY-LANGU		Customizing: Language with Which Texts are Read	20000118
14	GV_USER_NAME	Instance attribute	Protected	Type reference (TYPE)	SY-UNAME		Customizing: Users Whose Personalization is Used	20000118
15	GV_VISIBLE	Instance attribute	Protected	Type reference (TYPE)	BUS_LOCATOR-BOOLEAN		Property: Visibility	20000114
16	GV_WIDTH	Instance attribute	Protected	Type reference (TYPE)	I		Property: Width of Locator in Characters	20000114

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_TAB	Instance method	Public	Method	Adds a Tab	20000125
2	CREATE	Static method	Public	Method	Creates an Instance	20000118
3	DISPATCH	Instance method	Public	Method	Processes a Function Code in PAI	20000118
4	DISPLAY_IN_AREA	Instance method	Public	Method	Displays the Locator in a Subscreen Area	20000215
5	DISPLAY_LOCATOR	Instance method	Protected	Method	Shows the Locator Again When GV_VISIBLE/WIDTH Changes	20000118
6	FREE	Instance method	Public	Method	Releases the Locator and All Controls Contained	20000124
7	GET_ACTIVE_SEARCH_ID	Instance method	Public	Method	Provides All Current Search Parameters	20010220
8	GET_IMPLEMENTATION_PROGRAM	Static method	Private	Method	Provides the Program Names of the Implementing Function Grps	20001219
9	GET_SEARCH_RESULT_ALV	Instance method	Public	Method	Creates an ALV on the Search Tab	20000120
10	GET_VISIBLE	Instance method	Public	Method	Supplies Visibility	20000120
11	GET_WIDTH	Instance method	Public	Method	Supplies Width	20000120
12	INITIALIZE_FOR_DIALOG	Instance method	Protected	Method	Initializes the Locator After Creation by Dialog	20000222
13	ON_CLOSE_WHEN_FULLSCREEN	Instance method	Public	Method	Closes the locator, if it is in full screen mode	20010620
14	PERFORM_SEARCH	Instance method	Public	Method	Carries out the Currently Displayed Search	20000720
15	SET_ACTIVE_TAB	Instance method	Public	Method	Activates a Tab	20000127
16	SET_APPLICATION	Instance method	Public	Method	Sets the Locator Application	20010628
17	SET_FULLSCREEN	Instance method	Public	Method	Sets the Full Screen Locator	20040506
18	SET_LISTBOXES_VISIBLE	Instance method	Public	Method	Sets Visibility of List Boxes	20001219
19	SET_LOOK_FROM_PARAMETERS	Instance method	Public	Method	Sets Appearance Using Current SET/GET Parameters	20001122
20	SET_NEW_SEARCH_ID_AND_FIELDS	Instance method	Public	Method	Sets Search Application, Category, ID and Field Contents	20010220
21	SET_SEARCH_PARAMETERS	Instance method	Public	Method	Initializes an Instance with New Search Parameters	20000215
22	SET_SEARCH_RESULT_AREA	Instance method	Public	Method	Sets the Subscreen for the Search Result	20000118
23	SET_SEARCH_RESULT_SUB_SCREEN	Instance method	Public	Method	Sets the Subscreen for the Search Result	20000529
24	SET_VISIBLE	Instance method	Public	Method	Sets Visibility	20000114
25	SET_WIDTH	Instance method	Public	Method	Sets Width	20000114

Events

#	Event	Type	Visibility	Description	Created on
1	DISPLAY_SEARCH_RESULT	Instance Event (0)	Public (2)	Prepare New Search Result for Display	20000228
2	NEW_TAB_SELECTED	Instance Event (0)	Public (2)	New Tab is Selected	20000628

Types

Class CL_BUS_LOCATOR has no local type.

Method Signatures

Method ADD_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TAB	Call by reference		Object reference (TYPE REF TO)	CL_BUS_TABSTRIP_TAB		Neuer Tabreiter	20000125

Method ADD_TAB on class CL_BUS_LOCATOR has no exception.

Method CREATE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_LOCATOR	Call by reference	Object reference (TYPE REF TO)	CL_BUS_LOCATOR	Locator Instanz	20000118
2	Importing	IV_APPLICATION	Call by reference	Type reference (TYPE)	BUS_LOCATOR_APPLICATION	Locator-Anwendung	20010628
3	Importing	IV_IMPLEMENTATION	Call by reference	Type reference (TYPE)	BU_LOCATOR_IMPLEMENTATION	Locator: Schlüssel einer Implementierung	20001219
4	Importing	IV_USER_LANGUAGE	Call by reference	Type reference (TYPE)	SY-LANGU	Sprache des Benutzers	20000215
5	Importing	IV_USER_NAME	Call by reference	Type reference (TYPE)	SY-UNAME	Name des Benutzers	20000215

Method CREATE on class CL_BUS_LOCATOR has no exception.

Method DISPATCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DISPATCHED	Call by reference		Type reference (TYPE)	BUS_LOCATOR-BOOLEAN		Flag, ob der Funktionscode behandelt wurde	20000118
2	Importing	IV_FUNCTION_CODE	Call by reference		Type reference (TYPE)	BUS_SCREEN-FUNCTION_CODE		Funktionscode	20000118

Method DISPATCH on class CL_BUS_LOCATOR has no exception.

Method DISPLAY_IN_AREA Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_AREA	Call by reference	Type reference (TYPE)	BUS_SCREEN-AREA		Subscreen Bereich für den Locator	20000215
2	Importing	IV_WITH_BUTTONS	Call by reference	Type reference (TYPE)	BUS_LOCATOR-BOOLEAN	'X'	Kennzeichen: Mit Buttons über dem Tabstrip	20000728
3	Importing	IV_WITH_LISTBOXES	Call by reference	Type reference (TYPE)	BUS_LOCATOR-BOOLEAN	'X'	Kennzeichen: Mit Listboxen anzeigen	20001219
4	Importing	IV_WITH_TABSTRIP	Call by reference	Type reference (TYPE)	BUS_LOCATOR-BOOLEAN	'X'	Kennzeichen: Mit Tabstrip anzeigen	20000215

Method DISPLAY_IN_AREA on class CL_BUS_LOCATOR has no exception.

Method DISPLAY_LOCATOR Signature

Method DISPLAY_LOCATOR on class CL_BUS_LOCATOR has no parameter.
Method DISPLAY_LOCATOR on class CL_BUS_LOCATOR has no exception.

Method FREE Signature

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

Method GET_ACTIVE_SEARCH_ID Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_SEARCH_APPLICATION	Call by reference	Type reference (TYPE)	BUS_LOCATOR-SEARCH_APPLICATION	Locator Suchanwendung	20010220
2	Exporting	EV_SEARCH_FIELDS	Call by reference	Type reference (TYPE)	BUS_LOCATOR-SEARCH_FIELDS	Locator Suchfelder, generischer Container	20010220
3	Exporting	EV_SEARCH_ID	Call by reference	Type reference (TYPE)	BUS_LOCATOR-SEARCH_ID	Locator Suchid	20010220
4	Exporting	EV_SEARCH_TYPE	Call by reference	Type reference (TYPE)	BUS_LOCATOR-SEARCH_TYPE	Locator Suchtyp	20010220

Method GET_ACTIVE_SEARCH_ID on class CL_BUS_LOCATOR has no exception.

Method GET_IMPLEMENTATION_PROGRAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_PROGRAM_NAME	Call by reference		Type reference (TYPE)	BUS_SCREEN-PROGRAM_NAME		Programmname	20001219
2	Importing	IV_IMPLEMENTATION	Call by reference		Type reference (TYPE)	BU_LOCATOR_IMPLEMENTATION		Locator: Schlüssel einer Implementierung	20001219

#	Exception	Resumable	Description	Created on
1	UNKNOWN_IMPLEMENTATION		Unbekannte Implementierung	20001219

Method GET_SEARCH_RESULT_ALV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ALV	Call by reference		Object reference (TYPE REF TO)	CL_GUI_ALV_GRID		ALV Instanz auf Suche Tabreiter	20000120
2	Exporting	EV_CONTAINER	Call by reference		Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Container auf Suche Tabreiter	20000124

Method GET_SEARCH_RESULT_ALV on class CL_BUS_LOCATOR has no exception.

Method GET_VISIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_VISIBLE	Call by reference		Type reference (TYPE)	BUS_LOCATOR-BOOLEAN		Aktuelle Sichtbarkeit	20000120

Method GET_VISIBLE on class CL_BUS_LOCATOR has no exception.

Method GET_WIDTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_WIDTH	Call by reference		Type reference (TYPE)	I		Aktuelle Breite	20000120

Method GET_WIDTH on class CL_BUS_LOCATOR has no exception.

Method INITIALIZE_FOR_DIALOG Signature

Method INITIALIZE_FOR_DIALOG on class CL_BUS_LOCATOR has no parameter.
Method INITIALIZE_FOR_DIALOG on class CL_BUS_LOCATOR has no exception.

Method ON_CLOSE_WHEN_FULLSCREEN Signature

Method ON_CLOSE_WHEN_FULLSCREEN on class CL_BUS_LOCATOR has no parameter.
Method ON_CLOSE_WHEN_FULLSCREEN on class CL_BUS_LOCATOR has no exception.

Method PERFORM_SEARCH Signature

Method PERFORM_SEARCH on class CL_BUS_LOCATOR has no parameter.
Method PERFORM_SEARCH on class CL_BUS_LOCATOR has no exception.

Method SET_ACTIVE_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TAB	Call by reference		Object reference (TYPE REF TO)	CL_BUS_TABSTRIP_TAB		Wrapper für einn Tab Reiter	20000127

Method SET_ACTIVE_TAB on class CL_BUS_LOCATOR has no exception.

Method SET_APPLICATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION	Call by reference		Type reference (TYPE)	BUS_LOCATOR_APPLICATION		Locator-Anwendung	20010628

Method SET_APPLICATION on class CL_BUS_LOCATOR has no exception.

Method SET_FULLSCREEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STARTED_FULLSCREEN	Call by reference		Type reference (TYPE)	BUS_LOCATOR-BOOLEAN		Boolscher Typ: Nicht zur Verwendung auf Oberflächen	20040506

Method SET_FULLSCREEN on class CL_BUS_LOCATOR has no exception.

Method SET_LISTBOXES_VISIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VISIBLE	Call by reference		Type reference (TYPE)	BUS_LOCATOR-BOOLEAN		Kennzeichen: Sichtbar	20001219

Method SET_LISTBOXES_VISIBLE on class CL_BUS_LOCATOR has no exception.

Method SET_LOOK_FROM_PARAMETERS Signature

Method SET_LOOK_FROM_PARAMETERS on class CL_BUS_LOCATOR has no parameter.
Method SET_LOOK_FROM_PARAMETERS on class CL_BUS_LOCATOR has no exception.

Method SET_NEW_SEARCH_ID_AND_FIELDS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_SEARCH_APPLICATION	Call by reference	Type reference (TYPE)	BUS_LOCATOR-SEARCH_APPLICATION	Locator Suchanwendung	20010220
2	Importing	IV_SEARCH_FIELDS	Call by reference	Type reference (TYPE)	BUS_LOCATOR-SEARCH_FIELDS	Locator Suchfelder, generischer Container	20010220
3	Importing	IV_SEARCH_ID	Call by reference	Type reference (TYPE)	BUS_LOCATOR-SEARCH_ID	Locator Suchid	20010220
4	Importing	IV_SEARCH_TYPE	Call by reference	Type reference (TYPE)	BUS_LOCATOR-SEARCH_TYPE	Locator Suchtyp	20010220

Method SET_NEW_SEARCH_ID_AND_FIELDS on class CL_BUS_LOCATOR has no exception.

Method SET_SEARCH_PARAMETERS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SEARCH_APPLICATIONS	Value transfer	Type reference (TYPE)	BUS_LOCATOR-SEARCH_APPLICATION_TABLE		Anzuzeigede Suche-Anwendungen	20000228
2	Importing	IV_SEARCH_APPLICATION	Call by reference	Type reference (TYPE)	BUS_LOCATOR-SEARCH_APPLICATION		Aktive Locator Suche-Anwendung	20000217
3	Importing	IV_SEARCH_ID	Call by reference	Type reference (TYPE)	BUS_LOCATOR-SEARCH_ID		Aktive Locator Suche-Id	20000215
4	Importing	IV_SEARCH_TYPE	Call by reference	Type reference (TYPE)	BUS_LOCATOR-SEARCH_TYPE		Aktiver Locator Suche-Typ	20000215
5	Importing	IV_USE_LAST_SEARCH	Call by reference	Type reference (TYPE)	BUS_LOCATOR-BOOLEAN	'X'	Alle Einstellungen der letzten Suche verwenden, falls möglic	20000229

Method SET_SEARCH_PARAMETERS on class CL_BUS_LOCATOR has no exception.

Method SET_SEARCH_RESULT_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_AREA	Call by reference		Type reference (TYPE)	BUS_SCREEN_AREA		Private: BUS_SCREEN-AREA verwenden	20000118

Method SET_SEARCH_RESULT_AREA on class CL_BUS_LOCATOR has no exception.

Method SET_SEARCH_RESULT_SUB_SCREEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SUB_SCREEN	Call by reference		Object reference (TYPE REF TO)	CL_BUS_ABSTRACT_SUB_SCREEN		Anzuzeigender Subscreen	20000529

Method SET_SEARCH_RESULT_SUB_SCREEN on class CL_BUS_LOCATOR has no exception.

Method SET_VISIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VISIBLE	Call by reference		Type reference (TYPE)	BUS_LOCATOR-BOOLEAN		Boolscher Typ im GP, nicht an Oberflächen verwenden!	20000114

Method SET_VISIBLE on class CL_BUS_LOCATOR has no exception.

Method SET_WIDTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_WIDTH	Call by reference		Type reference (TYPE)	I		Locator Breite in Zeichen	20000117

Method SET_WIDTH on class CL_BUS_LOCATOR has no exception.

Event Signatures

Event DISPLAY_SEARCH_RESULT Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	IV_SEARCH	Exporting	Value transfer		Object reference (TYPE REF TO)	CL_BUS_LOCATOR_SEARCH		Suche	20000228

Event NEW_TAB_SELECTED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	IV_TAB	Exporting	Value transfer		Object reference (TYPE REF TO)	CL_BUS_TABSTRIP_TAB		Neuer aktiver Tabreiter	20000628

History

Last changed by/on	SAP	20040930
SAP Release Created in	12A

Object Hierarchy

Using

Used by

Advertise Links