SAP ABAP Class CL_FXS_IMAGE_PROCESSOR (Image Processor)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-I18 (Application Component) Internationalization (I18N)
     ⤷ S_XSLFO_SUPPLEMENTARY_IMAGE (Package) Supplementary image functionality

Properties

Class	CL_FXS_IMAGE_PROCESSOR
Short Description	Image Processor
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_XSLFO_SUPPLEMENTARY_IMAGE	Supplementary image functionality
Created	20081110	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_FXS_IMAGE_PROCESSOR has no forward declaration.

Interfaces

Class CL_FXS_IMAGE_PROCESSOR has no interface implemented.

Friends

Class CL_FXS_IMAGE_PROCESSOR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_IGS_IMGCONV	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_IGS_IMAGE_CONVERTER			20081110
2	MT_HANDLERS	Static Attribute	Protected	☐	See coding				20081110
3	MT_IMAGES	Instance attribute	Protected	☐	See coding				20081110
4	MV_IGS_DEST	Instance attribute	Protected	☐	See coding				20081110
5	MV_NEXT_HANDLE	Instance attribute	Protected	☐	Type reference (TYPE)	I	1		20081110

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_IMAGE	Instance method	Public	Method	Add image for further processing	20081110
2	ADD_IMAGE_FROM_URL	Instance method	Public	Method	Add image from given url (CL_FXS_URL_DATA_FETCHER)	20081110
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor		20081110
4	CONSTRUCTOR	Instance method	Public	Constructor		20081125
5	CONVERT	Instance method	Public	Method	Convert image to another format	20081110
6	DISCARD_IMAGE	Instance method	Public	Method	Discard image	20081110
7	DUPLICATE_IMAGE	Instance method	Public	Method	Duplicate image	20081111
8	FIND_HANDLER	Instance method	Protected	Method		20081110
9	GET_IMAGE	Instance method	Public	Method	Get binary image data	20081110
10	GET_INFO	Instance method	Public	Method	Get information about dimensions and other stuff	20081110
11	GET_NAMED_IMAGE	Instance method	Public	Method	Get image by name and size	20090928
12	GET_OTF_DPI	Instance method	Protected	Method		20081110
13	RESIZE	Instance method	Public	Method	Resize image	20081111

Events

Class CL_FXS_IMAGE_PROCESSOR has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_IMAGE	Protected	See coding			20081110	BEGIN OF ty_image, handle TYPE i, stream TYPE REF TO cl_fxs_binary_stream, handler TYPE REF TO cl_fxs_image_handler, mimetype TYPE string, xres TYPE i, yres TYPE i, xdpi TYPE i, ydpi TYPE i, bitdepth TYPE i, image_name type string, END OF ty_image

Method Signatures

Method ADD_IMAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20081110
2	Importing	IV_IMAGE_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Name of image for cache	20090928
3	Returning	RV_HANDLE	Value transfer	☐	Type reference (TYPE)	I			20081110

#	Exception	Resumable	Description	Created on
1	CX_FXS_IMAGE_UNSUPPORTED	☐	Unsupported image type	20081110

Method ADD_IMAGE_FROM_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_IMAGE_NAME	Call by reference	☑	Type reference (TYPE)	STRING		image name	20090928
2	Importing	IV_URL	Call by reference	☐	Type reference (TYPE)	STRING			20081110
3	Returning	RV_HANDLE	Value transfer	☐	Type reference (TYPE)	I			20081110

#	Exception	Resumable	Description	Created on
1	CX_FXS_IMAGE_UNSUPPORTED	☐	Unsupported image type	20081110

Method CLASS_CONSTRUCTOR Signature

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

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_FXS_IMAGE_PROCESSOR has no parameter.
Method CONSTRUCTOR on class CL_FXS_IMAGE_PROCESSOR has no exception.

Method CONVERT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FORMAT	Call by reference	☐	Type reference (TYPE)	STRING			20081110
2	Importing	IV_HANDLE	Call by reference	☐	Type reference (TYPE)	I			20081110
3	Importing	IV_OTF_ADJUST	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20081110

#	Exception	Resumable	Description	Created on
1	CX_SY_RANGE_OUT_OF_BOUNDS	☐	System Exceptions Accessing Subfields Beyond Boundary	20081110

Method DISCARD_IMAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HANDLE	Call by reference	☐	Type reference (TYPE)	I			20081110

Method DISCARD_IMAGE on class CL_FXS_IMAGE_PROCESSOR has no exception.

Method DUPLICATE_IMAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HANDLE	Call by reference	☐	Type reference (TYPE)	I			20081111
2	Returning	RV_HANDLE	Value transfer	☐	Type reference (TYPE)	I			20081111

#	Exception	Resumable	Description	Created on
1	CX_SY_RANGE_OUT_OF_BOUNDS	☐	System Exceptions Accessing Subfields Beyond Boundary	20081111

Method FIND_HANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_STREAM	Call by reference	☐	Object reference (TYPE REF TO)	CL_FXS_BINARY_STREAM			20081110
2	Returning	RO_HANDLER	Value transfer	☐	Object reference (TYPE REF TO)	CL_FXS_IMAGE_HANDLER			20081110

#	Exception	Resumable	Description	Created on
1	CX_FXS_IMAGE_UNSUPPORTED	☐	Unsupported image type	20081110

Method GET_IMAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HANDLE	Call by reference	☐	Type reference (TYPE)	I			20081110
2	Returning	RV_XSTRING	Value transfer	☐	Type reference (TYPE)	XSTRING			20081110

#	Exception	Resumable	Description	Created on
1	CX_SY_RANGE_OUT_OF_BOUNDS	☐	System Exceptions Accessing Subfields Beyond Boundary	20081110

Method GET_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_BITDEPTH	Call by reference	☐	Type reference (TYPE)	I			20081110
2	Exporting	EV_MIMETYPE	Call by reference	☐	Type reference (TYPE)	STRING			20081110
3	Exporting	EV_XDPI	Call by reference	☐	Type reference (TYPE)	I			20081110
4	Exporting	EV_XRES	Call by reference	☐	Type reference (TYPE)	I			20081110
5	Exporting	EV_YDPI	Call by reference	☐	Type reference (TYPE)	I			20081110
6	Exporting	EV_YRES	Call by reference	☐	Type reference (TYPE)	I			20081110
7	Importing	IV_HANDLE	Call by reference	☐	Type reference (TYPE)	I			20081110

#	Exception	Resumable	Description	Created on
1	CX_SY_RANGE_OUT_OF_BOUNDS	☐	System Exceptions Accessing Subfields Beyond Boundary	20081110

Method GET_NAMED_IMAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_IMAGE_HEIGHT	Call by reference	☐	Type reference (TYPE)	I		height in 1/72000 inch	20090928
2	Importing	IV_IMAGE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name of image	20090928
3	Importing	IV_IMAGE_WIDTH	Call by reference	☐	Type reference (TYPE)	I		width in 1/72000 inch	20090928
4	Returning	RT_HANDLE	Value transfer	☐	Type reference (TYPE)	I		image handle (0 if not found)	20090928

Method GET_NAMED_IMAGE on class CL_FXS_IMAGE_PROCESSOR has no exception.

Method GET_OTF_DPI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_XDPI	Call by reference	☐	Type reference (TYPE)	I			20081110
2	Importing	IV_YDPI	Call by reference	☐	Type reference (TYPE)	I			20081110
3	Returning	RV_DPI	Value transfer	☐	Type reference (TYPE)	I			20081110

Method GET_OTF_DPI on class CL_FXS_IMAGE_PROCESSOR has no exception.

Method RESIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HANDLE	Call by reference	☐	Type reference (TYPE)	I			20081111
2	Importing	IV_XRES	Call by reference	☐	Type reference (TYPE)	I			20081111
3	Importing	IV_YRES	Call by reference	☐	Type reference (TYPE)	I			20081111

#	Exception	Resumable	Description	Created on
1	CX_SY_RANGE_OUT_OF_BOUNDS	☐	System Exceptions Accessing Subfields Beyond Boundary	20081111

History

Last changed by/on	SAP	20110908
SAP Release Created in	720