SAP ABAP Class CL_FPM_GUIBB_CHART_CONFIG (Chart Configuration)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-CMP-FPM (Application Component) Floorplan Manager Web Dynpro ABAP
     ⤷ APB_FPM_GUIBB (Package) Generic UI building blocks

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FPM_GUIBB_CHART_CONFIG	Config API for Chart UIBB	20130204

Properties

Class	CL_FPM_GUIBB_CHART_CONFIG
Short Description	Chart Configuration
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	APB_FPM_GUIBB	Generic UI building blocks
Created	20130204	SAP
Last change	20141120
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_FPM_CHART_TO_CVOM_MAPPING	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_FPM_CHART_UIBB_ASSIST	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
4	IF_FPM_GUIBB_CHART_CONFIG	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_FPM_GUIBB_CHART_CONFIG	☐	☐	Config API for Chart UIBB	20130204

Friends

Class CL_FPM_GUIBB_CHART_CONFIG has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_CONFIG_NODE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Configuration node	20130211
2	MO_SERVICE_HANDLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_FPM_CFG_SERVICE_HANDLER		FPM Config Editor Service Handler	20130211
3	MO_STRUCTDESCR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Runtime Type Services	20130214
4	MR_CONFIG_DATA	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Configuration data	20130214
5	MT_ACTION_DEFINITION	Instance attribute	Private	☐	Type reference (TYPE)	FPMGB_T_ACTIONDEF		Action Definition	20130211
6	MT_DD07V	Static Attribute	Private	☐	Type reference (TYPE)	TY_T_DD07V		Domain fixed values	20130220

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_BUTTON_ROW_ELEMENT	Instance method	Private	Method	Add button row element	20130213
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20130211
3	CREATE_ELEMENT_ID	Instance method	Private	Method	Create an element ID	20130213
4	DECODE_EVENT_PARAMETERS	Instance method	Private	Method	Decode event parameters	20130211
5	DECODE_SPECIAL_PROPERTIES	Instance method	Private	Method	Decode special properties	20130211
6	ENCODE_EVENT_PARAMETERS	Instance method	Private	Method	Encode event parameters	20130213
7	ENCODE_SPECIAL_PROPERTIES	Instance method	Private	Method	Encode special properties	20130213
8	GET_BUTTON_ROW_ELEMENTS	Instance method	Private	Method	Get button row elements	20130211
9	GET_CONFIG_PATH_FOR_PROPERTY	Instance method	Private	Method	Get configuration nodes and attribute for chart property	20130213
10	IS_CHART_TYPE_PROPERTY_VALID	Static method	Private	Method	Returns whether a particular chart property is valid	20130212
11	IS_CHART_TYPE_VALID	Static method	Private	Method	Returns whether a particular chart type is valid	20130212
12	IS_COLLIDING_BUTTON_ROW_INDEX	Instance method	Private	Method	Returns whether a button row element index exists already	20130213
13	MOVE_BUTTON_ROW_ELEMENTS	Instance method	Private	Method	Moves the button row elements back starting from an index	20130213
14	SET_CHART_CONTEXT	Instance method	Public	Method		20131015

Events

Class CL_FPM_GUIBB_CHART_CONFIG has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_T_DD07V	Private	See coding			20130220	ty_t_dd07v TYPE SORTED TABLE OF dd07v WITH UNIQUE KEY valpos

Method Signatures

Method ADD_BUTTON_ROW_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_BUTTON_ROW_ELEMENT	Call by reference	☐	Type reference (TYPE)	CL_FPM_CHART_UIBB_ASSIST=>YS_BUTTON_ROW_ELEMENT		Button row element	20130213

#	Exception	Resumable	Description	Created on
1	CX_FPM_CONFIGURATION	☐	Configuration exceptions	20130213

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONFIG_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Configuration node	20130211
2	Importing	IO_MODEL_FACTORY	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_CHART_MODEL_FACTORY		Chart Model Factory	20130211
3	Importing	IO_SERVICE_HANDLER	Call by reference	☑	Object reference (TYPE REF TO)	IF_FPM_CFG_SERVICE_HANDLER		FPM Config Editor Service Handler	20130211
4	Importing	IR_CONFIG_DATA	Call by reference	☑	Object reference (TYPE REF TO)	DATA		Configuration data	20130214
5	Importing	IT_ACTION_DEFINITION	Call by reference	☐	Type reference (TYPE)	FPMGB_T_ACTIONDEF		Action Definition	20130211

Method CONSTRUCTOR on class CL_FPM_GUIBB_CHART_CONFIG has no exception.

Method CREATE_ELEMENT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ELEMENT_ID	Value transfer	☐	Type reference (TYPE)	FPM_ELEMENT_ID		FPM: Element ID	20130213

#	Exception	Resumable	Description	Created on
1	CX_FPM_CONFIGURATION	☐	Configuration exceptions	20130213

Method DECODE_EVENT_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENCODED_EVENT_PARAMETERS	Call by reference	☐	Type reference (TYPE)	STRING		Encoded event parameters	20130211
2	Importing	IV_EVENT_ID	Call by reference	☐	Type reference (TYPE)	FPM_EVENT_ID		ID of the FPM Event	20130211
3	Returning	RT_DECODED_EVENT_PARAMETER	Value transfer	☐	Type reference (TYPE)	FPM_T_PARAMETER_VALUE		Parameter values	20130211

Method DECODE_EVENT_PARAMETERS on class CL_FPM_GUIBB_CHART_CONFIG has no exception.

Method DECODE_SPECIAL_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENCODED_SPECIAL_PROPERTIES	Call by reference	☐	Type reference (TYPE)	STRING		Encoded special properties	20130211
2	Returning	RS_DECODED_SPECIAL_PROPERTIES	Value transfer	☐	Type reference (TYPE)	FPMGB_S_SPECIAL_PROPERTIES		Special Properties for UI Elements	20130211

Method DECODE_SPECIAL_PROPERTIES on class CL_FPM_GUIBB_CHART_CONFIG has no exception.

Method ENCODE_EVENT_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DECODED_EVENT_PARAMETER	Call by reference	☐	Type reference (TYPE)	FPM_T_PARAMETER_VALUE		Parameter values	20130213
2	Importing	IV_EVENT_ID	Call by reference	☐	Type reference (TYPE)	FPM_EVENT_ID		ID of the FPM Event	20130213
3	Returning	RV_ENCODED_EVENT_PARAMETERS	Value transfer	☐	Type reference (TYPE)	STRING		Encoded event parameters	20130213

Method ENCODE_EVENT_PARAMETERS on class CL_FPM_GUIBB_CHART_CONFIG has no exception.

Method ENCODE_SPECIAL_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DECODED_SPECIAL_PROPERTIES	Call by reference	☐	Type reference (TYPE)	FPMGB_S_SPECIAL_PROPERTIES		Special Properties for UI Elements	20130213
2	Returning	RV_ENCODED_SPECIAL_PROPERTIES	Value transfer	☐	Type reference (TYPE)	STRING		Encoded special properties	20130213

Method ENCODE_SPECIAL_PROPERTIES on class CL_FPM_GUIBB_CHART_CONFIG has no exception.

Method GET_BUTTON_ROW_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BUTTON_ROW_ELEMENT	Call by reference	☐	Type reference (TYPE)	CL_FPM_CHART_UIBB_ASSIST=>YT_BUTTON_ROW_ELEMENT			20130211

Method GET_BUTTON_ROW_ELEMENTS on class CL_FPM_GUIBB_CHART_CONFIG has no exception.

Method GET_CONFIG_PATH_FOR_PROPERTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CFG_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Node names	20130213
2	Exporting	EV_CFG_ATTRIBUTE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Attribute name	20130213
3	Importing	IV_CHART_TYPE	Call by reference	☐	Type reference (TYPE)	FPMGB_CHART_TYPE		Chart Type	20130213
4	Importing	IV_PROPERTY_NAME	Call by reference	☐	Type reference (TYPE)	IF_FPM_GUIBB_CHART_CONFIG=>TY_S_CHART_SETTING-PROPERTY_NAME		Property name	20130213

Method GET_CONFIG_PATH_FOR_PROPERTY on class CL_FPM_GUIBB_CHART_CONFIG has no exception.

Method IS_CHART_TYPE_PROPERTY_VALID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CHART_TYPE	Call by reference	☐	Type reference (TYPE)	FPMGB_CHART_TYPE		Chart Type	20130212
2	Importing	IV_PROPERTY_NAME	Call by reference	☐	Type reference (TYPE)	IF_FPM_GUIBB_CHART_CONFIG=>TY_S_CHART_SETTING-PROPERTY_NAME		Propery name	20130212
3	Returning	RV_VALID	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Indicator: Chart type property is valid	20130212

Method IS_CHART_TYPE_PROPERTY_VALID on class CL_FPM_GUIBB_CHART_CONFIG has no exception.

Method IS_CHART_TYPE_VALID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CHART_TYPE	Call by reference	☐	Type reference (TYPE)	FPMGB_CHART_TYPE		Chart Type	20130212
2	Returning	RV_VALID	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Indicator: Chart type is valid	20130212

Method IS_CHART_TYPE_VALID on class CL_FPM_GUIBB_CHART_CONFIG has no exception.

Method IS_COLLIDING_BUTTON_ROW_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INDEX	Call by reference	☐	Type reference (TYPE)	I		Button row element index	20130213
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Indicator: Button row element index exists already	20130213

Method IS_COLLIDING_BUTTON_ROW_INDEX on class CL_FPM_GUIBB_CHART_CONFIG has no exception.

Method MOVE_BUTTON_ROW_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_IS_MOVED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Indicator: Button row element indices have been changed	20130213
2	Exporting	EV_MAX_INDEX	Call by reference	☐	Type reference (TYPE)	I		Maximum button row element index	20130213
3	Importing	IV_START_INDEX	Call by reference	☐	Type reference (TYPE)	I		Position as of which button row elements have to be moved	20130213

Method MOVE_BUTTON_ROW_ELEMENTS on class CL_FPM_GUIBB_CHART_CONFIG has no exception.

Method SET_CHART_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CHART_CONTEXT	Call by reference	☐	Type reference (TYPE)	IF_FPM_GUIBB_CHART_CONFIG~TY_S_CHART_CONTEXT			20131015

Method SET_CHART_CONTEXT on class CL_FPM_GUIBB_CHART_CONFIG has no exception.

History

Last changed by/on	SAP	20141120
SAP Release Created in	740