com.sap.tc.webdynpro.clientserver.uielib.graphics.api
Interface IWDConverter

public interface IWDConverter

Method Summary

void	clear() Clears all conversion settings and results.
void	execute() Triggers an igs call.
byte[]	getImageAsByteArray() Returns the raw data of the converted image.
byte[]	getImageAsByteArray(java.lang.String id) Returns the raw data of the matching converted image.
java.lang.String	getImageUrlString() Returns a url string to the converted image in the Web Dynpro cache.
java.lang.String	getImageUrlString(java.lang.String id) Returns a url string to the matching converted image in the Web Dynpro cache.
WDConverterOutputFormat	getOutputFormat() Returns the matching output format of the converted file.
WDConverterOutputFormat	getOutputFormat(java.lang.String id) Returns the matching output format of the converted file.
java.util.List	getResultIds() Returns a list of all conversion result ids.
void	setHeight(int height) Sets the height of the converted file (image).
void	setIgsUrl(java.net.URL igsURL) Set the URL of the IGS that provides the conversoin services
void	setInputFormat(WDConverterInputFormat inputFormat) Sets the format of the file that is to be converted This property is mandatory.
void	setOutputFormat(WDConverterOutputFormat outputFormat) Sets the format of the converted file This property is mandatory.
void	setSourceUrlString(java.lang.String sourceUrl) Sets the url of the file that is to be converted.
void	setWidth(int width) Sets the width of the converted file (image).

Method Detail

setIgsUrl

public void setIgsUrl(java.net.URL igsURL)

Set the URL of the IGS that provides the conversoin services

setWidth

public void setWidth(int width)

Sets the width of the converted file (image). This property is optional.

setHeight

public void setHeight(int height)

Sets the height of the converted file (image). This property is optional.

setSourceUrlString

public void setSourceUrlString(java.lang.String sourceUrl)

Sets the url of the file that is to be converted. This property is mandatory.

setInputFormat

public void setInputFormat(WDConverterInputFormat inputFormat)

Sets the format of the file that is to be converted This property is mandatory.

setOutputFormat

public void setOutputFormat(WDConverterOutputFormat outputFormat)

Sets the format of the converted file This property is mandatory.

execute

public void execute()
             throws WDException

Triggers an igs call. Throws an exception if call was not successful.

clear

public void clear()

Clears all conversion settings and results.

getResultIds

public java.util.List getResultIds()
                            throws WDException

Returns a list of all conversion result ids.

getOutputFormat

public WDConverterOutputFormat getOutputFormat(java.lang.String id)
                                        throws WDException

Returns the matching output format of the converted file.

getOutputFormat

public WDConverterOutputFormat getOutputFormat()
                                        throws WDException

Returns the matching output format of the converted file.

getImageAsByteArray

public byte[] getImageAsByteArray(java.lang.String id)
                           throws WDException

Returns the raw data of the matching converted image.

getImageAsByteArray

public byte[] getImageAsByteArray()
                           throws WDException

Returns the raw data of the converted image.

getImageUrlString

public java.lang.String getImageUrlString(java.lang.String id)
                                   throws WDException

Returns a url string to the matching converted image in the Web Dynpro cache.

getImageUrlString

public java.lang.String getImageUrlString()
                                   throws WDException

Returns a url string to the converted image in the Web Dynpro cache.