SAP ABAP Class CL_TFR_PERSISTENCY (Typeface Repo Persistency Layer)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CCM-PRN (Application Component) Print and Output Management
     ⤷ S_FONT_SERVICES_TFR (Package) Typeface Repository

Properties

Class	CL_TFR_PERSISTENCY
Short Description	Typeface Repo Persistency Layer
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_FONT_SERVICES_TFR	Typeface Repository
Created	20090331	SAP
Last change	20130531	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_FONT_SELECTOR	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_TFR_PERSISTENCY	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_TFR_PERSISTENCY has no interface implemented.

Friends

Class CL_TFR_PERSISTENCY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GV_LOCKED	Static Attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL			20090421
2	GV_MOD	Static Attribute	Public	☑	Type reference (TYPE)	TFR_MODE	'P'	Typeface Repo - Mode of Entry (Productive/Test)	20090402

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE_FONT	Static method	Public	Method	Activate font for search	20090513
2	ADD_FONT_BINARY	Static method	Public	Method	Add font binary to repo	20090421
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor		20090514
4	CREATE_FONT_BY_BINARY	Static method	Public	Method		20100219
5	DEACTIVATE_FONT	Static method	Public	Method	Deactivate font for search	20090513
6	DO_CODEPOINT_SEARCH	Static method	Public	Method	Do codepoint search	20090420
7	DO_SYNC	Static method	Public	Method	Sync persistency layer	20090513
8	GET_CODEPOINTS	Static method	Public	Method	Get codepoint-glyph-width mapping for font	20090609
9	GET_FONT_ALIASES_FOR_SEARCH	Static method	Public	Method	Get all font aliases	20090527
10	GET_FONT_BINARY	Static method	Public	Method	Get font binary from repo	20090421
11	GET_FONT_BINARY_LENGTH	Static method	Public	Method	Get length of Font Binary	20090331
12	GET_FONT_BINARY_LOGIDS	Static method	Public	Method	Get a list of all logical id for one physical font	20090513
13	GET_FONT_BINARY_PHYSIDS	Static method	Public	Method	Get a list of all Font Binary PhysIDs	20090331
14	GET_FONT_INFO	Static method	Public	Method	Get font info	20090529
15	GET_FONT_INFO_BY_BINARY	Static method	Public	Method	Get font info by binary data	20100212
16	GET_GLYPHS	Static method	Public	Method	Get glyph-width mapping for font	20090609
17	GET_SEARCH_ENTRIES	Static method	Public	Method	Get all search entries for family	20090528
18	GET_SEARCH_FAMILIES	Static method	Public	Method	Get all searchable families	20090527
19	GET_SEARCH_PREFFAMILIES	Static method	Public	Method	Get all searchable preferred families	20090527
20	GET_SEARCH_PSFAMILIES	Static method	Public	Method	Get all searchable PostScript families	20090528
21	IS_AUTHORIZED	Static method	Public	Method	Check if current user is authorized to change TFR	20090416
22	IS_FONT_DELETION_ALLOWED	Static method	Private	Method	Is user allowed to delete this font? (No: font from SAP)	20120622
23	LOCK	Static method	Public	Method	Lock persistency layer	20090416
24	NEEDS_SYNC	Static method	Public	Method	Return true if persistency layer needs sync (e.g. after tp)	20090513
25	REMOVE_FONT	Static method	Public	Method	Remove font from repo, mainly for font from ttc file.	20100511
26	REMOVE_FONT_BINARY	Static method	Public	Method	Remove font binary from repo	20090422
27	RESET	Static method	Public	Method	Reset persistency	20090422
28	SWITCH_TO_PROD_MODE	Static method	Public	Method	Switch table access to productive mode (mod='P')	20090402
29	SWITCH_TO_TEST_MODE	Static method	Public	Method	Switch table access to test mode (mod='T')	20090402
30	UNLOCK	Static method	Public	Method	Unlock persistency layer	20090416

Events

Class CL_TFR_PERSISTENCY has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_TFRT_INFO_CODEPOINT	Public	See coding			20100216	BEGIN OF TY_TFRT_INFO_CODEPOINT. INCLUDE TYPE tfrt_info. types: chartab TYPE TFONT_CP_TO_WIDTH_TAB, GLYPHTAB TYPE TFONT_GLYPH_TO_WIDTH_TAB, "codepoint TYPE CL_FONT_SELECTOR=>TY_CODEPOINT_TAB, END OF TY_TFRT_INFO_CODEPOINT
2	TY_TFRT_INFO_CODEPOINT_TAB	Public	See coding			20100216	TY_TFRT_INFO_CODEPOINT_TAB TYPE STANDARD TABLE OF TY_TFRT_INFO_CODEPOINT WITH DEFAULT KEY
3	TY_TFRT_INFO_TAB	Public	See coding			20100212	TY_TFRT_INFO_TAB TYPE STANDARD TABLE OF tfrt_info

Method Signatures

Method ACTIVATE_FONT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LOGID	Call by reference	☐	Type reference (TYPE)	TFRS_LOGID		Typeface Repo - Logical Font Identifier	20090513
2	Importing	IV_DO_COMMIT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100511

#	Exception	Resumable	Description	Created on
1	CX_TFR_ERROR	☐	Exception for Typeface Repo	20090513

Method ADD_FONT_BINARY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BLOB	Call by reference	☐	Type reference (TYPE)	XSTRING			20090421
2	Importing	IV_DO_COMMIT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100511
3	Returning	RV_PHYSID	Value transfer	☐	Type reference (TYPE)	TFR_PHYSFONTID		Typeface Repo - Physical Font ID	20090421

#	Exception	Resumable	Description	Created on
1	CX_TFR_ERROR	☐	Exception for Typeface Repo	20090421

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_TFR_PERSISTENCY has no parameter.
Method CLASS_CONSTRUCTOR on class CL_TFR_PERSISTENCY has no exception.

Method CREATE_FONT_BY_BINARY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BLOB	Call by reference	☐	Type reference (TYPE)	XSTRING			20100219
2	Returning	RT_FONT	Value transfer	☐	Type reference (TYPE)	CL_FONT_SELECTOR=>TY_FONT_TAB			20100219

Method CREATE_FONT_BY_BINARY on class CL_TFR_PERSISTENCY has no exception.

Method DEACTIVATE_FONT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LOGID	Call by reference	☐	Type reference (TYPE)	TFRS_LOGID		Typeface Repo - Logical Font Identifier	20090513
2	Importing	IV_DO_COMMIT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100511

Method DEACTIVATE_FONT on class CL_TFR_PERSISTENCY has no exception.

Method DO_CODEPOINT_SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CP_SEL	Call by reference	☐	Type reference (TYPE)	TFRT_CODEPOINT_SELECTIONTAB		Typeface Repo - Table of Codepoints	20090422
2	Importing	IV_ALL_FONT	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20100219
3	Importing	IV_FLAVOR	Call by reference	☐	Type reference (TYPE)	TFR_FLAVOR		Typeface Repo - OpenType Flavor (TrueType/CompactFileFormat)	20090420
4	Importing	IV_PSTAB	Call by reference	☐	Type reference (TYPE)	STRING	'TFRT_SRCH_CHARC1'		20090422
5	Importing	IV_TTTAB	Call by reference	☐	Type reference (TYPE)	STRING	'TFRT_SRCH_CHART1'		20090422
6	Returning	RT_CP_SEL	Value transfer	☐	Type reference (TYPE)	TFRT_CODEPOINT_SELECTIONTAB		Typeface Repo - Codepoint Selection Table	20090422

#	Exception	Resumable	Description	Created on
1	CX_TFR_ERROR	☐	Exception for Typeface Repo	20120423

Method DO_SYNC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GUI	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090514
2	Importing	IV_SYNC_TEXT	Call by reference	☐	Type reference (TYPE)	STRING	''		20090514
3	Importing	IV_WAIT_TEXT	Call by reference	☐	Type reference (TYPE)	STRING	''		20090514

Method DO_SYNC on class CL_TFR_PERSISTENCY has no exception.

Method GET_CODEPOINTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOGIDX	Call by reference	☐	Type reference (TYPE)	TFR_INDEX		Typeface Repo - Logical Index into Font Binary	20090609
2	Importing	IV_PHYSID	Call by reference	☐	Type reference (TYPE)	TFR_PHYSFONTID		Typeface Repo - Physical Font ID	20090609
3	Returning	RT_CP_TO_WIDTH	Value transfer	☐	Type reference (TYPE)	TFONT_CP_TO_WIDTH_TAB		Codepoint - Glyph - Width Mapping Table	20090609

Method GET_CODEPOINTS on class CL_TFR_PERSISTENCY has no exception.

Method GET_FONT_ALIASES_FOR_SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_NAMETAB	Value transfer	☐	Type reference (TYPE)	TFRT_NAMEHASHTAB		Typeface Repo - Table of Names	20090528

Method GET_FONT_ALIASES_FOR_SEARCH on class CL_TFR_PERSISTENCY has no exception.

Method GET_FONT_BINARY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PHYSID	Call by reference	☐	Type reference (TYPE)	TFR_PHYSFONTID		Typeface Repo - Physical Font ID	20090421
2	Returning	RV_DATA	Value transfer	☐	Type reference (TYPE)	XSTRING		Font Binary	20090421

Method GET_FONT_BINARY on class CL_TFR_PERSISTENCY has no exception.

Method GET_FONT_BINARY_LENGTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PHYSID	Call by reference	☐	Type reference (TYPE)	TFR_PHYSFONTID		Typeface Repo - Physical Font ID	20090331
2	Returning	RV_LENGTH	Value transfer	☐	Type reference (TYPE)	I			20090331

Method GET_FONT_BINARY_LENGTH on class CL_TFR_PERSISTENCY has no exception.

Method GET_FONT_BINARY_LOGIDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PHYSID	Call by reference	☐	Type reference (TYPE)	TFR_PHYSFONTID		Typeface Repo - Physical Font ID	20090513
2	Returning	RT_LOGIDS	Value transfer	☐	Type reference (TYPE)	TFRT_LOGIDTAB		Typeface Repo - Table of Logical Font Ids	20090513

Method GET_FONT_BINARY_LOGIDS on class CL_TFR_PERSISTENCY has no exception.

Method GET_FONT_BINARY_PHYSIDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_IDS	Value transfer	☐	Type reference (TYPE)	TFRT_PHYSIDTAB		Typeface Repo - Table of PhysIDs	20090331

Method GET_FONT_BINARY_PHYSIDS on class CL_TFR_PERSISTENCY has no exception.

Method GET_FONT_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOGIDX	Call by reference	☐	Type reference (TYPE)	TFR_INDEX		Typeface Repo - Logical Index into Font Binary	20090529
2	Importing	IV_PHYSID	Call by reference	☐	Type reference (TYPE)	TFR_PHYSFONTID		Typeface Repo - Physical Font ID	20090529
3	Returning	RS_INFO	Value transfer	☐	Type reference (TYPE)	TFRS_INFO		Typeface Repo - Info about one logical Font	20090529

Method GET_FONT_INFO on class CL_TFR_PERSISTENCY has no exception.

Method GET_FONT_INFO_BY_BINARY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_INFO	Call by reference	☐	Type reference (TYPE)	CL_TFR_PERSISTENCY=>TY_TFRT_INFO_CODEPOINT_TAB		Typeface Repo - Info Table	20100329
2	Importing	IV_BLOB	Call by reference	☐	Type reference (TYPE)	XSTRING			20100212

Method GET_FONT_INFO_BY_BINARY on class CL_TFR_PERSISTENCY has no exception.

Method GET_GLYPHS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOGIDX	Call by reference	☐	Type reference (TYPE)	TFR_INDEX			20090609
2	Importing	IV_PHYSID	Call by reference	☐	Type reference (TYPE)	TFR_PHYSFONTID		Typeface Repo - Physical Font ID	20090609
3	Returning	RT_GLYPH_TO_WIDTH	Value transfer	☐	Type reference (TYPE)	TFONT_GLYPH_TO_WIDTH_TAB			20090609

Method GET_GLYPHS on class CL_TFR_PERSISTENCY has no exception.

Method GET_SEARCH_ENTRIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENCODING	Call by reference	☐	Type reference (TYPE)	TFR_ENCODING			20090528
2	Importing	IV_FAMILY	Call by reference	☐	Type reference (TYPE)	STRING			20090528
3	Importing	IV_FLAVOR	Call by reference	☐	Type reference (TYPE)	TFR_FLAVOR			20090528
4	Importing	IV_TYPE	Call by reference	☐	Type reference (TYPE)	C			20090528
5	Returning	RT_ENTRIES	Value transfer	☐	Type reference (TYPE)	TFRT_SRCH_KEYTAB		Typeface Repo - Table of search entries	20090528

Method GET_SEARCH_ENTRIES on class CL_TFR_PERSISTENCY has no exception.

Method GET_SEARCH_FAMILIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENCODING	Call by reference	☐	Type reference (TYPE)	TFR_ENCODING			20090528
2	Importing	IV_FLAVOR	Call by reference	☐	Type reference (TYPE)	TFR_FLAVOR			20090528
3	Returning	RT_FAMILIES	Value transfer	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20090527

Method GET_SEARCH_FAMILIES on class CL_TFR_PERSISTENCY has no exception.

Method GET_SEARCH_PREFFAMILIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENCODING	Call by reference	☐	Type reference (TYPE)	TFR_ENCODING			20090528
2	Importing	IV_FLAVOR	Call by reference	☐	Type reference (TYPE)	TFR_FLAVOR			20090528
3	Returning	RT_FAMILIES	Value transfer	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20090527

Method GET_SEARCH_PREFFAMILIES on class CL_TFR_PERSISTENCY has no exception.

Method GET_SEARCH_PSFAMILIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENCODING	Call by reference	☐	Type reference (TYPE)	TFR_ENCODING			20090528
2	Importing	IV_FLAVOR	Call by reference	☐	Type reference (TYPE)	TFR_FLAVOR			20090528
3	Returning	RT_FAMILIES	Value transfer	☐	Type reference (TYPE)	STRING_TABLE			20090528

Method GET_SEARCH_PSFAMILIES on class CL_TFR_PERSISTENCY has no exception.

Method IS_AUTHORIZED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_BOOL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090416

Method IS_AUTHORIZED on class CL_TFR_PERSISTENCY has no exception.

Method IS_FONT_DELETION_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PHYSID	Value transfer	☐	Type reference (TYPE)	TFR_PHYSFONTID		Typeface Repo - Physical Font ID	20120622

#	Exception	Resumable	Description	Created on
1	CX_TFR_ERROR	☐	Exception for Typeface Repo	20120703

Method LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_AUTH	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20090513
2	Importing	IV_WAIT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090513
3	Returning	RV_BOOL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090416

#	Exception	Resumable	Description	Created on
1	CX_TFR_ERROR	☐	Exception for Typeface Repo	20090421

Method NEEDS_SYNC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_BOOL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090513

Method NEEDS_SYNC on class CL_TFR_PERSISTENCY has no exception.

Method REMOVE_FONT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DO_COMMIT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100511
2	Importing	IV_LOGIDX	Call by reference	☐	Type reference (TYPE)	TFR_INDEX		Typeface Repo - Logical Index into Font Binary	20100511
3	Importing	IV_PHYSID	Call by reference	☐	Type reference (TYPE)	TFR_PHYSFONTID		Typeface Repo - Physical Font ID	20100511

#	Exception	Resumable	Description	Created on
1	CX_TFR_ERROR	☐	Exception for Typeface Repo	20100511

Method REMOVE_FONT_BINARY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DO_COMMIT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100511
2	Importing	IV_PHYSID	Call by reference	☐	Type reference (TYPE)	TFR_PHYSFONTID		Typeface Repo - Physical Font ID	20090422

#	Exception	Resumable	Description	Created on
1	CX_TFR_ERROR	☐	Exception for Typeface Repo	20090422

Method RESET Signature

Method RESET on class CL_TFR_PERSISTENCY has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_TFR_ERROR	☐		20090422

Method SWITCH_TO_PROD_MODE Signature

Method SWITCH_TO_PROD_MODE on class CL_TFR_PERSISTENCY has no parameter.
Method SWITCH_TO_PROD_MODE on class CL_TFR_PERSISTENCY has no exception.

Method SWITCH_TO_TEST_MODE Signature

Method SWITCH_TO_TEST_MODE on class CL_TFR_PERSISTENCY has no parameter.
Method SWITCH_TO_TEST_MODE on class CL_TFR_PERSISTENCY has no exception.

Method UNLOCK Signature

Method UNLOCK on class CL_TFR_PERSISTENCY has no parameter.
Method UNLOCK on class CL_TFR_PERSISTENCY has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	800