SAP ABAP Class CL_CFX_AREA_SELECTOR (Collaboration Folders: Navigation Tree)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PLM-CFO (Application Component) Collaboration Folders
     ⤷ CFX_UI (Package) Collaboration Folders: User Interface

Properties

Class	CL_CFX_AREA_SELECTOR
Short Description	Collaboration Folders: Navigation Tree
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CFX_UI	Collaboration Folders: User Interface
Created	20010118	SAP
Last change	20141109
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_CFX_AREA_SELECTOR has no forward declaration.

Interfaces

Class CL_CFX_AREA_SELECTOR has no interface implemented.

Friends

Class CL_CFX_AREA_SELECTOR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_AREAS	Instance attribute	Private	☐	Type reference (TYPE)	CFX_TT_AREAS		Node Data	20010118
2	M_AREA_NUMBER	Instance attribute	Private	☐	Type reference (TYPE)	I		Number of Areas	20010118
3	M_AREA_SELECTOR	Instance attribute	Private	☐	Type reference (TYPE)	CFX_TS_AREA_SELECTOR		Global Tree Data	20010118

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_AREA	Instance method	Public	Method	Add Area	20010118
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor Area Selector	20010118
3	GET_AREA	Instance method	Public	Method	Get Area	20010118
4	GET_AREA_NUMBER	Instance method	Public	Method	Get Number of Areas	20010118
5	GET_AREA_SELECTOR	Instance method	Public	Method	Get Global Tree Data	20010118
6	HANDLE_EVENTS	Static method	Public	Method	Handles Area Events	20010118
7	SET_AREA	Instance method	Public	Method	Set Area Data	20010118

Events

Class CL_CFX_AREA_SELECTOR has no event.

Types

Class CL_CFX_AREA_SELECTOR has no local type.

Method Signatures

Method ADD_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AREA_ID	Value transfer	☑	Type reference (TYPE)	STRING		Area id	20010122
2	Importing	I_DESCRIPTION	Value transfer	☑	Type reference (TYPE)	STRING		Description	20010122
3	Importing	I_HREF	Value transfer	☑	Type reference (TYPE)	STRING		Link	20010206
4	Importing	I_MARKED	Value transfer	☑	Type reference (TYPE)	STRING		If 'X': Area has focus	20010206
5	Importing	I_NAME	Value transfer	☑	Type reference (TYPE)	STRING		Name	20010122
6	Importing	I_NO_PERMISSION	Value transfer	☐	Type reference (TYPE)	STRING	SPACE	If 'X':no permission	20010122
7	Importing	I_OWNER_PERMISSION	Value transfer	☐	Type reference (TYPE)	STRING	SPACE	If 'X': owner permission	20010122
8	Importing	I_PUBLIC	Value transfer	☑	Type reference (TYPE)	STRING		If 'X': Area is public	20010122
9	Importing	I_READ_PERMISSION	Value transfer	☐	Type reference (TYPE)	STRING	SPACE	If 'X': read permission	20010122
10	Importing	I_WRITE_PERMISSION	Value transfer	☐	Type reference (TYPE)	STRING	SPACE	If 'X': write permission	20010122
11	Returning	R_NEW_AREA_INDEX	Value transfer	☐	Type reference (TYPE)	I		Area index	20010122

Method ADD_AREA on class CL_CFX_AREA_SELECTOR has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AREA_ID	Value transfer	☐	Type reference (TYPE)	STRING		Area id	20011120
2	Importing	I_COLLABORATION_ID	Value transfer	☐	Type reference (TYPE)	STRING		Collaboration Id	20010118
3	Importing	I_TOPIC_ID	Value transfer	☐	Type reference (TYPE)	STRING		topic id	20010206

Method CONSTRUCTOR on class CL_CFX_AREA_SELECTOR has no exception.

Method GET_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_AREA_ID	Value transfer	☐	Type reference (TYPE)	STRING		Area id	20010122
2	Exporting	E_DESCRIPTION	Value transfer	☐	Type reference (TYPE)	STRING		Description	20010122
3	Exporting	E_HREF	Value transfer	☐	Type reference (TYPE)	STRING		Link	20010206
4	Exporting	E_MARKED	Value transfer	☐	Type reference (TYPE)	STRING		If 'X': Area has focus	20010206
5	Exporting	E_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name	20010122
6	Exporting	E_NO_PERMISSION	Value transfer	☐	Type reference (TYPE)	STRING		If 'X': No permission is set	20010122
7	Exporting	E_OWNER_PERMISSION	Value transfer	☐	Type reference (TYPE)	STRING		If 'X': Owner permission is set	20010122
8	Exporting	E_PUBLIC	Value transfer	☐	Type reference (TYPE)	STRING		Public	20010122
9	Exporting	E_READ_PERMISSION	Value transfer	☐	Type reference (TYPE)	STRING		If 'X': Read permission is set	20010122
10	Exporting	E_WRITE_PERMISSION	Value transfer	☐	Type reference (TYPE)	STRING		If 'X': Write permission is set	20010122
11	Importing	I_AREA_INDEX	Value transfer	☐	Type reference (TYPE)	I		Index of area	20010118

Method GET_AREA on class CL_CFX_AREA_SELECTOR has no exception.

Method GET_AREA_NUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_AREA_NUMBER	Value transfer	☐	Type reference (TYPE)	I		Number of areas	20010118

Method GET_AREA_NUMBER on class CL_CFX_AREA_SELECTOR has no exception.

Method GET_AREA_SELECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR_MSG	Value transfer	☐	Type reference (TYPE)	STRING		Error message	20010206
2	Exporting	E_ICON	Value transfer	☐	Type reference (TYPE)	STRING		Icon	20010705
3	Exporting	E_OTR_AREA	Value transfer	☐	Type reference (TYPE)	STRING		OTR: cfx/collaboration_area	20010124
4	Exporting	E_SCENARIO	Value transfer	☐	Type reference (TYPE)	STRING		Scenario	20010611

Method GET_AREA_SELECTOR on class CL_CFX_AREA_SELECTOR has no exception.

Method HANDLE_EVENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_NAVIGATION	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_NAVIGATION		BSP navigation object	20010118
2	Importing	IP_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP request	20010118
3	Returning	R_EVENT_HANDLED	Value transfer	☐	Type reference (TYPE)	STRING		Is set when handler handled the event	20010118

Method HANDLE_EVENTS on class CL_CFX_AREA_SELECTOR has no exception.

Method SET_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AREA_ID	Value transfer	☑	Type reference (TYPE)	STRING		Area id	20010122
2	Importing	I_AREA_INDEX	Value transfer	☐	Type reference (TYPE)	I		Index of area	20010118
3	Importing	I_DESCRIPTION	Value transfer	☑	Type reference (TYPE)	STRING		Description	20010122
4	Importing	I_HREF	Value transfer	☑	Type reference (TYPE)	STRING		Link	20010206
5	Importing	I_MARKED	Value transfer	☑	Type reference (TYPE)	STRING		If 'X': Area has focus	20010206
6	Importing	I_NAME	Value transfer	☑	Type reference (TYPE)	STRING		Name	20010122
7	Importing	I_NO_PERMISSION	Value transfer	☐	Type reference (TYPE)	STRING	SPACE	No permission	20010122
8	Importing	I_OWNER_PERMISSION	Value transfer	☐	Type reference (TYPE)	STRING	SPACE	Owner permission	20010122
9	Importing	I_PUBLIC	Value transfer	☑	Type reference (TYPE)	STRING		Public	20010122
10	Importing	I_READ_PERMISSION	Value transfer	☐	Type reference (TYPE)	STRING	SPACE	Read permission	20010122
11	Importing	I_WRITE_PERMISSION	Value transfer	☐	Type reference (TYPE)	STRING	SPACE	Write permission	20010122

Method SET_AREA on class CL_CFX_AREA_SELECTOR has no exception.

History

Last changed by/on	SAP	20141109
SAP Release Created in	20A