SAP ABAP Class CL_FDT_WD_ISLAND_CTRL_MANAGER (FDT WD Island: Control Manager)

Hierarchy

☛

SAP_BASIS (Software Component) SAP Basis Component
⤷

BC-SRV-BR (Application Component) BRFplus - ABAP-Based Business Rules
⤷

SFDT_WD_ISLAND_INFRASTRUCTURE (Package) BRFplus: Island Infrastructure

Properties

Class	CL_FDT_WD_ISLAND_CTRL_MANAGER
Short Description	FDT WD Island: Control Manager
Super Class
Instantiability of a Class	2	Public
Final

General Data

Message Class
Program status
Category	0
Package	SFDT_WD_ISLAND_INFRASTRUCTURE	BRFplus: Island Infrastructure
Created	20110615	SAP
Last change	20140121	SAP
Shared Memory-enabled
Fixed point arithmetic
Unicode checks active

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	CL_FDT_WD_ISLAND_CTRL_MANAGER	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_FDT_WD_STATE	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
4	IF_FDT_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_FDT_WD_ISLAND_CTRL_MANAGER has no interface implemented.

Friends

Class CL_FDT_WD_ISLAND_CTRL_MANAGER has no friend class.

Attributes

#	Attribute	Level	Visibility	Typing	Associated Type	Initial Value	Description	Created on
1	GC_MAX_STACK_SIZE	Constant	Private	Type reference (TYPE)	I	4	Max stack size(controls)	20120920
2	MO_CONFIGURATION	Instance attribute	Private	Object reference (TYPE REF TO)	IF_FDT_WD_CONFIGURATION		FDT WD: Configuration	20110616
3	MO_META_DATA_MODEL	Instance attribute	Private	Object reference (TYPE REF TO)	CL_FDT_WD_ISLAND_META_MODEL		FDT Island: Meta Data Model	20110620
4	MO_MSG_MANAGER	Instance attribute	Private	Object reference (TYPE REF TO)	CL_FDT_WD_ISLAND_MSG_MANAGER		FDT WD Island: Msg Manager	20120612
5	MTS_CONTROL	Instance attribute	Private	Type reference (TYPE)	TS_CONTROL			20110616
6	MT_STACK	Instance attribute	Private	Type reference (TYPE)	T_STACK		Represents the stack of controls	20120919

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_CONTROL	Instance method	Public	Method	Adds a new control	20110616
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20110616
3	CREATE_DEFAULT_STATE	Static method	Private	Method	Create a new state object with default settings	20121115
4	CREATE_OBJECT_MANAGER	Instance method	Private	Method	Determines the object manager	20121114
5	DETERMINE_CONTROL_NAME	Static method	Private	Method	Determines the name of the control	20110620
6	GET_CONTROL_BY_HANDLE	Instance method	Public	Method	Returns a control by its handle	20110616
7	GET_CONTROL_BY_NAME	Instance method	Public	Method	Returns a control by control name	20110616
8	GET_ROOT_CONTROL_HANDLE	Instance method	Public	Method	Returns the root control handle	20110701
9	GET_STACK_SIZE	Instance method	Public	Method	Returns the size of the stack	20120920
10	IS_CONTROL_EXISTING	Instance method	Public	Method	Returns if a control is existing	20110620
11	IS_CONTROL_EXISTING_BY_HANDLE	Instance method	Public	Method	Returns if a control is existing(by providing a handle)	20120105
12	REMOVE_1ST_CONTROL_IN_STACK	Instance method	Public	Method	Removes the first control in stack	20120920
13	REMOVE_ALL_CONTROLS_IN_STACK	Instance method	Public	Method	Removes all controls in the stack	20121128
14	REMOVE_CONTROL	Instance method	Public	Method	Removes a control	20110616
15	REMOVE_CONTROL_DEEP	Instance method	Public	Method	Remove controls deep	20120927
16	SET_CONTROL_STATE	Instance method	Public	Method	Set the object state instance in an existing control	20121115
17	SET_OBJECT_STATE	Instance method	Private	Method	OBSOLETE	20120316
18	SET_OBJECT_STATE_DEEP	Instance method	Private	Method	OBSOLETE	20120618

Events

Class CL_FDT_WD_ISLAND_CTRL_MANAGER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	CONTROL_HANDLE	Public	Type reference (TYPE)	SYSUUID_C	Control Handle ID	20110616
2	S_CONTROL	Public	See coding			20110616	`BEGIN OF s_control, control_handle TYPE sysuuid_c, control_name TYPE string, id TYPE if_fdt_types=>id, state TYPE REF TO if_fdt_wd_state, timestamp TYPE if_fdt_types=>timestamp, object_manager TYPE REF TO cl_fdt_wd_island_obj_manager, parent_control TYPE control_handle, END OF s_control`
3	TS_CONTROL	Private	See coding			20110616	`ts_control TYPE SORTED TABLE OF s_control WITH UNIQUE KEY control_handle WITH NON-UNIQUE SORTED KEY parent COMPONENTS parent_control`
4	T_STACK	Private	See coding			20120919	`t_stack TYPE STANDARD TABLE OF control_handle`

Method Signatures

Method ADD_CONTROL Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_CONTROL_HANDLE	Call by reference	Type reference (TYPE)	CONTROL_HANDLE	Only for Unit Testing	20120612
2	Importing	IV_CONTROL_NAME	Call by reference	Type reference (TYPE)	STRING	Control Name	20110621
3	Importing	IV_ID	Call by reference	Type reference (TYPE)	IF_FDT_TYPES=>ID	Id	20110620
4	Importing	IV_PARENT_CONTROL	Call by reference	Type reference (TYPE)	CONTROL_HANDLE	Parent Control	20110620
5	Importing	IV_TIMESTAMP	Call by reference	Type reference (TYPE)	IF_FDT_TYPES=>TIMESTAMP	Timestamp	20110620
6	Returning	RV_CONTROL_HANDLE	Value transfer	Type reference (TYPE)	CONTROL_HANDLE	Control Handle	20110616

Method ADD_CONTROL on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IO_CONFIGURATION	Call by reference	Object reference (TYPE REF TO)	IF_FDT_WD_CONFIGURATION	Configuration	20110616
2	Importing	IO_META_DATA_MODEL	Call by reference	Object reference (TYPE REF TO)	CL_FDT_WD_ISLAND_META_MODEL	FDT Island: Meta Data Model	20110620
3	Importing	IO_MSG_MANAGER	Call by reference	Object reference (TYPE REF TO)	CL_FDT_WD_ISLAND_MSG_MANAGER	FDT WD Island: Manages Messages	20120612

Method CONSTRUCTOR on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method CREATE_DEFAULT_STATE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IO_PARENT_STATE	Call by reference	Object reference (TYPE REF TO)	IF_FDT_WD_STATE	FDT WD: State	20121115
2	Importing	IV_ID	Call by reference	Type reference (TYPE)	IF_FDT_TYPES=>ID	Universal Unique Identifier	20121115
3	Importing	IV_TIMESTAMP	Call by reference	Type reference (TYPE)	IF_FDT_TYPES=>TIMESTAMP	Time Stamp (active version, UTC)	20121115
4	Returning	RO_STATE	Value transfer	Object reference (TYPE REF TO)	IF_FDT_WD_STATE	FDT WD: State	20121115

Method CREATE_DEFAULT_STATE on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method CREATE_OBJECT_MANAGER Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_CONTROL_HANDLE	Call by reference	Type reference (TYPE)	CONTROL_HANDLE	Control Handle	20121114
2	Importing	IV_ID	Call by reference	Type reference (TYPE)	IF_FDT_TYPES=>ID	Universal Unique Identifier	20121114
3	Returning	RO_OBJECT_MANAGER	Value transfer	Object reference (TYPE REF TO)	CL_FDT_WD_ISLAND_OBJ_MANAGER	FDT WD: Island Object Manager	20121114

Method CREATE_OBJECT_MANAGER on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method DETERMINE_CONTROL_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MODEL	Call by reference		Object reference (TYPE REF TO)	CL_FDT_WD_ISLAND_MODEL			20121114
2	Returning	RV_CONTROL_NAME	Value transfer		Type reference (TYPE)	STRING			20110620

Method DETERMINE_CONTROL_NAME on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method GET_CONTROL_BY_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTROL_HANDLE	Call by reference		Type reference (TYPE)	CONTROL_HANDLE			20110616
2	Returning	RS_CONTROL	Value transfer		Type reference (TYPE)	S_CONTROL			20110616

Method GET_CONTROL_BY_HANDLE on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method GET_CONTROL_BY_NAME Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_CONTROL_NAME	Call by reference	Type reference (TYPE)	STRING	Control Name	20110620
2	Importing	IV_ID	Call by reference	Type reference (TYPE)	IF_FDT_TYPES=>ID		20110620
3	Importing	IV_TIMESTAMP	Call by reference	Type reference (TYPE)	IF_FDT_TYPES=>TIMESTAMP	Time Stamp (active version, UTC)	20110701
4	Returning	RS_CONTROL	Value transfer	Type reference (TYPE)	S_CONTROL		20110620

Method GET_CONTROL_BY_NAME on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method GET_ROOT_CONTROL_HANDLE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_ID	Call by reference	Type reference (TYPE)	IF_FDT_TYPES=>ID	ID	20110701
2	Importing	IV_TIMESTAMP	Call by reference	Type reference (TYPE)	IF_FDT_TYPES=>TIMESTAMP	Time Stamp (active version, UTC)	20110701
3	Returning	RV_CONTROL_HANDLE	Value transfer	Type reference (TYPE)	CONTROL_HANDLE	Control Handle ID	20110701

Method GET_ROOT_CONTROL_HANDLE on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method GET_STACK_SIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_STACK_SIZE	Value transfer		Type reference (TYPE)	I			20120920

Method GET_STACK_SIZE on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method IS_CONTROL_EXISTING Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_CONTROL_NAME	Call by reference	Type reference (TYPE)	STRING	Control Name (only required for child controls)	20110620
2	Importing	IV_ID	Call by reference	Type reference (TYPE)	IF_FDT_TYPES=>ID	Universal Unique Identifier	20110620
3	Importing	IV_TIMESTAMP	Call by reference	Type reference (TYPE)	IF_FDT_TYPES=>TIMESTAMP	Time Stamp (active version, UTC)	20110630
4	Returning	RV_EXISTS	Value transfer	Type reference (TYPE)	BOOLE_D	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20110620

Method IS_CONTROL_EXISTING on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method IS_CONTROL_EXISTING_BY_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTROL_HANDLE	Call by reference		Type reference (TYPE)	CONTROL_HANDLE		Control Handle	20120105
2	Returning	RV_EXISTS	Value transfer		Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20120105

Method IS_CONTROL_EXISTING_BY_HANDLE on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method REMOVE_1ST_CONTROL_IN_STACK Signature

Method REMOVE_1ST_CONTROL_IN_STACK on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no parameter.
Method REMOVE_1ST_CONTROL_IN_STACK on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method REMOVE_ALL_CONTROLS_IN_STACK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXCLUDE_CONTROL_HANDLE	Call by reference		Type reference (TYPE)	CL_FDT_WD_ISLAND_CTRL_MANAGER=>CONTROL_HANDLE		Control Handle ID	20121128

Method REMOVE_ALL_CONTROLS_IN_STACK on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method REMOVE_CONTROL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTROL_HANDLE	Call by reference		Type reference (TYPE)	CONTROL_HANDLE			20110620

Method REMOVE_CONTROL on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method REMOVE_CONTROL_DEEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTROL_HANDLE	Call by reference		Type reference (TYPE)	CONTROL_HANDLE			20120927

Method REMOVE_CONTROL_DEEP on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method SET_CONTROL_STATE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MESSAGE	Call by reference	Object reference (TYPE REF TO)	IF_FDT_WD_ISLAND_MESSAGE		Message Manager	20121115
2	Importing	IO_STATE	Call by reference	Object reference (TYPE REF TO)	IF_FDT_WD_STATE		FDT WD: State	20121115
3	Importing	IV_CONTROL_HANDLE	Call by reference	Type reference (TYPE)	CONTROL_HANDLE		Control Handle ID	20121115
4	Importing	IV_DEEP	Call by reference	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Set state also for sub-controls	20121115

Method SET_CONTROL_STATE on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method SET_OBJECT_STATE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IO_MESSAGE	Call by reference	Object reference (TYPE REF TO)	IF_FDT_WD_ISLAND_MESSAGE	Message Manager	20120319
2	Importing	IO_PARENT_STATE	Call by reference	Object reference (TYPE REF TO)	IF_FDT_WD_STATE	FDT WD: State	20120316
3	Importing	IO_STATE	Call by reference	Object reference (TYPE REF TO)	IF_FDT_WD_STATE	FDT WD: State	20120316
4	Importing	IV_CONTROL_HANDLE	Call by reference	Type reference (TYPE)	CONTROL_HANDLE	Control Handle ID	20120316
5	Importing	IV_ID	Call by reference	Type reference (TYPE)	IF_FDT_TYPES=>ID	Universal Unique Identifier	20120316
6	Importing	IV_TIMESTAMP	Call by reference	Type reference (TYPE)	IF_FDT_TYPES=>TIMESTAMP	Time Stamp (active version, UTC)	20120316

Method SET_OBJECT_STATE on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

Method SET_OBJECT_STATE_DEEP Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IO_MESSAGE	Call by reference	Object reference (TYPE REF TO)	IF_FDT_WD_ISLAND_MESSAGE	Message Manager	20120618
2	Importing	IO_PARENT_STATE	Call by reference	Object reference (TYPE REF TO)	IF_FDT_WD_STATE	Parent State	20120620
3	Importing	IO_STATE	Call by reference	Object reference (TYPE REF TO)	IF_FDT_WD_STATE	FDT WD: State	20120618
4	Importing	IS_CONTROL	Call by reference	Type reference (TYPE)	CL_FDT_WD_ISLAND_CTRL_MANAGER=>S_CONTROL	Control Handle ID	20120620

Method SET_OBJECT_STATE_DEEP on class CL_FDT_WD_ISLAND_CTRL_MANAGER has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	731

Object Hierarchy

Using

Used by

Advertise Links