SAP ABAP Class CL_PLANNING_CONTROL (Appointment Management: Planning Control)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-GBT-CAL (Application Component) Appointment Calendar
     ⤷ SZTG (Package) Calendar Control

Properties

Class	CL_PLANNING_CONTROL
Short Description	Appointment Management: Planning Control
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SZTG	Calendar Control
Created	20000202	SAP
Last change	20090618	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

Class CL_PLANNING_CONTROL has no interface implemented.

Friends

Class CL_PLANNING_CONTROL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	APPT_DURATION	Instance attribute	Private	☐	Type reference (TYPE)	SCSTP_TIMEDIFF		Appointment duration	20060907
2	COLUMN_BEGIN	Instance attribute	Private	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20000224
3	CONST_FUNC_DEC_MEETING_TIME	Constant	Public	☐	Type reference (TYPE)	UI_FUNC	'FB12'	Function Code for Reducing Meeting Time	20000901
4	CONST_FUNC_DELETE_ROW	Constant	Public	☐	Type reference (TYPE)	UI_FUNC	'FB31'	Function Code for Deleting Users	20000814
5	CONST_FUNC_INC_MEETING_TIME	Constant	Public	☐	Type reference (TYPE)	UI_FUNC	'FB11'	Function Code for Increasing Meeting Time	20000901
6	CONST_FUNC_INSERT_ROW	Constant	Public	☐	Type reference (TYPE)	UI_FUNC	'FB32'	Function Code for Adding Users	20000814
7	CONST_FUNC_NEXT_MEETING	Constant	Public	☐	Type reference (TYPE)	UI_FUNC	'FB33'	Function Code for Finding Next Free Time Period	20000831
8	CONST_FUNC_REFR_MEETING_TIME	Constant	Public	☐	Type reference (TYPE)	UI_FUNC	'FB21'	Copy Meeting Time from Picker	20000901
9	CONST_FUNC_SCROLL_LEFT	Constant	Public	☐	Type reference (TYPE)	UI_FUNC	'FB01'	Function Code for Scrolling Left	20000901
10	CONST_FUNC_SCROLL_RIGHT	Constant	Public	☐	Type reference (TYPE)	UI_FUNC	'FB02'	Function Code for Scrolling Right	20000901
11	CONTAINER_PERIOD	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for Period	20000710
12	CONTAINER_PLANNER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for Period	20000710
13	CP_OCCUPIED	Constant	Public	☐	Type reference (TYPE)	STRING	'Belegt'	Occupied	20041220
14	DAILY_TIME_FROM	Instance attribute	Private	☐	Type reference (TYPE)	TIMS		Daily Start of Display	20000904
15	DAILY_TIME_TO	Instance attribute	Private	☐	Type reference (TYPE)	TIMS		Daily End of Display	20000904
16	DATA_TABLE	Instance attribute	Private	☐	Type reference (TYPE)	LVC_T_DATA		Data transfer table for ListViewer control	20000203
17	DISPLAY_SETTINGS	Instance attribute	Private	☐	Type reference (TYPE)	SZTG_FBSET		Appointment Management: Settings for the Planner	20000210
18	DISP_DATE_FROM	Instance attribute	Private	☐	Type reference (TYPE)	DATS		Start Date of Display	20000210
19	DISP_DATE_TO	Instance attribute	Private	☐	Type reference (TYPE)	DATS		End Date of Display	20000210
20	DISP_TIME_FROM	Instance attribute	Private	☐	Type reference (TYPE)	TIMS		Start Date of Display	20000210
21	DISP_TIME_TO	Instance attribute	Private	☐	Type reference (TYPE)	TIMS		End Date of Display	20000210
22	FREE_BUSY_DATA	Instance attribute	Private	☐	Type reference (TYPE)	SZTG_TFB		Table for Data Transfer Between Cal. Framework and Planner	20000210
23	FREE_BUSY_READER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_PLANNING_FREE_BUSY_READER		Appointment Management: Data Collection for Planning Control	20000202
24	HOUR_TABLE	Instance attribute	Private	☐	Type reference (TYPE)	HOUR_PATTERN_T		Hourly Period Split	20000209
25	INFO_TABLE	Instance attribute	Private	☐	Type reference (TYPE)	LVC_T_INFO		Data information table for ListViewer control	20000203
26	MEETING_TIMES	Instance attribute	Private	☐	Type reference (TYPE)	SZTG_FBDATTAB		Appointment Management: Table for Time Period	20000210
27	PART_TABLE	Instance attribute	Private	☐	Type reference (TYPE)	PART_PATTERN_T		Mapping Table Participant ID for Position in Grid	20000829
28	PERIOD	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CALENDAR_PERIOD		Input Grid for Appointment Data	20000710
29	SCHEDULE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CALENDAR_CONTROL_SCHEDULE		Free/Busy View	20000203
30	SEARCH_DATE_FROM	Instance attribute	Private	☐	Type reference (TYPE)	DATS		Start Date for Appointment Search	20000901
31	SEARCH_TIME_FROM	Instance attribute	Private	☐	Type reference (TYPE)	TIMS		Start Time for Appointment Search	20000901
32	SPLITTER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_SPLITTER_CONTAINER		Splitter Control	20000710
33	TITLE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR80		Char 80	20000224
34	VIEW	Instance attribute	Public	☐	Type reference (TYPE)	CHAR1	1	Single-Character Flag	20000203

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_TOOLBAR	Instance method	Private	Method	Create Pushbuttons	20000810
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20000202
3	DATA_REFRESH	Instance method	Private	Method	Refresh Data	20000905
4	DELETE_PARTICIPANTS	Instance method	Public	Method	Delete Rows	20000810
5	DISPLAY	Instance method	Public	Method	Display Free/Busy Data	20000203
6	DISPLAY_REFRESH	Instance method	Public	Method	Refresh Display	20000210
7	GET_HOUR_TABLE	Instance method	Private	Method	Generates Hourly Period Split	20000207
8	GET_MEETING_TIMES	Instance method	Public	Method	Returns Selected Appointments	20000224
9	GET_PERIOD	Instance method	Private	Method	Read Period Values	20000711
10	GET_TOOLBAR	Instance method	Public	Method	Read Toolbar	20000810
11	INSERT_PARTICIPANTS	Instance method	Public	Method	Add Lines, if Necessary from the Specified Line	20000814
12	MODIFY_PARTICIPANTS	Instance method	Public	Method	Change rows	20000811
13	ON_DOUBLECLICK	Instance method	Private	Event handling method	Event Handler for Double-clicking	20000209
14	ON_PERIOD_CHANGED	Instance method	Private	Event handling method	Event Handler for Period Changes	20000710
15	ON_TOOLBAR_ACTION	Instance method	Private	Event handling method	Event Handler for Toolbar	20000211
16	SET_COLOR_INFOS	Instance method	Private	Method	Set Color Information	20081223
17	SET_MEETING_TIMES	Instance method	Public	Method	Set Selected Appointments	20000905
18	SET_NO_MEETING_TIMES	Instance method	Private	Method	Sets NO_MEETING_TIMES Flag for CL_PLANNER	20060629
19	SET_PERIOD	Instance method	Private	Method	Display Period Values	20000711
20	SET_TITLE	Instance method	Public	Method	Title in Free/Busy Part	20000224
21	SET_TOOLBAR	Instance method	Public	Method	Set Toolbar	20000810

Events

#	Event	Type	Visibility	Description	Created on
1	PARTICIPANT_DELETED	Instance Event (0)	Public (2)	Participant Deleted	20000810
2	PARTICIPANT_INSERTED	Instance Event (0)	Public (2)	Participant Added	20000814
3	PARTICIPANT_SELECTED	Instance Event (0)	Public (2)	Participant Selected	20000808

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	HOUR_PATTERN_S	Private	See coding		Period Split Structure	20000207
2	HOUR_PATTERN_T	Private	See coding		Period Split Table	20000207
3	PART_PATTERN_S	Private	See coding		PART_PATTERN_S	20000829
4	PART_PATTERN_T	Private	See coding		PART_PATTERN_T	20000829

Method Signatures

Method BUILD_TOOLBAR Signature

Method BUILD_TOOLBAR on class CL_PLANNING_CONTROL has no parameter.
Method BUILD_TOOLBAR on class CL_PLANNING_CONTROL has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPT_DURATION	Call by reference	☑	Type reference (TYPE)	SCSTP_TIMEDIFF		Termindauer	20060907
2	Importing	I_DISPLAY_SETTINGS	Call by reference	☑	Type reference (TYPE)	SZTG_FBSET		Terminverwaltung: Einstellungen für den Planner	20000207
3	Importing	I_FREE_BUSY_READER	Call by reference	☑	Object reference (TYPE REF TO)	IF_PLANNING_FREE_BUSY_READER		Terminverwaltung: Planungscontrol	20000202
4	Importing	I_NO_MEETING_TIMES	Call by reference	☑	Type reference (TYPE)	FLAG		Keine Terminvorschläge	20000831
5	Importing	I_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstracter Container fuer GUI Controls	20000203

Method CONSTRUCTOR on class CL_PLANNING_CONTROL has no exception.

Method DATA_REFRESH Signature

Method DATA_REFRESH on class CL_PLANNING_CONTROL has no parameter.
Method DATA_REFRESH on class CL_PLANNING_CONTROL has no exception.

Method DELETE_PARTICIPANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PARTICIPANTS	Call by reference	☐	Type reference (TYPE)	SZTG_TFB		Tabelle von zu löschenden Teilnehmern	20000810

Method DELETE_PARTICIPANTS on class CL_PLANNING_CONTROL has no exception.

Method DISPLAY Signature

Method DISPLAY on class CL_PLANNING_CONTROL has no parameter.
Method DISPLAY on class CL_PLANNING_CONTROL has no exception.

Method DISPLAY_REFRESH Signature

Method DISPLAY_REFRESH on class CL_PLANNING_CONTROL has no parameter.
Method DISPLAY_REFRESH on class CL_PLANNING_CONTROL has no exception.

Method GET_HOUR_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DAILY_FROM	Call by reference	☐	Type reference (TYPE)	T		Tagesbeginn	20000306
2	Importing	DAILY_TO	Call by reference	☐	Type reference (TYPE)	T		Tagesende	20000306
3	Importing	DATE_FROM	Call by reference	☐	Type reference (TYPE)	D		Beginn Datum	20000207
4	Importing	DATE_TO	Call by reference	☐	Type reference (TYPE)	D		Ende Datum	20000207
5	Exporting	HOUR_TABLE	Call by reference	☐	Type reference (TYPE)	HOUR_PATTERN_T		Zeitraster	20000210
6	Importing	TIME_FROM	Call by reference	☐	Type reference (TYPE)	T		Beginn Zeit	20000210
7	Importing	TIME_INTER	Call by reference	☐	Type reference (TYPE)	INT4		Zeitintervall für die Detailanzeige des Terminkalenders	20000207
8	Importing	TIME_TO	Call by reference	☐	Type reference (TYPE)	T		Ende Zeit	20000210

Method GET_HOUR_TABLE on class CL_PLANNING_CONTROL has no exception.

Method GET_MEETING_TIMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_MEETING_TIMES	Call by reference	☐	Type reference (TYPE)	SCSTIMEFRMTAB		Terminverwaltung: Tabelle für Zeitrahmen	20000224

Method GET_MEETING_TIMES on class CL_PLANNING_CONTROL has no exception.

Method GET_PERIOD Signature

Method GET_PERIOD on class CL_PLANNING_CONTROL has no parameter.
Method GET_PERIOD on class CL_PLANNING_CONTROL has no exception.

Method GET_TOOLBAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_TOOLBAR	Value transfer	☐	Type reference (TYPE)	TTB_BUTTON		Toolbar	20000810

Method GET_TOOLBAR on class CL_PLANNING_CONTROL has no exception.

Method INSERT_PARTICIPANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PARTICIPANTS	Call by reference	☐	Type reference (TYPE)	SZTG_TFB		Tabelle zur Datenübergabe zw. Kalenderframework und Planner	20000814
2	Importing	SUCCESSOR	Call by reference	☐	Type reference (TYPE)	SC_FBPARID		Eintrag vor dem eingefügt werden soll	20000814

Method INSERT_PARTICIPANTS on class CL_PLANNING_CONTROL has no exception.

Method MODIFY_PARTICIPANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PARTICIPANTS	Call by reference	☐	Type reference (TYPE)	SZTG_TFB		Tabelle zur Datenübergabe zw. Kalenderframework und Planner	20000811

Method MODIFY_PARTICIPANTS on class CL_PLANNING_CONTROL has no exception.

Method ON_DOUBLECLICK Signature

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

Method ON_DOUBLECLICK on class CL_PLANNING_CONTROL has no exception.

Method ON_PERIOD_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EP_BDAT	Value transfer	☐	Attribute reference (LIKE)				20000711
2	Importing	EP_BTIM	Value transfer	☐	Attribute reference (LIKE)				20000711
3	Importing	EP_EDAT	Value transfer	☐	Attribute reference (LIKE)				20000711
4	Importing	EP_ETIM	Value transfer	☐	Attribute reference (LIKE)				20000711

Method ON_PERIOD_CHANGED on class CL_PLANNING_CONTROL has no exception.

Method ON_TOOLBAR_ACTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	E_COL	Value transfer	☐	Attribute reference (LIKE)				20000211
2	Importing	E_FCODE	Value transfer	☐	Attribute reference (LIKE)				20000211
3	Importing	E_ROW	Value transfer	☐	Attribute reference (LIKE)				20000211

Method ON_TOOLBAR_ACTION on class CL_PLANNING_CONTROL has no exception.

Method SET_COLOR_INFOS Signature

Method SET_COLOR_INFOS on class CL_PLANNING_CONTROL has no parameter.
Method SET_COLOR_INFOS on class CL_PLANNING_CONTROL has no exception.

Method SET_MEETING_TIMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MEETING_TIMES	Call by reference	☐	Type reference (TYPE)	SCSTIMEFRMTAB		Terminverwaltung: Tabelle für Zeitrahmen	20000905

Method SET_MEETING_TIMES on class CL_PLANNING_CONTROL has no exception.

Method SET_NO_MEETING_TIMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NO_MEETING_TIMES	Call by reference	☐	Type reference (TYPE)	FLAG		allgemeines flag	20060629

Method SET_NO_MEETING_TIMES on class CL_PLANNING_CONTROL has no exception.

Method SET_PERIOD Signature

Method SET_PERIOD on class CL_PLANNING_CONTROL has no parameter.
Method SET_PERIOD on class CL_PLANNING_CONTROL has no exception.

Method SET_TITLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TITLE	Value transfer	☐	Type reference (TYPE)	C	SPACE	Titel	20000224

Method SET_TITLE on class CL_PLANNING_CONTROL has no exception.

Method SET_TOOLBAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_TOOLBAR	Value transfer	☐	Type reference (TYPE)	TTB_BUTTON		Toolbar	20000810

Method SET_TOOLBAR on class CL_PLANNING_CONTROL has no exception.

Event Signatures

Event PARTICIPANT_DELETED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	E_PART_ID	Exporting	Value transfer	☐	Type reference (TYPE)	SC_FBPARID		Terminverwaltung: ID eines Free/Busy Teilnehmers	20000810

Event PARTICIPANT_INSERTED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	E_PART_ID	Exporting	Value transfer	☐	Type reference (TYPE)	SC_FBPARID	SPACE	Eintrag auf dem der Cursor steht	20000814

Event PARTICIPANT_SELECTED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	E_PART_ID	Exporting	Value transfer	☐	Type reference (TYPE)	SC_FBPARID		Terminverwaltung: ID eines Free/Busy Teilnehmers	20000808

History

Last changed by/on	SAP	20090618
SAP Release Created in	46D