SAP ABAP Class CL_ISHMED_DOC_CTRLAREA_SCR (Superclass for Document Display in Control Area)

Hierarchy

☛ IS-H (Software Component) SAP Healthcare
   ⤷ IS-HMED (Application Component) Clinical System
     ⤷ NMED_DOC (Package) IS-H*MED: Medical Documents

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_ISHMED_DOC_SCREEN	i.s.h.med: Root Class of Presentation Layer for Documents	20050113
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ISHMED_DOC_SCREEN_CTRLAREA	Interface for Document Display Class Displayed as Control	20050113

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_ISHMED_DOC_BROWSER_SCR	Display Class for Documents in HTML Control	20050117
2	Inheritance (c INHERITING FROM c_ref)	CL_ISHMED_DOC_WORD_SCR	i.s.h.med Control for Office Integration	20050125

Properties

Class	CL_ISHMED_DOC_CTRLAREA_SCR
Short Description	Superclass for Document Display in Control Area
Super Class	CL_ISHMED_DOC_SCREEN	i.s.h.med: Root Class of Presentation Layer for Documents
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	NMED_DOC	IS-H*MED: Medical Documents
Created	20050113	SAP
Last change	20060208	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ISHMED_DOC_SCREEN_CTRLAREA	☐	☐	Interface for Document Display Class Displayed as Control	20050113

Friends

Class CL_ISHMED_DOC_CTRLAREA_SCR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_UCOMM_BACK	Constant	Private	☐	Type reference (TYPE)	SYUCOMM	'FW_END'	Function Code: Back	20050527
2	CO_UCOMM_CANCEL	Constant	Private	☐	Type reference (TYPE)	SYUCOMM	'FW_END'	Function Code: Cancel	20050527
3	CO_UCOMM_END	Constant	Private	☐	Type reference (TYPE)	SYUCOMM	'FW_END'	Function Code: Exit	20050527
4	C_ISH_FALSE	Instance attribute	Private	☐	Attribute reference (LIKE)				20050127
5	C_ISH_TRUE	Instance attribute	Private	☐	Attribute reference (LIKE)				20050127
6	GR_PARENT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Parent Element that Control Is Inserted In	20050113
7	GS_CONTENT_META	Instance attribute	Protected	☐	Type reference (TYPE)	RN2DOCCONTENT_META		Description Data for Content Part of Document	20050228
8	GS_DOCCAT	Instance attribute	Protected	☐	Type reference (TYPE)	RN2DOCCATEGORY		Doc Cat Information	20050613
9	S_ACTIVE_VIEW_CONTENT	Static Attribute	Private	☐	Type reference (TYPE)	TT_ACTIVE_VIEW			20050124
10	S_CONTROL_TAB	Static Attribute	Private	☐	Type reference (TYPE)	TT_CONTROL_TAB			20050113

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20050613
2	CREATE_CTRL_INSTANCE	Instance method	Protected	Method	Creates Required GUI Control	20050117
3	DO_SHOW	Instance method	Protected	Method	Initializes or Controls and Displays the Document In It	20050113
4	ENSURE_ACTIVE	Instance method	Public	Method	Ensures This Document Is Displayed	20050124
5	FREE_CONTROL_INSTANCE	Instance method	Protected	Method	Re-releases a Control If no Longer Used	20050117
6	GET_CTRL_INSTANCE	Instance method	Protected	Method	Creates a GUI Control or Returns an Existing One	20050113
7	IS_ACTIVE	Instance method	Protected	Method	Checks Whether This Document Is Active in Certain Control	20050124
8	MARK_AS_ACTIVE	Instance method	Protected	Method	Remembers That This Document Runs in a Control	20050124
9	RELOAD	Instance method	Public	Method	Gets Data Again and Resfreshes Content of Display	20050124
10	SHOW_AS_CONTROL	Instance method	Public	Method		20050113

Events

Class CL_ISHMED_DOC_CTRLAREA_SCR has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TT_ACTIVE_VIEW	Private	See coding			20050124	tt_active_view type table of t_active_view with key control_instance
2	TT_CONTROL_TAB	Private	See coding			20050124	tt_control_tab type standard table of t_controltab_line with default key
3	T_ACTIVE_VIEW	Private	See coding			20050124	begin of t_active_view, control_instance type ref to cl_gui_control, doc_key like g_doc_key_string, end of t_active_view
4	T_CONTROLTAB_LINE	Private	See coding			20050124	begin of t_controltab_line, id type string, parent type ref to cl_gui_container, control type ref to cl_gui_control, usage type i, end of t_controltab_line

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DOC	Call by reference	☐	Object reference (TYPE REF TO)	CL_ISHMED_DOC		IS-H*MED Dokumente: Controller-Klasse	20050613
2	Importing	IR_WP_ENV	Call by reference	☑	Object reference (TYPE REF TO)	IF_ISHMED_DOC_WP_ENV		Arbeitsplatzumgebung	20050613
3	Importing	IS_DOC_KEY	Call by reference	☐	Type reference (TYPE)	RN2DOC_KEY			20050613

#	Exception	Resumable	Description	Created on
1	CX_ISHMED_DOC_MAINTAIN	☐	IS-H*MED Dokumente: Ausnahmen bei Instanzierung	20050803

Method CREATE_CTRL_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CONTROL_ID	Call by reference	☐	Type reference (TYPE)	STRING		eine freie ID, unter der das Control verwaltet wird	20050117
2	Importing	I_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		das Elternelement des neuen Controls	20050117
3	Returning	R_GUI_CONTROL	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTROL		das angeforderte Control	20050117

Method CREATE_CTRL_INSTANCE on class CL_ISHMED_DOC_CTRLAREA_SCR has no exception.

Method DO_SHOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CONTENT_META	Call by reference	☐	Type reference (TYPE)	RN2DOCCONTENT_META		Format des anzuzeigenden Inhalts	20050119
2	Importing	I_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Elternelement, in dem die Anzeige verankert werden soll	20050124

#	Exception	Resumable	Description	Created on
1	CX_ISHMED_DOC_MAINTAIN	☐	IS-H*MED Dokumente: Ausnahmen bei Instanzierung	20050124

Method ENSURE_ACTIVE Signature

Method ENSURE_ACTIVE on class CL_ISHMED_DOC_CTRLAREA_SCR has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ISHMED_DOC_MAINTAIN	☐	IS-H*MED Dokumente: Anlegen / Pflege	20050124

Method FREE_CONTROL_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CONTROL	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTROL		Das freizugebende Control	20050120
2	Returning	R_USAGE_LEFT	Value transfer	☐	Type reference (TYPE)	I		Anzahl der noch verbleibenen Verwendungen	20050120

Method FREE_CONTROL_INSTANCE on class CL_ISHMED_DOC_CTRLAREA_SCR has no exception.

Method GET_CTRL_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CONTROL_ID	Call by reference	☐	Type reference (TYPE)	STRING		eine freie ID, unter der das Control verwaltet wird	20050113
2	Importing	I_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		das Elternelement des neuen Controls	20050113
3	Returning	R_GUI_CONTROL	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTROL		das angeforderte Control	20050113

Method GET_CTRL_INSTANCE on class CL_ISHMED_DOC_CTRLAREA_SCR has no exception.

Method IS_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CONTROL_INSTANCE	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTROL		Das Control, das geprüft wird	20050124
2	Returning	R_IS_ACTIVE	Value transfer	☐	Type reference (TYPE)	ISH_TRUE_FALSE		true: das Dokument wird schon in diesem Control gezeigt	20050124

Method IS_ACTIVE on class CL_ISHMED_DOC_CTRLAREA_SCR has no exception.

Method MARK_AS_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CONTROL_INSTANCE	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTROL		Control-Instanz, in der das Control instantiiert wurde	20050124

Method MARK_AS_ACTIVE on class CL_ISHMED_DOC_CTRLAREA_SCR has no exception.

Method RELOAD Signature

Method RELOAD on class CL_ISHMED_DOC_CTRLAREA_SCR has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ISHMED_DOC_MAINTAIN	☐	IS-H*MED Dokumente: Ausnahmen bei Instanzierung	20050124

Method SHOW_AS_CONTROL Signature

Method SHOW_AS_CONTROL on class CL_ISHMED_DOC_CTRLAREA_SCR has no parameter.
Method SHOW_AS_CONTROL on class CL_ISHMED_DOC_CTRLAREA_SCR has no exception.

History

Last changed by/on	SAP	20060208
SAP Release Created in	600