SAP ABAP Class CL_CCM_NAVIGATION_AREA (CIC Component Navigation Area)

Hierarchy

☛ BBPCRM (Software Component) BBPCRM
   ⤷ CRM-CIC (Application Component) Interaction Center WinClient
     ⤷ CCMA (Package) Interaction Center Components

Properties

Class	CL_CCM_NAVIGATION_AREA
Short Description	CIC Component Navigation Area
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	CCMA	Interaction Center Components
Created	19990317	SAP
Last change	20050224	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CIC0	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	CXTAB	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_CCM_NAVIGATION_AREA has no interface implemented.

Friends

Class CL_CCM_NAVIGATION_AREA has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_EVENT_OKCODE	Constant	Private	☐	Type reference (TYPE)	CIC0_EVENT	'OK_CODE'	OKCODE event of CIC	19990323
2	CO_MAX_NUM_OF_TABS	Constant	Private	☐	Type reference (TYPE)	I	4	Maximum number of tabs	19990318
3	CO_MAX_NUM_OF_TABS_CLASS	Static Attribute	Private	☐	Type reference (TYPE)	I	8	Maximum number of tabs of whole class	19990323
4	CO_OKCODE_CALLBACK_FUNC	Constant	Private	☐	Type reference (TYPE)	CIC0_FUNCNAME	'CCM_NAVIGATION_AREA_OK_CB'	Callback function for okcode event	19990324
5	CO_PROGRAM	Constant	Private	☐	Type reference (TYPE)	SYREPID	'SAPLCCM17'	Program	19990317
6	CO_SUBSCREEN	Constant	Private	☐	Type reference (TYPE)	SYDYNNR	'0100'	Subscreen	19990317
7	CO_SUBSCRIBER	Constant	Private	☐	Type reference (TYPE)	CIC0_SUBSCRIBER	'CCM_NAV_AR'	CIC subscriber	19990323
8	NUMBER_OF_TABS	Instance attribute	Private	☐	Type reference (TYPE)	I	2	Number of tabs	19990318
9	OKCODES_SUBSCRIBED	Static Attribute	Private	☐	Type reference (TYPE)	FLAG		Flag okcodes already subscribed	19990323
10	SCREEN_MANAGER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CCM_NAV_AREA_SCR_MANAGER		Screen manager	19990322
11	TABSTRIP	Instance attribute	Private	☐	Type reference (TYPE)	CXTAB_TABSTRIP		Tabstrip status	19990318
12	T_NAV_AREA_TABS	Instance attribute	Private	☐	See coding			Table of navigation area tabs	19990324

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE	Instance method	Public	Method	Activation of one tab	19990322
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	19990322
3	FINISH_PAI	Instance method	Public	Method	Finishing of subscreen PAI	19990318
4	GET_SCREEN_OF_TAB	Instance method	Public	Method	Get screen, which is on specified tab	19990322
5	GET_TAB_ATTRIBUTES	Instance method	Public	Method	Get attributes of tab	19990324
6	GET_TAB_REF	Instance method	Private	Method	Get object reference of tab (via external tab name)	19990322
7	OPEN_SUBSCREEN	Instance method	Public	Method	Opening of subscreen (only once called, before PREPARE_PBO)	19990317
8	PREPARE_PBO	Instance method	Public	Method	Preparation of call subscreen PBO	19990317
9	SUBSCRIBE	Instance method	Public	Method	Subscription to CIC events	19990323

Events

Class CL_CCM_NAVIGATION_AREA has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_TAB	Private	Object reference (TYPE REF TO)	CL_CCM_NAV_AREA_TAB	Tab of navigation area	19990318

Method Signatures

Method ACTIVATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	CCM_TAB_PROPERTIES-NAME		Name des Reiters, der aktiviert werden soll	19990322

Method ACTIVATE on class CL_CCM_NAVIGATION_AREA has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_SCREEN_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	CL_CCM_NAV_AREA_SCR_MANAGER		Dynpro-Manager	19990322

Method CONSTRUCTOR on class CL_CCM_NAVIGATION_AREA has no exception.

Method FINISH_PAI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_TABSTRIP	Call by reference	☐	Type reference (TYPE)	CXTAB_TABSTRIP		Tabstrip	19990318

Method FINISH_PAI on class CL_CCM_NAVIGATION_AREA has no exception.

Method GET_SCREEN_OF_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_SCREEN	Call by reference	☐	Type reference (TYPE)	SYDYNNR		Dynpro-Nummer (des Reiters)	19990322
2	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	CCM_TAB_PROPERTIES-NAME		Externer Name des Reiters	19990322

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐	Reiter nicht gefunden	19990329

Method GET_TAB_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_TAB_ICON	Call by reference	☐	Type reference (TYPE)	CCM_TAB_PROPERTIES-ICON		Reiter-Ikone	19990324
2	Exporting	EX_TAB_QUICKINFO	Call by reference	☐	Type reference (TYPE)	CCM_TAB_PROPERTIES-QUICKINFO		Reiter-Quickinfo	19990324
3	Exporting	EX_TAB_TEXT	Call by reference	☐	Type reference (TYPE)	CCM_TAB_PROPERTIES-TEXT		Reitertext	19990324
4	Exporting	EX_TAB_VISIBLE	Call by reference	☐	Type reference (TYPE)	CCM_TAB_PROPERTIES-VISIBLE		Sichtbarkeit des Reiters	19990324
5	Importing	IM_TAB_NAME	Call by reference	☐	Type reference (TYPE)	CCM_TAB_PROPERTIES-NAME		Reitername	19990324

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐	Reiter nicht gefunden	19990329

Method GET_TAB_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_TAB	Call by reference	☐	Object reference (TYPE REF TO)	CL_CCM_NAV_AREA_TAB		Navigationsbereich Objektreferenz	19990322
2	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	CCM_TAB_PROPERTIES-NAME		Externer Name des Reiters	19990322

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐	Navigationsreiter mit angegebenem Schlüssel nicht gefunden	19990329

Method OPEN_SUBSCREEN Signature

Method OPEN_SUBSCREEN on class CL_CCM_NAVIGATION_AREA has no parameter.
Method OPEN_SUBSCREEN on class CL_CCM_NAVIGATION_AREA has no exception.

Method PREPARE_PBO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_SUB_DYNNR	Call by reference	☐	Type reference (TYPE)	SYDYNNR		Subscreen-Nummer	19990317
2	Exporting	EX_SUB_REPID	Call by reference	☐	Type reference (TYPE)	SYREPID		Programm	19990317
3	Exporting	EX_TABSTRIP	Call by reference	☐	Type reference (TYPE)	CXTAB_TABSTRIP		Tabstrip	19990318

Method PREPARE_PBO on class CL_CCM_NAVIGATION_AREA has no exception.

Method SUBSCRIBE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_HANDLE	Call by reference	☐	Type reference (TYPE)	CIC0_HANDLE		CIC-Handle	19990323

Method SUBSCRIBE on class CL_CCM_NAVIGATION_AREA has no exception.

History

Last changed by/on	SAP	20050224
SAP Release Created in